Struct gstreamer_editing_services::Timeline [−][src]
pub struct Timeline(_);
Expand description
Timeline is the central object for any multimedia timeline.
A timeline is composed of a set of Track-s and a set of
Layer-s, which are added to the timeline using
TimelineExt::add_track() and TimelineExt::append_layer(), respectively.
The contained tracks define the supported types of the timeline
and provide the media output. Essentially, each track provides an
additional source gst::Pad.
Most usage of a timeline will likely only need a single GESAudioTrack
and/or a single GESVideoTrack. You can create such a timeline with
new_audio_video(). After this, you are unlikely to need to
work with the tracks directly.
A timeline’s layers contain Clip-s, which in turn control the
creation of TrackElement-s, which are added to the timeline’s
tracks. See signal::Timeline::select-tracks-for-object if you wish to have
more control over which track a clip’s elements are added to.
The layers are ordered, with higher priority layers having their
content prioritised in the tracks. This ordering can be changed using
TimelineExt::move_layer().
Editing
See TimelineElement for the various ways the elements of a timeline
can be edited.
If you change the timing or ordering of a timeline’s
TimelineElement-s, then these changes will not actually be taken
into account in the output of the timeline’s tracks until the
TimelineExt::commit() method is called. This allows you to move its
elements around, say, in response to an end user’s mouse dragging, with
little expense before finalising their effect on the produced data.
Overlaps and Auto-Transitions
There are certain restrictions placed on how GESSource-s may overlap
in a Track that belongs to a timeline. These will be enforced by
GES, so the user will not need to keep track of them, but they should
be aware that certain edits will be refused as a result if the overlap
rules would be broken.
Consider two GESSource-s, A and B, with start times startA and
startB, and end times endA and endB, respectively. The start
time refers to their property::TimelineElement::start, and the end time is
their property::TimelineElement::start + property::TimelineElement::duration. These
two sources overlap if:
- they share the same
property::TrackElement::track(nonNone), which belongs to the timeline; - they share the same
GES_TIMELINE_ELEMENT_LAYER_PRIORITY; and startA < endBandstartB < endA.
Note that when startA = endB or startB = endA then the two sources
will touch at their edges, but are not considered overlapping.
If, in addition, startA < startB < endA, then we can say that the
end of A overlaps the start of B.
If, instead, startA <= startB and endA >= endB, then we can say
that A fully overlaps B.
The overlap rules for a timeline are that:
- One source cannot fully overlap another source.
- A source can only overlap the end of up to one other source at its start.
- A source can only overlap the start of up to one other source at its end.
The last two rules combined essentially mean that at any given timeline
position, only up to two GESSource-s may overlap at that position. So
triple or more overlaps are not allowed.
If you switch on property::Timeline::auto-transition, then at any moment when
the end of one source (the first source) overlaps the start of another
(the second source), a TransitionClip will be automatically created
for the pair in the same layer and it will cover their overlap. If the
two elements are edited in a way such that the end of the first source
no longer overlaps the start of the second, the transition will be
automatically removed from the timeline. However, if the two sources
still overlap at the same edges after the edit, then the same
transition object will be kept, but with its timing and layer adjusted
accordingly.
Saving
To save/load a timeline, you can use the TimelineExt::load_from_uri()
and TimelineExt::save_to_uri() methods that use the default format.
Playing
A timeline is a gst::Bin with a source gst::Pad for each of its
tracks, which you can fetch with TimelineExt::pad_for_track(). You
will likely want to link these to some compatible sink gst::Element-s to
be able to play or capture the content of the timeline.
You can use a Pipeline to easily preview/play the timeline’s
content, or render it to a file.
Implements
TimelineExt, [trait@gst::prelude::BinExt], gst::prelude::ElementExt, gst::prelude::GstObjectExt, glib::ObjectExt, ExtractableExt
Implementations
Trait Implementations
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
Returns the type identifier of Self.
Auto Trait Implementations
impl RefUnwindSafe for Timelineimpl UnwindSafe for TimelineBlanket Implementations
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T. Read more
Upcasts an object to a reference of its superclass or interface T. Read more
Tries to downcast to a subclass or interface implementor T. Read more
Tries to downcast to a reference of its subclass or interface implementor T. Read more
Tries to cast to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
Tries to cast to reference to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
Casts to T unconditionally. Read more
Casts to &T unconditionally. Read more
Abort the state change of the element. This function is used by elements that do asynchronous state changes and find out something is wrong. Read more
Adds a pad (link point) to self. pad’s parent will be set to self;
see GstObjectExt::set_parent() for refcounting information. Read more
pub fn change_state(
&self,
transition: StateChange
) -> Result<StateChangeSuccess, StateChangeError>[src]
pub fn change_state(
&self,
transition: StateChange
) -> Result<StateChangeSuccess, StateChangeError>[src]Perform transition on self. Read more
pub fn continue_state(
&self,
ret: impl Into<StateChangeReturn>
) -> Result<StateChangeSuccess, StateChangeError>[src]
pub fn continue_state(
&self,
ret: impl Into<StateChangeReturn>
) -> Result<StateChangeSuccess, StateChangeError>[src]Commit the state change of the element and proceed to the next
pending state if any. This function is used
by elements that do asynchronous state changes.
The core will normally call this method automatically when an
element returned StateChangeReturn::Success from the state change function. Read more
v1_14 only.v1_14 only.v1_14 only.pub fn compatible_pad<P>(&self, pad: &P, caps: Option<&Caps>) -> Option<Pad> where
P: IsA<Pad>, [src]pub fn state(
&self,
timeout: impl Into<Option<ClockTime>>
) -> (Result<StateChangeSuccess, StateChangeError>, State, State)[src]pub fn link_filtered<P>(&self, dest: &P, filter: &Caps) -> Result<(), BoolError> where
P: IsA<Element>, [src]pub fn link_pads<P>(
&self,
srcpadname: Option<&str>,
dest: &P,
destpadname: Option<&str>
) -> Result<(), BoolError> where
P: IsA<Element>, [src]pub fn link_pads_filtered<P>(
&self,
srcpadname: Option<&str>,
dest: &P,
destpadname: Option<&str>,
filter: &Caps
) -> Result<(), BoolError> where
P: IsA<Element>, [src]pub fn link_pads_full<P>(
&self,
srcpadname: Option<&str>,
dest: &P,
destpadname: Option<&str>,
flags: PadLinkCheck
) -> Result<(), BoolError> where
P: IsA<Element>, [src]pub fn request_pad(
&self,
templ: &PadTemplate,
name: Option<&str>,
caps: Option<&Caps>
) -> Option<Pad>[src]v1_20 only.pub fn unlink_pads<P>(&self, srcpadname: &str, dest: &P, destpadname: &str) where
P: IsA<Element>, [src]pub fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]pub fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Pad) + Send + Sync, [src]pub fn connect_pad_removed<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Pad) + Send + Sync, [src]pub fn message_full<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32
) where
T: MessageErrorDomain, [src]pub fn message_full_with_details<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32,
structure: Structure
) where
T: MessageErrorDomain, [src]
pub fn message_full_with_details<T>(
&self,
type_: ElementMessageType,
code: T,
message: Option<&str>,
debug: Option<&str>,
file: &str,
function: &str,
line: u32,
structure: Structure
) where
T: MessageErrorDomain, [src]v1_10 only.pub fn add_property_deep_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId[src]
pub fn add_property_deep_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId[src]v1_10 only.pub fn add_property_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId[src]
pub fn add_property_notify_watch(
&self,
property_name: Option<&str>,
include_value: bool
) -> NotifyWatchId[src]v1_10 only.v1_10 only.pub fn query_convert<V, U>(&self, src_val: V) -> Option<U> where
U: SpecificFormattedValue,
V: Into<GenericFormattedValue>, [src]pub fn query_convert_generic<V>(
&self,
src_val: V,
dest_format: Format
) -> Option<GenericFormattedValue> where
V: Into<GenericFormattedValue>, [src]pub fn seek<V>(
&self,
rate: f64,
flags: SeekFlags,
start_type: SeekType,
start: V,
stop_type: SeekType,
stop: V
) -> Result<(), BoolError> where
V: Into<GenericFormattedValue>, [src]pub fn seek_simple<V>(
&self,
seek_flags: SeekFlags,
seek_pos: V
) -> Result<(), BoolError> where
V: Into<GenericFormattedValue>, [src]v1_10 only.v1_10 only.Adds the given element to the bin. Sets the element’s parent, and thus takes ownership of the element. An element can only be added to one bin. Read more
Recursively looks for elements with an unlinked pad of the given
direction within the specified bin and returns an unlinked pad
if one is found, or None otherwise. If a pad is found, the caller
owns a reference to it and should use gst_object_unref() on the
pad when it is not needed any longer. Read more
Looks for an element inside the bin that implements the given
interface. If such an element is found, it returns the element.
You can cast this element to the given interface afterwards. If you want
all elements that implement the interface, use
GstBinExtManual::iterate_all_by_interface(). This function recurses into child bins. Read more
Gets the element with the given name from a bin. This function recurses into child bins. Read more
Gets the element with the given name from this bin. If the element is not found, a recursion is performed on the parent bin. Read more
Queries self for the current latency and reconfigures this latency on all the
elements using a LATENCY event. Read more
Removes the element from the bin, unparenting it as well.
Unparenting the element means that the element will be dereferenced,
so if the bin holds the only reference to the element, the element
will be freed in the process of removing it from the bin. If you
want the element to still exist after removing, you need to call
gst_object_ref() before removing it from the bin. Read more
v1_10 only.Suppresses the given flags on the bin. ElementFlags of a
child element are propagated when it is added to the bin.
When suppressed flags are set, those specified flags will
not be propagated to the bin. Read more
Synchronizes the state of every child of self with the state
of self. See also ElementExt::sync_state_with_parent(). Read more
Forward all children messages, even those that would normally be filtered by the bin. This can be interesting when one wants to be notified of the EOS state of individual elements, for example. Read more
Forward all children messages, even those that would normally be filtered by the bin. This can be interesting when one wants to be notified of the EOS state of individual elements, for example. Read more
pub fn connect_deep_element_added<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Bin, &Element) + Send + Sync, [src]
pub fn connect_deep_element_added<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Bin, &Element) + Send + Sync, [src]v1_10 only.Will be emitted after the element was added to sub_bin. Read more
pub fn connect_deep_element_removed<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Bin, &Element) + Send + Sync, [src]
pub fn connect_deep_element_removed<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Bin, &Element) + Send + Sync, [src]v1_10 only.Will be emitted after the element was removed from sub_bin. Read more
pub fn connect_element_added<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Element) + Send + Sync, [src]
pub fn connect_element_added<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Element) + Send + Sync, [src]Will be emitted after the element was added to the bin. Read more
pub fn connect_element_removed<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Element) + Send + Sync, [src]
pub fn connect_element_removed<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &Element) + Send + Sync, [src]Will be emitted after the element was removed from the bin. Read more
pub fn connect_async_handling_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]pub fn connect_message_forward_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]pub fn connect_do_latency<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) -> Result<(), LoggableError> + Send + Sync, [src]v1_18 only.pub fn debug_to_dot_file<Q>(&self, details: DebugGraphDetails, file_name: Q) where
Q: AsRef<Path>, [src]pub fn debug_to_dot_file_with_ts<Q>(
&self,
details: DebugGraphDetails,
file_name: Q
) where
Q: AsRef<Path>, [src]pub fn add_control_binding<P>(&self, binding: &P) -> Result<(), BoolError> where
P: IsA<ControlBinding>, [src]
pub fn add_control_binding<P>(&self, binding: &P) -> Result<(), BoolError> where
P: IsA<ControlBinding>, [src]Attach the ControlBinding to the object. If there already was a
ControlBinding for this property it will be replaced. Read more
A default error function that uses g_printerr() to display the error message
and the optional debug string.. Read more
Gets the corresponding ControlBinding for the property. This should be
unreferenced again after use. Read more
Obtain the control-rate for this self. Audio processing Element
objects will use this rate to sub-divide their processing loop and call
sync_values() in between. The length of the processing segment
should be up to control-rate nanoseconds. Read more
Returns the parent of self. This function increases the refcount
of the parent object so you should gst_object_unref() it after usage. Read more
Generates a string describing the path of self in
the object hierarchy. Only useful (or used) for debugging. Read more
Gets the value for the given controlled property at the requested time. Read more
pub fn connect_parent_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]Returns true if the object is an instance of (can be cast to) T.
pub fn set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>[src]pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>[src]pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>, [src]pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>, [src]pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
N: Into<&'a str>, [src]Safety Read more
Safety Read more
Safety Read more
Safety Read more
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync, [src]pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec), [src]pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec), [src]pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>, [src]pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>, [src]pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>, [src]Same as connect but takes a SignalId instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>, [src]Same as connect_local but takes a SignalId instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>, [src]Same as connect_unsafe but takes a SignalId instead of a signal name.
Emit signal by signal id.
Emit signal with details by signal id.
Emit signal by it’s name.
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>, [src]Same as emit but takes Value for the arguments.
Same as emit_by_name but takes Value for the arguments.
Returns a SendValue clone of self.
impl<'a, T, C> FromValueOptional<'a> for T where
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>, [src]