MediaStream

gtk.media_stream.MediaStream is the integration point for media playback inside GTK.

GTK provides an implementation of the gtk.media_stream.MediaStream interface that is called gtk.media_file.MediaFile.

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

Members

Functions

gerror
void gerror(glib.error.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
glib.error.ErrorG getError()

If the stream is in an error state, returns the glib.error.ErrorG explaining that state.

getLoop
bool getLoop()

Returns whether the stream is set to loop.

getMuted
bool getMuted()

Returns whether the audio for the stream is muted.

getPlaying
bool getPlaying()

Return whether the stream is currently playing.

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.

realize
void realize(gdk.surface.Surface surface)

Called by users to attach the media stream to a gdk.surface.Surface 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.

streamEnded
void streamEnded()

Pauses the media stream and marks it as ended.

streamPrepared
void streamPrepared(bool hasAudio, bool hasVideo, bool seekable, long duration)

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

streamUnprepared
void streamUnprepared()

Resets a given media stream implementation.

unrealize
void unrealize(gdk.surface.Surface surface)

Undoes a previous call to gtk.media_stream.MediaStream.realize.

update
void update(long timestamp)

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

Mixed In Members

From mixin PaintableT!()

computeConcreteSize
void computeConcreteSize(double specifiedWidth, double specifiedHeight, double defaultWidth, double defaultHeight, double concreteWidth, double concreteHeight)

Compute a concrete size for the gdk.paintable.Paintable.

getCurrentImage
gdk.paintable.Paintable getCurrentImage()

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

getFlags
gdk.types.PaintableFlags 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 gdk.paintable.Paintable to invalidate their contents.

invalidateSize
void invalidateSize()

Called by implementations of gdk.paintable.Paintable to invalidate their size.

snapshot
void snapshot(gdk.snapshot.Snapshot snapshot, double width, double height)

Snapshots the given paintable with the given width and height.

connectInvalidateContents
ulong connectInvalidateContents(T callback, Flag!"After" after)

Connect to InvalidateContents signal.

connectInvalidateSize
ulong connectInvalidateSize(T callback, Flag!"After" after)

Connect to InvalidateSize signal.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

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

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.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.

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 gobject.object.ObjectG.refSink.

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 gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.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(gobject.param_spec.ParamSpec pspec)

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

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

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.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

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(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata 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:

thawNotify
void thawNotify()

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

watchClosure
void watchClosure(gobject.closure.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 gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.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.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.

From Paintable

newEmpty
gdk.paintable.Paintable newEmpty(int intrinsicWidth, int intrinsicHeight)

Returns a paintable that has the given intrinsic size and draws nothing.

computeConcreteSize
void computeConcreteSize(double specifiedWidth, double specifiedHeight, double defaultWidth, double defaultHeight, double concreteWidth, double concreteHeight)

Compute a concrete size for the gdk.paintable.Paintable.

getCurrentImage
gdk.paintable.Paintable getCurrentImage()

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

getFlags
gdk.types.PaintableFlags 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 gdk.paintable.Paintable to invalidate their contents.

invalidateSize
void invalidateSize()

Called by implementations of gdk.paintable.Paintable to invalidate their size.

snapshot
void snapshot(gdk.snapshot.Snapshot snapshot, double width, double height)

Snapshots the given paintable with the given width and height.

connectInvalidateContents
ulong connectInvalidateContents(T callback, Flag!"After" after)

Connect to InvalidateContents signal.

connectInvalidateSize
ulong connectInvalidateSize(T callback, Flag!"After" after)

Connect to InvalidateSize signal.