Gjsify LogoGjsify Logo

GtkMediaStream is the integration point for media playback inside GTK.

GTK provides an implementation of the GtkMediaStream interface that is called [classGtk.MediaFile].

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

Hierarchy

Index

Constructors

Properties

duration: number

The stream's duration in microseconds or 0 if unknown.

ended: boolean

Set when playback has finished.

error: GLib.Error

%NULL for a properly working stream or the GError that the stream is in.

g_type_instance: TypeInstance
has_audio: boolean

Whether the stream contains audio.

has_video: boolean

Whether the stream contains video.

loop: boolean

Try to restart the media from the beginning once it ended.

muted: boolean

Whether the audio stream should be muted.

parent_instance: GObject.Object
playing: boolean

Whether the stream is currently playing.

prepared: boolean

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

seekable: boolean

Set unless the stream is known to not support seeking.

seeking: boolean

Set while a seek is in progress.

timestamp: number

The current presentation timestamp in microseconds.

volume: number

Volume of the audio stream.

name: string

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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • compute_concrete_size(specified_width: number, specified_height: number, default_width: number, default_height: number): [number, number]
  • Compute a concrete size for the GdkPaintable.

    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]

  • connect(sigName: "notify::duration", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::ended", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::error", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::has-audio", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::has-video", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::loop", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::muted", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::playing", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::prepared", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::seekable", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::seeking", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::timestamp", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::volume", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "notify::duration", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::ended", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::error", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::has-audio", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::has-video", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::loop", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::muted", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::playing", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::prepared", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::seekable", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::seeking", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::timestamp", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::volume", callback: (($obj: MediaStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): void
  • emit(sigName: "notify::duration", ...args: any[]): void
  • emit(sigName: "notify::ended", ...args: any[]): void
  • emit(sigName: "notify::error", ...args: any[]): void
  • emit(sigName: "notify::has-audio", ...args: any[]): void
  • emit(sigName: "notify::has-video", ...args: any[]): void
  • emit(sigName: "notify::loop", ...args: any[]): void
  • emit(sigName: "notify::muted", ...args: any[]): void
  • emit(sigName: "notify::playing", ...args: any[]): void
  • emit(sigName: "notify::prepared", ...args: any[]): void
  • emit(sigName: "notify::seekable", ...args: any[]): void
  • emit(sigName: "notify::seeking", ...args: any[]): void
  • emit(sigName: "notify::timestamp", ...args: any[]): void
  • emit(sigName: "notify::volume", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freeze_notify(): 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::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 [methodGtk.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 [methodGtk.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 Paintable

  • get_data(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • get_duration(): number
  • get_ended(): boolean
  • If the stream is in an error state, returns the GError explaining that state.

    Any type of error can be reported here depending on the implementation of the media stream.

    A media stream in an error cannot be operated on, calls like [methodGtk.MediaStream.play] or [methodGtk.MediaStream.seek] will not have any effect.

    GtkMediaStream itself does not provide a way to unset an error, but implementations may provide options. For example, a [classGtk.MediaFile] will unset errors when a new source is set, e.g. with [methodGtk.MediaFile.set_file].

    Returns GLib.Error

  • get_intrinsic_aspect_ratio(): number
  • 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 [methodGdk.Paintable.snapshot].

    Usually when a paintable returns nonzero values from [methodGdk.Paintable.get_intrinsic_width] and [methodGdk.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

  • get_intrinsic_height(): 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 [methodGdk.Paintable.snapshot].

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

    Returns number

  • get_intrinsic_width(): 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 [methodGdk.Paintable.snapshot].

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

    Returns number

  • get_loop(): boolean
  • Returns whether the stream is set to loop.

    See [methodGtk.MediaStream.set_loop] for details.

    Returns boolean

  • get_muted(): boolean
  • Returns whether the audio for the stream is muted.

    See [methodGtk.MediaStream.set_muted] for details.

    Returns boolean

  • get_playing(): boolean
  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue 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 g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • get_timestamp(): number
  • get_volume(): number
  • Returns the volume of the audio for the stream.

    See [methodGtk.MediaStream.set_volume] for details.

    Returns number

  • getv(names: string[], values: any[]): void
  • 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

  • invalidate_contents(): void
  • Called by implementations of GdkPaintable to invalidate their contents.

    Unless the contents are invalidated, implementations must guarantee that multiple calls of [methodGdk.Paintable.snapshot] produce the same output.

    This function will emit the [signalGdk.Paintable::invalidate-contents] signal.

    If a paintable reports the %GDK_PAINTABLE_STATIC_CONTENTS flag, it must not call this function.

    Returns void

  • invalidate_size(): void
  • Called by implementations of GdkPaintable 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 [signalGdk.Paintable::invalidate-size] signal.

    If a paintable reports the %GDK_PAINTABLE_STATIC_SIZE flag, it must not call this function.

    Returns void

  • is_floating(): boolean
  • is_prepared(): boolean
  • Returns whether the stream has finished initializing.

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

    Returns boolean

  • is_seekable(): boolean
  • 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 [methodGtk.MediaStream.seek] on a non-seekable stream, though it will not do anything.

    Returns boolean

  • is_seeking(): boolean
  • notify(property_name: string): void
  • 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • pause(): void
  • play(): void
  • Called by users to attach the media stream to a GdkSurface they manage.

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

    Whoever calls this function is responsible for calling [methodGtk.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 [methodGtk.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

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] 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

  • run_dispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • seek(timestamp: number): 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 [propertyGtk.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

  • seek_failed(): 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 [methodGtk.MediaStream.seek_success] for the other way of ending a seek.

    Returns void

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

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

    See [methodGtk.MediaStream.seek_failed] for the other way of ending a seek.

    Returns void

  • set_data(key: string, data?: object): 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_loop(loop: boolean): 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

  • set_muted(muted: boolean): 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

  • set_playing(playing: boolean): void
  • Starts or pauses playback of the stream.

    Parameters

    • playing: boolean

      whether to start or pause playback

    Returns void

  • set_property(property_name: string, value?: any): void
  • set_volume(volume: number): 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

  • snapshot(snapshot: Gdk.Snapshot, width: number, height: number): 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 GdkSnapshot to snapshot to

    • width: number

      width to snapshot in

    • height: number

      height to snapshot in

    Returns void

  • steal_data(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • steal_qdata(quark: number): object
  • 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 #GQuark, naming the user data pointer

    Returns object

  • stream_ended(): void
  • Pauses the media stream and marks it as ended.

    This is a hint only, calls to [methodGtk.MediaStream.play] may still happen.

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

    Returns void

  • stream_prepared(has_audio: boolean, has_video: boolean, seekable: boolean, duration: number): void
  • Called by GtkMediaStream 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 [methodGtk.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

  • stream_unprepared(): void
  • Resets a given media stream implementation.

    [methodGtk.MediaStream.stream_prepared] can then be called again.

    This function will also reset any error state the stream was in.

    Returns void

  • thaw_notify(): 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::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

    • surface: Gdk.Surface

      the GdkSurface the stream was realized with

    Returns void

  • unref(): 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 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 instance. Use g_clear_object() for this.

    Returns void

  • update(timestamp: number): 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

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): 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.

    virtual

    Returns Paintable

  • vfunc_get_intrinsic_aspect_ratio(): number
  • 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 [methodGdk.Paintable.snapshot].

    Usually when a paintable returns nonzero values from [methodGdk.Paintable.get_intrinsic_width] and [methodGdk.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.

    virtual

    Returns number

  • vfunc_get_intrinsic_height(): 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 [methodGdk.Paintable.snapshot].

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

    virtual

    Returns number

  • vfunc_get_intrinsic_width(): 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 [methodGdk.Paintable.snapshot].

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

    virtual

    Returns number

  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • 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.

    virtual

    Parameters

    Returns void

  • vfunc_pause(): void
  • vfunc_play(): boolean
  • Called by users to attach the media stream to a GdkSurface they manage.

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

    Whoever calls this function is responsible for calling [methodGtk.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 [methodGtk.MediaStream.unrealize].

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

    virtual

    Parameters

    Returns void

  • vfunc_seek(timestamp: number): 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 [propertyGtk.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.

    virtual

    Parameters

    • timestamp: number

      timestamp to seek to.

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_snapshot(snapshot: Gdk.Snapshot, width: number, height: number): 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.

    virtual

    Parameters

    • snapshot: Gdk.Snapshot

      a GdkSnapshot 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.

    virtual

    Parameters

    • surface: Gdk.Surface

      the GdkSurface the stream was realized with

    Returns void

  • vfunc_update_audio(muted: boolean, volume: number): void
  • watch_closure(closure: TClosure<any, any>): 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

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compat_control(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • 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 #GParamSpec, 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 #GTypeInfo.) 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

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method