Struct gstreamer_editing_services::Group

pub struct Group { /* private fields */ }

A Group controls one or more Container-s (usually Clip-s, but it can also control other Group-s). Its children must share the same Timeline, but can otherwise lie in separate Layer-s and have different timings.

To initialise a group, you may want to use Container::group(), and similarly use GESContainerExt::ungroup() to dispose of it.

A group will maintain the relative start times of its children, as well as their relative layer priority. Therefore, if one of its children has its start set, all other children will have their start shifted by the same amount. Similarly, if one of its children moves to a new layer, the other children will also change layers to maintain the difference in their layer priorities. For example, if a child moves from a layer with priority 1 to a layer with priority 3, then another child that was in a layer with priority 0 will move to the layer with priority 2.

The start of a group refers to the earliest start time of its children. If the group’s start is set, all the children will be shifted equally such that the earliest start time will match the set value. The duration of a group is the difference between the earliest start time and latest end time of its children. If the group’s duration is increased, the children whose end time matches the end of the group will be extended accordingly. If it is decreased, then any child whose end time exceeds the new end time will also have their duration decreased accordingly.

A group may span several layers, but for methods such as TimelineElementExt::layer_priority() and TimelineElementExt::edit() a group is considered to have a layer priority that is the highest priority (numerically, the smallest) of all the layers it spans.

Properties

duration

An overwrite of the duration property. For a Group, this is the difference between the earliest start time and the latest end time (given by start + duration) amongst its children.

Readable | Writeable

in-point

An overwrite of the in-point property. This has no meaning for a group and should not be set.

Readable | Writeable

max-duration

An overwrite of the max-duration property. This has no meaning for a group and should not be set.

Readable | Writeable | Construct

priority

An overwrite of the priority property. Setting TimelineElement priorities is deprecated as all priority management is now done by GES itself.

Readable | Writeable

start

An overwrite of the start property. For a Group, this is the earliest start time amongst its children.

Readable | Writeable

Container

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

Implements

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

GLib type: GObject with reference counted clone semantics.

Implementations

impl Group

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

pub fn new() -> Group

Created a new empty group. You may wish to use Container::group() instead, which can return a different Container subclass if possible.

Returns

The new empty group.

Trait Implementations

impl Clone for Group

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 Group

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

Formats the value using the given formatter.

impl Default for Group

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Group

type ParamSpec = ParamSpecObject

type SetValue = Group

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Group

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 Group

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 Group

type Parent = Container

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Group

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

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Group

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Group

impl IsA<Container> for Group

impl IsA<Extractable> for Group

impl IsA<MetaContainer> for Group

impl IsA<TimelineElement> for Group