mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-02-23 06:26:23 +00:00
docs: Update documentation
This commit is contained in:
parent
97846d698c
commit
5d35024cd3
7 changed files with 30 additions and 11 deletions
|
@ -51,6 +51,8 @@ ges_track_add_object
|
||||||
ges_track_remove_object
|
ges_track_remove_object
|
||||||
ges_track_set_caps
|
ges_track_set_caps
|
||||||
ges_track_get_caps
|
ges_track_get_caps
|
||||||
|
ges_track_enable_update
|
||||||
|
ges_track_get_objects
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
GESTrackClass
|
GESTrackClass
|
||||||
GESTrackPrivate
|
GESTrackPrivate
|
||||||
|
@ -242,6 +244,7 @@ ges_timeline_add_track
|
||||||
ges_timeline_remove_track
|
ges_timeline_remove_track
|
||||||
ges_timeline_load_from_uri
|
ges_timeline_load_from_uri
|
||||||
ges_timeline_save_to_uri
|
ges_timeline_save_to_uri
|
||||||
|
ges_timeline_enable_update
|
||||||
<SUBSECTION usage>
|
<SUBSECTION usage>
|
||||||
ges_timeline_get_tracks
|
ges_timeline_get_tracks
|
||||||
ges_timeline_get_layers
|
ges_timeline_get_layers
|
||||||
|
@ -270,6 +273,8 @@ ges_timeline_layer_remove_object
|
||||||
ges_timeline_layer_set_priority
|
ges_timeline_layer_set_priority
|
||||||
ges_timeline_layer_get_priority
|
ges_timeline_layer_get_priority
|
||||||
ges_timeline_layer_get_objects
|
ges_timeline_layer_get_objects
|
||||||
|
ges_timeline_layer_get_auto_transition
|
||||||
|
ges_timeline_layer_set_auto_transition
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
GESTimelineLayerPrivate
|
GESTimelineLayerPrivate
|
||||||
ges_timeline_layer_set_timeline
|
ges_timeline_layer_set_timeline
|
||||||
|
@ -303,6 +308,7 @@ ges_timeline_object_move_to_layer
|
||||||
ges_timeline_object_set_top_effect_priority
|
ges_timeline_object_set_top_effect_priority
|
||||||
ges_timeline_object_set_supported_formats
|
ges_timeline_object_set_supported_formats
|
||||||
ges_timeline_object_get_supported_formats
|
ges_timeline_object_get_supported_formats
|
||||||
|
ges_timeline_object_split
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
GES_TIMELINE_OBJECT_DURATION
|
GES_TIMELINE_OBJECT_DURATION
|
||||||
GES_TIMELINE_OBJECT_INPOINT
|
GES_TIMELINE_OBJECT_INPOINT
|
||||||
|
@ -344,6 +350,10 @@ ges_timeline_pipeline_preview_set_video_sink
|
||||||
ges_timeline_pipeline_get_thumbnail_buffer
|
ges_timeline_pipeline_get_thumbnail_buffer
|
||||||
ges_timeline_pipeline_get_thumbnail_rgb24
|
ges_timeline_pipeline_get_thumbnail_rgb24
|
||||||
ges_timeline_pipeline_save_thumbnail
|
ges_timeline_pipeline_save_thumbnail
|
||||||
|
ges_timeline_pipeline_preview_get_audio_sink
|
||||||
|
ges_timeline_pipeline_preview_get_video_sink
|
||||||
|
ges_timeline_pipeline_preview_set_audio_sink
|
||||||
|
ges_timeline_pipeline_preview_set_video_sink
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
GESTimelinePipelineClass
|
GESTimelinePipelineClass
|
||||||
GESTimelinePipelinePrivate
|
GESTimelinePipelinePrivate
|
||||||
|
|
|
@ -237,7 +237,7 @@ ges_formatter_set_data (GESFormatter * formatter, void *data, gsize length)
|
||||||
*
|
*
|
||||||
* Lets you get the data @formatter used for loading.
|
* Lets you get the data @formatter used for loading.
|
||||||
*
|
*
|
||||||
* Returns: a pointer to the data.
|
* Returns: (transfer none): a pointer to the data.
|
||||||
*/
|
*/
|
||||||
void *
|
void *
|
||||||
ges_formatter_get_data (GESFormatter * formatter, gsize * length)
|
ges_formatter_get_data (GESFormatter * formatter, gsize * length)
|
||||||
|
|
|
@ -765,10 +765,10 @@ ges_timeline_layer_get_auto_transition (GESTimelineLayer * layer)
|
||||||
/**
|
/**
|
||||||
* ges_timeline_layer_set_auto_transition:
|
* ges_timeline_layer_set_auto_transition:
|
||||||
* @layer: a #GESTimelineLayer
|
* @layer: a #GESTimelineLayer
|
||||||
* @priority: whether the auto_transition is active
|
* @auto_transition: whether the auto_transition is active
|
||||||
*
|
*
|
||||||
* Sets the layer to the given @auto_transition. See the documentation of the
|
* Sets the layer to the given @auto_transition. See the documentation of the
|
||||||
* priority auto_transition for more information.
|
* property auto_transition for more information.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
ges_timeline_layer_set_auto_transition (GESTimelineLayer * layer,
|
ges_timeline_layer_set_auto_transition (GESTimelineLayer * layer,
|
||||||
|
|
|
@ -361,7 +361,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
|
||||||
* @object: the #GESTimelineObject
|
* @object: the #GESTimelineObject
|
||||||
* @tckobj: the #GESTrackObject that was removed.
|
* @tckobj: the #GESTrackObject that was removed.
|
||||||
*
|
*
|
||||||
* Will be emitted after a track object was added to the object.
|
* Will be emitted after a track object was removed from @object.
|
||||||
*
|
*
|
||||||
* Since: 0.10.2
|
* Since: 0.10.2
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -291,7 +291,7 @@ ges_timeline_object_set_supported_formats (GESTimelineObject * self,
|
||||||
GESTrackType supportedformats);
|
GESTrackType supportedformats);
|
||||||
|
|
||||||
GESTimelineObject *
|
GESTimelineObject *
|
||||||
ges_timeline_object_split(GESTimelineObject * ref_object, gint64 position);
|
ges_timeline_object_split(GESTimelineObject * self, gint64 position);
|
||||||
|
|
||||||
G_END_DECLS
|
G_END_DECLS
|
||||||
|
|
||||||
|
|
|
@ -1110,12 +1110,12 @@ ges_timeline_get_layers (GESTimeline * timeline)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ges_timeline_enable_update:
|
* ges_timeline_enable_update:
|
||||||
* @timeline : a #GESTimeline
|
* @timeline: a #GESTimeline
|
||||||
* @enabled : TRUE if the timeline must be updated, FALSE otherwise.
|
* @enabled: TRUE if the timeline must be updated, FALSE otherwise.
|
||||||
*
|
*
|
||||||
* Calls the enable_update function of the tracks contained by the timeline.
|
* Calls the enable_update function of the tracks contained by the timeline.
|
||||||
*
|
*
|
||||||
* Returns : True if success, FALSE otherwise.
|
* Returns: True if success, FALSE otherwise.
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
ges_timeline_enable_update (GESTimeline * timeline, gboolean enabled)
|
ges_timeline_enable_update (GESTimeline * timeline, gboolean enabled)
|
||||||
|
|
|
@ -483,6 +483,15 @@ ges_track_add_object (GESTrack * track, GESTrackObject * object)
|
||||||
return TRUE;
|
return TRUE;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ges_track_get_objects:
|
||||||
|
* @track: a #GESTrack
|
||||||
|
*
|
||||||
|
* Gets the #GESTrackObject contained in @track
|
||||||
|
*
|
||||||
|
* Returns: (transfer full) (element-type GESTrackObject): the list of
|
||||||
|
* #GESTrackObject present in the Track sorted by priority and start.
|
||||||
|
*/
|
||||||
GList *
|
GList *
|
||||||
ges_track_get_objects (GESTrack * track)
|
ges_track_get_objects (GESTrack * track)
|
||||||
{
|
{
|
||||||
|
@ -652,12 +661,12 @@ ges_track_get_timeline (GESTrack * track)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ges_track_enable_update:
|
* ges_track_enable_update:
|
||||||
* @track : a #GESTrack
|
* @track: a #GESTrack
|
||||||
* @enabled : TRUE if the composition must be updated, FALSE otherwise.
|
* @enabled: %TRUE if the composition must be updated, FALSE otherwise.
|
||||||
*
|
*
|
||||||
* Sets the @track 's composition update property to @enabled .
|
* Sets the @track 's composition update property to @enabled .
|
||||||
*
|
*
|
||||||
* Returns : True if success, FALSE otherwise.
|
* Returns: True if success, %FALSE otherwise.
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
ges_track_enable_update (GESTrack * track, gboolean enabled)
|
ges_track_enable_update (GESTrack * track, gboolean enabled)
|
||||||
|
|
Loading…
Reference in a new issue