Trait gstreamer_editing_services::prelude::GESTrackExt

pub trait GESTrackExt: IsA<Track> + Sealed + 'static {
    // Provided methods
    fn add_element(
        &self,
        object: &impl IsA<TrackElement>,
    ) -> Result<(), BoolError> { ... }
    fn add_element_full(
        &self,
        object: &impl IsA<TrackElement>,
    ) -> Result<(), Error> { ... }
    fn commit(&self) -> bool { ... }
    fn caps(&self) -> Option<Caps> { ... }
    fn elements(&self) -> Vec<TrackElement> { ... }
    fn is_mixing(&self) -> bool { ... }
    fn restriction_caps(&self) -> Option<Caps> { ... }
    fn timeline(&self) -> Option<Timeline> { ... }
    fn remove_element(
        &self,
        object: &impl IsA<TrackElement>,
    ) -> Result<(), BoolError> { ... }
    fn remove_element_full(
        &self,
        object: &impl IsA<TrackElement>,
    ) -> Result<(), Error> { ... }
    fn set_mixing(&self, mixing: bool) { ... }
    fn set_restriction_caps(&self, caps: &Caps) { ... }
    fn set_timeline(&self, timeline: &impl IsA<Timeline>) { ... }
    fn update_restriction_caps(&self, caps: &Caps) { ... }
    fn duration(&self) -> u64 { ... }
    fn id(&self) -> Option<GString> { ... }
    fn set_id(&self, id: Option<&str>) { ... }
    fn track_type(&self) -> TrackType { ... }
    fn connect_commited<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId { ... }
    fn connect_track_element_added<F: Fn(&Self, &TrackElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_track_element_removed<F: Fn(&Self, &TrackElement) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_duration_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_id_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId { ... }
    fn connect_mixing_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_restriction_caps_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
}

Trait containing all Track methods.

Implementors

AudioTrack, Track, VideoTrack

Provided Methods

fn add_element(&self, object: &impl IsA<TrackElement>) -> Result<(), BoolError>

See add_element(), which also gives an error.

object

The element to add

Returns

true if object was successfully added to self.

fn add_element_full(&self, object: &impl IsA<TrackElement>) -> Result<(), Error>

Adds the given track element to the track, which takes ownership of the element.

Note that this can fail if it would break a configuration rule of the track’s Timeline.

Note that a TrackElement can only be added to one track.

object

The element to add

Returns

true if object was successfully added to self.

fn commit(&self) -> bool

Commits all the pending changes for the elements contained in the track.

When changes are made to the timing or priority of elements within a track, they are not directly executed for the underlying nlecomposition and its children. This method will finally execute these changes so they are reflected in the data output of the track.

Any pending changes will be executed in the backend. The commited signal will be emitted once this has completed.

Note that TimelineExt::commit() will call this method on all of its tracks, so you are unlikely to need to use this directly.

Returns

true if pending changes were committed, or false if nothing needed to be committed.

fn caps(&self) -> Option<Caps>

Get the caps of the track.

Returns

The caps of self.

fn elements(&self) -> Vec<TrackElement>

Gets the track elements contained in the track. The returned list is sorted by the element’s priority and start.

Returns

A list of all the TrackElement-s in self.

fn is_mixing(&self) -> bool

Gets the mixing of the track.

Returns

Whether self is mixing.

fn restriction_caps(&self) -> Option<Caps>

Gets the restriction-caps of the track.

Returns

The restriction-caps of self.

fn timeline(&self) -> Option<Timeline>

Get the timeline this track belongs to.

Returns

The timeline that self belongs to, or None if it does not belong to a timeline.

fn remove_element( &self, object: &impl IsA<TrackElement>, ) -> Result<(), BoolError>

See remove_element_full(), which also returns an error.

object

The element to remove

Returns

true if object was successfully removed from self.

fn remove_element_full( &self, object: &impl IsA<TrackElement>, ) -> Result<(), Error>

Removes the given track element from the track, which revokes ownership of the element.

object

The element to remove

Returns

true if object was successfully removed from self.

fn set_mixing(&self, mixing: bool)

Sets the mixing for the track.

mixing

Whether self should be mixing

fn set_restriction_caps(&self, caps: &Caps)

Sets the restriction-caps for the track.

NOTE: Restriction caps are not taken into account when using mode=PipelineFlags::SMART_RENDER.

caps

The new restriction-caps for self

fn set_timeline(&self, timeline: &impl IsA<Timeline>)

Informs the track that it belongs to the given timeline. Calling this does not actually add the track to the timeline. For that, you should use TimelineExt::add_track(), which will also take care of informing the track that it belongs to the timeline. As such, there is no need for you to call this method.

fn update_restriction_caps(&self, caps: &Caps)

Updates the restriction-caps of the track using the fields found in the given caps. Each of the gst::Structure-s in caps is compared against the existing structure with the same index in the current restriction-caps. If there is no corresponding existing structure at that index, then the new structure is simply copied to that index. Otherwise, any fields in the new structure are copied into the existing structure. This will replace existing values, and may introduce new ones, but any fields ‘missing’ in the new structure are left unchanged in the existing structure.

For example, if the existing restriction-caps are “video/x-raw, width=480, height=360”, and the updating caps is “video/x-raw, format=I420, width=500; video/x-bayer, width=400”, then the new restriction-caps after calling this will be “video/x-raw, width=500, height=360, format=I420; video/x-bayer, width=400”.

caps

The caps to update the restriction-caps with

fn duration(&self) -> u64

Current duration of the track

Default value: O

fn id(&self) -> Option<GString>

The nlecomposition:id of the underlying nlecomposition.

fn set_id(&self, id: Option<&str>)

The nlecomposition:id of the underlying nlecomposition.

fn track_type(&self) -> TrackType

The track type of the track. This controls the type of TrackElement-s that can be added to the track. This should match with the track’s caps.

Once a track has been added to a Timeline, you should not change this.

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

This signal will be emitted once the changes initiated by commit() have been executed in the backend. In particular, this will be emitted whenever the underlying nlecomposition has been committed (see nlecomposition::commited).

fn connect_track_element_added<F: Fn(&Self, &TrackElement) + 'static>( &self, f: F, ) -> SignalHandlerId

Will be emitted after a track element is added to the track.

effect

The element that was added

fn connect_track_element_removed<F: Fn(&Self, &TrackElement) + 'static>( &self, f: F, ) -> SignalHandlerId

Will be emitted after a track element is removed from the track.

effect

The element that was removed

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

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

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

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

Object Safety

This trait is not object safe.

Implementors

impl<O: IsA<Track>> GESTrackExt for O