Optionalproperties: Partial<GES.AudioUriSource.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeWhether the effect of the element should be applied in its
GES.TrackElement.track. If set to false, it will not be used in
the output of the track.
Whether the control sources on the element (see
ges_track_element_set_control_source()) will be automatically
updated whenever the GES.TimelineElement.in_point or out-point of the
element change in value.
See ges_track_element_clamp_control_source() for how this is done
per control source.
Default value: true
Whether the control sources on the element (see
ges_track_element_set_control_source()) will be automatically
updated whenever the GES.TimelineElement.in_point or out-point of the
element change in value.
See ges_track_element_clamp_control_source() for how this is done
per control source.
Default value: true
This property is used to determine whether the 'internal time'
properties of the element have any meaning. In particular, unless
this is set to true, the GES.TimelineElement.in_point and
GES.TimelineElement.max_duration can not be set to any value other
than the default 0 and #GST_CLOCK_TIME_NONE, respectively.
If an element has some internal timed source Gst.Element that it
reads stream data from as part of its function in a GES.Track, then
you'll likely want to set this to true to allow the
GES.TimelineElement.in_point and GES.TimelineElement.max_duration to
be set.
The default value is determined by the GES.TrackElementClass
default_has_internal_source class property. For most
GES.SourceClass-es, this will be true, with the exception of those
that have a potentially static source, such as GES.ImageSourceClass
and GES.TitleSourceClass. Otherwise, this will usually be false.
For most GES.Operation-s you will likely want to leave this set to
false. The exception may be for an operation that reads some stream
data from some private internal source as part of manipulating the
input data from the usual linked upstream GES.TrackElement.
For example, you may want to set this to true for a
#GES_TRACK_TYPE_VIDEO operation that wraps a #textoverlay that reads
from a subtitle file and places its text on top of the received video
data. The GES.TimelineElement.in_point of the element would be used
to shift the initial seek time on the #textoverlay away from 0, and
the GES.TimelineElement.max_duration could be set to reflect the
time at which the subtitle file runs out of data.
Note that GES can not support track elements that have both internal content and manipulate the timing of their data streams (time effects).
This property is used to determine whether the 'internal time'
properties of the element have any meaning. In particular, unless
this is set to true, the GES.TimelineElement.in_point and
GES.TimelineElement.max_duration can not be set to any value other
than the default 0 and #GST_CLOCK_TIME_NONE, respectively.
If an element has some internal timed source Gst.Element that it
reads stream data from as part of its function in a GES.Track, then
you'll likely want to set this to true to allow the
GES.TimelineElement.in_point and GES.TimelineElement.max_duration to
be set.
The default value is determined by the GES.TrackElementClass
default_has_internal_source class property. For most
GES.SourceClass-es, this will be true, with the exception of those
that have a potentially static source, such as GES.ImageSourceClass
and GES.TitleSourceClass. Otherwise, this will usually be false.
For most GES.Operation-s you will likely want to leave this set to
false. The exception may be for an operation that reads some stream
data from some private internal source as part of manipulating the
input data from the usual linked upstream GES.TrackElement.
For example, you may want to set this to true for a
#GES_TRACK_TYPE_VIDEO operation that wraps a #textoverlay that reads
from a subtitle file and places its text on top of the received video
data. The GES.TimelineElement.in_point of the element would be used
to shift the initial seek time on the #textoverlay away from 0, and
the GES.TimelineElement.max_duration could be set to reflect the
time at which the subtitle file runs out of data.
Note that GES can not support track elements that have both internal content and manipulate the timing of their data streams (time effects).
The track type of the element, which determines the type of track the element can be added to (see GES.Track.track_type). This should correspond to the type of data that the element can produce or process.
The track type of the element, which determines the type of track the element can be added to (see GES.Track.track_type). This should correspond to the type of data that the element can produce or process.
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.
The initial offset to use internally when outputting content (in nanoseconds, but in the time coordinates of the internal content).
For example, for a GES.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 GES.TimelineElement.start, it will begin outputting the data from the timestamp in-point onwards, until it reaches the end of its GES.TimelineElement.duration in the timeline.
For elements that have no internal content, this should be kept as 0.
The initial offset to use internally when outputting content (in nanoseconds, but in the time coordinates of the internal content).
For example, for a GES.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 GES.TimelineElement.start, it will begin outputting the data from the timestamp in-point onwards, until it reaches the end of its GES.TimelineElement.duration in the timeline.
For elements that have no internal content, this should be kept as 0.
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 GES.TimelineElement.in_point of the element (which is in the same time coordinates), and will sometimes be used to limit the GES.TimelineElement.duration of the element in the timeline.
For example, for a GES.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.
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 GES.TimelineElement.in_point of the element (which is in the same time coordinates), and will sometimes be used to limit the GES.TimelineElement.duration of the element in the timeline.
For example, for a GES.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.
The parent container of the element.
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.
SignalconnectSignalconnect_SignalemitRegister a property of a child of the element to allow it to be
written with ges_timeline_element_set_child_property() and read with
ges_timeline_element_get_child_property(). A change in the property
will also appear in the GES.TimelineElement.SignalSignatures.deep_notify | GES.TimelineElement::deep-notify signal.
pspec should be unique from other children properties that have been
registered on self.
The specification for the property to add
The Gst.Object who the property belongs to
true if the property was successfully registered.
Create a copy of self. All the properties of self are copied into
a new element, with the exception of GES.TimelineElement.parent,
GES.TimelineElement.timeline and GES.TimelineElement.name. Other data,
such the list of a GES.Container's children, is not copied.
If deep is true, then the new element is prepared so that it can be
used in ges_timeline_element_paste() or ges_timeline_paste_element().
In the case of copying a GES.Container, this ensures that the children
of self will also be pasted. The new element should not be used for
anything else and can only be used once in a pasting operation. In
particular, the new element itself is not an actual 'deep' copy of
self, but should be thought of as an intermediate object used for a
single paste operation.
Whether the copy is needed for pasting
The newly create element, copied from self.
Edits the element within its timeline by adjusting its GES.TimelineElement.start, GES.TimelineElement.duration or GES.TimelineElement.in_point, and potentially doing the same for other elements in the timeline. See GES.EditMode for details about each edit mode. An edit may fail if it would place one of these properties out of bounds, or if it would place the timeline in an unsupported configuration.
Note that if you act on a GES.TrackElement, this will edit its parent
GES.Clip instead. Moreover, for any GES.TimelineElement, if you select
#GES_EDGE_NONE for #GES_EDIT_MODE_NORMAL or #GES_EDIT_MODE_RIPPLE, this
will edit the toplevel instead, but still in such a way as to make the
GES.TimelineElement.start of self reach the edit position.
Note that if the element's timeline has a GES.Timeline.snapping_distance set, then the edit position may be snapped to the edge of some element under the edited element.
new_layer_priority can be used to switch self, and other elements
moved by the edit, to a new layer. New layers may be be created if the
the corresponding layer priority/index does not yet exist for the
timeline.
The priority/index of the layer self should be moved to. -1 means no move
The edit mode
The edge of self where the edit should occur
The edit position: a new location for the edge of self (in nanoseconds) in the timeline coordinates
true if the edit of self completed, false on failure.
Gets the property of a child of the element.
property_name can either be in the format "prop-name" or
"TypeName::prop-name", where "prop-name" is the name of the property
to get (as used in g_object_get()), and "TypeName" is the type name of
the child (as returned by G_OBJECT_TYPE_NAME()). The latter format is
useful when two children of different types share the same property
name.
The first child found with the given "prop-name" property that was
registered with ges_timeline_element_add_child_property() (and of the
type "TypeName", if it was given) will have the corresponding
property copied into value.
Note that ges_timeline_element_get_child_properties() may be more
convenient for C programming.
The name of the child property to get
true if the property was found and copied to value.
Gets the GES.TimelineElement.duration for the element.
The duration of self (in nanoseconds).
Gets the GES.TimelineElement.in_point for the element.
The in-point of self (in nanoseconds).
Gets the priority of the layer the element is in. A GES.Group may span several layers, so this would return the highest priority (numerically, the smallest) amongst them.
The priority of the layer self is in, or #GES_TIMELINE_ELEMENT_NO_LAYER_PRIORITY if self does not exist in a layer.
Gets the GES.TimelineElement.max_duration for the element.
The max-duration of self (in nanoseconds).
Get the "natural" framerate of self. This is to say, for example
for a GES.VideoUriSource the framerate of the source.
Note that a GES.AudioSource may also have a natural framerate if it derives from the same GES.SourceClip asset as a GES.VideoSource, and its value will be that of the video source. For example, if the uri of a GES.UriClip points to a file that contains both a video and audio stream, then the corresponding GES.AudioUriSource will share the natural framerate of the corresponding GES.VideoUriSource.
Whether self has a natural framerate or not, framerate_n and framerate_d will be set to, respectively, 0 and -1 if it is not the case.
Gets the GES.TimelineElement.parent for the element.
The parent of self, or null if self has no parent.
Gets the GES.TimelineElement.start for the element.
The start of self (in nanoseconds).
Gets the GES.TimelineElement.timeline for the element.
The timeline of self, or null if self has no timeline.
Gets the toplevel GES.TimelineElement.parent of the element.
The toplevel parent of self.
Gets the track types that the element can interact with, i.e. the type of GES.Track it can exist in, or will create GES.TrackElement-s for.
The track types that self supports.
Paste an element inside the same timeline and layer as self. self
must be the return of ges_timeline_element_copy() with deep=TRUE,
and it should not be changed before pasting.
self is not placed in the timeline, instead a new element is created,
alike to the originally copied element. Note that the originally
copied element must stay within the same timeline and layer, at both
the point of copying and pasting.
Pasting may fail if it would place the timeline in an unsupported configuration.
After calling this function element should not be used. In particular,
element can not be pasted again. Instead, you can copy the
returned element and paste that copy (although, this is only possible
if the paste was successful).
See also ges_timeline_paste_element().
The position in the timeline element should be pasted to, i.e. the GES.TimelineElement.start value for the pasted element.
The newly created element, or null if pasting fails.
Remove a child property from the element. pspec should be a
specification that was passed to
ges_timeline_element_add_child_property(). The corresponding property
will no longer be registered as a child property for the element.
true if the property was successfully un-registered for self.
Edits the start time of an element within its timeline in ripple mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_RIPPLE and
#GES_EDGE_NONE.
The new start time of self in ripple mode
true if the ripple edit of self completed, false on failure.
Edits the end time of an element within its timeline in ripple mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_RIPPLE and
#GES_EDGE_END.
The new end time of self in ripple mode
true if the ripple edit of self completed, false on failure.
Edits the end time of an element within its timeline in roll mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_ROLL and
#GES_EDGE_END.
The new end time of self in roll mode
true if the roll edit of self completed, false on failure.
Edits the start time of an element within its timeline in roll mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_ROLL and
#GES_EDGE_START.
The new start time of self in roll mode
true if the roll edit of self completed, false on failure.
See ges_timeline_element_set_child_property_full(), which also gives an
error.
Note that ges_timeline_element_set_child_properties() may be more
convenient for C programming.
The name of the child property to set
The value to set the property to
true if the property was found and set.
Sets the property of a child of the element. Specifically, the property
corresponding to the pspec used in
ges_timeline_element_add_child_property() is set to value.
Sets the property of a child of the element.
property_name can either be in the format "prop-name" or
"TypeName::prop-name", where "prop-name" is the name of the property
to set (as used in g_object_set()), and "TypeName" is the type name of
the child (as returned by G_OBJECT_TYPE_NAME()). The latter format is
useful when two children of different types share the same property
name.
The first child found with the given "prop-name" property that was
registered with ges_timeline_element_add_child_property() (and of the
type "TypeName", if it was given) will have the corresponding
property set to value. Other children that may have also matched the
property name (and type name) are left unchanged!
The name of the child property to set
The value to set the property to
true if the property was found and set.
Sets GES.TimelineElement.duration for the element.
Whilst the element is part of a GES.Timeline, this is the same as
editing the element with ges_timeline_element_edit() under
#GES_EDIT_MODE_TRIM with #GES_EDGE_END. In particular, the
GES.TimelineElement.duration of the element may be snapped to a
different timeline time difference from the one given. In addition,
setting may fail if it would place the timeline in an unsupported
configuration, or the element does not have enough internal content to
last the desired duration.
The desired duration in its timeline
true if duration could be set for self.
Sets GES.TimelineElement.in_point for the element. If the new in-point is above the current GES.TimelineElement.max_duration of the element, this method will fail.
The in-point, in internal time coordinates
true if inpoint could be set for self.
Sets GES.TimelineElement.max_duration for the element. If the new maximum duration is below the current GES.TimelineElement.in_point of the element, this method will fail.
The maximum duration, in internal time coordinates
true if maxduration could be set for self.
Sets the GES.TimelineElement.name for the element. If null is given
for name, then the library will instead generate a new name based on
the type name of the element, such as the name "uriclip3" for a
GES.UriClip, and will set that name instead.
If self already has a GES.TimelineElement.timeline, you should not
call this function with name set to null.
You should ensure that, within each GES.Timeline, every element has a
unique name. If you call this function with name as null, then
the library should ensure that the set generated name is unique from
previously generated names. However, if you choose a name that
interferes with the naming conventions of the library, the library will
attempt to ensure that the generated names will not conflict with the
chosen name, which may lead to a different name being set instead, but
the uniqueness between generated and user-chosen names is not
guaranteed.
The name self should take
true if name or a generated name for self could be set.
Sets the GES.TimelineElement.parent for the element.
This is used internally and you should normally not call this. A
GES.Container will set the GES.TimelineElement.parent of its children
in ges_container_add() and ges_container_remove().
Note, if parent is not null, self must not already have a parent
set. Therefore, if you wish to switch parents, you will need to call
this function twice: first to set the parent to null, and then to the
new parent.
If parent is not null, you must ensure it already has a
(non-floating) reference to self before calling this.
true if parent could be set for self.
Sets the priority of the element within the containing layer.
The priority
true if priority could be set for self.
Sets GES.TimelineElement.start for the element. If the element has a parent, this will also move its siblings with the same shift.
Whilst the element is part of a GES.Timeline, this is the same as
editing the element with ges_timeline_element_edit() under
#GES_EDIT_MODE_NORMAL with #GES_EDGE_NONE. In particular, the
GES.TimelineElement.start of the element may be snapped to a different
timeline time from the one given. In addition, setting may fail if it
would place the timeline in an unsupported configuration.
The desired start position of the element in its timeline
true if start could be set for self.
Sets the GES.TimelineElement.timeline of the element.
This is used internally and you should normally not call this. A GES.Clip will have its GES.TimelineElement.timeline set through its GES.Layer. A GES.Track will similarly take care of setting the GES.TimelineElement.timeline of its GES.TrackElement-s. A GES.Group will adopt the same GES.TimelineElement.timeline as its children.
If timeline is null, this will stop its current
GES.TimelineElement.timeline from tracking it, otherwise timeline will
start tracking self. Note, in the latter case, self must not already
have a timeline set. Therefore, if you wish to switch timelines, you
will need to call this function twice: first to set the timeline to
null, and then to the new timeline.
true if timeline could be set for self.
Edits the start time of an element within its timeline in trim mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_TRIM and
#GES_EDGE_START.
The new start time of self in trim mode
true if the trim edit of self completed, false on failure.
Virtualvfunc_Prepare copy for pasting as a copy of self. At least by
copying the children properties of self into copy.
Virtualvfunc_Gets the priority of the layer the element is in. A GES.Group may span several layers, so this would return the highest priority (numerically, the smallest) amongst them.
Virtualvfunc_Get the "natural" framerate of self. This is to say, for example
for a GES.VideoUriSource the framerate of the source.
Note that a GES.AudioSource may also have a natural framerate if it derives from the same GES.SourceClip asset as a GES.VideoSource, and its value will be that of the video source. For example, if the uri of a GES.UriClip points to a file that contains both a video and audio stream, then the corresponding GES.AudioUriSource will share the natural framerate of the corresponding GES.VideoUriSource.
Virtualvfunc_Gets the track types that the element can interact with, i.e. the type of GES.Track it can exist in, or will create GES.TrackElement-s for.
Virtualvfunc_Edits the start time of an element within its timeline in ripple mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_RIPPLE and
#GES_EDGE_NONE.
The new start time of self in ripple mode
Virtualvfunc_Edits the end time of an element within its timeline in ripple mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_RIPPLE and
#GES_EDGE_END.
The new end time of self in ripple mode
Virtualvfunc_Edits the end time of an element within its timeline in roll mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_ROLL and
#GES_EDGE_END.
The new end time of self in roll mode
Virtualvfunc_Edits the start time of an element within its timeline in roll mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_ROLL and
#GES_EDGE_START.
The new start time of self in roll mode
Virtualvfunc_Virtualvfunc_Virtualvfunc_Sets GES.TimelineElement.duration for the element.
Whilst the element is part of a GES.Timeline, this is the same as
editing the element with ges_timeline_element_edit() under
#GES_EDIT_MODE_TRIM with #GES_EDGE_END. In particular, the
GES.TimelineElement.duration of the element may be snapped to a
different timeline time difference from the one given. In addition,
setting may fail if it would place the timeline in an unsupported
configuration, or the element does not have enough internal content to
last the desired duration.
The desired duration in its timeline
Virtualvfunc_Sets GES.TimelineElement.in_point for the element. If the new in-point is above the current GES.TimelineElement.max_duration of the element, this method will fail.
The in-point, in internal time coordinates
Virtualvfunc_Sets GES.TimelineElement.max_duration for the element. If the new maximum duration is below the current GES.TimelineElement.in_point of the element, this method will fail.
The maximum duration, in internal time coordinates
Virtualvfunc_Sets the GES.TimelineElement.parent for the element.
This is used internally and you should normally not call this. A
GES.Container will set the GES.TimelineElement.parent of its children
in ges_container_add() and ges_container_remove().
Note, if parent is not null, self must not already have a parent
set. Therefore, if you wish to switch parents, you will need to call
this function twice: first to set the parent to null, and then to the
new parent.
If parent is not null, you must ensure it already has a
(non-floating) reference to self before calling this.
Virtualvfunc_Sets the priority of the element within the containing layer.
The priority
Virtualvfunc_Sets GES.TimelineElement.start for the element. If the element has a parent, this will also move its siblings with the same shift.
Whilst the element is part of a GES.Timeline, this is the same as
editing the element with ges_timeline_element_edit() under
#GES_EDIT_MODE_NORMAL with #GES_EDGE_NONE. In particular, the
GES.TimelineElement.start of the element may be snapped to a different
timeline time from the one given. In addition, setting may fail if it
would place the timeline in an unsupported configuration.
The desired start position of the element in its timeline
Virtualvfunc_Edits the start time of an element within its timeline in trim mode.
See ges_timeline_element_edit() with #GES_EDIT_MODE_TRIM and
#GES_EDGE_START.
The new start time of self in trim mode
Adds all the properties of a Gst.Element that match the criteria as
children properties of the track element. If the name of element's
Gst.ElementFactory is not in blacklist, and the factory's
#GST_ELEMENT_METADATA_KLASS contains at least one member of
wanted_categories (e.g. #GST_ELEMENT_FACTORY_KLASS_DECODER), then
all the properties of element that are also in whitelist are added as
child properties of self using
ges_timeline_element_add_child_property().
This is intended to be used by subclasses when constructing.
The child object to retrieve properties from
An array of element factory "klass" categories to whitelist, or null to accept all categories
A blacklist of element factory names, or null to not blacklist any element factory
A whitelist of element property names, or null to whitelist all writeable properties
Deserializes the given string, and adds and sets the found fields and
their values on the container. The string should be the return of
ges_meta_container_metas_to_string().
A string to deserialize and add to container
true if the fields in str was successfully deserialized and added to container.
Checks whether the specified field has been registered as static, and
gets the registered type and flags of the field, as used in
ges_meta_container_register_meta() and
ges_meta_container_register_static_meta().
The key for the container field to check
true if the meta_item field has been registered on container.
Clamp the GstTimedValueControlSource for the specified child property
to lie between the GES.TimelineElement.in_point and out-point of the
element. The out-point is the #GES_TIMELINE_ELEMENT_END of the element
translated from the timeline coordinates to the internal source
coordinates of the element.
If the property does not have a GstTimedValueControlSource set by
ges_track_element_set_control_source(), nothing happens. Otherwise, if
a timed value for the control source lies before the in-point of the
element, or after its out-point, then it will be removed. At the
in-point and out-point times, a new interpolated value will be placed.
The name of the child property to clamp the control source of
Edits the element within its track.
A whitelist of layers where the edit can be performed, null allows all layers in the timeline
The edit mode
The edge of object where the edit should occur
The edit position: a new location for the edge of object (in nanoseconds)
true if the edit of object completed, false on failure.
Calls the given function on each of the meta container's set metadata fields.
A function to call on each of container's set metadata fields
Get all the control bindings that have been created for the children
properties of the track element using
ges_track_element_set_control_source(). The keys used in the returned
hash table are the child property names that were passed to
ges_track_element_set_control_source(), and their values are the
corresponding created Gst.ControlBinding.
A hash table containing all child-property-name/control-binding pairs for trackelement.
Whether the control sources for the child properties of object are automatically clamped.
Gets the current boolean value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
true if the boolean value under meta_item was copied to dest.
Gets the control binding that was created for the specified child
property of the track element using
ges_track_element_set_control_source(). The given property_name must
be the same name of the child property that was passed to
ges_track_element_set_control_source().
The name of the child property to return the control binding of
The control binding that was created for the specified child property of object, or null if property_name does not correspond to any control binding.
Gets the current date value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
true if the date value under meta_item was copied to dest.
Gets the current date time value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
true if the date time value under meta_item was copied to dest.
Gets the current double value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
true if the double value under meta_item was copied to dest.
Get the Gst.Element that the track element's underlying nleobject controls.
The Gst.Element being controlled by the nleobject that object wraps.
Gets the current float value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
true if the float value under meta_item was copied to dest.
Gets the GES.Asset.id of some associated asset. It may be the case that the object has no set asset, or even that such an asset does not yet exist in the GES cache. Instead, this will return the asset GES.Asset.id that is compatible with the current state of the object, as determined by the GES.Extractable implementer. If it was indeed extracted from an asset, this should return the same as its corresponding asset GES.Asset.id.
The GES.Asset.id of some associated GES.Asset that is compatible with self's current state.
Gets the current int value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
true if the int value under meta_item was copied to dest.
Gets the current int64 value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
true if the int64 value under meta_item was copied to dest.
Gets the current marker list value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
A copy of the marker list value under key, or null if it could not be fetched.
Gets the current string value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
The string value under meta_item, or null if it could not be fetched.
Get the GES.TrackElement.track for the element.
The track that object belongs to, or null if it does not belong to a track.
Gets the GES.TrackElement.track_type for the element.
The track-type of object.
Gets the current uint value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
true if the uint value under meta_item was copied to dest.
Gets the current uint64 value of the specified field of the meta container. If the field does not have a set value, or it is of the wrong type, the method will fail.
The key for the container field to get
true if the uint64 value under meta_item was copied to dest.
Get whether the given track element is a core track element. That is,
it was created by the create_track_elements GES.ClipClass method for
some GES.Clip.
Note that such a track element can only be added to a clip that shares
the same GES.Asset as the clip that created it. For example, you are
allowed to move core children between clips that resulted from
ges_container_ungroup(), but you could not move the core child from a
GES.UriClip to a GES.TitleClip or another GES.UriClip with a different
GES.UriClip.uri.
Moreover, if a core track element is added to a clip, it will always be
added as a core child. Therefore, if this returns true, then element
will be a core child of its parent clip.
true if element is a core track element.
Gets an array of GObject.ParamSpec* for all configurable properties of the
children of object.
An array of GObject.ParamSpec* which should be freed after use or null if something went wrong.
Looks up which element and pspec would be effected by the given name. If various
contained elements have this property name you will get the first one, unless you
specify the class name in name.
Name of the property to look up. You can specify the name of the class as such: "ClassName::property-name", to guarantee that you get the proper GParamSpec in case various GstElement-s contain the same property name. If you don't do so, you will get the first element found, having this property and the and the corresponding GParamSpec.
TRUE if element and pspec could be found. FALSE otherwise. In that case the values for pspec and element are not modified. Unref element after usage.
Serializes the set metadata fields of the meta container to a string.
A serialized container.
Sets the value of the specified field of the meta container to the
given value, and registers the field to only hold a value of the
same type. After calling this, only values of the same type as value
can be set for this field. The given flags can be set to make this
field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold value types, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given boolean value, and registers the field to only hold a boolean typed value. After calling this, only boolean values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold boolean typed values, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given date value, and registers the field to only hold a date typed value. After calling this, only date values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold date typed values, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given date time value, and registers the field to only hold a date time typed value. After calling this, only date time values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold date time typed values, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given double value, and registers the field to only hold a double typed value. After calling this, only double values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold double typed values, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given float value, and registers the field to only hold a float typed value. After calling this, only float values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold float typed values, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given int value, and registers the field to only hold an int typed value. After calling this, only int values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold int typed values, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given int64 value, and registers the field to only hold an int64 typed value. After calling this, only int64 values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold int64 typed values, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given string value, and registers the field to only hold a string typed value. After calling this, only string values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold string typed values, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given uint value, and registers the field to only hold a uint typed value. After calling this, only uint values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold uint typed values, with the given flags, and the field was successfully set to value.
Sets the value of the specified field of the meta container to the given uint64 value, and registers the field to only hold a uint64 typed value. After calling this, only uint64 values can be set for this field. The given flags can be set to make this field only readable after calling this method.
true if the meta_item field was successfully registered on container to only hold uint64 typed values, with the given flags, and the field was successfully set to value.
Registers a static metadata field on the container to only hold the specified type. After calling this, setting a value under this field can only succeed if its type matches the registered type of the field.
Unlike ges_meta_container_register_meta(), no (initial) value is set
for this field, which means you can use this method to reserve the
space to be optionally set later.
Note that if a value has already been set for the field being
registered, then its type must match the registering type, and its
value will be left in place. If the field has no set value, then
you will likely want to include #GES_META_WRITABLE in flags to allow
the value to be set later.
true if the meta_item field was successfully registered on container to only hold type values, with the given flags.
Removes the Gst.ControlBinding that was created for the specified child
property of the track element using
ges_track_element_set_control_source(). The given property_name must
be the same name of the child property that was passed to
ges_track_element_set_control_source().
The name of the child property to remove the control binding from
true if the control binding was removed from the specified child property of object, or false if an error occurred.
Sets GES.TrackElement.active for the element.
Whether object should be active in its track
true if the property was toggled.
Sets the asset for this extractable object.
When an object is extracted from an asset using ges_asset_extract() its
asset will be automatically set. Note that many classes that implement
GES.Extractable will automatically create their objects using assets
when you call their new methods. However, you can use this method to
associate an object with a compatible asset if it was created by other
means and does not yet have an asset. Or, for some implementations of
GES.Extractable, you can use this to change the asset of the given
extractable object, which will lead to a change in its state to
match the new asset GES.Asset.id.
true if asset could be successfully set on self.
Sets GES.TrackElement.auto_clamp_control_sources. If set to true, this
will immediately clamp all the control sources.
Whether to automatically clamp the control sources for the child properties of object
Sets the value of the specified field of the meta container to the given boolean value.
The key for the container field to set
The value to set under meta_item
true if value was set under meta_item for container.
Creates a Gst.ControlBinding for the specified child property of the
track element using the given control source. The given property_name
should refer to an existing child property of the track element, as
used in ges_timeline_element_lookup_child().
If binding_type is "direct", then the control binding is created with
gst_direct_control_binding_new() using the given control source. If
binding_type is "direct-absolute", it is created with
gst_direct_control_binding_new_absolute() instead.
The control source to bind the child property to
The name of the child property to control
The type of binding to create ("direct" or "direct-absolute")
true if the specified child property could be bound to source, or false if an error occurred.
Sets the value of the specified field of the meta container to the given double value.
The key for the container field to set
The value to set under meta_item
true if value was set under meta_item for container.
Sets the value of the specified field of the meta container to the given float value.
The key for the container field to set
The value to set under meta_item
true if value was set under meta_item for container.
Sets GES.TrackElement.has_internal_source for the element. If this is
set to false, this method will also set the
GES.TimelineElement.in_point of the element to 0 and its
GES.TimelineElement.max_duration to #GST_CLOCK_TIME_NONE.
Whether the object should be allowed to have its 'internal time' properties set.
false if has_internal_source is forbidden for object and true in any other case.
Sets the value of the specified field of the meta container to the given int value.
The key for the container field to set
The value to set under meta_item
true if value was set under meta_item for container.
Sets the value of the specified field of the meta container to the given int64 value.
The key for the container field to set
The value to set under meta_item
true if value was set under meta_item for container.
Sets the value of the specified field of the meta container to the given marker list value.
The key for the container field to set
The value to set under meta_item
true if value was set under meta_item for container.
Sets the value of the specified field of the meta container to a
copy of the given value. If the given value is null, the field
given by meta_item is removed and true is returned.
true if value was set under meta_item for container.
Sets the value of the specified field of the meta container to the given string value.
The key for the container field to set
The value to set under meta_item
true if value was set under meta_item for container.
Sets the GES.TrackElement.track_type for the element.
Sets the value of the specified field of the meta container to the given uint value.
The key for the container field to set
The value to set under meta_item
true if value was set under meta_item for container.
Sets the value of the specified field of the meta container to the given uint64 value.
The key for the container field to set
The value to set under meta_item
true if value was set under meta_item for container.
Virtualvfunc_Notify when the GES.TrackElement.active property changes
Whether the element is active or not inside the #nlecomposition
Virtualvfunc_Virtualvfunc_Virtualvfunc_Virtualvfunc_Gets the GES.Asset.id of some associated asset. It may be the case that the object has no set asset, or even that such an asset does not yet exist in the GES cache. Instead, this will return the asset GES.Asset.id that is compatible with the current state of the object, as determined by the GES.Extractable implementer. If it was indeed extracted from an asset, this should return the same as its corresponding asset GES.Asset.id.
Virtualvfunc_Looks up which element and pspec would be effected by the given name. If various
contained elements have this property name you will get the first one, unless you
specify the class name in name.
Name of the property to look up. You can specify the name of the class as such: "ClassName::property-name", to guarantee that you get the proper GParamSpec in case various GstElement-s contain the same property name. If you don't do so, you will get the first element found, having this property and the and the corresponding GParamSpec.
Virtualvfunc_This method is called after the GES.Asset of an object is
set. If your class supports the asset of an object changing, then you
can use this method to change the parameters of the object to match the
new asset GES.Asset.id. If setting the asset should be able to fail,
you should implement set_asset_full instead.
Virtualvfunc_Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
data to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcompat_Staticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Children Properties
{{ libs/GESVideoUriSource-children-props.md }}