Class media-stream - cl-cffi-gtk4 API documentation

Package: gtk

Class gtk:media-stream

Superclasses

gdk:paintable, gobject:object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

gtk:media-file

Direct Slots

duration

The duration property of type :int64 (Read)
The stream's duration in microseconds or 0 if unknown.
Allowed values: >= 0
Default value: 0

ended

The ended property of type :boolean (Read)
Set when playback has finished.
Default value: false

error

The error property of type GError (Read)
Nil for a properly working stream or the GError that the stream is in.

has-audio

The has-audio property of type :boolean (Read)
Whether the stream contains audio.
Default value: false

has-video

The has-video property of type :boolean (Read)
Whether the stream contains video.
Default value: false

loop

The loop property of type :boolean (Read / Write)
Try to restart the media from the beginning once it ended.
Default value: false

muted

The muted property of type :boolean (Read / Write)
Whether the audio stream should be muted.
Default value: false

playing

The playing property of type :boolean (Read / Write)
Whether the audio stream should be muted.
Default value: false

prepared

The prepared property of type :boolean (Read / Write)
Whether the stream has finished initializing and existence of audio and video is known.
Default value: false

seekable

The seekable property of type :boolean (Read)
Set unless the stream is known to not support seeking.
Default value: true

seeking

The seeking property of type :boolean (Read)
Set while a seek is in progress.
Default value: false

timestamp

The timestamp property of type :int64 (Read)
The current presentation timestamp in microseconds.
Allowed values: >= 0
Default value: 0

volume

The volume property of type :double (Read / Write)
Volume of the audio stream.
Allowed values: [0,1]
Default value: 1

Details

The gtk:media-stream object is the integration point for media playback inside GTK. GTK provides an implementation of the gtk:media-stream interface that is called the gtk:media-file object.

Apart from application-facing API for stream playback, the gtk:media-stream object has a number of APIs that are only useful for implementations and should not be used in applications: gtk:media-stream-prepared, gtk:media-stream-unprepared, gtk.media-stream-update, gtk:media-stream-ended, gtk:media-stream-seek-success, gtk:media-stream-seek-failed, gtk:media-stream-gerror, gtk:media-stream-error, gtk:media-stream-error-valist functions.