Trait gstreamer_editing_services::prelude::TimelineExt[−][src]

pub trait TimelineExt: 'static {
Show methods
    fn add_layer<P: IsA<Layer>>(&self, layer: &P) -> Result<(), BoolError>;
    fn add_track<P: IsA<Track>>(&self, track: &P) -> Result<(), BoolError>;
    fn append_layer(&self) -> Layer;
    fn commit(&self) -> bool;
    fn commit_sync(&self) -> bool;
    fn is_auto_transition(&self) -> bool;
    fn duration(&self) -> ClockTime;
    fn element(&self, name: &str) -> Option<TimelineElement>;
    fn frame_at(&self, timestamp: ClockTime) -> FrameNumber;
    fn frame_time(&self, frame_number: FrameNumber) -> Option<ClockTime>;
    fn groups(&self) -> Vec<Group>;
    fn layer(&self, priority: u32) -> Option<Layer>;
    fn layers(&self) -> Vec<Layer>;
    fn pad_for_track<P: IsA<Track>>(&self, track: &P) -> Option<Pad>;
    fn snapping_distance(&self) -> Option<ClockTime>;
    fn track_for_pad<P: IsA<Pad>>(&self, pad: &P) -> Option<Track>;
    fn tracks(&self) -> Vec<Track>;
    fn is_empty(&self) -> bool;
    fn load_from_uri(&self, uri: &str) -> Result<(), Error>;
    fn move_layer<P: IsA<Layer>>(
        &self, 
        layer: &P, 
        new_layer_priority: u32
    ) -> Result<(), BoolError>;
    fn paste_element<P: IsA<TimelineElement>>(
        &self, 
        element: &P, 
        position: ClockTime, 
        layer_priority: i32
    ) -> Option<TimelineElement>;
    fn remove_layer<P: IsA<Layer>>(&self, layer: &P) -> Result<(), BoolError>;
    fn remove_track<P: IsA<Track>>(&self, track: &P) -> Result<(), BoolError>;
    fn save_to_uri<P: IsA<Asset>>(
        &self, 
        uri: &str, 
        formatter_asset: Option<&P>, 
        overwrite: bool
    ) -> Result<(), Error>;
    fn set_auto_transition(&self, auto_transition: bool);
    fn set_snapping_distance(
        &self, 
        snapping_distance: impl Into<Option<ClockTime>>
    );
    fn connect_commited<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
    fn connect_group_added<F: Fn(&Self, &Group) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_layer_added<F: Fn(&Self, &Layer) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_layer_removed<F: Fn(&Self, &Layer) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_select_element_track<F: Fn(&Self, &Clip, &TrackElement) -> Track + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_snapping_ended<F: Fn(&Self, &TrackElement, &TrackElement, u64) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_snapping_started<F: Fn(&Self, &TrackElement, &TrackElement, u64) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_track_added<F: Fn(&Self, &Track) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_track_removed<F: Fn(&Self, &Track) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_auto_transition_notify<F: Fn(&Self) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_duration_notify<F: Fn(&Self) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_snapping_distance_notify<F: Fn(&Self) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
}

Expand description

Trait containing all Timeline methods.

Implementors

Timeline

Required methods

fn add_layer<P: IsA<Layer>>(&self, layer: &P) -> Result<(), BoolError>[src]

👎 Deprecated:

Since 1.18

Add a layer to the timeline.

If the layer contains Clip-s, then this may trigger the creation of their core track element children for the timeline’s tracks, and the placement of the clip’s children in the tracks of the timeline using signal::Timeline::select-tracks-for-object. Some errors may occur if this would break one of the configuration rules of the timeline in one of its tracks. In such cases, some track elements would fail to be added to their tracks, but this method would still return true. As such, it is advised that you only add clips to layers that already part of a timeline. In such situations, LayerExt::add_clip() is able to fail if adding the clip would cause such an error.

Deprecated since 1.18

This method requires you to ensure the layer’s property::Layer::priority will be unique to the timeline. Use append_layer() and move_layer() instead.

`layer`

The layer to add

Returns

true if layer was properly added.

fn add_track<P: IsA<Track>>(&self, track: &P) -> Result<(), BoolError>[src]

Add a track to the timeline.

If the timeline already contains clips, then this may trigger the creation of their core track element children for the track, and the placement of the clip’s children in the track of the timeline using signal::Timeline::select-tracks-for-object. Some errors may occur if this would break one of the configuration rules for the timeline in the track. In such cases, some track elements would fail to be added to the track, but this method would still return true. As such, it is advised that you avoid adding tracks to timelines that already contain clips.

