Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>
*
* Looks up the GStreamer tag for a ID3v2 tag.
*
- * Returns: The corresponding GStreamer tag or NULL if none exists.
+ * Returns: (nullable): The corresponding GStreamer tag or NULL if none exists.
*/
const gchar *
gst_tag_from_id3_tag (const gchar * id3_tag)
* Looks up the GStreamer tag for an ID3v2 user tag (e.g. description in
* TXXX frame or owner in UFID frame).
*
- * Returns: The corresponding GStreamer tag or NULL if none exists.
+ * Returns: (nullable): The corresponding GStreamer tag or NULL if none exists.
*/
const gchar *
gst_tag_from_id3_user_tag (const gchar * type, const gchar * id3_user_tag)
*
* Looks up the ID3v2 tag for a GStreamer tag.
*
- * Returns: The corresponding ID3v2 tag or NULL if none exists.
+ * Returns: (nullable): The corresponding ID3v2 tag or NULL if none exists.
*/
const gchar *
gst_tag_to_id3_tag (const gchar * gst_tag)
* Parses the data containing an ID3v1 tag and returns a #GstTagList from the
* parsed data.
*
- * Returns: A new tag list or NULL if the data was not an ID3v1 tag.
+ * Returns: (transfer full) (nullable): A new tag list or NULL if the data was not an ID3v1 tag.
*/
GstTagList *
gst_tag_list_new_from_id3v1 (const guint8 * data)
*
* Gets the ID3v1 genre name for a given ID.
*
- * Returns: the genre or NULL if no genre is associated with that ID.
+ * Returns: (nullable): the genre or NULL if no genre is associated with that ID.
*/
const gchar *
gst_tag_id3_genre_get (const guint id)
*
* Looks up the GStreamer tag for a vorbiscomment tag.
*
- * Returns: The corresponding GStreamer tag or NULL if none exists.
+ * Returns: (nullable): The corresponding GStreamer tag or NULL if none exists.
*/
const gchar *
gst_tag_from_vorbis_tag (const gchar * vorbis_tag)
*
* Looks up the vorbiscomment tag for a GStreamer tag.
*
- * Returns: The corresponding vorbiscomment tag or NULL if none exists.
+ * Returns: (nullable): The corresponding vorbiscomment tag or NULL if none exists.
*/
const gchar *
gst_tag_to_vorbis_tag (const gchar * gst_tag)
* Creates a new tag list that contains the information parsed out of a
* vorbiscomment packet.
*
- * Returns: A new #GstTagList with all tags that could be extracted from the
+ * Returns: (transfer full) (nullable): A new #GstTagList with all tags that could be extracted from the
* given vorbiscomment buffer or NULL on error.
*/
GstTagList *
* Creates a new tag list that contains the information parsed out of a
* vorbiscomment packet.
*
- * Returns: A new #GstTagList with all tags that could be extracted from the
+ * Returns: (transfer full) (nullable): A new #GstTagList with all tags that could be extracted from the
* given vorbiscomment buffer or NULL on error.
*/
GstTagList *
*
* Creates a new vorbiscomment buffer from a tag list.
*
- * Returns: A new #GstBuffer containing a vorbiscomment buffer with all tags
+ * Returns: (transfer full): A new #GstBuffer containing a vorbiscomment buffer with all tags
* that could be converted from the given tag list.
*/
GstBuffer *
*
* Gets the list of supported schemas in the xmp lib
*
- * Returns: (transfer none): a %NULL terminated array of strings with the
+ * Returns: (transfer none) (array zero-terminated=1): a %NULL terminated array of strings with the
* schema names
*/
const gchar **
*
* Parse a xmp packet into a taglist.
*
- * Returns: new taglist or %NULL, free the list when done
+ * Returns: (transfer full) (nullable): new taglist or %NULL, free the list when done
*/
GstTagList *
gst_tag_list_from_xmp_buffer (GstBuffer * buffer)
* gst_tag_list_to_xmp_buffer:
* @list: tags
* @read_only: does the container forbid inplace editing
- * @schemas: (array zero-terminated):
+ * @schemas: (array zero-terminated=1):
* %NULL terminated array of schemas to be used on serialization
*
* Formats a taglist as a xmp packet using only the selected
* schemas. An empty list (%NULL) means that all schemas should
* be used
*
- * Returns: new buffer or %NULL, unref the buffer when done
+ * Returns: (transfer full) (nullable): new buffer or %NULL, unref the buffer when done
*/
GstBuffer *
gst_tag_list_to_xmp_buffer (const GstTagList * list, gboolean read_only,
* Creates a new tag list that contains the information parsed out of a
* ID3 tag.
*
- * Returns: A new #GstTagList with all tags that could be extracted from the
+ * Returns: (transfer full) (nullable): A new #GstTagList with all tags that could be extracted from the
* given vorbiscomment buffer or NULL on error.
*/
GstTagList *
* tagging purposes (e.g. to tag an audio track appropriately in a video or
* audio editor).
*
- * Returns: (transfer full): NULL-terminated string array with two-letter
+ * Returns: (transfer full) (array zero-terminated=1): NULL-terminated string array with two-letter
* language codes. Free with g_strfreev() when no longer needed.
*/
gchar **
*
* Language codes are case-sensitive and expected to be lower case.
*
- * Returns: language name in UTF-8 format, or NULL if @language_code could
+ * Returns: (nullable): language name in UTF-8 format, or NULL if @language_code could
* not be mapped to a language name. The returned string must not be
* modified and does not need to freed; it will stay valid until the
* application is terminated.
*
* Language codes are case-sensitive and expected to be lower case.
*
- * Returns: two-letter ISO-639-1 language code string that maps to @lang_code,
+ * Returns: (nullable): two-letter ISO-639-1 language code string that maps to @lang_code,
* or NULL if no mapping is known. The returned string must not be
* modified or freed.
*/
*
* Language codes are case-sensitive and expected to be lower case.
*
- * Returns: three-letter ISO-639-2 language code string that maps to @lang_code,
+ * Returns: (nullable): three-letter ISO-639-2 language code string that maps to @lang_code,
* or NULL if no mapping is known. The returned string must not be
* modified or freed.
*/
*
* Language codes are case-sensitive and expected to be lower case.
*
- * Returns: three-letter ISO-639-2 language code string that maps to @lang_code,
+ * Returns: (nullable): three-letter ISO-639-2 language code string that maps to @lang_code,
* or NULL if no mapping is known. The returned string must not be
* modified or freed.
*/
* (e.g. to tag an audio track appropriately in a video or audio editor, or
* an image in a camera application).
*
- * Returns: (transfer full): NULL-terminated array of license strings. Free
+ * Returns: (transfer full) (array zero-terminated=1): NULL-terminated array of license strings. Free
* with g_strfreev() when no longer needed.
*/
gchar **
* Get the nick name of a license, which is a short (untranslated) string
* such as e.g. "CC BY-NC-ND 2.0 UK".
*
- * Returns: the nick name of the license, or NULL if the license is unknown
+ * Returns: (nullable): the nick name of the license, or NULL if the license is unknown
*/
const gchar *
gst_tag_get_license_nick (const gchar * license_ref)
* Get the title of a license, which is a short translated description
* of the license's features (generally not very pretty though).
*
- * Returns: the title of the license, or NULL if the license is unknown or
+ * Returns: (nullable): the title of the license, or NULL if the license is unknown or
* no title is available.
*/
const gchar *
* Get the description of a license, which is a translated description
* of the license's main features.
*
- * Returns: the description of the license, or NULL if the license is unknown
+ * Returns: (nullable): the description of the license, or NULL if the license is unknown
* or a description is not available.
*/
const gchar *
* dk, es, fi, fr, hr, hu, il, in, it, jp, kr, mk, mt, mx, my, nl, pe, pl,
* pt, scotland, se, si, tw, uk, us, za.
*
- * Returns: the jurisdiction code of the license, or NULL if the license is
+ * Returns: (nullable): the jurisdiction code of the license, or NULL if the license is
* unknown or is not specific to a particular jurisdiction.
*/
const gchar *
*
* Get the version of a license.
*
- * Returns: the version of the license, or NULL if the license is not known or
+ * Returns: (nullable): the version of the license, or NULL if the license is not known or
* has no version
*/
const gchar *
* are specified, the current locale will be tried. If that also doesn't work,
* WINDOWS-1252/ISO-8859-1 is assumed (which will almost always succeed).
*
- * Returns: a newly-allocated string in UTF-8 encoding, or NULL
+ * Returns: (nullable): a newly-allocated string in UTF-8 encoding, or NULL
*/
gchar *
gst_tag_freeform_string_to_utf8 (const gchar * data, gint size,
* This function will do various checks and typefind the encoded image
* data (we can't trust the declared mime type).
*
- * Returns: a newly-allocated image sample for use in tag lists, or NULL
+ * Returns: (transfer full) (nullable): a newly-allocated image sample for use in tag lists, or NULL
*/
GstSample *
gst_tag_image_data_to_image_sample (const guint8 * image_data,
projects / platform / upstream / gstreamer.git / commitdiff