Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>
/**
* ges_asset_extract:
* @self: The #GESAsset to extract an object from
- * @error: (allow-none): An error to be set in case something goes wrong,
+ * @error: (optional): An error to be set in case something goes wrong,
* or %NULL to ignore
*
* Extracts a new #GESAsset:extractable-type object from the asset. The
* @clip: The #GESClip to split
* @position: The timeline position at which to perform the split, between
* the start and end of the clip
- * @error: (nullable): Return location for an error
+ * @error: (optional) (nullable): Return location for an error
*
* Splits a clip at the given timeline position into two clips. The clip
* must already have a #GESClip:layer.
*
* Returns: (transfer none) (nullable): The newly created clip resulting
* from the splitting @clip, or %NULL if @clip can't be split.
+ *
* Since: 1.18
*/
GESClip *
* clip, but this method is not intended to be used to create the core
* elements of the clip.
*
- * Returns: (transfer none)(allow-none): The newly created element, or
+ * Returns: (transfer none) (nullable): The newly created element, or
* %NULL if an error occurred.
*/
/* FIXME: this is not used elsewhere in the GES library */
* @clip: A #GESClip
* @child: A child of @clip
* @track: The track to add @child to
- * @error: (nullable): Return location for an error
+ * @error: (optional) (nullable): Return location for an error
*
* Adds the track element child of the clip to a specific track.
*
/**
* ges_container_group:
- * @containers: (transfer none)(element-type GESContainer) (allow-none):
+ * @containers: (transfer none) (element-type GESContainer) (nullable):
* The #GESContainer-s to group
*
* Groups the containers into a single container by merging them. The
* elements is not a #GESClip, this method will try to create a #GESGroup
* instead.
*
- * Returns: (transfer floating): The container created by merging
+ * Returns: (transfer floating) (nullable): The container created by merging
* @containers, or %NULL if they could not be merged into a single
* container.
*/
*
* See ges_layer_add_asset_full(), which also gives an error.
*
- * Returns: (transfer none): The newly created clip.
+ * Returns: (transfer none) (nullable): The newly created clip.
*/
GESClip *
ges_layer_add_asset (GESLayer * layer,
*
* Serializes the set metadata fields of the meta container to a string.
*
- * Returns: (transfer full): A serialized @container, or %NULL if an error
- * occurred.
+ * Returns: (transfer full): A serialized @container.
*/
gchar *
ges_meta_container_metas_to_string (GESMetaContainer * container)
* container. If the field does not have a set value, or it is of the
* wrong type, the method will fail.
*
- * Returns: (transfer none): The string value under @meta_item, or %NULL
+ * Returns: (transfer none) (nullable): The string value under @meta_item, or %NULL
* if it could not be fetched.
*/
const gchar *
*
* Gets the current value of the specified field of the meta container.
*
- * Returns: (transfer none): The value under @key, or %NULL if @container
+ * Returns: (transfer none) (nullable): The value under @key, or %NULL if @container
* does not have the field set.
*/
const GValue *
* container. If the field does not have a set value, or it is of the
* wrong type, the method will fail.
*
- * Returns: (transfer full): A copy of the marker list value under @key,
+ * Returns: (transfer full) (nullable): A copy of the marker list value under @key,
* or %NULL if it could not be fetched.
* Since: 1.18
*/
* ges_meta_container_get_date:
* @container: A #GESMetaContainer
* @meta_item: The key for the @container field to get
- * @dest: (out): Destination into which the value under @meta_item
+ * @dest: (out) (optional) (transfer full): Destination into which the value under @meta_item
* should be copied.
*
* Gets the current date value of the specified field of the meta
* ges_meta_container_get_date_time:
* @container: A #GESMetaContainer
* @meta_item: The key for the @container field to get
- * @dest: (out): Destination into which the value under @meta_item
+ * @dest: (out) (optional) (transfer full): Destination into which the value under @meta_item
* should be copied.
*
* Gets the current date time value of the specified field of the meta
* the image is used. You can retrieve these caps from the returned sample
* with gst_sample_get_caps().
*
- * Returns: (transfer full): A sample of @self's current image preview in
+ * Returns: (transfer full) (nullable): A sample of @self's current image preview in
* the format given by @caps, or %NULL if an error prevented fetching the
* sample.
*/
* native size
* @format: The desired mime type (for example, "image/jpeg")
* @location: The path to save the thumbnail to
- * @error: (out) (allow-none) (transfer full): An error to be set in case
+ * @error: (out) (optional) (transfer full): An error to be set in case
* something goes wrong, or %NULL to ignore
*
* Saves the currently displayed image of the pipeline in preview to the
*
* See ges_pipeline_get_thumbnail().
*
- * Returns: (transfer full): A sample of @self's current image preview in
+ * Returns: (transfer full) (nullable): A sample of @self's current image preview in
* the "RGB" format, scaled to @width and @height, or %NULL if an error
* prevented fetching the sample.
*/
*
* Gets the #GESPipeline:video-sink of the pipeline.
*
- * Returns: (transfer full): The video sink used by @self for preview.
+ * Returns: (transfer full) (nullable): The video sink used by @self for preview.
*/
GstElement *
ges_pipeline_preview_get_video_sink (GESPipeline * self)
/**
* ges_pipeline_preview_set_video_sink:
* @self: A #GESPipeline in #GST_STATE_NULL
- * @sink: (transfer none): A video sink for @self to use for preview
+ * @sink: (transfer none) (nullable): A video sink for @self to use for preview
*
* Sets the #GESPipeline:video-sink of the pipeline.
*/
*
* Gets the #GESPipeline:audio-sink of the pipeline.
*
- * Returns: (transfer full): The audio sink used by @self for preview.
+ * Returns: (transfer full) (nullable): The audio sink used by @self for preview.
*/
GstElement *
ges_pipeline_preview_get_audio_sink (GESPipeline * self)
/**
* ges_pipeline_preview_set_audio_sink:
* @self: A #GESPipeline in #GST_STATE_NULL
- * @sink: (transfer none): A audio sink for @self to use for preview
+ * @sink: (transfer none) (nullable): A audio sink for @self to use for preview
*
* Sets the #GESPipeline:audio-sink of the pipeline.
*/
* }
* ]|
*
- * Returns: (transfer full) (allow-none): The new URI of @wrong_asset
+ * Returns: (transfer full) (nullable): The new URI of @wrong_asset
*/
_signals[MISSING_URI_SIGNAL] =
g_signal_new ("missing-uri", G_TYPE_FROM_CLASS (klass),
* @extractable_type: The extractable_type of the asset
* to retrieve from @object
*
- * Returns: (transfer full) (allow-none): The #GESAsset with
+ * Returns: (transfer full) (nullable): The #GESAsset with
* @id or %NULL if no asset with @id as an ID
*/
GESAsset *
*
* Get the last buffer @playsink showed
*
- * Returns: (transfer full): A #GstSample containing the last frame from
+ * Returns: (transfer full) (nullable): A #GstSample containing the last frame from
* @playsink in the format defined by the @caps
*
* Deprecated: 1.18: Use the "convert-sample" action signal of
/**
* ges_text_overlay_clip_set_text:
* @self: the #GESTextOverlayClip* to set text on
- * @text: the text to render. an internal copy of this text will be
+ * @text: (nullable): the text to render. an internal copy of this text will be
* made.
*
* Sets the text this clip will render.
/**
* ges_text_overlay_clip_set_font_desc:
* @self: the #GESTextOverlayClip*
- * @font_desc: the pango font description
+ * @font_desc: (nullable): the pango font description
*
* Sets the pango font description of the text
*
*
* Get the text currently set on @self.
*
- * Returns: The text currently set on @self.
+ * Returns: (nullable): The text currently set on @self.
*
*/
const gchar *
*
* Get the pango font description used by @self.
*
- * Returns: The pango font description used by @self.
+ * Returns: (nullable): The pango font description used by @self.
*/
const char *
ges_text_overlay_clip_get_font_desc (GESTextOverlayClip * self)
/**
* ges_text_overlay_set_text:
* @self: the #GESTextOverlay* to set text on
- * @text: the text to render. an internal copy of this text will be
+ * @text: (nullable): the text to render. an internal copy of this text will be
* made.
*
* Sets the text this track element will render.
/**
* ges_text_overlay_set_font_desc:
* @self: the #GESTextOverlay
- * @font_desc: the pango font description
+ * @font_desc: (nullable): the pango font description
*
* Sets the pango font description of the text this track element
* will render.
*
* Get the text currently set on @source.
*
- * Returns: The text currently set on @source.
+ * Returns: (nullable): The text currently set on @source.
*/
const gchar *
ges_text_overlay_get_text (GESTextOverlay * self)
*
* Get the pango font description currently set on @source.
*
- * Returns: The pango font description currently set on @source.
+ * Returns: (nullable): The pango font description currently set on @source.
*/
const char *
ges_text_overlay_get_font_desc (GESTextOverlay * self)
* @self, but should be thought of as an intermediate object used for a
* single paste operation.
*
- * Returns: (transfer floating): The newly create element,
- * copied from @self.
+ * Returns: (transfer floating): The newly create element, copied from @self.
*/
G_GNUC_BEGIN_IGNORE_DEPRECATIONS; /* Start ignoring GParameter deprecation */
GESTimelineElement *
*
* Gets the #GESTimelineElement:name for the element.
*
- * Returns: (transfer full): The name of @self.
+ * Returns: (transfer full) (nullable): The name of @self.
*/
gchar *
ges_timeline_element_get_name (GESTimelineElement * self)
/**
* ges_timeline_element_set_name:
* @self: A #GESTimelineElement
- * @name: (allow-none): The name @self should take
+ * @name: (nullable): The name @self should take
*
* Sets the #GESTimelineElement:name for the element. If %NULL is given
* for @name, then the library will instead generate a new name based on
* @edge: The edge of @self where the edit should occur
* @position: The edit position: a new location for the edge of @self
* (in nanoseconds) in the timeline coordinates
- * @error: (nullable): Return location for an error
+ * @error: (optional): Return location for an error
*
* Edits the element within its timeline by adjusting its
* #GESTimelineElement:start, #GESTimelineElement:duration or
* Simplified version of #GESTimeline::select-tracks-for-object which only
* allows @track_element to be added to a single #GESTrack.
*
- * Returns: (transfer full): A track to put @track_element into, or %NULL if
+ * Returns: (transfer full) (nullable): A track to put @track_element into, or %NULL if
* it should be discarded.
*
* Since: 1.18
/**
* ges_timeline_new_from_uri:
* @uri: The URI to load from
- * @error: (out) (allow-none): An error to be set if loading fails, or
+ * @error: (out) (optional): An error to be set if loading fails, or
* %NULL to ignore
*
* Creates a timeline from the given URI.
*
- * Returns: (transfer floating) (nullable): A new timeline if the uri was loaded
+ * Returns: (transfer floating): A new timeline if the uri was loaded
* successfully, or %NULL if the uri could not be loaded.
*/
GESTimeline *
/**
* ges_title_clip_set_text:
* @self: the #GESTitleClip* to set text on
- * @text: the text to render. an internal copy of this text will be
+ * @text: (nullable): the text to render. an internal copy of this text will be
* made.
*
* Sets the text this clip will render.
/**
* ges_title_clip_set_font_desc:
* @self: the #GESTitleClip*
- * @font_desc: the pango font description
+ * @font_desc: (nullable): the pango font description
*
* Sets the pango font description of the text.
*
*
* Get the text currently set on @self.
*
- * Returns: The text currently set on @self.
+ * Returns: (transfer full) (nullable): The text currently set on @self.
*
* Deprecated:1.6: use #ges_timeline_element_get_children_properties instead.
* See #GESTitleSource for more information about exposed properties
*
* Get the pango font description used by @self.
*
- * Returns: The pango font description used by @self.
+ * Returns: (transfer full) (nullable): The pango font description used by @self.
*
* Deprecated:1.6: use #ges_timeline_element_get_children_properties instead.
* See #GESTitleSource for more information about exposed properties
/**
* ges_title_source_set_text:
* @self: the #GESTitleSource* to set text on
- * @text: the text to render. an internal copy of this text will be
+ * @text: (nullable): the text to render. an internal copy of this text will be
* made.
*
* Sets the text this track element will render.
/**
* ges_title_source_set_font_desc:
* @self: the #GESTitleSource
- * @font_desc: the pango font description
+ * @font_desc: (nullable): the pango font description
*
* Set the pango font description this source will use to render
* the text.
*
* Get the text currently set on the @source.
*
- * Returns: (transfer full): The text currently set on the @source.
+ * Returns: (transfer full) (nullable): The text currently set on the @source.
*
* Deprecated: 1.16: Use ges_timeline_element_get_child_property instead
* (this actually returns a newly allocated string)
*
* Get the pango font description used by @source.
*
- * Returns: (transfer full): The pango font description used by this
+ * Returns: (transfer full) (nullable): The pango font description used by this
* @source.
*
* Deprecated: 1.16: Use ges_timeline_element_get_child_property instead
* Get the #GstElement that the track element's underlying nleobject
* controls.
*
- * Returns: (transfer none): The #GstElement being controlled by the
+ * Returns: (transfer none) (nullable): The #GstElement being controlled by the
* nleobject that @object wraps.
*/
GstElement *
*
* Get the #GESTrack:caps of the track.
*
- * Returns: The caps of @track.
+ * Returns: (nullable): The caps of @track.
*/
const GstCaps *
ges_track_get_caps (GESTrack * track)
*
* Gets the #GESTrack:restriction-caps of the track.
*
- * Returns: (transfer full): The restriction-caps of @track.
+ * Returns: (transfer full) (nullable): The restriction-caps of @track.
*
* Since: 1.18
*/
* Creates a new timeline containing a single #GESAudioTrack and a
* single #GESVideoTrack.
*
- * Returns: (transfer floating): The new timeline, or %NULL if the tracks
- * could not be created and added.
+ * Returns: (transfer floating): The new timeline.
*/
GESTimeline *