Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3261>
/**
* ges_asset_extract:
* @self: The #GESAsset to extract an object from
- * @error: (optional): An error to be set in case something goes wrong,
+ * @error: 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
/**
* ges_asset_request_finish:
* @res: The task result to fetch the asset from
- * @error: (out) (allow-none) (transfer full): An error to be set in case
- * something goes wrong, or %NULL to ignore
+ * @error: An error to be set in case something goes wrong, or %NULL to ignore
*
* Fetches an asset requested by ges_asset_request_async(), which
* finalises the request.
* @clip: The #GESClip to split
* @position: The timeline position at which to perform the split, between
* the start and end of the clip
- * @error: (optional) (nullable): Return location for an error
+ * @error: Return location for an error
*
* Splits a clip at the given timeline position into two clips. The clip
* must already have a #GESClip:layer.
* @clip: A #GESClip
* @child: A child of @clip
* @track: The track to add @child to
- * @error: (optional) (nullable): Return location for an error
+ * @error: Return location for an error
*
* Adds the track element child of the clip to a specific track.
*
* @formatter: a #GESFormatter
* @timeline: a #GESTimeline
* @uri: the URI to load from
- * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
+ * @error: An error to be set in case something wrong happens or %NULL
*
* Virtual method for loading a timeline from a given URI.
*
* @timeline: a #GESTimeline
* @uri: the URI to save to
* @overwrite: Whether the file should be overwritten in case it exists
- * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
+ * @error: An error to be set in case something wrong happens or %NULL
*
* Virtual method for saving a timeline to a uri.
*
* native size
* @format: The desired mime type (for example, "image/jpeg")
* @location: The path to save the thumbnail to
- * @error: (out) (optional) (transfer full): An error to be set in case
- * something goes wrong, or %NULL to ignore
+ * @error: 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
* given location, in the specified dimensions and format.
* from which the timeline as been loaded or default to the best formatter
* as defined in #ges_find_formatter_for_uri
* @overwrite: %TRUE to overwrite file if it exists
- * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
+ * @error: An error to be set in case something wrong happens or %NULL
*
* Save the timeline of @project to @uri. You should make sure that @timeline
* is one of the timelines that have been extracted from @project
* ges_project_load:
* @project: A #GESProject that has an @uri set already
* @timeline: A blank timeline to load @project into
- * @error: (out) (allow-none): An error to be set in case something wrong happens or %NULL
+ * @error: An error to be set in case something wrong happens or %NULL
*
* Loads @project into @timeline
*
* @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: (optional): Return location for an error
+ * @error: Return location for an error
*
* Edits the element within its timeline by adjusting its
* #GESTimelineElement:start, #GESTimelineElement:duration or
/**
* ges_timeline_new_from_uri:
* @uri: The URI to load from
- * @error: (out) (optional): An error to be set if loading fails, or
+ * @error: An error to be set if loading fails, or
* %NULL to ignore
*
* Creates a timeline from the given URI.
* ges_timeline_load_from_uri:
* @timeline: An empty #GESTimeline into which to load the formatter
* @uri: The URI to load from
- * @error: (out) (allow-none): An error to be set if loading fails, or
+ * @error: An error to be set if loading fails, or
* %NULL to ignore
*
* Loads the contents of URI into the timeline.
* @uri: The location to save to
* @formatter_asset: (allow-none): The formatter asset to use, or %NULL
* @overwrite: %TRUE to overwrite file if it exists
- * @error: (out) (allow-none): An error to be set if saving fails, or
+ * @error: An error to be set if saving fails, or
* %NULL to ignore
*
* Saves the timeline to the given location. If @formatter_asset is %NULL,
/**
* gst_transcoder_message_parse_error:
* @msg: A #GstMessage
- * @error: (out): the resulting error
- * @details: (out): (transfer none): A GstStructure containing extra details about the error
+ * @error: (out) (optional) (transfer full): the resulting error
+ * @details: (out): (transfer full): A GstStructure containing extra details about the error
*
* Parse the given error @msg and extract the corresponding #GError
*
/**
* gst_transcoder_message_parse_warning:
* @msg: A #GstMessage
- * @error: (out): the resulting warning
- * @details: (out): (transfer none): A GstStructure containing extra details about the warning
+ * @error: (out) (optional) (transfer full): the resulting warning
+ * @details: (out): (transfer full): A GstStructure containing extra details about the warning
*
* Parse the given error @msg and extract the corresponding #GError warning
*
* gst_va_memory_get_surface:
* @mem: a #GstMemory
*
- * Returns: (type guint): the VASurfaceID in @mem.
+ * Returns: (type guint) (transfer none): the VASurfaceID in @mem.
*
* Since: 1.22
*/
* gst_va_buffer_get_surface:
* @buffer: a #GstBuffer
*
- * Returns: (type guint): the VASurfaceID in @buffer.
+ * Returns: (type guint) (transfer none): the VASurfaceID in @buffer.
*
* Since: 1.22
*/
* gst_va_buffer_get_aux_surface:
* @buffer: a #GstBuffer
*
- * Returns: (type guint): the VASurfaceID attached to
+ * Returns: (type guint) (transfer none): the VASurfaceID attached to
* @buffer.
*
* Since: 1.22
/**
* gst_vulkan_error_to_g_error: (skip)
* @result: a VkResult
- * @error: (inout) (optional): a #GError to fill
+ * @error: (out) (optional) (transfer full): a #GError to fill
* @format: the printf-like format to write into the #GError
* @...: arguments for @format
*
* @display: a #GstGLDisplay
* @other_context: (transfer none): other #GstGLContext to share resources with.
* @p_context: (transfer full) (out): resulting #GstGLContext
- * @error: (optional): resulting #GError
+ * @error: resulting #GError
*
* It requires the display's object lock to be held.
*
/**
* gst_gl_shader_new_link_with_stages:
* @context: a #GstGLContext
- * @error: (optional): a #GError
+ * @error: a #GError
* @...: a NULL terminated list of #GstGLSLStage's
*
* Each stage will attempt to be compiled and attached to @shader. Then
/**
* gst_gl_shader_new_with_stages:
* @context: a #GstGLContext
- * @error: (optional): a #GError
+ * @error: a #GError
* @...: a NULL terminated list of #GstGLSLStage's
*
* Each stage will attempt to be compiled and attached to @shader. On error,
/**
* gst_gl_shader_new_default:
* @context: a #GstGLContext
- * @error: (optional): a #GError that is filled on failure
+ * @error: a #GError that is filled on failure
*
* Note: must be called in the GL thread
*
* gst_gl_shader_compile_attach_stage:
* @shader: a #GstGLShader
* @stage: a #GstGLSLStage to attach
- * @error: (optional): a #GError
+ * @error: a #GError
*
* Compiles @stage and attaches it to @shader.
*
/**
* gst_gl_shader_link:
* @shader: a #GstGLShader
- * @error: (optional): a #GError
+ * @error: a #GError
*
* Links the current list of #GstGLSLStage's in @shader.
*
* gst_discoverer_discover_uri:
* @discoverer: A #GstDiscoverer
* @uri: The URI to run on.
- * @err: (out) (optional): If an error occurred, this field will be filled in.
+ * @err: If an error occurred, this field will be filled in.
*
* Synchronously discovers the given @uri.
*
* gst_discoverer_new:
* @timeout: timeout per file, in nanoseconds. Allowed are values between
* one second (#GST_SECOND) and one hour (3600 * #GST_SECOND)
- * @err: (optional): a pointer to a #GError. can be %NULL
+ * @err: a pointer to a #GError. can be %NULL
*
* Creates a new #GstDiscoverer with the provided timeout.
*
/**
* gst_rtsp_connection_get_tls:
* @conn: a #GstRTSPConnection
- * @error: (optional): #GError for error reporting, or NULL to ignore.
+ * @error: #GError for error reporting, or NULL to ignore.
*
* Get the TLS connection of @conn.
*
* gst_rtsp_message_new_response:
* @msg: (out) (transfer full): a location for the new #GstRTSPMessage
* @code: the status code
- * @reason: (transfer none) (optional): the status reason or %NULL
- * @request: (transfer none) (optional): the request that triggered the response or %NULL
+ * @reason: (transfer none) (nullable): the status reason or %NULL
+ * @request: (transfer none) (nullable): the request that triggered the response or %NULL
*
* Create a new response #GstRTSPMessage with @code and @reason and store the
* result message in @msg. Free with gst_rtsp_message_free().
* gst_rtsp_message_init_response:
* @msg: (out caller-allocates): a #GstRTSPMessage
* @code: the status code
- * @reason: (transfer none) (optional): the status reason or %NULL
- * @request: (transfer none) (optional): the request that triggered the response or %NULL
+ * @reason: (transfer none) (nullable): the status reason or %NULL
+ * @request: (transfer none) (nullable): the request that triggered the response or %NULL
*
* Initialize @msg with @code and @reason.
*
* gst_mikey_message_new_from_bytes:
* @bytes: a #GBytes
* @info: a #GstMIKEYDecryptInfo
- * @error: (optional): a #GError
+ * @error: a #GError
*
* Make a new #GstMIKEYMessage from @bytes.
*
* @data: (array length=size) (element-type guint8): bytes to read
* @size: length of @data
* @info: #GstMIKEYDecryptInfo
- * @error: (optional): a #GError
+ * @error: a #GError
*
* Parse @size bytes from @data into a #GstMIKEYMessage. @info contains the
* parameters to decrypt and verify the data.
* gst_rtsp_server_create_socket:
* @server: a #GstRTSPServer
* @cancellable: (allow-none): a #GCancellable
- * @error: (out): a #GError
+ * @error: a #GError
*
* Create a #GSocket for @server. The socket will listen on the
* configured service.
* gst_rtsp_server_create_source:
* @server: a #GstRTSPServer
* @cancellable: (nullable): a #GCancellable or %NULL.
- * @error: (out): a #GError
+ * @error: a #GError
*
* Create a #GSource for @server. The new source will have a default
* #GSocketSourceFunc of gst_rtsp_server_io_func().
* @type: Whether to create a source or a sink
* @uri: URI to create an element for
* @elementname: (nullable): Name of created element, can be %NULL.
- * @error: (optional): address where to store error information, or %NULL.
+ * @error: address where to store error information, or %NULL.
*
* Creates an element for handling the given URI.
*
* gst_uri_handler_set_uri:
* @handler: A #GstURIHandler
* @uri: URI to set
- * @error: (optional): address where to store a #GError in case of
+ * @error: address where to store a #GError in case of
* an error, or %NULL
*
* Tries to set the URI of the given handler.
/**
* gst_net_time_packet_new:
- * @buffer: (array zero-terminated="0" fixed-size="16") (nullable): a buffer from which to construct the packet, or NULL
+ * @buffer: (array zero-terminated=0 fixed-size=16) (nullable): a buffer from which to construct the packet, or NULL
*
* Creates a new #GstNetTimePacket from a buffer received over the network. The
* caller is responsible for ensuring that @buffer is at least
*
* MT safe. Caller owns return value (g_free to free).
*
- * Returns: (transfer full) (array zero-terminated="0" fixed-size="16"): A newly allocated sequence of #GST_NET_TIME_PACKET_SIZE bytes.
+ * Returns: (transfer full) (array zero-terminated=0 fixed-size=16): A newly allocated sequence of #GST_NET_TIME_PACKET_SIZE bytes.
*/
guint8 *
gst_net_time_packet_serialize (const GstNetTimePacket * packet)
/**
* gst_ntp_packet_new:
- * @buffer: (array zero-terminated="0" fixed-size="48"): a buffer from which to construct the packet, or NULL
+ * @buffer: (array zero-terminated=0 fixed-size=48): a buffer from which to construct the packet, or NULL
* @error: a #GError
*
* Creates a new #GstNtpPacket from a buffer received over the network. The
*
* MT safe. Caller owns return value (g_free to free).
*
- * Returns: (transfer full) (array zero-terminated="0" fixed-size="48"): A newly allocated sequence of #GST_NTP_PACKET_SIZE bytes.
+ * Returns: (transfer full) (array zero-terminated=0 fixed-size=48): A newly allocated sequence of #GST_NTP_PACKET_SIZE bytes.
*/
guint8 *
gst_ntp_packet_serialize (const GstNtpPacket * packet)