Struct gstreamer_player::Player

pub struct Player { /* private fields */ }

Starting from GStreamer 1.20, application developers are strongly advised to migrate to GstPlay. Player will be deprecated in 1.20 and most likely removed by 1.24.

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

signal-dispatcher

Writeable | Construct Only

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 | Construct Only

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

Signals

buffering

duration-changed

end-of-stream

error

media-info-updated

mute-changed

position-updated

seek-done

state-changed

uri-loaded

video-dimensions-changed

volume-changed

warning

Object

deep-notify

The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.

Detailed

Implements

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

GLib type: GObject with reference counted clone semantics.

Implementations

impl Player

pub fn new( video_renderer: Option<impl IsA<PlayerVideoRenderer>>, signal_dispatcher: Option<impl IsA<PlayerSignalDispatcher>>, ) -> Player

Creates a new Player instance that uses signal_dispatcher to dispatch signals to some event loop system, or emits signals directly if NULL is passed. See gst_player_g_main_context_signal_dispatcher_new().

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

GstPlayerVideoRenderer to use

signal_dispatcher

GstPlayerSignalDispatcher to use

Returns

a new Player 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_: PlayerColorBalanceType) -> f64

Retrieve the current value of the indicated type_.

type_

PlayerColorBalanceType

Returns

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

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

A Function to get current audio PlayerAudioInfo instance.

Returns

current audio track.

The caller should free it with g_object_unref()

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

A Function to get current subtitle PlayerSubtitleInfo instance.

Returns

current subtitle track.

The caller should free it with g_object_unref()

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

A Function to get current video PlayerVideoInfo 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<PlayerMediaInfo>

A Function to get the current media info PlayerMediaInfo instance.

Returns

media info instance.

The caller should free it with g_object_unref()

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_idex.

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_: PlayerColorBalanceType, value: f64)

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

type_

PlayerColorBalanceType

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_player_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 visualizations 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.

This volume is a linear factor. For showing the volume in a GUI it might make sense to first convert from a different format. Volume sliders should usually use a cubic volume. See gst_stream_volume_convert_volume().

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<PlayerVideoRenderer>

pub fn audio_streams(info: &PlayerMediaInfo) -> Vec<PlayerAudioInfo>

info

a PlayerMediaInfo

Returns

A GList of matching PlayerAudioInfo.

pub fn subtitle_streams(info: &PlayerMediaInfo) -> Vec<PlayerSubtitleInfo>

info

a PlayerMediaInfo

Returns

A GList of matching PlayerSubtitleInfo.

pub fn video_streams(info: &PlayerMediaInfo) -> Vec<PlayerVideoInfo>

info

a PlayerMediaInfo

Returns

A GList of matching PlayerVideoInfo.

pub fn visualizations_get() -> Vec<PlayerVisualization>

Returns

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

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

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

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

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

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

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

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

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

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

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

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_volume_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

impl Player

pub fn config(&self) -> PlayerConfig

Get a copy of the current configuration of the player. 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: PlayerConfig) -> Result<(), BoolError>

Set the configuration of the player. If the player is already configured, and the configuration haven’t change, this function will return true. If the player is not in the GST_PLAYER_STATE_STOPPED, this method will return false and active configuration will remain.

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

This function takes ownership of config.

config

a gst::Structure

Returns

true when the configuration could be set.

pub fn connect_duration_changed<F: Fn(&Player, Option<ClockTime>) + Send + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_position_updated<F: Fn(&Player, Option<ClockTime>) + Send + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_seek_done<F: Fn(&Player, ClockTime) + Send + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn video_snapshot( &self, format: PlayerSnapshotFormat, 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_PLAYER_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 Player

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 Player

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

Formats the value using the given formatter.

impl Default for Player

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Player

type ParamSpec = ParamSpecObject

type SetValue = Player

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Player

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 Player

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 Player

type Parent = Object

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

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for Player

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Player

impl IsA<Object> for Player

impl Send for Player

impl Sync for Player