Gambas Documentation
Documents

MediaPipeline (gb.media)

This class implements a GStreamer "pipeline".

A pipeline is a special container that provides its children a global clock and a message bus. This is the base class for the MediaPlayer control that implements a fully functional media player.

This class inherits MediaContainer.

This class is creatable.

This class acts like a read / write array.

Properties
Duration   Return the duration of the processed data in seconds.
Length   A synonymous for Duration.
Pos   This is a synonymous for the Position property.
Position   Return or set the current position inside the processed data in seconds.
Progress   Return the buffering progress.
Speed   Return or set the media playing speed rate.

Inherited properties
Children   Return a virtual collection of all MediaContainer children.
Handle   Return the internal GStreamer handle associated with a MediaControl.
Inputs   Return the name of all inputs.
Name   Return or set the name of the MediaControl.
Outputs   Return the name of all outputs.
Parent   Return the parent of the control.
State   Return or define the state of the MediaControl.
Tag   Return or set the MediaControl tag.
Type   Return the type of the MediaControl.

Methods
Close   Close the pipeline, i.e. set its state and the state of all children to Null.
Forward   Move forward a specific number of frames.
Pause   Pause the pipeline, i.e. set its state and the state of all children to Paused.
Play   Start playing, i.e. set the state of the pipeline and all its children to Playing.
Seek   Move the stream to a specific position, following the constraints defined by the specified flags.
Stop   Stop the pipeline, i.e. set its state and the state of all its children to Ready.

Inherited methods
AddInput   Choose an input of a child control that will act as an input for the container.
AddOutput   Choose an output of a child control that will act as an output for the container.
GetLastImage   Return the last image displayed by a video output control.
GetLink   Return the description of an input or output from its name.
LinkLaterTo   Link the current control to the Target control as soon as a new output appears on it.
LinkTo   Link an output of the current MediaControl to the input of the Target MediaControl.
SetWindow   This methods tells the MediaControl to draw its output inside a specific GUI control.

Events
AboutToFinish   This event is raised when the current playing media is about to finish.
Buffering   This event is raised when the pipeline is buffering data.
Duration   Raised when the duration of a pipeline has changed.
End   Raised when the end of stream has been reached while playing.
Event   This event is raised when the Media object emits any internal event.
Message   Raised when a child control emits a message.
Position   This event is raised when the stream position changes.
Progress   This event is raised while the media is played, and until it is stopped.
Start   This event is raised when a new media starts playing.
Tag   Raised when some tags have been found.

Inherited events
State   This event is raised when the state of the control has changed.