Struct MediaSource 

pub struct MediaSource { /* private fields */ }

MediaSource is the entry point into the W3C Media Source API. It offers functionality similar to GstAppSrc for client-side web or JavaScript applications decoupling the source of media from its processing and playback.

To interact with a Media Source, connect it to a MseSrc that is in some GstPipeline using attach(). Then create at least one SourceBuffer using add_source_buffer(). Finally, feed some media data to the Source Buffer(s) using SourceBuffer::append_buffer() and play the pipeline.

Properties

active-source-buffers

A SourceBufferList of every SourceBuffer in this Media Source that is considered active

Specification

Readable

duration

The Duration of the Media Source as a GstClockTime

Specification

Readable | Writeable

position

The position of the player consuming from the Media Source

Readable | Writeable

ready-state

The Ready State of the Media Source

Specification

Readable

source-buffers

A SourceBufferList of every SourceBuffer in this Media Source

Specification

Readable

Object

name

Readable | Writeable | Construct

parent

The parent of the object. Please note, that when changing the ‘parent’ property, we don’t emit GObject::notify and [deep-notify][struct@crate::gst::Object#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

on-source-close

on-source-ended

Emitted when self_ has ended, normally through MediaSource::end_of_stream().

Specification

on-source-open

Emitted when self_ has been opened.

Specification

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

GLib type: GObject with reference counted clone semantics.

Implementations

impl MediaSource

pub fn new() -> MediaSource

Creates a new MediaSource instance. The instance is in the MediaSourceReadyState::Closed state and is not associated with any media player.

Specification

Returns

a new MediaSource instance

pub fn add_source_buffer(&self, type_: &str) -> Result<SourceBuffer, Error>

Add a SourceBuffer to this MediaSource of the specified media type. The Media Source must be in the MediaSourceReadyState MediaSourceReadyState::Open.

Specification

type_

A MIME type describing the format of the incoming media

Returns

a new SourceBuffer instance on success, otherwise NULL

pub fn attach(&self, element: &MseSrc)

Associates self with element. Normally, the Element will be part of a GstPipeline that plays back the data submitted to the Media Source’s Source Buffers.

MseSrc is a special source element that is designed to consume media from a MediaSource.

Specification

element

MseSrc source Element

pub fn clear_live_seekable_range(&self) -> Result<(), Error>

Clear the live seekable range for self. This will inform the component playing this Media Source that there is no seekable time range.

If the ready state is not MediaSourceReadyState::Open, it will fail and set an error.

Specification

Returns

TRUE on success, FALSE otherwise

pub fn detach(&self)

Detaches self from any MseSrc element that it may be associated with.

pub fn end_of_stream(&self, eos_error: MediaSourceEOSError) -> Result<(), Error>

Mark self as reaching the end of stream, disallowing new data inputs.

Specification

eos_error

The error type, if any

Returns

TRUE on success, FALSE otherwise

pub fn active_source_buffers(&self) -> SourceBufferList

Gets a SourceBufferList containing all the Source Buffers currently associated with this Media Source that are considered “active.” For a Source Buffer to be considered active, either its video track is selected, its audio track is enabled, or its text track is visible or hidden. This object will reflect any future changes to the parent Media Source as well.

Specification

Returns

a new SourceBufferList instance

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

Gets the current duration of self.

Specification

Returns

the current duration as a GstClockTime

pub fn live_seekable_range(&self) -> MediaSourceRange

Get the live seekable range of self. Will fill in the supplied range with the current live seekable range.

Returns

range

time range

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

Gets the current playback position of the Media Source.

Returns

the current playback position as a GstClockTime

pub fn ready_state(&self) -> MediaSourceReadyState

Gets the current Ready State of the Media Source.

Specification

Returns

the current MediaSourceReadyState value

pub fn source_buffers(&self) -> SourceBufferList

Gets a SourceBufferList containing all the Source Buffers currently associated with this Media Source. This object will reflect any future changes to the parent Media Source as well.

Specification

Returns

a SourceBufferList instance

pub fn remove_source_buffer(&self, buffer: &SourceBuffer) -> Result<(), Error>

Remove buffer from self.

buffer must have been created as a child of self and self must be in the MediaSourceReadyState MediaSourceReadyState::Open.

Specification

buffer

SourceBuffer instance

Returns

TRUE on success, FALSE otherwise

pub fn set_duration( &self, duration: impl Into<Option<ClockTime>>, ) -> Result<(), Error>

Sets the duration of self.

Specification

duration

The new duration to apply to self.

Returns

TRUE on success, FALSE otherwise

pub fn set_live_seekable_range( &self, start: impl Into<Option<ClockTime>>, end: impl Into<Option<ClockTime>>, ) -> Result<(), Error>

Set the live seekable range for self. This range informs the component playing this Media Source what it can allow the user to seek through.

If the ready state is not MediaSourceReadyState::Open, or the supplied start time is later than end it will fail and set an error.

Specification

start

The earliest point in the stream considered seekable

end

The latest point in the stream considered seekable

Returns

TRUE on success, FALSE otherwise

pub fn is_type_supported(type_: &str) -> bool

Determines whether the current Media Source configuration can process media of the supplied type_.

type_

A MIME type value

Returns

TRUE when supported, FALSE otherwise

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

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

Emitted when self_ has ended, normally through end_of_stream().

Specification

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

Emitted when self_ has been opened.

Specification

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

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

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

impl MediaSource

pub fn set_position(&self, position: impl Into<Option<ClockTime>>)

Trait Implementations

impl Clone for MediaSource

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 MediaSource

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

Formats the value using the given formatter.

impl Default for MediaSource

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for MediaSource

type ParamSpec = ParamSpecObject

type SetValue = MediaSource

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MediaSource

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 MediaSource

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,

Restrict a value to a certain interval.

impl ParentClassIs for MediaSource

type Parent = Object

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

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 MediaSource

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 MediaSource

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MediaSource

impl IsA<Object> for MediaSource

impl Send for MediaSource

impl Sync for MediaSource