mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-30 13:41:48 +00:00
massive update to doc comments
This commit is contained in:
parent
709332ef09
commit
b0358d5da1
14 changed files with 49 additions and 31 deletions
|
@ -331,8 +331,9 @@ GES_TIMELINE_TITLE_SOURCE_GET_CLASS
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>ges-track-video-background-source</FILE>
|
<FILE>ges-track-video-background-source</FILE>
|
||||||
<TITLE>GESTrackVideoBackgroundSource</TITLE>
|
<TITLE>GESTrackVideoBackgroundSource</TITLE>
|
||||||
GESTrackAudioBackgroundSource
|
GESTrackVideoBackgroundSource
|
||||||
GESTrackAudioBackgroundSourceClass
|
GESTrackVideoBackgroundSourceClass
|
||||||
|
GESTrackVideoBgSrcPattern
|
||||||
ges_track_video_background_source_new
|
ges_track_video_background_source_new
|
||||||
ges_track_vbg_src_get_type
|
ges_track_vbg_src_get_type
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
|
@ -376,18 +377,11 @@ GES_TRACK_TITLE_SOURCE_GET_CLASS
|
||||||
GES_TYPE_TRACK_TITLE_SOURCE
|
GES_TYPE_TRACK_TITLE_SOURCE
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>ges-track-video-background-source</FILE>
|
|
||||||
<TITLE>GESTrackVideoBackgroundSource</TITLE>
|
|
||||||
GESTrackVideoBackgroundSource
|
|
||||||
GESTrackVideoBackgroundSourceClass
|
|
||||||
GESTrackVideoBgSrcPattern
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>ges-track-audio-background-source</FILE>
|
<FILE>ges-track-audio-background-source</FILE>
|
||||||
<TITLE>GESTrackAudioBackgroundSource</TITLE>
|
<TITLE>GESTrackAudioBackgroundSource</TITLE>
|
||||||
|
GESTrackAudioBackgroundSource
|
||||||
|
GESTrackAudioBackgroundSourceClass
|
||||||
ges_track_audio_background_source_new
|
ges_track_audio_background_source_new
|
||||||
ges_track_abg_src_get_type
|
ges_track_abg_src_get_type
|
||||||
ges_track_video_title_source_new
|
ges_track_video_title_source_new
|
||||||
|
|
|
@ -19,7 +19,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-timeline-backgroundsource
|
* SECTION:ges-timeline-background-source
|
||||||
* @short_description: An object for manipulating media files in a GESTimeline
|
* @short_description: An object for manipulating media files in a GESTimeline
|
||||||
*
|
*
|
||||||
* Represents all the output treams from a particular uri. It is assumed that
|
* Represents all the output treams from a particular uri. It is assumed that
|
||||||
|
|
|
@ -46,15 +46,16 @@ G_BEGIN_DECLS
|
||||||
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_BACKGROUND_SOURCE, GESTimelineBackgroundSourceClass))
|
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_BACKGROUND_SOURCE, GESTimelineBackgroundSourceClass))
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GESTimelineSource:
|
* GESTimelineBackgroundSource:
|
||||||
|
* @parent: parent
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
struct _GESTimelineBackgroundSource {
|
struct _GESTimelineBackgroundSource {
|
||||||
GESTimelineSource parent;
|
GESTimelineSource parent;
|
||||||
gboolean mute;
|
|
||||||
|
|
||||||
/*< private >*/
|
/*< private >*/
|
||||||
|
gboolean mute;
|
||||||
gint vpattern;
|
gint vpattern;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -19,7 +19,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-timeline-titlesource
|
* SECTION:ges-timeline-title-source
|
||||||
* @short_description: An object for manipulating media files in a GESTimeline
|
* @short_description: An object for manipulating media files in a GESTimeline
|
||||||
*
|
*
|
||||||
* Represents all the output treams from a particular uri. It is assumed that
|
* Represents all the output treams from a particular uri. It is assumed that
|
||||||
|
|
|
@ -46,7 +46,8 @@ G_BEGIN_DECLS
|
||||||
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_TITLE_SOURCE, GESTimelineTitleSourceClass))
|
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_TITLE_SOURCE, GESTimelineTitleSourceClass))
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GESTimelineSource:
|
* GESTimelineTitleSource:
|
||||||
|
* @parent: parent
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -120,7 +120,7 @@ ges_timeline_transition_class_init (GESTimelineTransitionClass * klass)
|
||||||
object_class->finalize = ges_timeline_transition_finalize;
|
object_class->finalize = ges_timeline_transition_finalize;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GESTimelineTransition: vtype
|
* GESTimelineTransition:vtype
|
||||||
*
|
*
|
||||||
* The SMPTE wipe to use, or 0 for crossfade.
|
* The SMPTE wipe to use, or 0 for crossfade.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -19,7 +19,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-track-source
|
* SECTION:ges-track-audio-background-source
|
||||||
* @short_description: Base Class for single-media sources
|
* @short_description: Base Class for single-media sources
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -43,11 +43,13 @@ G_BEGIN_DECLS
|
||||||
|
|
||||||
#define GES_TRACK_AUDIO_BACKGROUND_SOURCE_GET_CLASS(obj) \
|
#define GES_TRACK_AUDIO_BACKGROUND_SOURCE_GET_CLASS(obj) \
|
||||||
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_AUDIO_BACKGROUND_SOURCE, GESTrackAudioBackgroundSourceClass))
|
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_AUDIO_BACKGROUND_SOURCE, GESTrackAudioBackgroundSourceClass))
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GESTrackAudioBackgroundSource:
|
* GESTrackAudioBackgroundSource:
|
||||||
* @uri: #gchar *, the URI of the media audio_background to play
|
* @parent: parent
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
struct _GESTrackAudioBackgroundSource {
|
struct _GESTrackAudioBackgroundSource {
|
||||||
GESTrackBackgroundSource parent;
|
GESTrackBackgroundSource parent;
|
||||||
|
|
||||||
|
@ -57,12 +59,13 @@ struct _GESTrackAudioBackgroundSource {
|
||||||
/**
|
/**
|
||||||
* GESTrackAudioBackgroundSourceClass:
|
* GESTrackAudioBackgroundSourceClass:
|
||||||
* @parent_class: parent class
|
* @parent_class: parent class
|
||||||
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
struct _GESTrackAudioBackgroundSourceClass {
|
struct _GESTrackAudioBackgroundSourceClass {
|
||||||
GESTrackBackgroundSourceClass parent_class;
|
GESTrackBackgroundSourceClass parent_class;
|
||||||
|
|
||||||
/* <public> */
|
/*< public >*/
|
||||||
};
|
};
|
||||||
|
|
||||||
GType ges_track_abg_src_get_type (void);
|
GType ges_track_abg_src_get_type (void);
|
||||||
|
|
|
@ -19,8 +19,8 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-track-source
|
* SECTION:ges-track-background-source
|
||||||
* @short_description: Base Class for single-media sources
|
* @short_description: Base Class for background source track objects
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "ges-internal.h"
|
#include "ges-internal.h"
|
||||||
|
|
|
@ -46,13 +46,13 @@ G_BEGIN_DECLS
|
||||||
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_BACKGROUND_SOURCE, GESTrackBackgroundSourceClass))
|
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_BACKGROUND_SOURCE, GESTrackBackgroundSourceClass))
|
||||||
/**
|
/**
|
||||||
* GESTrackBackgroundSource:
|
* GESTrackBackgroundSource:
|
||||||
* @uri: #gchar *, the URI of the media file to play
|
* @parent: parent
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
struct _GESTrackBackgroundSource {
|
struct _GESTrackBackgroundSource {
|
||||||
GESTrackSource parent;
|
GESTrackSource parent;
|
||||||
|
|
||||||
/*< public >*/
|
/*< private >*/
|
||||||
GstElement *element;
|
GstElement *element;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -64,7 +64,7 @@ struct _GESTrackBackgroundSource {
|
||||||
struct _GESTrackBackgroundSourceClass {
|
struct _GESTrackBackgroundSourceClass {
|
||||||
GESTrackSourceClass parent_class;
|
GESTrackSourceClass parent_class;
|
||||||
|
|
||||||
/* <public> */
|
/*< public >*/
|
||||||
GstElement* (*create_element) (GESTrackBackgroundSource *obj);
|
GstElement* (*create_element) (GESTrackBackgroundSource *obj);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -19,7 +19,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-track-source
|
* SECTION:ges-track-title-source
|
||||||
* @short_description: Base Class for single-media sources
|
* @short_description: Base Class for single-media sources
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -46,7 +46,7 @@ G_BEGIN_DECLS
|
||||||
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_TITLE_SOURCE, GESTrackTitleSourceClass))
|
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_TITLE_SOURCE, GESTrackTitleSourceClass))
|
||||||
/**
|
/**
|
||||||
* GESTrackTitleSource:
|
* GESTrackTitleSource:
|
||||||
* @uri: #gchar *, the URI of the media file to play
|
* @parent: parent
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
struct _GESTrackTitleSource {
|
struct _GESTrackTitleSource {
|
||||||
|
|
|
@ -19,8 +19,8 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:ges-track-source
|
* SECTION:ges-track-video-background-source
|
||||||
* @short_description: Base Class for single-media sources
|
* @short_description: implements solid colors and patterns with videotestsrc
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include "ges-internal.h"
|
#include "ges-internal.h"
|
||||||
|
|
|
@ -44,6 +44,26 @@ G_BEGIN_DECLS
|
||||||
#define GES_TRACK_VIDEO_BACKGROUND_SOURCE_GET_CLASS(obj) \
|
#define GES_TRACK_VIDEO_BACKGROUND_SOURCE_GET_CLASS(obj) \
|
||||||
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_VIDEO_BACKGROUND_SOURCE, GESTrackVideoBackgroundSourceClass))
|
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_VIDEO_BACKGROUND_SOURCE, GESTrackVideoBackgroundSourceClass))
|
||||||
|
|
||||||
|
/**$
|
||||||
|
* GESTrackVideoBgSrcPattern:$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_SMPTE: A standard SMPTE test pattern$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_SNOW: Random noise$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_BLACK: A black image$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_WHITE: A white image$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_RED: A red image$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_GREEN: A green image$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_BLUE: A blue image$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_CHECKERS1: Checkers pattern (1px)$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_CHECKERS2: Checkers pattern (2px)$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_CHECKERS4: Checkers pattern (4px)$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_CHECKERS8: Checkers pattern (8px)$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_CIRCULAR: Circular pattern$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_BLINK: Alternate between black and white$
|
||||||
|
* @GES_TRACK_VIDEO_BG_SRC_SMPTE75: SMPTE test pattern (75% color bars)$
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
typedef enum {
|
typedef enum {
|
||||||
GES_TRACK_VIDEO_BG_SRC_SMPTE,
|
GES_TRACK_VIDEO_BG_SRC_SMPTE,
|
||||||
GES_TRACK_VIDEO_BG_SRC_SNOW,
|
GES_TRACK_VIDEO_BG_SRC_SNOW,
|
||||||
|
@ -63,8 +83,7 @@ typedef enum {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GESTrackVideoBackgroundSource:
|
* GESTrackVideoBackgroundSource:
|
||||||
* @uri: #gchar *, the URI of the media video_background to play
|
* @parent: parent
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
struct _GESTrackVideoBackgroundSource {
|
struct _GESTrackVideoBackgroundSource {
|
||||||
GESTrackBackgroundSource parent;
|
GESTrackBackgroundSource parent;
|
||||||
|
|
Loading…
Reference in a new issue