MediaStream

GtkMediaStream is the integration point for media playback inside GTK.

GTK provides an implementation of the GtkMediaStream interface that is called [class@Gtk.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: [method@Gtk.MediaStream.prepared], [method@Gtk.MediaStream.unprepared], [method@Gtk.MediaStream.update], [method@Gtk.MediaStream.ended], [method@Gtk.MediaStream.seek_success], [method@Gtk.MediaStream.seek_failed], [method@Gtk.MediaStream.gerror], [method@Gtk.MediaStream.error], [method@Gtk.MediaStream.error_valist].

class MediaStream : ObjectG , PaintableIF {

protected

GtkMediaStream* gtkMediaStream;

GtkMediaStream* getMediaStreamStruct(bool transferOwnership);

void* getStruct();

this(GtkMediaStream* gtkMediaStream, bool ownedRef);

mixin PaintableT!(GtkMediaStream) ;

static GType getType();

void ended();

void errorValist(GQuark domain, int code, string format, void* args);

void gerror(ErrorG error);

long getDuration();

long getTimestamp();

double getVolume();

void prepared(bool hasAudio, bool hasVideo, bool seekable, long duration);

void realize(Surface surface);

void seek(long timestamp);

void seekFailed();

void seekSuccess();

void setLoop(bool loop);

void setMuted(bool muted);

void setPlaying(bool playing);

void setVolume(double volume);

void unprepared();

void unrealize(Surface surface);

void update(long timestamp);

}

Constructors

this this(GtkMediaStream* gtkMediaStream, bool ownedRef): Sets our main struct and passes it to the parent class.

Members

Functions

ended void ended(): Pauses the media stream and marks it as ended.
errorValist void errorValist(GQuark domain, int code, string format, void* args): Sets @self into an error state using a printf()-style format string.
gerror void gerror(ErrorG error): Sets @self into an error state.
getDuration long getDuration(): Gets the duration of the stream.
getEnded bool getEnded(): Returns whether the streams playback is finished.
getError ErrorG getError(): If the stream is in an error state, returns the GError explaining that state.
getLoop bool getLoop(): Returns whether the stream is set to loop.
getMediaStreamStruct GtkMediaStream* getMediaStreamStruct(bool transferOwnership): Get the main Gtk struct
getMuted bool getMuted(): Returns whether the audio for the stream is muted.
getPlaying bool getPlaying(): Return whether the stream is currently playing.
getStruct void* getStruct(): the main Gtk struct as a void*
getTimestamp long getTimestamp(): Returns the current presentation timestamp in microseconds.
getVolume double getVolume(): Returns the volume of the audio for the stream.
hasAudio bool hasAudio(): Returns whether the stream has audio.
hasVideo bool hasVideo(): Returns whether the stream has video.
isPrepared bool isPrepared(): Returns whether the stream has finished initializing.
isSeekable bool isSeekable(): Checks if a stream may be seekable.
isSeeking bool isSeeking(): Checks if there is currently a seek operation going on.
pause void pause(): Pauses playback of the stream.
play void play(): Starts playing the stream.
prepared void prepared(bool hasAudio, bool hasVideo, bool seekable, long duration): Called by GtkMediaStream implementations to advertise the stream being ready to play and providing details about the stream.
realize void realize(Surface surface): Called by users to attach the media stream to a GdkSurface they manage.
seek void seek(long timestamp): Start a seek operation on @self to @timestamp.
seekFailed void seekFailed(): Ends a seek operation started via GtkMediaStream.seek() as a failure.
seekSuccess void seekSuccess(): Ends a seek operation started via GtkMediaStream.seek() successfully.
setLoop void setLoop(bool loop): Sets whether the stream should loop.
setMuted void setMuted(bool muted): Sets whether the audio stream should be muted.
setPlaying void setPlaying(bool playing): Starts or pauses playback of the stream.
setVolume void setVolume(double volume): Sets the volume of the audio stream.
unprepared void unprepared(): Resets a given media stream implementation.
unrealize void unrealize(Surface surface): Undoes a previous call to gtk_media_stream_realize().
update void update(long timestamp): Media stream implementations should regularly call this function to update the timestamp reported by the stream.

Mixins

__anonymous mixin PaintableT!(GtkMediaStream): Undocumented in source.

Static functions

getType GType getType()

Variables

gtkMediaStream GtkMediaStream* gtkMediaStream;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
ownedRef bool ownedRef;: Undocumented in source.
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
isGcRoot bool isGcRoot;: Undocumented in source.
signals DClosure[gulong] signals;: Undocumented in source.
destroyNotify void destroyNotify(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify void toggleNotify(ObjectG obj, GObject* object, int isLastRef): Undocumented in source. Be warned that the author may not have intended to support it.
~this ~this(): Undocumented in source.
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
removeGcRoot void removeGcRoot(): Undocumented in source. Be warned that the author may not have intended to support it.
setProperty void setProperty(string propertyName, T value)
unref deprecated void unref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
doref deprecated ObjectG doref(ObjectG obj): Undocumented in source. Be warned that the author may not have intended to support it.
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): 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().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): 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.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): 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().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): 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:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom): 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.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
forceFloating void forceFloating(): 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().
freezeNotify void freezeNotify(): 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.
getData void* getData(string key): Gets a named field from the objects table of associations (see g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, Value[] values): 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.
isFloating bool isFloating(): Checks whether @object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property @property_name on @object.
notifyByPspec void notifyByPspec(ParamSpec pspec): Emits a "notify" signal for the property specified by @pspec on @object.
doref alias doref = ref_: Undocumented in source.
ref_ ObjectG ref_(): Increases the reference count of @object.
refSink ObjectG refSink(): Increase the reference count of @object, and possibly remove the floating[floating-ref] reference, if @object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(GQuark quark): 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);
thawNotify void thawNotify(): 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.
unref void unref(): Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(Closure closure): 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.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is disposed. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a #GObject.

From PaintableIF

getPaintableStruct GdkPaintable* getPaintableStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
computeConcreteSize void computeConcreteSize(double specifiedWidth, double specifiedHeight, double defaultWidth, double defaultHeight, double concreteWidth, double concreteHeight): Compute a concrete size for the GdkPaintable.
getCurrentImage PaintableIF getCurrentImage(): Gets an immutable paintable for the current contents displayed by @paintable.
getFlags GdkPaintableFlags getFlags(): Get flags for the paintable.
getIntrinsicAspectRatio double getIntrinsicAspectRatio(): Gets the preferred aspect ratio the @paintable would like to be displayed at.
getIntrinsicHeight int getIntrinsicHeight(): Gets the preferred height the @paintable would like to be displayed at.
getIntrinsicWidth int getIntrinsicWidth(): Gets the preferred width the @paintable would like to be displayed at.
invalidateContents void invalidateContents(): Called by implementations of GdkPaintable to invalidate their contents.
invalidateSize void invalidateSize(): Called by implementations of GdkPaintable to invalidate their size.
snapshot void snapshot(Snapshot snapshot, double width, double height): Snapshots the given paintable with the given @width and @height.
addOnInvalidateContents gulong addOnInvalidateContents(void delegate(PaintableIF) dlg, ConnectFlags connectFlags): Emitted when the contents of the @paintable change.
addOnInvalidateSize gulong addOnInvalidateSize(void delegate(PaintableIF) dlg, ConnectFlags connectFlags): Emitted when the intrinsic size of the @paintable changes.