*/
/**
* SECTION: gesasset
+ * @title: GESAsset
* @short_description: Represents usable resources inside the GStreamer Editing Services
*
* The Assets in the GStreamer Editing Services represent the resources
/**
* SECTION:gesaudiosource
+ * @title: GESAudioSource
* @short_description: Base Class for audio sources
*
* <refsect1 id="GESVideoSource.children_properties" role="properties">
- * <title role="children_properties.title">Children Properties</title>
- * <para>You can use the following children properties through the
- * #ges_track_element_set_child_property and alike set of methods:</para>
+ * <title role="children_properties.title">Children Properties
+ * You can use the following children properties through the
+ * #ges_track_element_set_child_property and alike set of methods:
* <informaltable frame="none">
* <tgroup cols="3">
* <colspec colname="properties_type" colwidth="150px"/>
/**
* SECTION:gesaudiotestsource
+ * @title: GESAudioTestSource
* @short_description: produce a simple test waveform or silence
- *
+ *
* Outputs a test audio stream using audiotestsrc. The default property values
* output silence. Useful for testing pipelines, or to fill gaps in an audio
* track.
/**
* SECTION: gesaudiotrack
+ * @title: GESAudioTrack
* @short_description: A standard GESTrack for raw audio
*
* Sane default properties to specify and fixate the output stream are
/**
* SECTION:gesaudiotransition
+ * @title: GESAudioTransition
* @short_description: implements audio crossfade transition
*/
/**
* SECTION:gesaudiourisource
+ * @title: GESAudioUriSource
* @short_description: outputs a single audio stream from a given file
*/
/**
* SECTION: gesbaseeffectclip
+ * @title: GESBaseEffectClip
* @short_description: An effect in a GESLayer
*
* The effect will be applied on the sources that have lower priorities
/**
* SECTION:gesbaseeffect
+ * @title: GESBaseEffect
* @short_description: adds an effect to a stream in a GESSourceClip or a
* GESLayer
*/
/**
* SECTION: gesbasetransitionclip
+ * @title: GESBaseTransitionClip
* @short_description: Base classes for transitions
*/
*/
/**
* SECTION: gesclipasset
+ * @title: GESClipAsset
* @short_description: A GESAsset subclass specialized in GESClip extraction
*
* The #GESUriClipAsset is a special #GESAsset specilized in #GESClip.
/**
* SECTION:gesclip
+ * @title: GESClip
* @short_description: Base Class for objects in a GESLayer
*
* A #GESClip is a 'natural' object which controls one or more
* You might rather use the ges_clip_move_to_layer function to
* move #GESClip-s from a layer to another.
*
- *
* Returns: %TRUE if @clip is currently moving from its current layer
* %FALSE otherwize
**/
/**
* SECTION:gescontainer
+ * @title: GESContainer
* @short_description: Base Class for objects responsible for controlling other
* GESTimelineElement-s
*/
* controlled by this Container. NOTE: Do not modify.
* @height: The span of priorities this container occupies
*
- *
* The #GESContainer base class.
*/
struct _GESContainer
/**
* SECTION: geseffectclip
+ * @title: GESEffectClip
* @short_description: An effect created by parse-launch style bin descriptions
* in a GESLayer
*
/**
* SECTION:geseffect
+ * @title: GESEffect
* @short_description: adds an effect build from a parse-launch style
* bin description to a stream in a GESSourceClip or a GESLayer
*/
/**
* SECTION:ges-enums
+ * @title: GES Enumerations
* @short_description: Various enums for the Gstreamer Editing Services
*/
*/
/**
* SECTION: gesextractable
+ * @title: GESExtractable Interface
* @short_description: An interface for objects which can be extracted from a GESAsset
*
* FIXME: Long description needed
/**
* SECTION:gesformatter
+ * @title: GESFormatter
* @short_description: Timeline saving and loading.
*
**/
/**
* SECTION: ges-gerror
+ * @title: GESErrors
* @short_description: GError — Categorized error messages
*/
/**
* SECTION:gesgroup
+ * @title: GESGroup
* @short_description: Class that permits to group GESClip-s in a timeline,
* letting the user manage it a single GESTimelineElement
*
/**
* SECTION:gesimagesource
+ * @title: GESImageSource
* @short_description: outputs the video stream from a media file as a still
* image.
*
/**
* SECTION:geslayer
+ * @title: GESLayer
* @short_description: Non-overlapping sequence of GESClip
*
* Responsible for the ordering of the various contained Clip(s). A
G_END_DECLS
#endif /* _GES_LAYER */
-
/**
* SECTION:gesmultifilesource
+ * @title: GESMultiFileSource
* @short_description: outputs the video stream from a sequence of images.
*
* Outputs the video stream from a given image sequence. The start frame
/**
* SECTION:gesoperationclip
+ * @title: GESOperationClip
* @short_description: Base Class for operations in a GESLayer
*
* Operations are any kind of object that both outputs AND consumes data.
/**
* SECTION:gesoperation
+ * @title: GESOperation
* @short_description: Base Class for effects and overlays
*/
/**
* SECTION:gesoverlayclip
+ * @title: GESOverlayClip
* @short_description: Base Class for overlays in a GESLayer
*
* Overlays are objects which modify the underlying layer(s).
* Examples of overlays include text, image watermarks, or audio dubbing.
*
* Transitions, which change from one source to another over time, are
- * not considered overlays.
+ * not considered overlays.
*/
#include "ges-internal.h"
/**
* SECTION:gespipeline
+ * @title: GESPipeline
* @short_description: Convenience GstPipeline for editing.
*
* #GESPipeline allows developers to view and render #GESTimeline
/**
* SECTION: gespitiviformatter
+ * @title: GESPitiviFormatter
* @short_description: A formatter for the obsolete Pitivi xptv project file format
*
* This is a legacy format and you should avoid to use it. The formatter
*/
/**
* SECTION: gesproject
+ * @title: GESProject
* @short_description: A GESAsset that is used to manage projects
*
* The #GESProject is used to control a set of #GESAsset and is a
/**
* SECTION:gessourceclip
+ * @title: GESSourceClip
* @short_description: Base Class for sources of a GESLayer
*/
/**
* SECTION:gessource
+ * @title: GESSource
* @short_description: Base Class for single-media sources
*/
/**
* SECTION:gestestclip
+ * @title: GESTestClip
* @short_description: Render video and audio test patterns in a GESLayer
*
* Useful for testing purposes.
/**
* GESTestClip:
- *
*/
struct _GESTestClip {
/**
* SECTION:gestextoverlayclip
+ * @title: GESTextOverlayClip
* @short_description: Render text onto another stream in a GESLayer
*
* Renders text onto the next lower priority stream using textrender.
/**
* GESTextOverlayClip:
- *
*/
struct _GESTextOverlayClip
/**
* SECTION:gestextoverlay
+ * @title: GESTextOverlay
* @short_description: render text onto another video stream in a GESLayer
*
*/
/**
* SECTION:gestimelineelement
+ * @title: GESTimelineElement
* @short_description: Base Class for all elements that will be in a way or
* another inside a GESTimeline.
*
* ges_timeline_element_get_name:
* @self: a #GESTimelineElement
*
- *
* Returns a copy of the name of @self.
* Caller should g_free() the return value after usage.
*
* @self: a #GESTimelineElement
* @name: (allow-none): The name @self should take (if avalaible<)
*
- *
* Sets the name of object, or gives @self a guaranteed unique name (if name is NULL).
* This function makes a copy of the provided name, so the caller retains ownership
* of the name it sent.
G_END_DECLS
#endif /* _GES_TIMELINE_ELEMENT_H_ */
-
/**
* SECTION:gestimeline
+ * @title: GESTimeline
* @short_description: Multimedia timeline
*
* #GESTimeline is the central object for any multimedia timeline.
/**
* SECTION:gestitleclip
+ * @title: GESTitleClip
* @short_description: Render stand-alone titles in GESLayer.
*
* Renders the given text in the specified font, at specified position, and
/**
* SECTION:gestitlesource
+ * @title: GESTitleSource
* @short_description: render stand-alone text titles
*
* #GESTitleSource is a GESTimelineElement that implements the notion
* of titles in GES.
*
* <refsect1 id="GESTileSource.children_properties" role="properties">
- * <title role="children_properties.title">Children Properties</title>
- * <para>You can use the following children properties through the
- * #ges_track_element_set_child_property and alike set of methods:</para>
+ * <title role="children_properties.title">Children Properties
+ * You can use the following children properties through the
+ * #ges_track_element_set_child_property and alike set of methods:
* <informaltable frame="none">
* <tgroup cols="3">
* <colspec colname="properties_type" colwidth="150px"/>
typedef struct _GESTitleSourcePrivate GESTitleSourcePrivate;
-/**
+/**
* GESTitleSource:
*
*/
* GESTitleSourceClass:
* @parent_class: parent class
*/
-
struct _GESTitleSourceClass {
GESVideoSourceClass parent_class;
/**
* SECTION: gestrackelementasset
+ * @title: GESTrackElementAsset
* @short_description: A GESAsset subclass specialized in GESTrackElement extraction
*/
/**
* SECTION:gestrackelement
+ * @title: GESTrackElement
* @short_description: Base Class for objects contained in a GESTrack
*
* #GESTrackElement is the Base Class for any object that can be contained in a
/**
* SECTION:gestrack
+ * @title: GESTrack
* @short_description: Composition of objects
*
* Corresponds to one output format (i.e. audio OR video).
/**
* SECTION: gestransitionclip
+ * @title: GESTransitionClip
* @short_description: Transition from one clip to another in a GESLayer
*
* Creates an object that mixes together the two underlying objects, A and B.
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
-
-/**
+/**
* SECTION:gestransition
+ * @title: GESTransition
* @short_description: base class for audio and video transitions
*
*/
*/
/**
* SECTION: gesuriclipasset
+ * @title: GESUriClipAsset
* @short_description: A GESAsset subclass specialized in GESUriClip extraction
*
* The #GESUriClipAsset is a special #GESAsset that lets you handle
*****************************************************************/
/**
* SECTION: gesurisourceasset
+ * @title: GESUriClipAsset
* @short_description: A GESAsset subclass specialized in GESUriSource extraction
*
* NOTE: You should never request such a #GESAsset as they will be created automatically
/**
* SECTION: gesuriclip
+ * @title: GESUriClip
* @short_description: An object for manipulating media files in a GESTimeline
*
* Represents all the output streams from a particular uri. It is assumed that
/**
* SECTION:ges-utils
+ * @title: GES utilities
* @short_description: Convenience methods
*
*/
/**
* SECTION:gesvideosource
+ * @title: GESVideoSource
* @short_description: Base Class for video sources
*
* <refsect1 id="GESVideoSource.children_properties" role="properties">
- * <title role="children_properties.title">Children Properties</title>
- * <para>You can use the following children properties through the
- * #ges_track_element_set_child_property and alike set of methods:</para>
+ * # Children Properties
+ * You can use the following children properties through the
+ * #ges_track_element_set_child_property and alike set of methods:
* <informaltable frame="none">
* <tgroup cols="3">
* <colspec colname="properties_type" colwidth="150px"/>
/**
* SECTION:gesvideotestsource
+ * @title: GESVideoTestSource
* @short_description: produce solid colors and patterns
*/
/**
* SECTION: gesvideotrack
+ * @title: GESVideoTrack
* @short_description: A standard GESTrack for raw video
*/
/**
* SECTION:gesvideotransition
+ * @title: GESVideoTransition
* @short_description: implements video crossfade transition
*/
/**
* SECTION:gesvideourisource
+ * @title: GESVideoUriSource
* @short_description: outputs a single video stream from a given file
*/