Struct gstreamer_editing_services::Container

pub struct Container { /* private fields */ }

A Container is a timeline element that controls other TimelineElement-s, which are its children. In particular, it is responsible for maintaining the relative start and duration times of its children. Therefore, if a container is temporally adjusted or moved to a new layer, it may accordingly adjust and move its children. Similarly, a change in one of its children may prompt the parent to correspondingly change its siblings.

This is an Abstract Base Class, you cannot instantiate it.

Properties

height

The span of the container’s children’s priority values, which is the number of integers that lie between (inclusive) the minimum and maximum priorities found amongst the container’s children (maximum - minimum + 1).

Readable

TimelineElement

duration

The duration that the element is in effect for in the timeline (a time difference in nanoseconds using the time coordinates of the timeline). For example, for a source element, this would determine for how long it should output its internal content for. For an operation element, this would determine for how long its effect should be applied to any source content.

Readable | Writeable

in-point

The initial offset to use internally when outputting content (in nanoseconds, but in the time coordinates of the internal content).

For example, for a VideoUriSource that references some media file, the “internal content” is the media file data, and the in-point would correspond to some timestamp in the media file. When playing the timeline, and when the element is first reached at timeline-time start, it will begin outputting the data from the timestamp in-point onwards, until it reaches the end of its duration in the timeline.

For elements that have no internal content, this should be kept as 0.

Readable | Writeable

max-duration

The full duration of internal content that is available (a time difference in nanoseconds using the time coordinates of the internal content).

This will act as a cap on the in-point of the element (which is in the same time coordinates), and will sometimes be used to limit the duration of the element in the timeline.

For example, for a VideoUriSource that references some media file, this would be the length of the media file.

For elements that have no internal content, or whose content is indefinite, this should be kept as GST_CLOCK_TIME_NONE.

Readable | Writeable | Construct

name

The name of the element. This should be unique within its timeline.

Readable | Writeable | Construct

parent

The parent container of the element.

Readable | Writeable

priority

The priority of the element.

Readable | Writeable

serialize

Whether the element should be serialized.

Readable | Writeable

start

The starting position of the element in the timeline (in nanoseconds and in the time coordinates of the timeline). For example, for a source element, this would determine the time at which it should start outputting its internal content. For an operation element, this would determine the time at which it should start applying its effect to any source content.

Readable | Writeable

timeline

The timeline that the element lies within.

Readable | Writeable

Signals

child-added

Will be emitted after a child is added to the container. Usually, you should connect with g_signal_connect_after() since the signal may be stopped internally.

child-removed

Will be emitted after a child is removed from the container.

TimelineElement

child-property-added

Emitted when the element has a new child property registered. See TimelineElementExt::add_child_property().

Note that some GES elements will be automatically created with pre-registered children properties. You can use TimelineElementExt::list_children_properties() to list these.

child-property-removed

Emitted when the element has a child property unregistered. See TimelineElementExt::remove_child_property().

deep-notify

Emitted when a child of the element has one of its registered properties set. See TimelineElementExt::add_child_property(). Note that unlike notify, a child property name can not be used as a signal detail.

Detailed

MetaContainer

notify-meta

This is emitted for a meta container whenever the metadata under one of its fields changes, is set for the first time, or is removed. In the latter case, value will be None.

Detailed

Implements

GESContainerExt, TimelineElementExt, [trait@glib::ObjectExt], ExtractableExt, MetaContainerExt, [TimelineElementExtManual][trait@crate::prelude::TimelineElementExtManual]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Container

pub const NONE: Option<&'static Container> = None

pub fn group(containers: &[Container]) -> Option<Container>

Groups the containers into a single container by merging them. The containers must all belong to the same timeline.

If the elements are all Clip-s then this method will attempt to combine them all into a single Clip. This should succeed if they: share the same start, duration and in-point; exist in the same layer; and all of the sources share the same Asset. If this fails, or one of the elements is not a Clip, this method will try to create a Group instead.

containers

The Container-s to group

Returns

The container created by merging containers, or None if they could not be merged into a single container.

Trait Implementations

impl Clone for Container

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 Container

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

Formats the value using the given formatter.

impl HasParamSpec for Container

type ParamSpec = ParamSpecObject

type SetValue = Container

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Container

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 Container

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 Container

type Parent = TimelineElement

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

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 Container

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 Container

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Container

impl IsA<Container> for BaseEffectClip

impl IsA<Container> for BaseTransitionClip

impl IsA<Container> for Clip

impl IsA<Container> for EffectClip

impl IsA<Container> for Group

impl IsA<Container> for OperationClip

impl IsA<Container> for OverlayClip

impl IsA<Container> for SourceClip

impl IsA<Container> for TestClip

impl IsA<Container> for TextOverlayClip

impl IsA<Container> for TitleClip

impl IsA<Container> for TransitionClip

impl IsA<Container> for UriClip

impl IsA<Extractable> for Container

impl IsA<MetaContainer> for Container

impl IsA<TimelineElement> for Container