1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::{ffi, Container, Extractable, MetaContainer, TimelineElement};
use glib::translate::*;

glib::wrapper! {
    /// A [`Group`][crate::Group] controls one or more [`Container`][crate::Container]-s (usually [`Clip`][crate::Clip]-s,
    /// but it can also control other [`Group`][crate::Group]-s). Its children must share
    /// the same [`Timeline`][crate::Timeline], but can otherwise lie in separate [`Layer`][crate::Layer]-s
    /// and have different timings.
    ///
    /// To initialise a group, you may want to use [`Container::group()`][crate::Container::group()],
    /// and similarly use [`GESContainerExt::ungroup()`][crate::prelude::GESContainerExt::ungroup()] to dispose of it.
    ///
    /// A group will maintain the relative [`start`][struct@crate::TimelineElement#start] times of
    /// its children, as well as their relative layer [`priority`][struct@crate::Layer#priority].
    /// Therefore, if one of its children has its [`start`][struct@crate::TimelineElement#start]
    /// set, all other children will have their [`start`][struct@crate::TimelineElement#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`][struct@crate::Layer#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`][struct@crate::Group#start] of a group refers to the earliest start
    /// time of its children. If the group's [`start`][struct@crate::Group#start] is set, all the
    /// children will be shifted equally such that the earliest start time
    /// will match the set value. The [`duration`][struct@crate::Group#duration] of a group is the
    /// difference between the earliest start time and latest end time of its
    /// children. If the group's [`duration`][struct@crate::Group#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()`][crate::prelude::TimelineElementExt::layer_priority()] and
    /// [`TimelineElementExt::edit()`][crate::prelude::TimelineElementExt::edit()] a group is considered to have a layer
    /// priority that is the highest [`priority`][struct@crate::Layer#priority] (numerically, the
    /// smallest) of all the layers it spans.
    ///
    /// ## Properties
    ///
    ///
    /// #### `duration`
    ///  An overwrite of the [`duration`][struct@crate::TimelineElement#duration] property. For a
    /// [`Group`][crate::Group], this is the difference between the earliest
    /// [`start`][struct@crate::TimelineElement#start] time and the latest end time (given by
    /// [`start`][struct@crate::TimelineElement#start] + [`duration`][struct@crate::TimelineElement#duration]) amongst
    /// its children.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `in-point`
    ///  An overwrite of the [`in-point`][struct@crate::TimelineElement#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`][struct@crate::TimelineElement#max-duration] property. This
    /// has no meaning for a group and should not be set.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `priority`
    ///  An overwrite of the [`priority`][struct@crate::TimelineElement#priority] property.
    /// Setting [`TimelineElement`][crate::TimelineElement] priorities is deprecated as all priority
    /// management is now done by GES itself.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `start`
    ///  An overwrite of the [`start`][struct@crate::TimelineElement#start] property. For a
    /// [`Group`][crate::Group], this is the earliest [`start`][struct@crate::TimelineElement#start] time
    /// amongst its children.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>Container</h4></summary>
    ///
    ///
    /// #### `height`
    ///  The span of the container's children's [`priority`][struct@crate::TimelineElement#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
    /// </details>
    /// <details><summary><h4>TimelineElement</h4></summary>
    ///
    ///
    /// #### `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`][crate::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`][struct@crate::TimelineElement#start], it will begin outputting the
    /// data from the timestamp in-point **onwards**, until it reaches the
    /// end of its [`duration`][struct@crate::TimelineElement#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`][struct@crate::TimelineElement#in-point] of the
    /// element (which is in the same time coordinates), and will sometimes
    /// be used to limit the [`duration`][struct@crate::TimelineElement#duration] of the element in
    /// the timeline.
    ///
    /// For example, for a [`VideoUriSource`][crate::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
    /// </details>
    ///
    /// # Implements
    ///
    /// [`GESContainerExt`][trait@crate::prelude::GESContainerExt], [`TimelineElementExt`][trait@crate::prelude::TimelineElementExt], [`trait@glib::ObjectExt`], [`ExtractableExt`][trait@crate::prelude::ExtractableExt], [`MetaContainerExt`][trait@crate::prelude::MetaContainerExt], [`TimelineElementExtManual`][trait@crate::prelude::TimelineElementExtManual]
    #[doc(alias = "GESGroup")]
    pub struct Group(Object<ffi::GESGroup, ffi::GESGroupClass>) @extends Container, TimelineElement, @implements Extractable, MetaContainer;

    match fn {
        type_ => || ffi::ges_group_get_type(),
    }
}

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

    /// Created a new empty group. You may wish to use
    /// [`Container::group()`][crate::Container::group()] instead, which can return a different
    /// [`Container`][crate::Container] subclass if possible.
    ///
    /// # Returns
    ///
    /// The new empty group.
    #[doc(alias = "ges_group_new")]
    pub fn new() -> Group {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::ges_group_new()) }
    }
}

impl Default for Group {
    fn default() -> Self {
        Self::new()
    }
}