Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

active?: boolean

Whether the effect of the element should be applied in its #GESTrackElement:track. If set to %FALSE, it will not be used in the output of the track.

auto_clamp_control_sources?: boolean

Whether the control sources on the element (see ges_track_element_set_control_source()) will be automatically updated whenever the #GESTimelineElement: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

bin_description?: string

The description of the effect bin with a gst-launch-style pipeline description.

Example: "videobalance saturation=1.5 hue=+0.5"

duration?: number

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.

has_internal_source?: boolean

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 #GESTimelineElement:in-point and #GESTimelineElement: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 #GstElement that it reads stream data from as part of its function in a #GESTrack, then you'll likely want to set this to %TRUE to allow the #GESTimelineElement:in-point and #GESTimelineElement:max-duration to be set.

The default value is determined by the #GESTrackElementClass default_has_internal_source class property. For most #GESSourceClass-es, this will be %TRUE, with the exception of those that have a potentially static source, such as #GESImageSourceClass and #GESTitleSourceClass. Otherwise, this will usually be %FALSE.

For most #GESOperation-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 #GESTrackElement.

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 #GESTimelineElement:in-point of the element would be used to shift the initial seek time on the #textoverlay away from 0, and the #GESTimelineElement: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).

in_point?: number

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

For example, for a #GESVideoUriSource 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 #GESTimelineElement:start, it will begin outputting the data from the timestamp in-point onwards, until it reaches the end of its #GESTimelineElement:duration in the timeline.

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

max_duration?: number

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 #GESTimelineElement:in-point of the element (which is in the same time coordinates), and will sometimes be used to limit the #GESTimelineElement:duration of the element in the timeline.

For example, for a #GESVideoUriSource 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.

name?: string

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

The parent container of the element.

priority?: number

The priority of the element.

serialize?: boolean

Whether the element should be serialized.

start?: number

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.

timeline?: GES.Timeline

The timeline that the element lies within.

track_type?: TrackType

The track type of the element, which determines the type of track the element can be added to (see #GESTrack:track-type). This should correspond to the type of data that the element can produce or process.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method