docs: A round of updates

This commit is contained in:
Edward Hervey 2010-12-08 15:36:55 +01:00
parent bac19fd829
commit faec1e803d
29 changed files with 87 additions and 153 deletions

View file

@ -4,6 +4,8 @@
<FILE>ges-common</FILE> <FILE>ges-common</FILE>
<TITLE>Initialization</TITLE> <TITLE>Initialization</TITLE>
ges_init ges_init
<SUBSECTION Standard>
GES_PADDING
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -39,7 +41,6 @@ ges_video_transition_type_get_type
<FILE>ges-track</FILE> <FILE>ges-track</FILE>
<TITLE>GESTrack</TITLE> <TITLE>GESTrack</TITLE>
GESTrack GESTrack
GESTrackClass
ges_track_audio_raw_new ges_track_audio_raw_new
ges_track_video_raw_new ges_track_video_raw_new
ges_track_new ges_track_new
@ -47,6 +48,7 @@ ges_track_add_object
ges_track_remove_object ges_track_remove_object
ges_track_set_caps ges_track_set_caps
<SUBSECTION Standard> <SUBSECTION Standard>
GESTrackClass
GESTrackPrivate GESTrackPrivate
ges_track_set_timeline ges_track_set_timeline
ges_track_get_type ges_track_get_type
@ -125,9 +127,9 @@ GES_TYPE_TRACK_OPERATION
<FILE>ges-track-filesource</FILE> <FILE>ges-track-filesource</FILE>
<TITLE>GESTrackFileSource</TITLE> <TITLE>GESTrackFileSource</TITLE>
GESTrackFileSource GESTrackFileSource
GESTrackFileSourceClass
ges_track_filesource_new ges_track_filesource_new
<SUBSECTION Standard> <SUBSECTION Standard>
GESTrackFileSourceClass
GESTrackFileSourcePrivate GESTrackFileSourcePrivate
GES_TRACK_FILESOURCE GES_TRACK_FILESOURCE
GES_TRACK_FILESOURCE_CLASS GES_TRACK_FILESOURCE_CLASS
@ -142,7 +144,7 @@ ges_track_filesource_get_type
<FILE>ges-track-image-source</FILE> <FILE>ges-track-image-source</FILE>
<TITLE>GESTrackImageSource</TITLE> <TITLE>GESTrackImageSource</TITLE>
GESTrackImageSource GESTrackImageSource
GESTrackImageSourceClass ges_track_image_source_new
<SUBSECTION Standard> <SUBSECTION Standard>
GESTrackImageSourcePrivate GESTrackImageSourcePrivate
GES_IS_TRACK_IMAGE_SOURCE GES_IS_TRACK_IMAGE_SOURCE
@ -151,8 +153,8 @@ GES_TRACK_IMAGE_SOURCE
GES_TRACK_IMAGE_SOURCE_CLASS GES_TRACK_IMAGE_SOURCE_CLASS
GES_TRACK_IMAGE_SOURCE_GET_CLASS GES_TRACK_IMAGE_SOURCE_GET_CLASS
GES_TYPE_TRACK_IMAGE_SOURCE GES_TYPE_TRACK_IMAGE_SOURCE
GESTrackImageSourceClass
ges_track_image_source_get_type ges_track_image_source_get_type
ges_track_image_source_new
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -175,9 +177,9 @@ ges_track_transition_get_type
<FILE>ges-track-audio-transition</FILE> <FILE>ges-track-audio-transition</FILE>
<TITLE>GESTrackAudioTransition</TITLE> <TITLE>GESTrackAudioTransition</TITLE>
GESTrackAudioTransition GESTrackAudioTransition
GESTrackAudioTransitionClass
ges_track_audio_transition_new ges_track_audio_transition_new
<SUBSECTION Standard> <SUBSECTION Standard>
GESTrackAudioTransitionClass
GESTrackAudioTransitionPrivate GESTrackAudioTransitionPrivate
GES_IS_TRACK_AUDIO_TRANSITION GES_IS_TRACK_AUDIO_TRANSITION
ges_track_audio_transition_get_type ges_track_audio_transition_get_type
@ -192,10 +194,10 @@ GES_TYPE_TRACK_AUDIO_TRANSITION
<FILE>ges-track-video-transition</FILE> <FILE>ges-track-video-transition</FILE>
<TITLE>GESTrackVideoTransition</TITLE> <TITLE>GESTrackVideoTransition</TITLE>
GESTrackVideoTransition GESTrackVideoTransition
GESTrackVideoTransitionClass
ges_track_video_transition_new ges_track_video_transition_new
ges_track_video_transition_set_type ges_track_video_transition_set_type
<SUBSECTION Standard> <SUBSECTION Standard>
GESTrackVideoTransitionClass
GESTrackVideoTransitionPrivate GESTrackVideoTransitionPrivate
ges_track_video_transition_get_type ges_track_video_transition_get_type
GES_IS_TRACK_VIDEO_TRANSITION GES_IS_TRACK_VIDEO_TRANSITION
@ -210,7 +212,6 @@ GES_TYPE_TRACK_VIDEO_TRANSITION
<FILE>ges-timeline</FILE> <FILE>ges-timeline</FILE>
<TITLE>GESTimeline</TITLE> <TITLE>GESTimeline</TITLE>
GESTimeline GESTimeline
GESTimelineClass
ges_timeline_new ges_timeline_new
ges_timeline_new_audio_video ges_timeline_new_audio_video
ges_timeline_new_from_uri ges_timeline_new_from_uri
@ -218,11 +219,13 @@ ges_timeline_add_layer
ges_timeline_remove_layer ges_timeline_remove_layer
ges_timeline_add_track ges_timeline_add_track
ges_timeline_remove_track ges_timeline_remove_track
ges_timeline_get_track_for_pad
ges_timeline_load_from_uri ges_timeline_load_from_uri
ges_timeline_save_to_uri ges_timeline_save_to_uri
<SUBSECTION usage>
ges_timeline_get_tracks ges_timeline_get_tracks
ges_timeline_get_track_for_pad
<SUBSECTION Standard> <SUBSECTION Standard>
GESTimelineClass
ges_timeline_get_type ges_timeline_get_type
GES_IS_TIMELINE GES_IS_TIMELINE
GES_IS_TIMELINE_CLASS GES_IS_TIMELINE_CLASS
@ -283,6 +286,7 @@ ges_timeline_object_release_track_object
ges_timeline_object_get_track_objects ges_timeline_object_get_track_objects
ges_timeline_object_set_layer ges_timeline_object_set_layer
ges_timeline_object_set_priority ges_timeline_object_set_priority
GESTimelineObjectPrivate
GES_IS_TIMELINE_OBJECT GES_IS_TIMELINE_OBJECT
GES_IS_TIMELINE_OBJECT_CLASS GES_IS_TIMELINE_OBJECT_CLASS
GES_TIMELINE_OBJECT GES_TIMELINE_OBJECT
@ -297,7 +301,6 @@ ges_timeline_object_get_type
<FILE>ges-timeline-pipeline</FILE> <FILE>ges-timeline-pipeline</FILE>
<TITLE>GESTimelinePipeline</TITLE> <TITLE>GESTimelinePipeline</TITLE>
GESTimelinePipeline GESTimelinePipeline
GESTimelinePipelineClass
GESPipelineFlags GESPipelineFlags
ges_timeline_pipeline_new ges_timeline_pipeline_new
ges_timeline_pipeline_add_timeline ges_timeline_pipeline_add_timeline
@ -307,6 +310,8 @@ 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
<SUBSECTION Standard> <SUBSECTION Standard>
GESTimelinePipelineClass
GESTimelinePipelinePrivate
ges_play_sink_convert_frame ges_play_sink_convert_frame
ges_timeline_pipeline_get_type ges_timeline_pipeline_get_type
GES_TIMELINE_PIPELINE GES_TIMELINE_PIPELINE
@ -339,9 +344,9 @@ GES_TYPE_TIMELINE_SOURCE
<FILE>ges-timeline-filesource</FILE> <FILE>ges-timeline-filesource</FILE>
<TITLE>GESTimelineFileSource</TITLE> <TITLE>GESTimelineFileSource</TITLE>
GESTimelineFileSource GESTimelineFileSource
GESTimelineFileSourceClass
ges_timeline_filesource_new ges_timeline_filesource_new
<SUBSECTION Standard> <SUBSECTION Standard>
GESTimelineFileSourceClass
ges_tl_filesource_get_type ges_tl_filesource_get_type
GES_IS_TIMELINE_FILE_SOURCE GES_IS_TIMELINE_FILE_SOURCE
GES_IS_TIMELINE_FILE_SOURCE_CLASS GES_IS_TIMELINE_FILE_SOURCE_CLASS
@ -390,10 +395,10 @@ ges_timeline_transition_get_type
<FILE>ges-custom-timeline-source</FILE> <FILE>ges-custom-timeline-source</FILE>
<TITLE>GESCustomTimelineSource</TITLE> <TITLE>GESCustomTimelineSource</TITLE>
GESCustomTimelineSource GESCustomTimelineSource
GESCustomTimelineSourceClass
FillTrackObjectUserFunc FillTrackObjectUserFunc
ges_custom_timeline_source_new ges_custom_timeline_source_new
<SUBSECTION Standard> <SUBSECTION Standard>
GESCustomTimelineSourceClass
ges_cust_timeline_src_get_type ges_cust_timeline_src_get_type
GESCustomTimelineSourcePrivate GESCustomTimelineSourcePrivate
GES_CUSTOM_TIMELINE_SOURCE GES_CUSTOM_TIMELINE_SOURCE
@ -408,12 +413,12 @@ GES_TYPE_CUSTOM_TIMELINE_SOURCE
<FILE>ges-simple-timeline-layer</FILE> <FILE>ges-simple-timeline-layer</FILE>
<TITLE>GESSimpleTimelineLayer</TITLE> <TITLE>GESSimpleTimelineLayer</TITLE>
GESSimpleTimelineLayer GESSimpleTimelineLayer
GESSimpleTimelineLayerClass
ges_simple_timeline_layer_new ges_simple_timeline_layer_new
ges_simple_timeline_layer_add_object ges_simple_timeline_layer_add_object
ges_simple_timeline_layer_move_object ges_simple_timeline_layer_move_object
ges_simple_timeline_layer_is_valid ges_simple_timeline_layer_is_valid
<SUBSECTION Standard> <SUBSECTION Standard>
GESSimpleTimelineLayerClass
ges_simple_timeline_layer_get_type ges_simple_timeline_layer_get_type
GESSimpleTimelineLayerPrivate GESSimpleTimelineLayerPrivate
GES_IS_SIMPLE_TIMELINE_LAYER GES_IS_SIMPLE_TIMELINE_LAYER
@ -446,9 +451,9 @@ GES_TIMELINE_TEST_SOURCE_GET_CLASS
<FILE>ges-timeline-title-source</FILE> <FILE>ges-timeline-title-source</FILE>
<TITLE>GESTimelineTitleSource</TITLE> <TITLE>GESTimelineTitleSource</TITLE>
GESTimelineTitleSource GESTimelineTitleSource
GESTimelineTitleSourceClass
ges_timeline_title_source_new ges_timeline_title_source_new
<SUBSECTION Standard> <SUBSECTION Standard>
GESTimelineTitleSourceClass
GESTimelineTitleSourcePrivate GESTimelineTitleSourcePrivate
ges_tl_title_src_get_type ges_tl_title_src_get_type
GES_IS_TIMELINE_TITLE_SOURCE GES_IS_TIMELINE_TITLE_SOURCE
@ -462,9 +467,9 @@ GES_TIMELINE_TITLE_SOURCE_GET_CLASS
<FILE>ges-timeline-text-overlay</FILE> <FILE>ges-timeline-text-overlay</FILE>
<TITLE>GESTimelineTextOverlay</TITLE> <TITLE>GESTimelineTextOverlay</TITLE>
GESTimelineTextOverlay GESTimelineTextOverlay
GESTimelineTextOverlayClass
ges_timeline_text_overlay_new ges_timeline_text_overlay_new
<SUBSECTION Standard> <SUBSECTION Standard>
GESTimelineTextOverlayClass
GESTimelineTextOverlayPrivate GESTimelineTextOverlayPrivate
ges_tl_text_overlay_get_type ges_tl_text_overlay_get_type
GES_IS_TIMELINE_TEXT_OVERLAY GES_IS_TIMELINE_TEXT_OVERLAY
@ -479,10 +484,10 @@ GES_TYPE_TIMELINE_TEXT_OVERLAY
<FILE>ges-track-video-test-source</FILE> <FILE>ges-track-video-test-source</FILE>
<TITLE>GESTrackVideoTestSource</TITLE> <TITLE>GESTrackVideoTestSource</TITLE>
GESTrackVideoTestSource GESTrackVideoTestSource
GESTrackVideoTestSourceClass
ges_track_video_test_source_new ges_track_video_test_source_new
ges_track_video_test_source_set_pattern ges_track_video_test_source_set_pattern
<SUBSECTION Standard> <SUBSECTION Standard>
GESTrackVideoTestSourceClass
GESTrackVideoTestSourcePrivate GESTrackVideoTestSourcePrivate
ges_track_video_test_source_get_type ges_track_video_test_source_get_type
GES_IS_TRACK_VIDEO_TEST_SOURCE GES_IS_TRACK_VIDEO_TEST_SOURCE
@ -497,11 +502,11 @@ GES_TYPE_TRACK_VIDEO_TEST_SOURCE
<FILE>ges-track-audio-test-source</FILE> <FILE>ges-track-audio-test-source</FILE>
<TITLE>GESTrackAudioTestSource</TITLE> <TITLE>GESTrackAudioTestSource</TITLE>
GESTrackAudioTestSource GESTrackAudioTestSource
GESTrackAudioTestSourceClass
ges_track_audio_test_source_new ges_track_audio_test_source_new
ges_track_audio_test_source_set_freq ges_track_audio_test_source_set_freq
ges_track_audio_test_source_set_volume ges_track_audio_test_source_set_volume
<SUBSECTION Standard> <SUBSECTION Standard>
GESTrackAudioTestSourceClass
GESTrackAudioTestSourcePrivate GESTrackAudioTestSourcePrivate
ges_track_audio_test_source_get_type ges_track_audio_test_source_get_type
GES_TRACK_AUDIO_TEST_SOURCE GES_TRACK_AUDIO_TEST_SOURCE
@ -516,14 +521,13 @@ GES_IS_TRACK_AUDIO_TEST_SOURCE_CLASS
<FILE>ges-track-title-source</FILE> <FILE>ges-track-title-source</FILE>
<TITLE>GESTrackTitleSource</TITLE> <TITLE>GESTrackTitleSource</TITLE>
GESTrackTitleSource GESTrackTitleSource
GESTrackTitleSourceClass
ges_tl_title_src_get_type
ges_track_title_source_set_text ges_track_title_source_set_text
ges_track_title_source_set_font_desc ges_track_title_source_set_font_desc
ges_track_title_source_set_halignment ges_track_title_source_set_halignment
ges_track_title_source_set_valignment ges_track_title_source_set_valignment
ges_track_title_source_new ges_track_title_source_new
<SUBSECTION Standard> <SUBSECTION Standard>
GESTrackTitleSourceClass
GESTrackTitleSourcePrivate GESTrackTitleSourcePrivate
ges_track_title_src_get_type ges_track_title_src_get_type
GES_TRACK_TITLE_SOURCE GES_TRACK_TITLE_SOURCE
@ -539,13 +543,13 @@ GES_IS_TRACK_TITLE_SOURCE_CLASS
<FILE>ges-track-text-overlay</FILE> <FILE>ges-track-text-overlay</FILE>
<TITLE>GESTrackTextOverlay</TITLE> <TITLE>GESTrackTextOverlay</TITLE>
GESTrackTextOverlay GESTrackTextOverlay
GESTrackTextOverlayClass
ges_track_text_overlay_new ges_track_text_overlay_new
ges_track_text_overlay_set_font_desc ges_track_text_overlay_set_font_desc
ges_track_text_overlay_set_halignment ges_track_text_overlay_set_halignment
ges_track_text_overlay_set_text ges_track_text_overlay_set_text
ges_track_text_overlay_set_valignment ges_track_text_overlay_set_valignment
<SUBSECTION Standard> <SUBSECTION Standard>
GESTrackTextOverlayClass
GESTrackTextOverlayPrivate GESTrackTextOverlayPrivate
ges_track_text_overlay_get_type ges_track_text_overlay_get_type
GES_IS_TRACK_TEXT_OVERLAY GES_IS_TRACK_TEXT_OVERLAY
@ -593,9 +597,9 @@ GESFormatterSaveMethod
<FILE>ges-keyfile-formatter</FILE> <FILE>ges-keyfile-formatter</FILE>
<TITLE>GESKeyFileFormatter</TITLE> <TITLE>GESKeyFileFormatter</TITLE>
GESKeyfileFormatter GESKeyfileFormatter
GESKeyfileFormatterClass
ges_keyfile_formatter_new ges_keyfile_formatter_new
<SUBSECTION Standard> <SUBSECTION Standard>
GESKeyfileFormatterClass
GES_IS_KEYFILE_FORMATTER GES_IS_KEYFILE_FORMATTER
GES_IS_KEYFILE_FORMATTER_CLASS GES_IS_KEYFILE_FORMATTER_CLASS
GES_KEYFILE_FORMATTER GES_KEYFILE_FORMATTER

