mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-22 05:56:31 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Update documentation

Browse source
This commit is contained in:
Thibault Saunier 2011-12-06 23:11:25 -03:00
parent 97846d698c
commit 5d35024cd3
7 changed files with 30 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/libs/ges-sections.txt
View file

@ -51,6 +51,8 @@ ges_track_add_object
ges_track_remove_object
ges_track_set_caps
ges_track_get_caps
ges_track_enable_update
ges_track_get_objects
<SUBSECTION Standard>
GESTrackClass
GESTrackPrivate
@ -242,6 +244,7 @@ ges_timeline_add_track
ges_timeline_remove_track
ges_timeline_load_from_uri
ges_timeline_save_to_uri
ges_timeline_enable_update
<SUBSECTION usage>
ges_timeline_get_tracks
ges_timeline_get_layers
@ -270,6 +273,8 @@ ges_timeline_layer_remove_object
ges_timeline_layer_set_priority
ges_timeline_layer_get_priority
ges_timeline_layer_get_objects
ges_timeline_layer_get_auto_transition
ges_timeline_layer_set_auto_transition
<SUBSECTION Standard>
GESTimelineLayerPrivate
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_supported_formats
ges_timeline_object_get_supported_formats
ges_timeline_object_split
<SUBSECTION Standard>
GES_TIMELINE_OBJECT_DURATION
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_rgb24
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>
GESTimelinePipelineClass
GESTimelinePipelinePrivate

2
ges/ges-formatter.c
View file

@ -237,7 +237,7 @@ ges_formatter_set_data (GESFormatter * formatter, void *data, gsize length)
*
* Lets you get the data @formatter used for loading.
*
* Returns: a pointer to the data.
* Returns: (transfer none): a pointer to the data.
*/
void *
ges_formatter_get_data (GESFormatter * formatter, gsize * length)

4
ges/ges-timeline-layer.c
View file

@ -765,10 +765,10 @@ ges_timeline_layer_get_auto_transition (GESTimelineLayer * layer)
/**
* ges_timeline_layer_set_auto_transition:
* @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
* priority auto_transition for more information.
* property auto_transition for more information.
*/
void
ges_timeline_layer_set_auto_transition (GESTimelineLayer * layer,

2
ges/ges-timeline-object.c
View file

@ -361,7 +361,7 @@ ges_timeline_object_class_init (GESTimelineObjectClass * klass)
* @object: the #GESTimelineObject
* @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
*/

2
ges/ges-timeline-object.h
View file

@ -291,7 +291,7 @@ ges_timeline_object_set_supported_formats (GESTimelineObject * self,
GESTrackType supportedformats);
GESTimelineObject *
ges_timeline_object_split(GESTimelineObject * ref_object, gint64 position);
ges_timeline_object_split(GESTimelineObject * self, gint64 position);
G_END_DECLS

6
ges/ges-timeline.c
View file

@ -1110,12 +1110,12 @@ ges_timeline_get_layers (GESTimeline * timeline)
/**
* ges_timeline_enable_update:
* @timeline : a #GESTimeline
* @enabled : TRUE if the timeline must be updated, FALSE otherwise.
* @timeline: a #GESTimeline
* @enabled: TRUE if the timeline must be updated, FALSE otherwise.
*
* 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
ges_timeline_enable_update (GESTimeline * timeline, gboolean enabled)

15
ges/ges-track.c
View file

@ -483,6 +483,15 @@ ges_track_add_object (GESTrack * track, GESTrackObject * object)
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 *
ges_track_get_objects (GESTrack * track)
{
@ -652,12 +661,12 @@ ges_track_get_timeline (GESTrack * track)
/**
* ges_track_enable_update:
* @track : a #GESTrack
* @enabled : TRUE if the composition must be updated, FALSE otherwise.
* @track: a #GESTrack
* @enabled: %TRUE if the composition must be updated, FALSE otherwise.
*
* Sets the @track 's composition update property to @enabled .
*
* Returns : True if success, FALSE otherwise.
* Returns: True if success, %FALSE otherwise.
*/
gboolean
ges_track_enable_update (GESTrack * track, gboolean enabled)