mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-30 05:31:15 +00:00
ges: add some g-i annotations according to documentation
Mainly (transfer xxx) and (nullable). Also fix some typo. https://bugzilla.gnome.org/show_bug.cgi?id=766459
This commit is contained in:
parent
dc95299080
commit
813c4b4fb7
33 changed files with 96 additions and 94 deletions
|
@ -477,7 +477,7 @@ _gtask_return_true (GTask * task, gpointer udata)
|
||||||
*
|
*
|
||||||
* Looks for asset with specified id in cache and it's completely loaded.
|
* Looks for asset with specified id in cache and it's completely loaded.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The #GESAsset found or %NULL
|
* Returns: (transfer none) (nullable): The #GESAsset found or %NULL
|
||||||
*/
|
*/
|
||||||
GESAsset *
|
GESAsset *
|
||||||
ges_asset_cache_lookup (GType extractable_type, const gchar * id)
|
ges_asset_cache_lookup (GType extractable_type, const gchar * id)
|
||||||
|
@ -770,7 +770,7 @@ ges_asset_list_proxies (GESAsset * asset)
|
||||||
* ges_asset_get_proxy:
|
* ges_asset_get_proxy:
|
||||||
* @asset: The #GESAsset to get currenlty used proxy
|
* @asset: The #GESAsset to get currenlty used proxy
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The proxy in use for @asset
|
* Returns: (transfer none) (nullable): The proxy in use for @asset
|
||||||
*/
|
*/
|
||||||
GESAsset *
|
GESAsset *
|
||||||
ges_asset_get_proxy (GESAsset * asset)
|
ges_asset_get_proxy (GESAsset * asset)
|
||||||
|
@ -788,7 +788,7 @@ ges_asset_get_proxy (GESAsset * asset)
|
||||||
* ges_asset_get_proxy_target:
|
* ges_asset_get_proxy_target:
|
||||||
* @proxy: The #GESAsset from which to get the the asset it proxies.
|
* @proxy: The #GESAsset from which to get the the asset it proxies.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The #GESAsset that is proxied by @proxy
|
* Returns: (transfer none) (nullable): The #GESAsset that is proxied by @proxy
|
||||||
*/
|
*/
|
||||||
GESAsset *
|
GESAsset *
|
||||||
ges_asset_get_proxy_target (GESAsset * proxy)
|
ges_asset_get_proxy_target (GESAsset * proxy)
|
||||||
|
@ -1283,8 +1283,8 @@ ges_list_assets (GType filter)
|
||||||
* ges_asset_get_error:
|
* ges_asset_get_error:
|
||||||
* @self: The asset to retrieve the error from
|
* @self: The asset to retrieve the error from
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The #GError of the asset or %NULL if the asset was
|
* Returns: (transfer none) (nullable): The #GError of the asset or %NULL if
|
||||||
* loaded without issue
|
* the asset was loaded without issue
|
||||||
*
|
*
|
||||||
* Since: 1.8
|
* Since: 1.8
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -203,7 +203,7 @@ ges_audio_test_source_get_volume (GESAudioTestSource * self)
|
||||||
*
|
*
|
||||||
* Creates a new #GESAudioTestSource.
|
* Creates a new #GESAudioTestSource.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESAudioTestSource.
|
* Returns: (transfer floating) (nullable): The newly created #GESAudioTestSource.
|
||||||
*/
|
*/
|
||||||
GESAudioTestSource *
|
GESAudioTestSource *
|
||||||
ges_audio_test_source_new (void)
|
ges_audio_test_source_new (void)
|
||||||
|
|
|
@ -114,7 +114,7 @@ ges_audio_track_class_init (GESAudioTrackClass * klass)
|
||||||
* Creates a new #GESAudioTrack of type #GES_TRACK_TYPE_AUDIO and with generic
|
* Creates a new #GESAudioTrack of type #GES_TRACK_TYPE_AUDIO and with generic
|
||||||
* raw audio caps ("audio/x-raw");
|
* raw audio caps ("audio/x-raw");
|
||||||
*
|
*
|
||||||
* Returns: A new #GESTrack
|
* Returns: (transfer floating): A new #GESTrack
|
||||||
*/
|
*/
|
||||||
GESAudioTrack *
|
GESAudioTrack *
|
||||||
ges_audio_track_new (void)
|
ges_audio_track_new (void)
|
||||||
|
|
|
@ -287,7 +287,7 @@ ges_audio_transition_duration_changed (GESTrackElement * track_element,
|
||||||
*
|
*
|
||||||
* Creates a new #GESAudioTransition.
|
* Creates a new #GESAudioTransition.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESAudioTransition.
|
* Returns: (transfer floating): The newly created #GESAudioTransition.
|
||||||
*/
|
*/
|
||||||
GESAudioTransition *
|
GESAudioTransition *
|
||||||
ges_audio_transition_new (void)
|
ges_audio_transition_new (void)
|
||||||
|
|
|
@ -185,8 +185,8 @@ ges_audio_uri_source_init (GESAudioUriSource * self)
|
||||||
*
|
*
|
||||||
* Creates a new #GESAudioUriSource for the provided @uri.
|
* Creates a new #GESAudioUriSource for the provided @uri.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESAudioUriSource, or %NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created
|
||||||
* error.
|
* #GESAudioUriSource, or %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESAudioUriSource *
|
GESAudioUriSource *
|
||||||
ges_audio_uri_source_new (gchar * uri)
|
ges_audio_uri_source_new (gchar * uri)
|
||||||
|
|
|
@ -824,8 +824,8 @@ ges_clip_init (GESClip * self)
|
||||||
* keep a reference to the newly created trackelement, you therefore need to
|
* keep a reference to the newly created trackelement, you therefore need to
|
||||||
* call @ges_container_remove when you are done with it.
|
* call @ges_container_remove when you are done with it.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): A #GESTrackElement. Returns NULL if the #GESTrackElement could not
|
* Returns: (transfer none) (nullable): A #GESTrackElement. Returns NULL if
|
||||||
* be created.
|
* the #GESTrackElement could not be created.
|
||||||
*/
|
*/
|
||||||
GESTrackElement *
|
GESTrackElement *
|
||||||
ges_clip_create_track_element (GESClip * clip, GESTrackType type)
|
ges_clip_create_track_element (GESClip * clip, GESTrackType type)
|
||||||
|
@ -1053,8 +1053,8 @@ ges_clip_move_to_layer (GESClip * clip, GESLayer * layer)
|
||||||
* Note: If many objects match, then the one with the highest priority will be
|
* Note: If many objects match, then the one with the highest priority will be
|
||||||
* returned.
|
* returned.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): The #GESTrackElement used by @track, else %NULL,
|
* Returns: (transfer full) (nullable): The #GESTrackElement used by @track,
|
||||||
* Unref after usage
|
* else %NULL. Unref after usage
|
||||||
*/
|
*/
|
||||||
|
|
||||||
GESTrackElement *
|
GESTrackElement *
|
||||||
|
@ -1090,7 +1090,7 @@ ges_clip_find_track_element (GESClip * clip, GESTrack * track, GType type)
|
||||||
*
|
*
|
||||||
* Get the #GESLayer to which this clip belongs.
|
* Get the #GESLayer to which this clip belongs.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): The #GESLayer where this @clip is being
|
* Returns: (transfer full) (nullable): The #GESLayer where this @clip is being
|
||||||
* used, or %NULL if it is not used on any layer. The caller should unref it
|
* used, or %NULL if it is not used on any layer. The caller should unref it
|
||||||
* usage.
|
* usage.
|
||||||
*/
|
*/
|
||||||
|
@ -1265,8 +1265,8 @@ ges_clip_set_top_effect_index (GESClip * clip, GESBaseEffect * effect,
|
||||||
* property must be registered using @ges_effect_class_register_rate_property;
|
* property must be registered using @ges_effect_class_register_rate_property;
|
||||||
* for the 'pitch' plugin, this is already done.
|
* for the 'pitch' plugin, this is already done.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The newly created #GESClip resulting from the
|
* Returns: (transfer none) (nullable): The newly created #GESClip resulting
|
||||||
* splitting
|
* from the splitting or %NULL if the clip can't be split.
|
||||||
*/
|
*/
|
||||||
GESClip *
|
GESClip *
|
||||||
ges_clip_split (GESClip * clip, guint64 position)
|
ges_clip_split (GESClip * clip, guint64 position)
|
||||||
|
|
|
@ -176,7 +176,7 @@ _create_track_element (GESClip * self, GESTrackType type)
|
||||||
*
|
*
|
||||||
* Creates a new #GESEffectClip from the description of the bin.
|
* Creates a new #GESEffectClip from the description of the bin.
|
||||||
*
|
*
|
||||||
* Returns: a newly created #GESEffectClip, or
|
* Returns: (transfer floating) (nullable): a newly created #GESEffectClip, or
|
||||||
* %NULL if something went wrong.
|
* %NULL if something went wrong.
|
||||||
*/
|
*/
|
||||||
GESEffectClip *
|
GESEffectClip *
|
||||||
|
|
|
@ -257,7 +257,7 @@ ges_effect_create_element (GESTrackElement * object)
|
||||||
* #ges_asset_request (GES_TYPE_EFFECT, "audio your ! bin ! description", NULL);
|
* #ges_asset_request (GES_TYPE_EFFECT, "audio your ! bin ! description", NULL);
|
||||||
* and extract that asset to be in full control.
|
* and extract that asset to be in full control.
|
||||||
*
|
*
|
||||||
* Returns: a newly created #GESEffect, or %NULL if something went
|
* Returns: (nullable): a newly created #GESEffect, or %NULL if something went
|
||||||
* wrong.
|
* wrong.
|
||||||
*/
|
*/
|
||||||
GESEffect *
|
GESEffect *
|
||||||
|
|
|
@ -83,7 +83,8 @@ ges_extractable_default_init (GESExtractableInterface * iface)
|
||||||
*
|
*
|
||||||
* Method for getting an asset from a #GESExtractable
|
* Method for getting an asset from a #GESExtractable
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The #GESAsset or %NULL if none has been set
|
* Returns: (transfer none) (nullable): The #GESAsset or %NULL if none has
|
||||||
|
* been set
|
||||||
*/
|
*/
|
||||||
GESAsset *
|
GESAsset *
|
||||||
ges_extractable_get_asset (GESExtractable * self)
|
ges_extractable_get_asset (GESExtractable * self)
|
||||||
|
@ -212,8 +213,8 @@ ges_extractable_type_get_asset_type (GType type)
|
||||||
*
|
*
|
||||||
* Check if @id is valid for @type
|
* Check if @id is valid for @type
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): A newly allocated string containing the actuall
|
* Returns: (transfer full) (nullable): A newly allocated string containing
|
||||||
* ID (after some processing) or %NULL if the ID is wrong.
|
* the actual ID (after some processing) or %NULL if the ID is wrong.
|
||||||
*/
|
*/
|
||||||
gchar *
|
gchar *
|
||||||
ges_extractable_type_check_id (GType type, const gchar * id, GError ** error)
|
ges_extractable_type_check_id (GType type, const gchar * id, GError ** error)
|
||||||
|
|
|
@ -791,7 +791,7 @@ ges_group_init (GESGroup * self)
|
||||||
* together, it is recommanded to use the #ges_container_group method so the
|
* together, it is recommanded to use the #ges_container_group method so the
|
||||||
* proper subclass is selected.
|
* proper subclass is selected.
|
||||||
*
|
*
|
||||||
* Returns: The new empty group.
|
* Returns: (transfer floating): The new empty group.
|
||||||
*/
|
*/
|
||||||
GESGroup *
|
GESGroup *
|
||||||
ges_group_new (void)
|
ges_group_new (void)
|
||||||
|
|
|
@ -181,7 +181,7 @@ ges_image_source_init (GESImageSource * self)
|
||||||
*
|
*
|
||||||
* Creates a new #GESImageSource for the provided @uri.
|
* Creates a new #GESImageSource for the provided @uri.
|
||||||
*
|
*
|
||||||
* Returns: A new #GESImageSource.
|
* Returns: (transfer floating): A new #GESImageSource.
|
||||||
*/
|
*/
|
||||||
GESImageSource *
|
GESImageSource *
|
||||||
ges_image_source_new (gchar * uri)
|
ges_image_source_new (gchar * uri)
|
||||||
|
|
|
@ -502,7 +502,7 @@ ges_layer_is_empty (GESLayer * layer)
|
||||||
* are constructed, you should connect to the container::child-added signal which
|
* are constructed, you should connect to the container::child-added signal which
|
||||||
* is emited right after those elements are ready to be used.
|
* is emited right after those elements are ready to be used.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the clip was properly added to the layer, or FALSE
|
* Returns: %TRUE if the clip was properly added to the layer, or %FALSE
|
||||||
* if the @layer refuses to add the clip.
|
* if the @layer refuses to add the clip.
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
|
@ -662,7 +662,7 @@ ges_layer_add_asset (GESLayer * layer,
|
||||||
*
|
*
|
||||||
* Creates a new #GESLayer.
|
* Creates a new #GESLayer.
|
||||||
*
|
*
|
||||||
* Returns: A new #GESLayer
|
* Returns: (transfer floating): A new #GESLayer
|
||||||
*/
|
*/
|
||||||
GESLayer *
|
GESLayer *
|
||||||
ges_layer_new (void)
|
ges_layer_new (void)
|
||||||
|
@ -676,7 +676,7 @@ ges_layer_new (void)
|
||||||
*
|
*
|
||||||
* Get the #GESTimeline in which #GESLayer currently is.
|
* Get the #GESTimeline in which #GESLayer currently is.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): the #GESTimeline in which #GESLayer
|
* Returns: (transfer none) (nullable): the #GESTimeline in which #GESLayer
|
||||||
* currently is or %NULL if not in any timeline yet.
|
* currently is or %NULL if not in any timeline yet.
|
||||||
*/
|
*/
|
||||||
GESTimeline *
|
GESTimeline *
|
||||||
|
|
|
@ -426,8 +426,8 @@ ges_meta_container_set_meta (GESMetaContainer * container,
|
||||||
*
|
*
|
||||||
* Serializes a meta container to a string.
|
* Serializes a meta container to a string.
|
||||||
*
|
*
|
||||||
* Returns: a newly-allocated string, or NULL in case of an error. The
|
* Returns: (nullable): a newly-allocated string, or NULL in case of an error.
|
||||||
* string must be freed with g_free() when no longer needed.
|
* The string must be freed with g_free() when no longer needed.
|
||||||
*/
|
*/
|
||||||
gchar *
|
gchar *
|
||||||
ges_meta_container_metas_to_string (GESMetaContainer * container)
|
ges_meta_container_metas_to_string (GESMetaContainer * container)
|
||||||
|
|
|
@ -261,7 +261,7 @@ ges_multi_file_source_init (GESMultiFileSource * self)
|
||||||
*
|
*
|
||||||
* Creates a new #GESMultiFileSource for the provided @uri.
|
* Creates a new #GESMultiFileSource for the provided @uri.
|
||||||
*
|
*
|
||||||
* Returns: A new #GESMultiFileSource.
|
* Returns: (transfer floating): A new #GESMultiFileSource.
|
||||||
*/
|
*/
|
||||||
GESMultiFileSource *
|
GESMultiFileSource *
|
||||||
ges_multi_file_source_new (gchar * uri)
|
ges_multi_file_source_new (gchar * uri)
|
||||||
|
|
|
@ -401,7 +401,7 @@ no_encodebin:
|
||||||
*
|
*
|
||||||
* Creates a new conveninence #GESPipeline.
|
* Creates a new conveninence #GESPipeline.
|
||||||
*
|
*
|
||||||
* Returns: the new #GESPipeline.
|
* Returns: (transfer floating): the new #GESPipeline.
|
||||||
*/
|
*/
|
||||||
GESPipeline *
|
GESPipeline *
|
||||||
ges_pipeline_new (void)
|
ges_pipeline_new (void)
|
||||||
|
@ -921,7 +921,7 @@ _unlink_track (GESPipeline * self, GESTrack * track)
|
||||||
/**
|
/**
|
||||||
* ges_pipeline_set_timeline:
|
* ges_pipeline_set_timeline:
|
||||||
* @pipeline: a #GESPipeline
|
* @pipeline: a #GESPipeline
|
||||||
* @timeline: the #GESTimeline to set on the @pipeline.
|
* @timeline: (transfer full): the #GESTimeline to set on the @pipeline.
|
||||||
*
|
*
|
||||||
* Sets the timeline to use in this pipeline.
|
* Sets the timeline to use in this pipeline.
|
||||||
*
|
*
|
||||||
|
@ -1196,7 +1196,7 @@ ges_pipeline_set_mode (GESPipeline * pipeline, GESPipelineFlags mode)
|
||||||
* is currently used by the sink. This information can be retrieve from caps
|
* is currently used by the sink. This information can be retrieve from caps
|
||||||
* associated with the buffer.
|
* associated with the buffer.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): a #GstSample or %NULL
|
* Returns: (transfer full) (nullable): a #GstSample or %NULL
|
||||||
*/
|
*/
|
||||||
|
|
||||||
GstSample *
|
GstSample *
|
||||||
|
@ -1288,7 +1288,7 @@ ges_pipeline_save_thumbnail (GESPipeline * self, int width, int
|
||||||
* The caller is responsible for unreffing the returned sample with
|
* The caller is responsible for unreffing the returned sample with
|
||||||
* #gst_sample_unref.
|
* #gst_sample_unref.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): a #GstSample or %NULL
|
* Returns: (transfer full) (nullable): a #GstSample or %NULL
|
||||||
*/
|
*/
|
||||||
|
|
||||||
GstSample *
|
GstSample *
|
||||||
|
|
|
@ -732,7 +732,7 @@ ges_project_create_asset (GESProject * project, const gchar * id,
|
||||||
* "asset-added" signal to get the asset when it finally gets added to
|
* "asset-added" signal to get the asset when it finally gets added to
|
||||||
* @project
|
* @project
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): The newly created #GESAsset
|
* Returns: (transfer full) (nullable): The newly created #GESAsset or %NULL.
|
||||||
*/
|
*/
|
||||||
GESAsset *
|
GESAsset *
|
||||||
ges_project_create_asset_sync (GESProject * project, const gchar * id,
|
ges_project_create_asset_sync (GESProject * project, const gchar * id,
|
||||||
|
|
|
@ -358,8 +358,8 @@ ges_test_clip_create_track_element (GESClip * clip, GESTrackType type)
|
||||||
*
|
*
|
||||||
* Creates a new #GESTestClip.
|
* Creates a new #GESTestClip.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESTestClip, or NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created #GESTestClip,
|
||||||
* error.
|
* or %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESTestClip *
|
GESTestClip *
|
||||||
ges_test_clip_new (void)
|
ges_test_clip_new (void)
|
||||||
|
@ -379,8 +379,8 @@ ges_test_clip_new (void)
|
||||||
*
|
*
|
||||||
* Creates a new #GESTestClip for the provided @nick.
|
* Creates a new #GESTestClip for the provided @nick.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESTestClip, or NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created #GESTestClip,
|
||||||
* error.
|
* or %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESTestClip *
|
GESTestClip *
|
||||||
ges_test_clip_new_for_nick (gchar * nick)
|
ges_test_clip_new_for_nick (gchar * nick)
|
||||||
|
|
|
@ -38,7 +38,6 @@ G_DEFINE_TYPE (GESTextOverlayClip, ges_text_overlay_clip,
|
||||||
#define DEFAULT_PROP_FONT_DESC "Serif 36"
|
#define DEFAULT_PROP_FONT_DESC "Serif 36"
|
||||||
#define DEFAULT_PROP_VALIGNMENT GES_TEXT_VALIGN_BASELINE
|
#define DEFAULT_PROP_VALIGNMENT GES_TEXT_VALIGN_BASELINE
|
||||||
#define DEFAULT_PROP_HALIGNMENT GES_TEXT_HALIGN_CENTER
|
#define DEFAULT_PROP_HALIGNMENT GES_TEXT_HALIGN_CENTER
|
||||||
#
|
|
||||||
|
|
||||||
struct _GESTextOverlayClipPrivate
|
struct _GESTextOverlayClipPrivate
|
||||||
{
|
{
|
||||||
|
@ -583,8 +582,8 @@ ges_text_overlay_clip_create_track_element (GESClip * clip, GESTrackType type)
|
||||||
*
|
*
|
||||||
* Creates a new #GESTextOverlayClip
|
* Creates a new #GESTextOverlayClip
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESTextOverlayClip, or NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created
|
||||||
* error.
|
* #GESTextOverlayClip, or %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESTextOverlayClip *
|
GESTextOverlayClip *
|
||||||
ges_text_overlay_clip_new (void)
|
ges_text_overlay_clip_new (void)
|
||||||
|
|
|
@ -425,8 +425,8 @@ ges_text_overlay_get_ypos (GESTextOverlay * self)
|
||||||
*
|
*
|
||||||
* Creates a new #GESTextOverlay.
|
* Creates a new #GESTextOverlay.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESTextOverlay or %NULL if something went
|
* Returns: (transfer floating) (nullable): The newly created #GESTextOverlay or
|
||||||
* wrong.
|
* %NULL if something went wrong.
|
||||||
*/
|
*/
|
||||||
GESTextOverlay *
|
GESTextOverlay *
|
||||||
ges_text_overlay_new (void)
|
ges_text_overlay_new (void)
|
||||||
|
|
|
@ -553,8 +553,8 @@ had_parent:
|
||||||
* Returns the parent of @self. This function increases the refcount
|
* Returns the parent of @self. This function increases the refcount
|
||||||
* of the parent object so you should gst_object_unref() it after usage.
|
* of the parent object so you should gst_object_unref() it after usage.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): parent of @self, this can be %NULL if @self
|
* Returns: (transfer full) (nullable): parent of @self, this can be %NULL if
|
||||||
* has no parent. unref after usage.
|
* @self has no parent. unref after usage.
|
||||||
*/
|
*/
|
||||||
GESTimelineElement *
|
GESTimelineElement *
|
||||||
ges_timeline_element_get_parent (GESTimelineElement * self)
|
ges_timeline_element_get_parent (GESTimelineElement * self)
|
||||||
|
@ -629,8 +629,8 @@ had_timeline:
|
||||||
* Returns the timeline of @self. This function increases the refcount
|
* Returns the timeline of @self. This function increases the refcount
|
||||||
* of the timeline so you should gst_object_unref() it after usage.
|
* of the timeline so you should gst_object_unref() it after usage.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): timeline of @self, this can be %NULL if @self
|
* Returns: (transfer full) (nullable): timeline of @self, this can be %NULL if
|
||||||
* has no timeline. unref after usage.
|
* @self has no timeline. unref after usage.
|
||||||
*/
|
*/
|
||||||
GESTimeline *
|
GESTimeline *
|
||||||
ges_timeline_element_get_timeline (GESTimelineElement * self)
|
ges_timeline_element_get_timeline (GESTimelineElement * self)
|
||||||
|
|
|
@ -2786,7 +2786,7 @@ timeline_fill_gaps (GESTimeline * timeline)
|
||||||
*
|
*
|
||||||
* Creates a new empty #GESTimeline.
|
* Creates a new empty #GESTimeline.
|
||||||
*
|
*
|
||||||
* Returns: The new timeline.
|
* Returns: (transfer floating): The new timeline.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
GESTimeline *
|
GESTimeline *
|
||||||
|
@ -2808,8 +2808,8 @@ ges_timeline_new (void)
|
||||||
*
|
*
|
||||||
* Creates a timeline from the given URI.
|
* Creates a timeline from the given URI.
|
||||||
*
|
*
|
||||||
* Returns: A new timeline if the uri was loaded successfully, or NULL if the
|
* Returns (transfer floating) (nullable): A new timeline if the uri was loaded
|
||||||
* uri could not be loaded
|
* successfully, or NULL if the uri could not be loaded.
|
||||||
*/
|
*/
|
||||||
GESTimeline *
|
GESTimeline *
|
||||||
ges_timeline_new_from_uri (const gchar * uri, GError ** error)
|
ges_timeline_new_from_uri (const gchar * uri, GError ** error)
|
||||||
|
@ -2831,7 +2831,7 @@ ges_timeline_new_from_uri (const gchar * uri, GError ** error)
|
||||||
*
|
*
|
||||||
* Loads the contents of URI into the given timeline.
|
* Loads the contents of URI into the given timeline.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the timeline was loaded successfully, or FALSE if the uri
|
* Returns: %TRUE if the timeline was loaded successfully, or %FALSE if the uri
|
||||||
* could not be loaded.
|
* could not be loaded.
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
|
@ -2864,8 +2864,8 @@ ges_timeline_load_from_uri (GESTimeline * timeline, const gchar * uri,
|
||||||
*
|
*
|
||||||
* Saves the timeline to the given location
|
* Saves the timeline to the given location
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the timeline was successfully saved to the given location,
|
* Returns: %TRUE if the timeline was successfully saved to the given location,
|
||||||
* else FALSE.
|
* else %FALSE.
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
ges_timeline_save_to_uri (GESTimeline * timeline, const gchar * uri,
|
ges_timeline_save_to_uri (GESTimeline * timeline, const gchar * uri,
|
||||||
|
@ -2921,12 +2921,12 @@ ges_timeline_append_layer (GESTimeline * timeline)
|
||||||
/**
|
/**
|
||||||
* ges_timeline_add_layer:
|
* ges_timeline_add_layer:
|
||||||
* @timeline: a #GESTimeline
|
* @timeline: a #GESTimeline
|
||||||
* @layer: the #GESLayer to add
|
* @layer: (transfer full): the #GESLayer to add
|
||||||
*
|
*
|
||||||
* Add the layer to the timeline. The reference to the @layer will be stolen
|
* Add the layer to the timeline. The reference to the @layer will be stolen
|
||||||
* by the @timeline.
|
* by the @timeline.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the layer was properly added, else FALSE.
|
* Returns: %TRUE if the layer was properly added, else %FALSE.
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
ges_timeline_add_layer (GESTimeline * timeline, GESLayer * layer)
|
ges_timeline_add_layer (GESTimeline * timeline, GESLayer * layer)
|
||||||
|
@ -3001,7 +3001,7 @@ ges_timeline_add_layer (GESTimeline * timeline, GESLayer * layer)
|
||||||
* the layer will be dropped. If you wish to use the @layer after calling this
|
* the layer will be dropped. If you wish to use the @layer after calling this
|
||||||
* method, you need to take a reference before calling.
|
* method, you need to take a reference before calling.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the layer was properly removed, else FALSE.
|
* Returns: %TRUE if the layer was properly removed, else %FALSE.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
gboolean
|
gboolean
|
||||||
|
@ -3051,12 +3051,12 @@ ges_timeline_remove_layer (GESTimeline * timeline, GESLayer * layer)
|
||||||
/**
|
/**
|
||||||
* ges_timeline_add_track:
|
* ges_timeline_add_track:
|
||||||
* @timeline: a #GESTimeline
|
* @timeline: a #GESTimeline
|
||||||
* @track: the #GESTrack to add
|
* @track: (transfer full): the #GESTrack to add
|
||||||
*
|
*
|
||||||
* Add a track to the timeline. The reference to the track will be stolen by the
|
* Add a track to the timeline. The reference to the track will be stolen by the
|
||||||
* pipeline.
|
* pipeline.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the track was properly added, else FALSE.
|
* Returns: %TRUE if the track was properly added, else %FALSE.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* FIXME: create track elements for clips which have already been
|
/* FIXME: create track elements for clips which have already been
|
||||||
|
@ -3143,7 +3143,7 @@ ges_timeline_add_track (GESTimeline * timeline, GESTrack * track)
|
||||||
* @track will be removed. If you wish to use the @track after calling this
|
* @track will be removed. If you wish to use the @track after calling this
|
||||||
* function you must ensure that you have a reference to it.
|
* function you must ensure that you have a reference to it.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the @track was properly removed, else FALSE.
|
* Returns: %TRUE if the @track was properly removed, else %FALSE.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/* FIXME: release any track elements associated with this layer. currenly this
|
/* FIXME: release any track elements associated with this layer. currenly this
|
||||||
|
@ -3222,8 +3222,8 @@ ges_timeline_remove_track (GESTimeline * timeline, GESTrack * track)
|
||||||
*
|
*
|
||||||
* Search the #GESTrack corresponding to the given @timeline's @pad.
|
* Search the #GESTrack corresponding to the given @timeline's @pad.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The corresponding #GESTrack if it is found,
|
* Returns: (transfer none) (nullable): The corresponding #GESTrack if it is
|
||||||
* or %NULL if there is an error.
|
* found, or %NULL if there is an error.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
GESTrack *
|
GESTrack *
|
||||||
|
@ -3251,8 +3251,8 @@ ges_timeline_get_track_for_pad (GESTimeline * timeline, GstPad * pad)
|
||||||
*
|
*
|
||||||
* Search the #GstPad corresponding to the given @timeline's @track.
|
* Search the #GstPad corresponding to the given @timeline's @track.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The corresponding #GstPad if it is found,
|
* Returns: (transfer none) (nullable): The corresponding #GstPad if it is
|
||||||
* or %NULL if there is an error.
|
* found, or %NULL if there is an error.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
GstPad *
|
GstPad *
|
||||||
|
@ -3573,7 +3573,7 @@ ges_timeline_set_snapping_distance (GESTimeline * timeline,
|
||||||
*
|
*
|
||||||
* Gets a #GESTimelineElement contained in the timeline
|
* Gets a #GESTimelineElement contained in the timeline
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): The #GESTimelineElement or %NULL if
|
* Returns: (transfer full) (nullable): The #GESTimelineElement or %NULL if
|
||||||
* not found.
|
* not found.
|
||||||
*/
|
*/
|
||||||
GESTimelineElement *
|
GESTimelineElement *
|
||||||
|
@ -3641,7 +3641,8 @@ ges_timeline_is_empty (GESTimeline * timeline)
|
||||||
*
|
*
|
||||||
* Retrieve the layer with @priority as a priority
|
* Retrieve the layer with @priority as a priority
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): A #GESLayer or %NULL if no layer with @priority was found
|
* Returns: (transfer full) (nullable): A #GESLayer or %NULL if no layer with
|
||||||
|
* @priority was found
|
||||||
*
|
*
|
||||||
* Since 1.6
|
* Since 1.6
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -688,8 +688,8 @@ ges_title_clip_create_track_element (GESClip * clip, GESTrackType type)
|
||||||
*
|
*
|
||||||
* Creates a new #GESTitleClip
|
* Creates a new #GESTitleClip
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESTitleClip, or NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created #GESTitleClip,
|
||||||
* error.
|
* or %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESTitleClip *
|
GESTitleClip *
|
||||||
ges_title_clip_new (void)
|
ges_title_clip_new (void)
|
||||||
|
|
|
@ -601,8 +601,8 @@ ges_title_source_get_ypos (GESTitleSource * source)
|
||||||
*
|
*
|
||||||
* Creates a new #GESTitleSource.
|
* Creates a new #GESTitleSource.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESTitleSource, or %NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created #GESTitleSource,
|
||||||
* error.
|
* or %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESTitleSource *
|
GESTitleSource *
|
||||||
ges_title_source_new (void)
|
ges_title_source_new (void)
|
||||||
|
|
|
@ -853,8 +853,8 @@ _ges_track_element_get_layer_priority (GESTrackElement * element)
|
||||||
*
|
*
|
||||||
* Get the #GESTrack to which this object belongs.
|
* Get the #GESTrack to which this object belongs.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The #GESTrack to which this object belongs. Can be %NULL if it
|
* Returns: (transfer none) (nullable): The #GESTrack to which this object
|
||||||
* is not in any track
|
* belongs. Can be %NULL if it is not in any track
|
||||||
*/
|
*/
|
||||||
GESTrack *
|
GESTrack *
|
||||||
ges_track_element_get_track (GESTrackElement * object)
|
ges_track_element_get_track (GESTrackElement * object)
|
||||||
|
@ -1525,8 +1525,8 @@ ges_track_element_set_control_source (GESTrackElement * object,
|
||||||
* Looks up the various controlled properties for that #GESTrackElement,
|
* Looks up the various controlled properties for that #GESTrackElement,
|
||||||
* and returns the #GstControlBinding which controls @property_name.
|
* and returns the #GstControlBinding which controls @property_name.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): the #GstControlBinding associated with @property_name, or %NULL
|
* Returns: (transfer none) (nullable): the #GstControlBinding associated with
|
||||||
* if that property is not controlled.
|
* @property_name, or %NULL if that property is not controlled.
|
||||||
*/
|
*/
|
||||||
GstControlBinding *
|
GstControlBinding *
|
||||||
ges_track_element_get_control_binding (GESTrackElement * object,
|
ges_track_element_get_control_binding (GESTrackElement * object,
|
||||||
|
|
|
@ -711,7 +711,7 @@ ges_track_init (GESTrack * self)
|
||||||
* The newly created track will steal a reference to the caps. If you wish to
|
* The newly created track will steal a reference to the caps. If you wish to
|
||||||
* use those caps elsewhere, you will have to take an extra reference.
|
* use those caps elsewhere, you will have to take an extra reference.
|
||||||
*
|
*
|
||||||
* Returns: A new #GESTrack.
|
* Returns: (transfer floating): A new #GESTrack.
|
||||||
*/
|
*/
|
||||||
GESTrack *
|
GESTrack *
|
||||||
ges_track_new (GESTrackType type, GstCaps * caps)
|
ges_track_new (GESTrackType type, GstCaps * caps)
|
||||||
|
@ -1059,7 +1059,7 @@ ges_track_get_caps (GESTrack * track)
|
||||||
*
|
*
|
||||||
* Get the #GESTimeline this track belongs to. Can be %NULL.
|
* Get the #GESTimeline this track belongs to. Can be %NULL.
|
||||||
*
|
*
|
||||||
* Returns: The #GESTimeline this track belongs to. Can be %NULL.
|
* Returns: (nullable): The #GESTimeline this track belongs to. Can be %NULL.
|
||||||
*/
|
*/
|
||||||
const GESTimeline *
|
const GESTimeline *
|
||||||
ges_track_get_timeline (GESTrack * track)
|
ges_track_get_timeline (GESTrack * track)
|
||||||
|
|
|
@ -337,8 +337,8 @@ _create_track_element (GESClip * clip, GESTrackType type)
|
||||||
*
|
*
|
||||||
* Creates a new #GESTransitionClip.
|
* Creates a new #GESTransitionClip.
|
||||||
*
|
*
|
||||||
* Returns: a newly created #GESTransitionClip, or %NULL if something
|
* Returns: (transfer floating) (nullable): a newly created #GESTransitionClip,
|
||||||
* went wrong.
|
* or %NULL if something went wrong.
|
||||||
*/
|
*/
|
||||||
GESTransitionClip *
|
GESTransitionClip *
|
||||||
ges_transition_clip_new (GESVideoStandardTransitionType vtype)
|
ges_transition_clip_new (GESVideoStandardTransitionType vtype)
|
||||||
|
@ -372,8 +372,8 @@ ges_transition_clip_new (GESVideoStandardTransitionType vtype)
|
||||||
*
|
*
|
||||||
* Creates a new #GESTransitionClip for the provided @nick.
|
* Creates a new #GESTransitionClip for the provided @nick.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESTransitionClip, or %NULL if something
|
* Returns: (transfer floating) (nullable): The newly created #GESTransitionClip,
|
||||||
* went wrong
|
* or %NULL if something went wrong
|
||||||
*/
|
*/
|
||||||
|
|
||||||
GESTransitionClip *
|
GESTransitionClip *
|
||||||
|
|
|
@ -476,7 +476,8 @@ ges_uri_clip_asset_new (const gchar * uri, GCancellable * cancellable,
|
||||||
* Creates a #GESUriClipAsset for @uri syncronously. You should avoid
|
* Creates a #GESUriClipAsset for @uri syncronously. You should avoid
|
||||||
* to use it in application, and rather create #GESUriClipAsset asynchronously
|
* to use it in application, and rather create #GESUriClipAsset asynchronously
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): A reference to the requested asset or %NULL if an error happend
|
* Returns: (transfer none) (nullable): A reference to the requested asset or
|
||||||
|
* %NULL if an error happened
|
||||||
*/
|
*/
|
||||||
GESUriClipAsset *
|
GESUriClipAsset *
|
||||||
ges_uri_clip_asset_request_sync (const gchar * uri, GError ** error)
|
ges_uri_clip_asset_request_sync (const gchar * uri, GError ** error)
|
||||||
|
|
|
@ -517,8 +517,8 @@ ges_uri_clip_create_track_element (GESClip * clip, GESTrackType type)
|
||||||
*
|
*
|
||||||
* Creates a new #GESUriClip for the provided @uri.
|
* Creates a new #GESUriClip for the provided @uri.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESUriClip, or NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created #GESUriClip, or
|
||||||
* error.
|
* %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESUriClip *
|
GESUriClip *
|
||||||
ges_uri_clip_new (gchar * uri)
|
ges_uri_clip_new (gchar * uri)
|
||||||
|
|
|
@ -39,7 +39,7 @@ static GstElementFactory *compositor_factory = NULL;
|
||||||
* Creates a new #GESTimeline containing a raw audio and a
|
* Creates a new #GESTimeline containing a raw audio and a
|
||||||
* raw video track.
|
* raw video track.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESTimeline.
|
* Returns: (transfer floating): The newly created #GESTimeline.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
GESTimeline *
|
GESTimeline *
|
||||||
|
|
|
@ -130,8 +130,8 @@ ges_video_test_source_get_pattern (GESVideoTestSource * source)
|
||||||
*
|
*
|
||||||
* Creates a new #GESVideoTestSource.
|
* Creates a new #GESVideoTestSource.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESVideoTestSource, or %NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created
|
||||||
* error.
|
* #GESVideoTestSource, or %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESVideoTestSource *
|
GESVideoTestSource *
|
||||||
ges_video_test_source_new (void)
|
ges_video_test_source_new (void)
|
||||||
|
|
|
@ -133,7 +133,7 @@ ges_video_track_class_init (GESVideoTrackClass * klass)
|
||||||
* Creates a new #GESVideoTrack of type #GES_TRACK_TYPE_VIDEO and with generic
|
* Creates a new #GESVideoTrack of type #GES_TRACK_TYPE_VIDEO and with generic
|
||||||
* raw video caps ("video/x-raw");
|
* raw video caps ("video/x-raw");
|
||||||
*
|
*
|
||||||
* Returns: A new #GESTrack.
|
* Returns: (transfer floating): A new #GESTrack.
|
||||||
*/
|
*/
|
||||||
GESVideoTrack *
|
GESVideoTrack *
|
||||||
ges_video_track_new (void)
|
ges_video_track_new (void)
|
||||||
|
|
|
@ -649,8 +649,8 @@ ges_video_transition_get_transition_type (GESVideoTransition * trans)
|
||||||
*
|
*
|
||||||
* Creates a new #GESVideoTransition.
|
* Creates a new #GESVideoTransition.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESVideoTransition, or %NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created
|
||||||
* error.
|
* #GESVideoTransition, or %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESVideoTransition *
|
GESVideoTransition *
|
||||||
ges_video_transition_new (void)
|
ges_video_transition_new (void)
|
||||||
|
|
|
@ -186,8 +186,8 @@ ges_video_uri_source_init (GESVideoUriSource * self)
|
||||||
*
|
*
|
||||||
* Creates a new #GESVideoUriSource for the provided @uri.
|
* Creates a new #GESVideoUriSource for the provided @uri.
|
||||||
*
|
*
|
||||||
* Returns: The newly created #GESVideoUriSource, or %NULL if there was an
|
* Returns: (transfer floating) (nullable): The newly created #GESVideoUriSource,
|
||||||
* error.
|
* or %NULL if there was an error.
|
||||||
*/
|
*/
|
||||||
GESVideoUriSource *
|
GESVideoUriSource *
|
||||||
ges_video_uri_source_new (gchar * uri)
|
ges_video_uri_source_new (gchar * uri)
|
||||||
|
|
Loading…
Reference in a new issue