View file

@ -69,6 +69,7 @@ typedef gboolean (*FillTrackObjectUserFunc) (GESTimelineObject * object,
/** /**
* GESCustomTimelineSource: * GESCustomTimelineSource:
* *
* Debugging custom timeline source
*/ */
struct _GESCustomTimelineSource { struct _GESCustomTimelineSource {
@ -83,8 +84,6 @@ struct _GESCustomTimelineSource {
/** /**
* GESCustomTimelineSourceClass: * GESCustomTimelineSourceClass:
* @parent_class: parent class
*
*/ */
struct _GESCustomTimelineSourceClass { struct _GESCustomTimelineSourceClass {

View file

@ -107,7 +107,7 @@ ges_formatter_new_for_uri (gchar * uri)
* ges_default_formatter_new: * ges_default_formatter_new:
* *
* Creates a new instance of the default GESFormatter type on this system * Creates a new instance of the default GESFormatter type on this system
* (currently #GESKeyFileFormatter). * (currently #GESKeyfileFormatter).
* *
* Returns: a #GESFormatter instance or NULL * Returns: a #GESFormatter instance or NULL
*/ */

View file

@ -48,22 +48,17 @@
*/ */
struct _GESKeyfileFormatter { struct _GESKeyfileFormatter {
/*< private >*/
GESFormatter parent; GESFormatter parent;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };
/**
* GESKeyfileFormatterClass:
* @parent_class: parent class
*/
struct _GESKeyfileFormatterClass { struct _GESKeyfileFormatterClass {
/*< private >*/
GESFormatterClass parent_class; GESFormatterClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -441,13 +441,13 @@ ges_simple_timeline_layer_new (void)
/** /**
* ges_simple_timeline_layer_is_valid: * ges_simple_timeline_layer_is_valid:
* @layer: a #GESSimpleTimelineLayer
* *
* FALSE when the arrangement of objects in the layer would cause errors or * Checks whether the arrangement of objects in the layer would cause errors
* unexpected output during playback. Do not set the containing pipeline * or unexpected output during playback. Do not set the containing pipeline
* state to PLAYING when this property is FALSE. * state to PLAYING when this property is FALSE.
* *
* Returns: #True if current arrangement of the layer is valid, #False * Returns: #TRUE if current arrangement of the layer is valid else #FALSE.
* otherwise
*/ */
gboolean gboolean
ges_simple_timeline_layer_is_valid (GESSimpleTimelineLayer * layer) ges_simple_timeline_layer_is_valid (GESSimpleTimelineLayer * layer)

View file

@ -48,32 +48,25 @@ typedef struct _GESSimpleTimelineLayerPrivate GESSimpleTimelineLayerPrivate;
/** /**
* GESSimpleTimelineLayer: * GESSimpleTimelineLayer:
*
*/ */
struct _GESSimpleTimelineLayer { struct _GESSimpleTimelineLayer {
/*< private >*/
GESTimelineLayer parent; GESTimelineLayer parent;
/*< private >*/
GESSimpleTimelineLayerPrivate *priv; GESSimpleTimelineLayerPrivate *priv;
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };
/**
* GESSimpleTimelineLayerClass:
* @parent_class: parent class
*
*/
struct _GESSimpleTimelineLayerClass { struct _GESSimpleTimelineLayerClass {
/*< private >*/
GESTimelineLayerClass parent_class; GESTimelineLayerClass parent_class;
/*< signals >*/
/*< signals >*/
void (*object_moved) (GESTimelineLayer * layer, GESTimelineObject * object, void (*object_moved) (GESTimelineLayer * layer, GESTimelineObject * object,
gint old_position, gint new_position); gint old_position, gint new_position);
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];

View file

@ -51,9 +51,9 @@ G_BEGIN_DECLS
*/ */
struct _GESTimelineFileSource { struct _GESTimelineFileSource {
/*< private >*/
GESTimelineSource parent; GESTimelineSource parent;
/*< private >*/
gchar *uri; gchar *uri;
gboolean mute; gboolean mute;
@ -71,13 +71,11 @@ struct _GESTimelineFileSource {
/** /**
* GESTimelineFileSourceClass: * GESTimelineFileSourceClass:
* @parent_class: parent class
*/ */
struct _GESTimelineFileSourceClass { struct _GESTimelineFileSourceClass {
GESTimelineSourceClass parent_class;
/*< private >*/ /*< private >*/
GESTimelineSourceClass parent_class;
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];

View file

@ -73,13 +73,13 @@ struct _GESTimelineLayer {
/** /**
* GESTimelineLayerClass: * GESTimelineLayerClass:
* @parent_class: layer parent class
* @get_objects: method to get the objects contained in the layer * @get_objects: method to get the objects contained in the layer
* *
* Subclasses can override the @get_objects if they can provide a more * Subclasses can override the @get_objects if they can provide a more
* efficient way of providing the list of contained #GESTimelineObject(s). * efficient way of providing the list of contained #GESTimelineObject(s).
*/ */
struct _GESTimelineLayerClass { struct _GESTimelineLayerClass {
/*< private >*/
GObjectClass parent_class; GObjectClass parent_class;
/*< public >*/ /*< public >*/

View file

@ -139,15 +139,12 @@ typedef gboolean (*CreateTrackObjectsFunc) (GESTimelineObject * object,
/** /**
* GESTimelineObject: * GESTimelineObject:
* @layer: the #GESTimelineLayer where this object is being used.
* *
* The GESTimelineObject subclass. Subclasses can access these fields. * The GESTimelineObject subclass. Subclasses can access these fields.
*/ */
struct _GESTimelineObject { struct _GESTimelineObject {
GObject parent;
/*< private >*/ /*< private >*/
GObject parent;
GESTimelineObjectPrivate *priv; GESTimelineObjectPrivate *priv;
@ -167,7 +164,6 @@ struct _GESTimelineObject {
/** /**
* GESTimelineObjectClass: * GESTimelineObjectClass:
* @parent_class: object parent class
* @create_track_object: method to create a single #GESTrackObject for a given #GESTrack. * @create_track_object: method to create a single #GESTrackObject for a given #GESTrack.
* @create_track_objects: method to crate multiple #GESTrackObjects for a * @create_track_objects: method to crate multiple #GESTrackObjects for a
* #GESTrack. * #GESTrack.
@ -177,6 +173,7 @@ struct _GESTimelineObject {
* Subclasses can override the @create_track_object and @fill_track_object methods. * Subclasses can override the @create_track_object and @fill_track_object methods.
*/ */
struct _GESTimelineObjectClass { struct _GESTimelineObjectClass {
/*< private >*/
GObjectClass parent_class; GObjectClass parent_class;
/*< public >*/ /*< public >*/

View file

@ -51,10 +51,10 @@ typedef struct _GESTimelineOverlayPrivate GESTimelineOverlayPrivate;
*/ */
struct _GESTimelineOverlay { struct _GESTimelineOverlay {
GESTimelineObject parent;
/*< private >*/ /*< private >*/
GESTimelineObject parent;
GESTimelineOverlayPrivate *priv; GESTimelineOverlayPrivate *priv;
/* Padding for API extension */ /* Padding for API extension */

View file

@ -596,7 +596,7 @@ ges_timeline_pipeline_add_timeline (GESTimelinePipeline * pipeline,
/** /**
* ges_timeline_pipeline_set_render_settings: * ges_timeline_pipeline_set_render_settings:
* @pipeline: a #GESTimelinePipeline * @pipeline: a #GESTimelinePipeline
* @output_uri: the %URI to which the timeline will be rendered * @output_uri: the URI to which the timeline will be rendered
* @profile: the #GstEncodingProfile to use to render the timeline. * @profile: the #GstEncodingProfile to use to render the timeline.
* *
* Specify where the pipeline shall be rendered and with what settings. * Specify where the pipeline shall be rendered and with what settings.

View file

@ -70,9 +70,9 @@ typedef enum {
*/ */
struct _GESTimelinePipeline { struct _GESTimelinePipeline {
/*< private >*/
GstPipeline parent; GstPipeline parent;
/* <private> */
GESTimelinePipelinePrivate *priv; GESTimelinePipelinePrivate *priv;
/* Padding for API extension */ /* Padding for API extension */
@ -86,9 +86,9 @@ struct _GESTimelinePipeline {
*/ */
struct _GESTimelinePipelineClass { struct _GESTimelinePipelineClass {
/*< private >*/
GstPipelineClass parent_class; GstPipelineClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -50,6 +50,7 @@ typedef struct _GESTimelineSourcePrivate GESTimelineSourcePrivate;
/** /**
* GESTimelineSource: * GESTimelineSource:
* *
* Base class for sources of a #GESTimelineLayer
*/ */
struct _GESTimelineSource { struct _GESTimelineSource {
@ -69,13 +70,12 @@ struct _GESTimelineSource {
/** /**
* GESTimelineSourceClass: * GESTimelineSourceClass:
* @parent_class: parent class
*/ */
struct _GESTimelineSourceClass { struct _GESTimelineSourceClass {
/*< private >*/
GESTimelineObjectClass parent_class; GESTimelineObjectClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -54,9 +54,9 @@ typedef struct _GESTimelineTestSourcePrivate GESTimelineTestSourcePrivate;
*/ */
struct _GESTimelineTestSource { struct _GESTimelineTestSource {
/*< private >*/
GESTimelineSource parent; GESTimelineSource parent;
/*< private >*/
gboolean mute; gboolean mute;
GESVideoTestPattern vpattern; GESVideoTestPattern vpattern;
gdouble freq; gdouble freq;
@ -70,13 +70,12 @@ struct _GESTimelineTestSource {
/** /**
* GESTimelineTestSourceClass: * GESTimelineTestSourceClass:
* @parent_class: parent class
*/ */
struct _GESTimelineTestSourceClass { struct _GESTimelineTestSourceClass {
/*< private >*/
GESTimelineSourceClass parent_class; GESTimelineSourceClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -53,9 +53,9 @@ typedef struct _GESTimelineTextOverlayPrivate GESTimelineTextOverlayPrivate;
*/ */
struct _GESTimelineTextOverlay { struct _GESTimelineTextOverlay {
/*< private >*/
GESTimelineOverlay parent; GESTimelineOverlay parent;
/*< private >*/
gboolean mute; gboolean mute;
gchar *text; gchar *text;
gchar *font_desc; gchar *font_desc;
@ -70,13 +70,12 @@ struct _GESTimelineTextOverlay {
/** /**
* GESTimelineTextOverlayClass: * GESTimelineTextOverlayClass:
* @parent_class: parent class
*/ */
struct _GESTimelineTextOverlayClass { struct _GESTimelineTextOverlayClass {
GESTimelineOverlayClass parent_class; /*< private >*/
/*< public >*/ GESTimelineOverlayClass parent_class;
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];

View file

@ -49,13 +49,14 @@ typedef struct _GESTimelineTitleSourcePrivate GESTimelineTitleSourcePrivate;
/** /**
* GESTimelineTitleSource: * GESTimelineTitleSource:
* *
* Render stand-alone titles in GESTimelineLayer.
*/ */
struct _GESTimelineTitleSource { struct _GESTimelineTitleSource {
/*< private >*/
GESTimelineSource parent; GESTimelineSource parent;
/*< private >*/
gboolean mute; gboolean mute;
gchar *text; gchar *text;
gchar *font_desc; gchar *font_desc;
@ -68,15 +69,10 @@ struct _GESTimelineTitleSource {
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };
/**
* GESTimelineTitleSourceClass:
* @parent_class: parent class
*/
struct _GESTimelineTitleSourceClass { struct _GESTimelineTitleSourceClass {
/*< private >*/
GESTimelineSourceClass parent_class; GESTimelineSourceClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -49,9 +49,9 @@ typedef struct _GESTimelineTransitionPrivate GESTimelineTransitionPrivate;
* GESTimelineTransition: * GESTimelineTransition:
* @vtype: a #GESVideoTransitionType indicating the type of video transition * @vtype: a #GESVideoTransitionType indicating the type of video transition
* to apply. * to apply.
*
*/ */
struct _GESTimelineTransition { struct _GESTimelineTransition {
/*< private >*/
GESTimelineObject parent; GESTimelineObject parent;
/*< public >*/ /*< public >*/
@ -66,14 +66,13 @@ struct _GESTimelineTransition {
/** /**
* GESTimelineTransitionClass: * GESTimelineTransitionClass:
* @parent_class: parent class
* *
*/ */
struct _GESTimelineTransitionClass { struct _GESTimelineTransitionClass {
/*< private >*/
GESTimelineObjectClass parent_class; GESTimelineObjectClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -920,7 +920,8 @@ ges_timeline_get_track_for_pad (GESTimeline * timeline, GstPad * pad)
* Returns the list of #GESTrack used by the Timeline. * Returns the list of #GESTrack used by the Timeline.
* *
* Returns: A list of #GESTrack. The caller should unref each track * Returns: A list of #GESTrack. The caller should unref each track
* once he is done with them. */ * once he is done with them.
*/
GList * GList *
ges_timeline_get_tracks (GESTimeline * timeline) ges_timeline_get_tracks (GESTimeline * timeline)
{ {

View file

@ -46,15 +46,16 @@ G_BEGIN_DECLS
typedef struct _GESTrackAudioTestSourcePrivate GESTrackAudioTestSourcePrivate; typedef struct _GESTrackAudioTestSourcePrivate GESTrackAudioTestSourcePrivate;
/**
/**
* GESTrackAudioTestSource: * GESTrackAudioTestSource:
* *
*/ */
struct _GESTrackAudioTestSource { struct _GESTrackAudioTestSource {
/*< private >*/
GESTrackSource parent; GESTrackSource parent;
/*< private >*/
gdouble freq; gdouble freq;
gdouble volume; gdouble volume;
@ -64,16 +65,10 @@ struct _GESTrackAudioTestSource {
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };
/**
* GESTrackAudioTestSourceClass:
* @parent_class: parent class
*
*/
struct _GESTrackAudioTestSourceClass { struct _GESTrackAudioTestSourceClass {
/*< private >*/
GESTrackSourceClass parent_class; GESTrackSourceClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -46,7 +46,7 @@ G_BEGIN_DECLS
typedef struct _GESTrackAudioTransitionPrivate GESTrackAudioTransitionPrivate; typedef struct _GESTrackAudioTransitionPrivate GESTrackAudioTransitionPrivate;
/** /**
* GESTrackAudioTransition: * GESTrackAudioTransition:
* *
*/ */
@ -69,16 +69,9 @@ struct _GESTrackAudioTransition {
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };
/**
* GESTrackAudioTransitionClass:
* @parent_class: parent class
*
*/
struct _GESTrackAudioTransitionClass { struct _GESTrackAudioTransitionClass {
GESTrackTransitionClass parent_class; GESTrackTransitionClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -46,33 +46,25 @@ G_BEGIN_DECLS
typedef struct _GESTrackFileSourcePrivate GESTrackFileSourcePrivate; typedef struct _GESTrackFileSourcePrivate GESTrackFileSourcePrivate;
/** /**
* GESTrackFileSource: * GESTrackFileSource:
* @uri: #gchar *, the URI of the media file to play
*
*/ */
struct _GESTrackFileSource { struct _GESTrackFileSource {
/*< private >*/
GESTrackSource parent; GESTrackSource parent;
/*< public >*/
gchar *uri; gchar *uri;
/*< private >*/
GESTrackFileSourcePrivate *priv; GESTrackFileSourcePrivate *priv;
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };
/**
* GESTrackFileSourceClass:
* @parent_class: parent class
*/
struct _GESTrackFileSourceClass { struct _GESTrackFileSourceClass {
/*< private >*/
GESTrackSourceClass parent_class; GESTrackSourceClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -46,15 +46,13 @@ G_BEGIN_DECLS
typedef struct _GESTrackImageSourcePrivate GESTrackImageSourcePrivate; typedef struct _GESTrackImageSourcePrivate GESTrackImageSourcePrivate;
/** /**
* GESTrackImageSource: * GESTrackImageSource:
* @uri: #gchar *, the URI of the media file to play
*
*/ */
struct _GESTrackImageSource { struct _GESTrackImageSource {
/*< private >*/
GESTrackSource parent; GESTrackSource parent;
/*< public >*/
gchar *uri; gchar *uri;
GESTrackImageSourcePrivate *priv; GESTrackImageSourcePrivate *priv;
@ -63,16 +61,9 @@ struct _GESTrackImageSource {
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };
/**
* GESTrackImageSourceClass:
* @parent_class: parent class
*/
struct _GESTrackImageSourceClass { struct _GESTrackImageSourceClass {
GESTrackSourceClass parent_class; GESTrackSourceClass parent_class;
/* <public> */
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -132,7 +132,6 @@ struct _GESTrackObject {
guint32 pending_gnl_priority; guint32 pending_gnl_priority;
gboolean pending_active; gboolean pending_active;
GstElement *gnlobject; GstElement *gnlobject;
GESTrackObjectPrivate *priv; GESTrackObjectPrivate *priv;
@ -143,7 +142,6 @@ struct _GESTrackObject {
/** /**
* GESTrackObjectClass: * GESTrackObjectClass:
* @parent_class: parent class
* @create_gnl_object: method to create the GNonLin container object. * @create_gnl_object: method to create the GNonLin container object.
* @start_changed: start property of gnlobject has changed * @start_changed: start property of gnlobject has changed
* @media_start_changed: media-start property of gnlobject has changed * @media_start_changed: media-start property of gnlobject has changed
@ -155,6 +153,7 @@ struct _GESTrackObject {
* of GNonLin object will be created. * of GNonLin object will be created.
*/ */
struct _GESTrackObjectClass { struct _GESTrackObjectClass {
/*< private >*/
GObjectClass parent_class; GObjectClass parent_class;
/*< public >*/ /*< public >*/

View file

@ -49,16 +49,14 @@ typedef struct _GESTrackOperationPrivate GESTrackOperationPrivate;
/** /**
* GESTrackOperation: * GESTrackOperation:
* @parent: parent
* *
* Base class for overlays, transitions, and effects * Base class for overlays, transitions, and effects
*
*/ */
struct _GESTrackOperation { struct _GESTrackOperation {
/*< private >*/
GESTrackObject parent; GESTrackObject parent;
/*< private >*/
GstElement *element; GstElement *element;
GESTrackOperationPrivate *priv; GESTrackOperationPrivate *priv;
@ -69,14 +67,15 @@ struct _GESTrackOperation {
/** /**
* GESTrackOperationClass: * GESTrackOperationClass:
* @parent_class: the parent class
* @create_element: virtual method which creates the GStreamer element for * @create_element: virtual method which creates the GStreamer element for
* this object * this object
*/ */
struct _GESTrackOperationClass { struct _GESTrackOperationClass {
/*< private >*/
GESTrackObjectClass parent_class; GESTrackObjectClass parent_class;
/*< public >*/
GstElement *(*create_element) (GESTrackOperation *); GstElement *(*create_element) (GESTrackOperation *);
/*< private >*/ /*< private >*/

View file

@ -49,16 +49,14 @@ typedef struct _GESTrackSourcePrivate GESTrackSourcePrivate;
/** /**
* GESTrackSource: * GESTrackSource:
* @parent: parent
* *
* Base class for single-media sources * Base class for single-media sources
*
*/ */
struct _GESTrackSource { struct _GESTrackSource {
/*< private >*/
GESTrackObject parent; GESTrackObject parent;
/*< private >*/
GstElement *element; GstElement *element;
GESTrackSourcePrivate *priv; GESTrackSourcePrivate *priv;
@ -69,15 +67,16 @@ struct _GESTrackSource {
/** /**
* GESTrackSourceClass: * GESTrackSourceClass:
* @parent_class: the parent class
* @create_element: virtual method which creates the GStreamer element for * @create_element: virtual method which creates the GStreamer element for
* this object * this object
* *
*/ */
struct _GESTrackSourceClass { struct _GESTrackSourceClass {
/*< private >*/
GESTrackObjectClass parent_class; GESTrackObjectClass parent_class;
/*< public >*/
GstElement *(*create_element) (GESTrackSource *); GstElement *(*create_element) (GESTrackSource *);
/*< private >*/ /*< private >*/

View file

@ -47,14 +47,13 @@ G_BEGIN_DECLS
typedef struct _GESTrackTextOverlayPrivate GESTrackTextOverlayPrivate; typedef struct _GESTrackTextOverlayPrivate GESTrackTextOverlayPrivate;
/** /**
* GESTrackTextOverlay: * GESTrackTextOverlay:
*
*/ */
struct _GESTrackTextOverlay { struct _GESTrackTextOverlay {
/*< private >*/
GESTrackOperation parent; GESTrackOperation parent;
/*< private >*/
gchar *text; gchar *text;
gchar *font_desc; gchar *font_desc;
GESTextHAlign halign; GESTextHAlign halign;
@ -67,11 +66,6 @@ struct _GESTrackTextOverlay {
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };
/**
* GESTrackTextOverlayClass:
* @parent_class: parent class
*/
struct _GESTrackTextOverlayClass { struct _GESTrackTextOverlayClass {
GESTrackOperationClass parent_class; GESTrackOperationClass parent_class;

View file

@ -55,16 +55,14 @@ typedef struct _GESTrackTransitionPrivate GESTrackTransitionPrivate;
/** /**
* GESTrackTransition: * GESTrackTransition:
* *
* Track level representation of a transition. Has a concrete implementation * Base class for media transitions.
* for both audio and video streams.
*
*/ */
struct _GESTrackTransition struct _GESTrackTransition
{ {
/*< private >*/
GESTrackObject parent; GESTrackObject parent;
/*< private >*/
GESTrackTransitionPrivate *priv; GESTrackTransitionPrivate *priv;
/* Padding for API extension */ /* Padding for API extension */
@ -72,11 +70,12 @@ struct _GESTrackTransition
}; };
/** /**
* GESTrackTransitionClass * GESTrackTransitionClass:
* @parent_class: parent class * @create_element: return the element that should be controlled by the transition
*/ */
struct _GESTrackTransitionClass { struct _GESTrackTransitionClass {
/*< private >*/
GESTrackObjectClass parent_class; GESTrackObjectClass parent_class;
/*< public >*/ /*< public >*/

View file

@ -47,13 +47,13 @@ G_BEGIN_DECLS
typedef struct _GESTrackVideoTestSourcePrivate GESTrackVideoTestSourcePrivate; typedef struct _GESTrackVideoTestSourcePrivate GESTrackVideoTestSourcePrivate;
/** /**
* GESTrackVideoTestSource: * GESTrackVideoTestSource:
*/ */
struct _GESTrackVideoTestSource { struct _GESTrackVideoTestSource {
/*< private >*/
GESTrackSource parent; GESTrackSource parent;
/*< private >*/
GESVideoTestPattern pattern; GESVideoTestPattern pattern;
GESTrackVideoTestSourcePrivate *priv; GESTrackVideoTestSourcePrivate *priv;
@ -62,15 +62,9 @@ struct _GESTrackVideoTestSource {
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };
/**
* GESTrackVideoTestSourceClass:
* @parent_class: parent class
*/
struct _GESTrackVideoTestSourceClass { struct _GESTrackVideoTestSourceClass {
GESTrackSourceClass parent_class; GESTrackSourceClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };

View file

@ -77,13 +77,12 @@ struct _GESTrack {
/** /**
* GESTrackClass: * GESTrackClass:
* @parent_class: parent class
*/ */
struct _GESTrackClass { struct _GESTrackClass {
/*< private >*/
GstBinClass parent_class; GstBinClass parent_class;
/*< private >*/
/* Padding for API extension */ /* Padding for API extension */
gpointer _ges_reserved[GES_PADDING]; gpointer _ges_reserved[GES_PADDING];
}; };