Class (GI Class)

Gtk-4.0GtkMediaStreamAbstract

The integration point for media playback inside GTK.

GTK provides an implementation of the Gtk.MediaStream interface that is called Gtk.MediaFile.

Apart from application-facing API for stream playback, Gtk.MediaStream has a number of APIs that are only useful for implementations and should not be used in applications: Gtk.MediaStream.prepared, Gtk.MediaStream.unprepared, Gtk.MediaStream.update, Gtk.MediaStream.ended, Gtk.MediaStream.seek_success, Gtk.MediaStream.seek_failed, Gtk.MediaStream.gerror, Gtk.MediaStream.error, Gtk.MediaStream.error_valist.

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Methods - Inherited from GObject

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

Accessors

  • get prepared(): boolean

    Whether the stream has finished initializing and existence of audio and video is known.

    Returns boolean

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    • ...args: never[]

      the property on source to bind

    Returns any

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Compute a concrete size for the Gdk.Paintable.

    Applies the sizing algorithm outlined in the CSS Image spec to the given paintable. See that link for more details.

    It is not necessary to call this function when both specified_width and specified_height are known, but it is useful to call this function in GtkWidget:measure implementations to compute the other dimension when only one dimension is given.

    Parameters

    • specified_width: number

      the width paintable could be drawn into or 0.0 if unknown

    • specified_height: number

      the height paintable could be drawn into or 0.0 if unknown

    • default_width: number

      the width paintable would be drawn into if no other constraints were given

    • default_height: number

      the height paintable would be drawn into if no other constraints were given

    Returns [number, number]

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Sets self into an error state.

    This will pause the stream (you can check for an error via Gtk.MediaStream.get_error in your GtkMediaStream.pause() implementation), abort pending seeks and mark the stream as prepared.

    if the stream is already in an error state, this call will be ignored and the existing error will be retained.

    To unset an error, the stream must be reset via a call to Gtk.MediaStream.unprepared.

    Parameters

    Returns void

  • Gets an immutable paintable for the current contents displayed by paintable.

    This is useful when you want to retain the current state of an animation, for example to take a screenshot of a running animation.

    If the paintable is already immutable, it will return itself.

    Returns Gdk.Paintable

    An immutable paintable for the current contents of paintable

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets the duration of the stream.

    If the duration is not known, 0 will be returned.

    Returns number

    the duration of the stream or 0 if not known.

  • Returns whether the streams playback is finished.

    Returns boolean

    true if playback is finished

  • Gets the preferred aspect ratio the paintable would like to be displayed at.

    The aspect ratio is the width divided by the height, so a value of 0.5 means that the paintable prefers to be displayed twice as high as it is wide. Consumers of this interface can use this to preserve aspect ratio when displaying the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.

    Usually when a paintable returns nonzero values from Gdk.Paintable.get_intrinsic_width and Gdk.Paintable.get_intrinsic_height the aspect ratio should conform to those values, though that is not required.

    If the paintable does not have a preferred aspect ratio, it returns 0. Negative values are never returned.

    Returns number

    the intrinsic aspect ratio of paintable or 0 if none.

  • Gets the preferred height the paintable would like to be displayed at.

    Consumers of this interface can use this to reserve enough space to draw the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.

    If the paintable does not have a preferred height, it returns 0. Negative values are never returned.

    Returns number

    the intrinsic height of paintable or 0 if none.

  • Gets the preferred width the paintable would like to be displayed at.

    Consumers of this interface can use this to reserve enough space to draw the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.

    If the paintable does not have a preferred width, it returns 0. Negative values are never returned.

    Returns number

    the intrinsic width of paintable or 0 if none.

  • Return whether the stream is currently playing.

    Returns boolean

    true if the stream is playing

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • Returns the current presentation timestamp in microseconds.

    Returns number

    the timestamp in microseconds

  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Called by implementations of Gdk.Paintable to invalidate their size.

    As long as the size is not invalidated, paintable must return the same values for its intrinsic width, height and aspect ratio.

    This function will emit the Gdk.Paintable::invalidate-size signal.

    If a paintable reports the Gdk.PaintableFlags.STATIC_SIZE flag, it must not call this function.

    Returns void

  • Returns whether the stream has finished initializing.

    At this point the existence of audio and video is known.

    Returns boolean

    true if the stream is prepared

  • Checks if a stream may be seekable.

    This is meant to be a hint. Streams may not allow seeking even if this function returns true. However, if this function returns false, streams are guaranteed to not be seekable and user interfaces may hide controls that allow seeking.

    It is allowed to call Gtk.MediaStream.seek on a non-seekable stream, though it will not do anything.

    Returns boolean

    true if the stream may support seeking

  • Checks if there is currently a seek operation going on.

    Returns boolean

    true if a seek operation is ongoing.

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    Returns void

  • Pauses playback of the stream.

    If the stream is not playing, do nothing.

    Returns void

  • Starts playing the stream.

    If the stream is in error or already playing, do nothing.

    Returns void

  • Called by users to attach the media stream to a Gdk.Surface they manage.

    The stream can then access the resources of surface for its rendering purposes. In particular, media streams might want to create a Gdk.GLContext or sync to the Gdk.FrameClock.

    Whoever calls this function is responsible for calling Gtk.MediaStream.unrealize before either the stream or surface get destroyed.

    Multiple calls to this function may happen from different users of the video, even with the same surface. Each of these calls must be followed by its own call to Gtk.MediaStream.unrealize.

    It is not required to call this function to make a media stream work.

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the floating reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • Start a seek operation on self to timestamp.

    If timestamp is out of range, it will be clamped.

    Seek operations may not finish instantly. While a seek operation is in process, the Gtk.MediaStream.seeking property will be set.

    When calling gtk_media_stream_seek() during an ongoing seek operation, the new seek will override any pending seek.

    Parameters

    • timestamp: number

      timestamp to seek to.

    Returns void

  • Ends a seek operation started via GtkMediaStream.seek() as a failure.

    This will not cause an error on the stream and will assume that playback continues as if no seek had happened.

    See Gtk.MediaStream.seek_success for the other way of ending a seek.

    Returns void

  • Ends a seek operation started via GtkMediaStream.seek() successfully.

    This function will unset the GtkMediaStream:ended property if it was set.

    See Gtk.MediaStream.seek_failed for the other way of ending a seek.

    Returns void

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets whether the stream should loop.

    In this case, it will attempt to restart playback from the beginning instead of stopping at the end.

    Not all streams may support looping, in particular non-seekable streams. Those streams will ignore the loop setting and just end.

    Parameters

    • loop: boolean

      true if the stream should loop

    Returns void

  • Sets whether the audio stream should be muted.

    Muting a stream will cause no audio to be played, but it does not modify the volume. This means that muting and then unmuting the stream will restore the volume settings.

    If the stream has no audio, calling this function will still work but it will not have an audible effect.

    Parameters

    • muted: boolean

      true if the stream should be muted

    Returns void

  • Starts or pauses playback of the stream.

    Parameters

    • playing: boolean

      whether to start or pause playback

    Returns void

  • Sets the volume of the audio stream.

    This function call will work even if the stream is muted.

    The given volume should range from 0.0 for silence to 1.0 for as loud as possible. Values outside of this range will be clamped to the nearest value.

    If the stream has no audio or is muted, calling this function will still work but it will not have an immediate audible effect. When the stream is unmuted, the new volume setting will take effect.

    Parameters

    • volume: number

      New volume of the stream from 0.0 to 1.0

    Returns void

  • Snapshots the given paintable with the given width and height.

    The paintable is drawn at the current (0,0) offset of the snapshot. If width and height are not larger than zero, this function will do nothing.

    Parameters

    • snapshot: Gdk.Snapshot

      a Gdk.Snapshot to snapshot to

    • width: number

      width to snapshot in

    • height: number

      height to snapshot in

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Pauses the media stream and marks it as ended.

    This is a hint only, calls to Gtk.MediaStream.play may still happen.

    The media stream must be prepared when this function is called.

    Returns void

  • Called by Gtk.MediaStream implementations to advertise the stream being ready to play and providing details about the stream.

    Note that the arguments are hints. If the stream implementation cannot determine the correct values, it is better to err on the side of caution and return true. User interfaces will use those values to determine what controls to show.

    This function may not be called again until the stream has been reset via Gtk.MediaStream.stream_unprepared.

    Parameters

    • has_audio: boolean

      true if the stream should advertise audio support

    • has_video: boolean

      true if the stream should advertise video support

    • seekable: boolean

      true if the stream should advertise seekability

    • duration: number

      The duration of the stream or 0 if unknown

    Returns void

  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Undoes a previous call to gtk_media_stream_realize().

    This causes the stream to release all resources it had allocated from surface.

    Parameters

    Returns void

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • Media stream implementations should regularly call this function to update the timestamp reported by the stream.

    It is up to implementations to call this at the frequency they deem appropriate.

    The media stream must be prepared when this function is called.

    Parameters

    • timestamp: number

      the new timestamp

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • Gets an immutable paintable for the current contents displayed by paintable.

    This is useful when you want to retain the current state of an animation, for example to take a screenshot of a running animation.

    If the paintable is already immutable, it will return itself.

    Returns Gdk.Paintable

  • Gets the preferred aspect ratio the paintable would like to be displayed at.

    The aspect ratio is the width divided by the height, so a value of 0.5 means that the paintable prefers to be displayed twice as high as it is wide. Consumers of this interface can use this to preserve aspect ratio when displaying the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.

    Usually when a paintable returns nonzero values from Gdk.Paintable.get_intrinsic_width and Gdk.Paintable.get_intrinsic_height the aspect ratio should conform to those values, though that is not required.

    If the paintable does not have a preferred aspect ratio, it returns 0. Negative values are never returned.

    Returns number

  • Gets the preferred height the paintable would like to be displayed at.

    Consumers of this interface can use this to reserve enough space to draw the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.

    If the paintable does not have a preferred height, it returns 0. Negative values are never returned.

    Returns number

  • Gets the preferred width the paintable would like to be displayed at.

    Consumers of this interface can use this to reserve enough space to draw the paintable.

    This is a purely informational value and does not in any way limit the values that may be passed to Gdk.Paintable.snapshot.

    If the paintable does not have a preferred width, it returns 0. Negative values are never returned.

    Returns number

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • Pauses playback of the stream.

    If the stream is not playing, do nothing.

    Returns void

  • Called by users to attach the media stream to a Gdk.Surface they manage.

    The stream can then access the resources of surface for its rendering purposes. In particular, media streams might want to create a Gdk.GLContext or sync to the Gdk.FrameClock.

    Whoever calls this function is responsible for calling Gtk.MediaStream.unrealize before either the stream or surface get destroyed.

    Multiple calls to this function may happen from different users of the video, even with the same surface. Each of these calls must be followed by its own call to Gtk.MediaStream.unrealize.

    It is not required to call this function to make a media stream work.

    Parameters

    Returns void

  • Start a seek operation on self to timestamp.

    If timestamp is out of range, it will be clamped.

    Seek operations may not finish instantly. While a seek operation is in process, the Gtk.MediaStream.seeking property will be set.

    When calling gtk_media_stream_seek() during an ongoing seek operation, the new seek will override any pending seek.

    Parameters

    • timestamp: number

      timestamp to seek to.

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

  • Snapshots the given paintable with the given width and height.

    The paintable is drawn at the current (0,0) offset of the snapshot. If width and height are not larger than zero, this function will do nothing.

    Parameters

    • snapshot: Gdk.Snapshot

      a Gdk.Snapshot to snapshot to

    • width: number

      width to snapshot in

    • height: number

      height to snapshot in

    Returns void

  • Undoes a previous call to gtk_media_stream_realize().

    This causes the stream to release all resources it had allocated from surface.

    Parameters

    Returns void

  • Parameters

    • muted: boolean
    • volume: number

    Returns void

  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    Returns void

Methods - Inherited from GObject

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures