Struct gstreamer_play::Play

pub struct Play { /* private fields */ }

The goal of the GstPlay library is to ease the integration of multimedia playback features in applications. Thus, if you need to build a media player from the ground-up, GstPlay provides the features you will most likely need.

An example player is available in gst-examples/playback/player/gst-play/.

Internally the GstPlay makes use of the playbin3 element. The legacy playbin2 can be selected if the GST_PLAY_USE_PLAYBIN3=0 environment variable has been set.

Important note: If your application relies on the GstBus to get notifications from GstPlay, you need to add some explicit clean-up code in order to prevent the GstPlay object from leaking. See below for the details. If you use the GstPlaySignalAdapter, no special clean-up is required.

When the GstPlaySignalAdapter is not used, the GstBus owned by GstPlay should be set to flushing state before any attempt to drop the last reference of the GstPlay object. An example in C:

⚠️ The following code is in c ⚠️

...
GstBus *bus = gst_play_get_message_bus (player);
gst_bus_set_flushing (bus, TRUE);
gst_object_unref (bus);
gst_object_unref (player);

The messages managed by the player contain a reference to itself, and if the bus watch is just removed together with dropping the player then the bus will simply keep them around forever (and the bus never goes away because the player has a strong reference to it, so there’s a reference cycle as long as there are messages). Setting the bus to flushing state forces it to get rid of its queued messages, thus breaking any possible reference cycle.

Properties

audio-video-offset

Readable | Writeable

current-audio-track

Readable

current-subtitle-track

Readable

current-video-track

Readable

duration

Readable

media-info

Readable

mute

Readable | Writeable

pipeline

Readable

position

Readable

rate

Readable | Writeable

subtitle-video-offset

Readable | Writeable

suburi

Readable | Writeable

uri

Readable | Writeable

video-multiview-flags

Readable | Writeable

video-multiview-mode

Readable | Writeable

video-renderer

Readable | Writeable

volume

Readable | Writeable

Object

name

Readable | Writeable | Construct

parent

The parent of the object. Please note, that when changing the ‘parent’ property, we don’t emit [notify][struct@crate::glib::Object#notify] and deep-notify signals due to locking issues. In some cases one can use GstBin::element-added or GstBin::element-removed signals on the parent to achieve a similar effect.

Readable | Writeable

Implements

gst::prelude::ObjectExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Play

pub fn new(video_renderer: Option<impl IsA<PlayVideoRenderer>>) -> Play

Creates a new Play instance.

Video is going to be rendered by video_renderer, or if None is provided no special video set up will be done and some default handling will be performed.

This also initializes GStreamer via gst_init() on the first call if this didn’t happen before.

video_renderer

GstPlayVideoRenderer to use

Returns

a new Play instance

pub fn audio_video_offset(&self) -> i64

Retrieve the current value of audio-video-offset property

Returns

The current value of audio-video-offset in nanoseconds

pub fn color_balance(&self, type_: PlayColorBalanceType) -> f64

Retrieve the current value of the indicated type_.

type_

PlayColorBalanceType

Returns

The current value of type_, between [0,1]. In case of error -1 is returned.

pub fn current_audio_track(&self) -> Option<PlayAudioInfo>

A Function to get current audio PlayAudioInfo instance.

Returns

current audio track.

The caller should free it with g_object_unref()

pub fn current_subtitle_track(&self) -> Option<PlaySubtitleInfo>

A Function to get current subtitle PlaySubtitleInfo instance.

Returns

current subtitle track.

The caller should free it with g_object_unref()

pub fn current_video_track(&self) -> Option<PlayVideoInfo>

A Function to get current video PlayVideoInfo instance.

Returns

current video track.

The caller should free it with g_object_unref()

pub fn current_visualization(&self) -> Option<GString>

Returns

Name of the currently enabled visualization. g_free() after usage.

pub fn duration(&self) -> Option<ClockTime>

Retrieves the duration of the media stream that self represents.

Returns

the duration of the currently-playing media stream, in nanoseconds.

pub fn media_info(&self) -> Option<PlayMediaInfo>

A Function to get the current media info PlayMediaInfo instance.

Returns

media info instance.

The caller should free it with g_object_unref()

pub fn message_bus(&self) -> Bus

GstPlay API exposes a gst::Bus instance which purpose is to provide data structures representing play-internal events in form of gst::Messages of type GST_MESSAGE_APPLICATION.

Each message carries a “play-message” field of type PlayMessage. Further fields of the message data are specific to each possible value of that enumeration.

Applications can consume the messages asynchronously within their own event-loop / UI-thread etc. Note that in case the application does not consume the messages, the bus will accumulate these internally and eventually fill memory. To avoid that, the bus has to be set “flushing”.

Returns

The play message bus instance

pub fn multiview_flags(&self) -> VideoMultiviewFlags

Retrieve the current value of the indicated type_.

Returns

The current value of type_, Default: 0x00000000 “none

pub fn multiview_mode(&self) -> VideoMultiviewFramePacking

Retrieve the current value of the indicated type_.

Returns

The current value of type_, Default: -1 “none”

pub fn is_muted(&self) -> bool

Returns

true if the currently-playing stream is muted.

pub fn pipeline(&self) -> Element

Returns

The internal playbin instance.

The caller should free it with g_object_unref()

pub fn position(&self) -> Option<ClockTime>

Returns

the absolute position time, in nanoseconds, of the currently-playing stream.

pub fn rate(&self) -> f64

Returns

current playback rate

pub fn subtitle_uri(&self) -> Option<GString>

Current subtitle URI

Returns

URI of the current external subtitle. g_free() after usage.

pub fn subtitle_video_offset(&self) -> i64

Retrieve the current value of subtitle-video-offset property

Returns

The current value of subtitle-video-offset in nanoseconds

pub fn uri(&self) -> Option<GString>

Gets the URI of the currently-playing stream.

Returns

a string containing the URI of the currently-playing stream. g_free() after usage.

pub fn volume(&self) -> f64

Returns the current volume level, as a percentage between 0 and 1.

Returns

the volume as percentage between 0 and 1.

pub fn has_color_balance(&self) -> bool

Checks whether the self has color balance support available.

Returns

true if self has color balance support. Otherwise, false.

pub fn pause(&self)

Pauses the current stream.

pub fn play(&self)

Request to play the loaded stream.

pub fn seek(&self, position: ClockTime)

Seeks the currently-playing stream to the absolute position time in nanoseconds.

position

position to seek in nanoseconds

pub fn set_audio_track(&self, stream_index: i32) -> Result<(), BoolError>

stream_index

stream index

Returns

true or false

Sets the audio track stream_index.

pub fn set_audio_track_enabled(&self, enabled: bool)

Enable or disable the current audio track.

enabled

TRUE or FALSE

pub fn set_audio_video_offset(&self, offset: i64)

Sets audio-video-offset property by value of offset

offset

gint64 in nanoseconds

pub fn set_color_balance(&self, type_: PlayColorBalanceType, value: f64)

Sets the current value of the indicated channel type_ to the passed value.

type_

PlayColorBalanceType

value

The new value for the type_, ranged [0,1]

pub fn set_multiview_flags(&self, flags: VideoMultiviewFlags)

Sets the current value of the indicated mode type_ to the passed value.

flags

The new value for the type_

pub fn set_multiview_mode(&self, mode: VideoMultiviewFramePacking)

Sets the current value of the indicated mode type_ to the passed value.

mode

The new value for the type_

pub fn set_mute(&self, val: bool)

true if the currently-playing stream should be muted.

val

Mute state the should be set

pub fn set_rate(&self, rate: f64)

Playback at specified rate

rate

playback rate

pub fn set_subtitle_track(&self, stream_index: i32) -> Result<(), BoolError>

stream_index

stream index

Returns

true or false

Sets the subtitle stack stream_index.

pub fn set_subtitle_track_enabled(&self, enabled: bool)

Enable or disable the current subtitle track.

enabled

TRUE or FALSE

pub fn set_subtitle_uri(&self, uri: Option<&str>)

Sets the external subtitle URI. This should be combined with a call to gst_play_set_subtitle_track_enabled(self, TRUE) so the subtitles are actually rendered.

uri

subtitle URI

pub fn set_subtitle_video_offset(&self, offset: i64)

Sets subtitle-video-offset property by value of offset

offset

gint64 in nanoseconds

pub fn set_uri(&self, uri: Option<&str>)

Sets the next URI to play.

uri

next URI to play.

pub fn set_video_track(&self, stream_index: i32) -> Result<(), BoolError>

stream_index

stream index

Returns

true or false

Sets the video track stream_index.

pub fn set_video_track_enabled(&self, enabled: bool)

Enable or disable the current video track.

enabled

TRUE or FALSE

pub fn set_visualization(&self, name: Option<&str>) -> Result<(), BoolError>

name

visualization element obtained from visualizations_get()

Returns

true if the visualization was set correctly. Otherwise, false.

pub fn set_visualization_enabled(&self, enabled: bool)

Enable or disable the visualization.

enabled

TRUE or FALSE

pub fn set_volume(&self, val: f64)

Sets the volume level of the stream as a percentage between 0 and 1.

val

the new volume level, as a percentage between 0 and 1

pub fn stop(&self)

Stops playing the current stream and resets to the first position in the stream.

pub fn suburi(&self) -> Option<GString>

pub fn set_suburi(&self, suburi: Option<&str>)

pub fn video_multiview_flags(&self) -> VideoMultiviewFlags

pub fn set_video_multiview_flags( &self, video_multiview_flags: VideoMultiviewFlags, )

pub fn video_multiview_mode(&self) -> VideoMultiviewFramePacking

pub fn set_video_multiview_mode( &self, video_multiview_mode: VideoMultiviewFramePacking, )

pub fn video_renderer(&self) -> Option<PlayVideoRenderer>

pub fn set_video_renderer<P: IsA<PlayVideoRenderer>>( &self, video_renderer: Option<&P>, )

pub fn audio_streams(info: &PlayMediaInfo) -> Vec<PlayAudioInfo>

info

a PlayMediaInfo

Returns

A GList of matching PlayAudioInfo.

pub fn subtitle_streams(info: &PlayMediaInfo) -> Vec<PlaySubtitleInfo>

info

a PlayMediaInfo

Returns

A GList of matching PlaySubtitleInfo.

pub fn video_streams(info: &PlayMediaInfo) -> Vec<PlayVideoInfo>

info

a PlayMediaInfo

Returns

A GList of matching PlayVideoInfo.

pub fn is_play_message(msg: &Message) -> bool

msg

A gst::Message

Returns

A gboolean indicating whether the passed message represents a Play message or not.

pub fn visualizations_get() -> Vec<PlayVisualization>

Returns

a None terminated array containing all available visualizations. Use gst_play_visualizations_free() after usage.

pub fn connect_audio_video_offset_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_current_audio_track_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_current_subtitle_track_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_current_video_track_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_duration_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_media_info_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_mute_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_pipeline_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_position_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_rate_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_subtitle_video_offset_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_suburi_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_uri_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_video_multiview_flags_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_video_multiview_mode_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_video_renderer_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_volume_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

impl Play

pub fn config(&self) -> PlayConfig

Get a copy of the current configuration of the play. This configuration can either be modified and used for the set_config() call or it must be freed after usage.

Returns

a copy of the current configuration of self. Use gst_structure_free() after usage or set_config().

pub fn set_config(&self, config: PlayConfig) -> Result<(), BoolError>

Set the configuration of the play. If the play is already configured, and the configuration hasn’t changed, this function will return true. If the play is not in the GST_PLAY_STATE_STOPPED, this method will return false and active configuration will remain.

config is a gst::Structure that contains the configuration parameters for the play.

This function takes ownership of config.

config

a gst::Structure

Returns

true when the configuration could be set.

pub fn video_snapshot( &self, format: PlaySnapshotFormat, config: Option<&StructureRef>, ) -> Option<Sample>

Get a snapshot of the currently selected video stream, if any. The format can be selected with format and optional configuration is possible with config. Currently supported settings are:

• width, height of type G_TYPE_INT
• pixel-aspect-ratio of type GST_TYPE_FRACTION Except for GST_PLAY_THUMBNAIL_RAW_NATIVE format, if no config is set, pixel-aspect-ratio would be 1/1

format

output format of the video snapshot

config

Additional configuration

Returns

Current video snapshot sample or None on failure

Trait Implementations

impl Clone for Play

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Play

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Play

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Play

type ParamSpec = ParamSpecObject

type SetValue = Play

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Play>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Play

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Play

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Play

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Play

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Play

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Play

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Play

impl IsA<Object> for Play

impl Send for Play

impl Sync for Play