`track`

The track to add

Returns

true if track was properly added.

fn append_layer(&self) -> Layer[src]

Append a newly created layer to the timeline. The layer will be added at the lowest property::Layer::priority (numerically, the highest).

Returns

The newly created layer.

fn commit(&self) -> bool[src]

Commit all the pending changes of the clips contained in the timeline.

When changes happen in a timeline, they are not immediately executed internally, in a way that effects the output data of the timeline. You should call this method when you are done with a set of changes and you want them to be executed.

Any pending changes will be executed in the backend. The signal::Timeline::commited signal will be emitted once this has completed. You should not try to change the state of the timeline, seek it or add tracks to it before receiving this signal. You can use commit_sync() if you do not want to perform other tasks in the mean time.

Note that all the pending changes will automatically be executed when the timeline goes from gst::State::Ready to gst::State::Paused, which is usually triggered by a corresponding state changes in a containing Pipeline.

Returns

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

fn commit_sync(&self) -> bool[src]

Commit all the pending changes of the clips contained in the timeline and wait for the changes to complete.

See commit().

Returns

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

fn is_auto_transition(&self) -> bool[src]

Gets property::Timeline::auto-transition for the timeline.

Returns

The auto-transition of self_.

fn duration(&self) -> ClockTime[src]

Get the current property::Timeline::duration of the timeline

Returns

The current duration of self.

fn element(&self, name: &str) -> Option<TimelineElement>[src]

Gets the element contained in the timeline with the given name.

`name`

The name of the element to find

Returns

The timeline element in self with the given name, or None if it was not found.

fn frame_at(&self, timestamp: ClockTime) -> FrameNumber[src]

This is supported on crate feature v1_18 only.

This method allows you to convert a timeline GstClockTime into its corresponding GESFrameNumber in the timeline’s output.

`timestamp`

The timestamp to get the corresponding frame number of

Returns

The frame number timestamp corresponds to.

fn frame_time(&self, frame_number: FrameNumber) -> Option<ClockTime>[src]

This is supported on crate feature v1_18 only.

This method allows you to convert a timeline output frame number into a timeline GstClockTime. For example, this time could be used to seek to a particular frame in the timeline’s output, or as the edit position for an element within the timeline.

`frame_number`

The frame number to get the corresponding timestamp of in the timeline coordinates

Returns

The timestamp corresponding to frame_number in the output of self.

fn groups(&self) -> Vec<Group>[src]

Get the list of Group-s present in the timeline.

Returns

The list of groups that contain clips present in self’s layers. Must not be changed.

fn layer(&self, priority: u32) -> Option<Layer>[src]

Retrieve the layer whose index in the timeline matches the given priority.

`priority`

The priority/index of the layer to find

Returns

The layer with the given priority, or None if none was found.

Since 1.6

fn layers(&self) -> Vec<Layer>[src]

Get the list of Layer-s present in the timeline.

Returns

The list of layers present in self sorted by priority.

fn pad_for_track<P: IsA<Track>>(&self, track: &P) -> Option<Pad>[src]

Search for the gst::Pad corresponding to the given timeline’s track. You can link to this pad to receive the output data of the given track.

`track`

A track

Returns

The pad corresponding to track, or None if there is an error.

fn snapping_distance(&self) -> Option<ClockTime>[src]

Gets the property::Timeline::snapping-distance for the timeline.

Returns

The snapping distance (in nanoseconds) of self.

fn track_for_pad<P: IsA<Pad>>(&self, pad: &P) -> Option<Track>[src]

Search for the Track corresponding to the given timeline’s pad.

`pad`

A pad

Returns

The track corresponding to pad, or None if there is an error.

fn tracks(&self) -> Vec<Track>[src]

Get the list of Track-s used by the timeline.

Returns

The list of tracks used by self.

fn is_empty(&self) -> bool[src]

Check whether the timeline is empty or not.

Returns

true if self is empty.

fn load_from_uri(&self, uri: &str) -> Result<(), Error>[src]

Loads the contents of URI into the timeline.

`uri`

The URI to load from

Returns

true if the timeline was loaded successfully from uri.

fn move_layer<P: IsA<Layer>>(
    &self, 
    layer: &P, 
    new_layer_priority: u32
) -> Result<(), BoolError>