mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-06-05 15:08:53 +00:00
Code Issues 1 Projects Releases Wiki Activity

Minor documentation fixes: GESExtractable, GESAsset

Browse source
This commit is contained in:
Alexandru Băluț 2014-02-18 22:14:00 +01:00 committed by Thibault Saunier
parent d972508107
commit eef3861272
2 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
ges/ges-asset.c
View file

@ -20,12 +20,12 @@
*/ */
/** /**
* SECTION: ges-asset * SECTION: ges-asset
* @short_description: Represents usable ressources inside the GStreamer Editing Services * @short_description: Represents usable resources inside the GStreamer Editing Services
* *
* The Assets in the GStreamer Editing Services represent the ressources * The Assets in the GStreamer Editing Services represent the resources
* that can be used. You can create assets for any type that implements the #GESExtractable * that can be used. You can create assets for any type that implements the #GESExtractable
* interface, for example #GESClips, #GESFormatter, and #GESTrackElement do implement it. * interface, for example #GESClips, #GESFormatter, and #GESTrackElement do implement it.
* This means that asssets will represent for example a #GESUriClips, #GESBaseEffect etc, * This means that assets will represent for example a #GESUriClips, #GESBaseEffect etc,
* and then you can extract objects of those types with the appropriate parameters from the asset * and then you can extract objects of those types with the appropriate parameters from the asset
* using the #ges_asset_extract method: * using the #ges_asset_extract method:
* *
@ -46,18 +46,18 @@
* to the #GESAsset through the #GESMetaContainer interface and you have a model for your * to the #GESAsset through the #GESMetaContainer interface and you have a model for your
* custom effects. Note that #GESAsset management is making easier thanks to the #GESProject class. * custom effects. Note that #GESAsset management is making easier thanks to the #GESProject class.
* *
* Each asset are represented by a pair of @extractable_type and @id (string). Actually the @extractable_type * Each asset is represented by a pair of @extractable_type and @id (string). Actually the @extractable_type
* is the type that implements the #GESExtractable interface, that means that for example for a #GESUriClip, * is the type that implements the #GESExtractable interface, that means that for example for a #GESUriClip,
* the type that implements the #GESExtractable interface is #GESClip. * the type that implements the #GESExtractable interface is #GESClip.
* The identifier represents different things depending on the @extractable_type and you should check * The identifier represents different things depending on the @extractable_type and you should check
* the documentation of each type to know what the ID of #GESAsset actually represents for that type. By default, * the documentation of each type to know what the ID of #GESAsset actually represents for that type. By default,
* we only have one #GESAsset per type, and the @id is the name of the type, but this behaviour is overriden * we only have one #GESAsset per type, and the @id is the name of the type, but this behaviour is overriden
* to be more usefull. For example, for GESTransitionClips, the ID is the vtype of the transition * to be more useful. For example, for GESTransitionClips, the ID is the vtype of the transition
* you will extract from it (ie crossfade, box-wipe-rc etc..) For #GESEffect the id is the * you will extract from it (ie crossfade, box-wipe-rc etc..) For #GESEffect the ID is the
* @bin-description property of the extracted objects (ie the gst-launch style description of the bin that * @bin-description property of the extracted objects (ie the gst-launch style description of the bin that
* will be used). * will be used).
* *
* Each and every #GESAsset are cached into GES, and you can query those with the #ges_list_assets function. * Each and every #GESAsset is cached into GES, and you can query those with the #ges_list_assets function.
* Also the system will automatically register #GESAssets for #GESFormatters and #GESTransitionClips * Also the system will automatically register #GESAssets for #GESFormatters and #GESTransitionClips
* and standard effects (actually not implemented yet) and you can simply query those calling: * and standard effects (actually not implemented yet) and you can simply query those calling:
* |[ * |[

10
ges/ges-extractable.c
View file

@ -20,7 +20,7 @@
*/ */
/** /**
* SECTION: ges-extractable * SECTION: ges-extractable
* @short_description: An interface letting an object be extracted from a GESAsset * @short_description: An interface for objects which can be extracted from a GESAsset
* *
* FIXME: Long description needed * FIXME: Long description needed
*/ */
@ -78,11 +78,11 @@ ges_extractable_default_init (GESExtractableInterface * iface)
/** /**
* ges_extractable_get_asset: * ges_extractable_get_asset:
* @self: The #GESExtractable from which to retrieve a #GESAsset from * @self: The #GESExtractable from which to retrieve a #GESAsset
* *
* Method to get a asset from a #GESExtractable * Method for getting an asset from a #GESExtractable
* *
* Returns: (transfer none): the #GESAsset or %NULL if none have been set * Returns: (transfer none): The #GESAsset or %NULL if none has been set
*/ */
GESAsset * GESAsset *
ges_extractable_get_asset (GESExtractable * self) ges_extractable_get_asset (GESExtractable * self)
@ -97,7 +97,7 @@ ges_extractable_get_asset (GESExtractable * self)
* @self: Target object * @self: Target object
* @asset: (transfer none): The #GESAsset to set * @asset: (transfer none): The #GESAsset to set
* *
* Method to set asset which was used to instaniate specified object * Method to set the asset which instantiated the specified object
*/ */
void void
ges_extractable_set_asset (GESExtractable * self, GESAsset * asset) ges_extractable_set_asset (GESExtractable * self, GESAsset * asset)