Gst-1.0 ▶ Gst ▶ TagList

constructor

• new TagList(properties?: Partial<{ mini_object: MiniObject }>): TagList

  Parameters

  • Optionalproperties: Partial<{ mini_object: MiniObject }>

  Returns TagList

Static$gtype

add_value

• add_value(mode: Gst.TagMergeMode, tag: string, value: any): void

  Sets the GValue for a given tag using the specified mode.

  Parameters

  • mode: Gst.TagMergeMode

    the mode to use

  • tag: string

    tag

  • value: any

    GValue for this tag

  Returns void

copy

• copy(): TagList

  Creates a new Gst.TagList as a copy of the old taglist. The new taglist will have a refcount of 1, owned by the caller, and will be writable as a result.

  Note that this function is the semantic equivalent of a gst_tag_list_ref() followed by a gst_tag_list_make_writable(). If you only want to hold on to a reference to the data, you should use gst_tag_list_ref().

  When you are finished with the taglist, call gst_tag_list_unref() on it.

  Returns TagList

  the new Gst.TagList

foreach

• foreach(func: TagForeachFunc): void

  Calls the given function for each tag inside the tag list. Note that if there is no tag, the function won't be called at all.

  Parameters

  • func: TagForeachFunc

    function to be called for each tag

  Returns void

get_boolean

• get_boolean(tag: string): [boolean, boolean]

  Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, boolean]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_boolean_index

• get_boolean_index(tag: string, index: number): [boolean, boolean]

  Gets the value that is at the given index for the given tag in the given list.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, boolean]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_date

• get_date(tag: string): [boolean, GLib.Date]

  Copies the first date for the given tag in the taglist into the variable pointed to by value. Free the date with g_date_free() when it is no longer needed.

  Free-function: g_date_free

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, GLib.Date]

  true, if a date was copied, false if the tag didn't exist in the given list or if it was null.

get_date_index

• get_date_index(tag: string, index: number): [boolean, GLib.Date]

  Gets the date that is at the given index for the given tag in the given list and copies it into the variable pointed to by value. Free the date with g_date_free() when it is no longer needed.

  Free-function: g_date_free

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, GLib.Date]

  true, if a value was copied, false if the tag didn't exist in the given list or if it was null.

get_date_time

• get_date_time(tag: string): [boolean, Gst.DateTime]

  Copies the first datetime for the given tag in the taglist into the variable pointed to by value. Unref the date with gst_date_time_unref() when it is no longer needed.

  Free-function: gst_date_time_unref

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, Gst.DateTime]

  true, if a datetime was copied, false if the tag didn't exist in the given list or if it was null.

get_date_time_index

• get_date_time_index(tag: string, index: number): [boolean, Gst.DateTime]

  Gets the datetime that is at the given index for the given tag in the given list and copies it into the variable pointed to by value. Unref the datetime with gst_date_time_unref() when it is no longer needed.

  Free-function: gst_date_time_unref

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, Gst.DateTime]

  true, if a value was copied, false if the tag didn't exist in the given list or if it was null.

get_double

• get_double(tag: string): [boolean, number]

  Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_double_index

• get_double_index(tag: string, index: number): [boolean, number]

  Gets the value that is at the given index for the given tag in the given list.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_float

• get_float(tag: string): [boolean, number]

  Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_float_index

• get_float_index(tag: string, index: number): [boolean, number]

  Gets the value that is at the given index for the given tag in the given list.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_int

• get_int(tag: string): [boolean, number]

  Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_int_index

• get_int_index(tag: string, index: number): [boolean, number]

  Gets the value that is at the given index for the given tag in the given list.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_int64

• get_int64(tag: string): [boolean, number]

  Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_int64_index

• get_int64_index(tag: string, index: number): [boolean, number]

  Gets the value that is at the given index for the given tag in the given list.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_pointer

• get_pointer(tag: string): [boolean, any]

  Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, any]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_pointer_index

• get_pointer_index(tag: string, index: number): [boolean, any]

  Gets the value that is at the given index for the given tag in the given list.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, any]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_sample

• get_sample(tag: string): [boolean, Sample]

  Copies the first sample for the given tag in the taglist into the variable pointed to by sample. Free the sample with gst_sample_unref() when it is no longer needed. You can retrieve the buffer from the sample using gst_sample_get_buffer() and the associated caps (if any) with gst_sample_get_caps().

  Free-function: gst_sample_unref

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, Sample]

  true, if a sample was returned, false if the tag didn't exist in the given list or if it was null.

get_sample_index

• get_sample_index(tag: string, index: number): [boolean, Sample]

  Gets the sample that is at the given index for the given tag in the given list and copies it into the variable pointed to by sample. Free the sample with gst_sample_unref() when it is no longer needed. You can retrieve the buffer from the sample using gst_sample_get_buffer() and the associated caps (if any) with gst_sample_get_caps().

  Free-function: gst_sample_unref

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, Sample]

  true, if a sample was copied, false if the tag didn't exist in the given list or if it was null.

get_scope

• get_scope(): Gst.TagScope

  Gets the scope of list.

  Returns Gst.TagScope

  The scope of list

get_string

• get_string(tag: string): [boolean, string]

  Copies the contents for the given tag into the value, possibly merging multiple values into one if multiple values are associated with the tag.

  Use gst_tag_list_get_string_index (list, tag, 0, value) if you want to retrieve the first string associated with this tag unmodified.

  The resulting string in value will be in UTF-8 encoding and should be freed by the caller using g_free when no longer needed. The returned string is also guaranteed to be non-null and non-empty.

  Free-function: g_free

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, string]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_string_index

• get_string_index(tag: string, index: number): [boolean, string]

  Gets the value that is at the given index for the given tag in the given list.

  The resulting string in value will be in UTF-8 encoding and should be freed by the caller using g_free when no longer needed. The returned string is also guaranteed to be non-null and non-empty.

  Free-function: g_free

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, string]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_tag_size

• get_tag_size(tag: string): number

  Checks how many value are stored in this tag list for the given tag.

  Parameters

  • tag: string

    the tag to query

  Returns number

  The number of tags stored

get_uint

• get_uint(tag: string): [boolean, number]

  Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_uint_index

• get_uint_index(tag: string, index: number): [boolean, number]

  Gets the value that is at the given index for the given tag in the given list.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_uint64

• get_uint64(tag: string): [boolean, number]

  Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.

  Parameters

  • tag: string

    tag to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_uint64_index

• get_uint64_index(tag: string, index: number): [boolean, number]

  Gets the value that is at the given index for the given tag in the given list.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, number]

  true, if a value was copied, false if the tag didn't exist in the given list.

get_value_index

• get_value_index(tag: string, index: number): GObject.Value | null

  Gets the value that is at the given index for the given tag in the given list.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns GObject.Value | null

  The GValue for the specified entry or null if the tag wasn't available or the tag doesn't have as many entries

insert

• insert(from: TagList, mode: Gst.TagMergeMode): void

  Inserts the tags of the from list into the first list using the given mode.

  Parameters

  • from: TagList

    list to merge from

  • mode: Gst.TagMergeMode

    the mode to use

  Returns void

is_empty

• is_empty(): boolean

  Checks if the given taglist is empty.

  Returns boolean

  true if the taglist is empty, otherwise false.

is_equal

• is_equal(list2: TagList): boolean

  Checks if the two given taglists are equal.

  Parameters

  • list2: TagList

    a Gst.TagList.

  Returns boolean

  true if the taglists are equal, otherwise false

is_writable

• is_writable(): boolean

  Tests if you can safely modify taglist. It is only safe to modify taglist when there is only one owner of the taglist - ie, the object is writable.

  Returns boolean

make_writable

• make_writable(): TagList

  Returns a writable copy of taglist.

  If there is only one reference count on taglist, the caller must be the owner, and so this function will return the taglist object unchanged. If on the other hand there is more than one reference on the object, a new taglist object will be returned. The caller's reference on taglist will be removed, and instead the caller will own a reference to the returned object.

  In short, this function unrefs the taglist in the argument and refs the taglist that it returns. Don't access the argument after calling this function. See also: gst_tag_list_ref().

  Returns TagList

  a writable taglist which may or may not be the same as taglist

merge

• merge(list2: TagList | null, mode: Gst.TagMergeMode): TagList | null

  Merges the two given lists into a new list. If one of the lists is null, a copy of the other is returned. If both lists are null, null is returned.

  Free-function: gst_tag_list_unref

  Parameters

  • list2: TagList | null

    second list to merge

  • mode: Gst.TagMergeMode

    the mode to use

  Returns TagList | null

  the new list

n_tags

• n_tags(): number

  Get the number of tags in list.

  Returns number

  The number of tags in list.

nth_tag_name

• nth_tag_name(index: number): string

  Get the name of the tag in list at index.

  Parameters

  • index: number

    the index

  Returns string

  The name of the tag at index.

peek_string_index

• peek_string_index(tag: string, index: number): [boolean, string]

  Peeks at the value that is at the given index for the given tag in the given list.

  The resulting string in value will be in UTF-8 encoding and doesn't need to be freed by the caller. The returned string is also guaranteed to be non-null and non-empty.

  Parameters

  • tag: string

    tag to read out

  • index: number

    number of entry to read out

  Returns [boolean, string]

  true, if a value was set, false if the tag didn't exist in the given list.

ref

• ref(): TagList

  Add a reference to a Gst.TagList mini object.

  From this point on, until the caller calls gst_tag_list_unref() or gst_tag_list_make_writable(), it is guaranteed that the taglist object will not change. To use a Gst.TagList object, you must always have a refcount on it -- either the one made implicitly by e.g. gst_tag_list_new(), or via taking one explicitly with this function.

  Returns TagList

  the same Gst.TagList mini object.

remove_tag

• remove_tag(tag: string): void

  Removes the given tag from the taglist.

  Parameters

  • tag: string

    tag to remove

  Returns void

set_scope

• set_scope(scope: Gst.TagScope): void

  Sets the scope of list to scope. By default the scope of a taglist is stream scope.

  Parameters

  • scope: Gst.TagScope

    new scope for list

  Returns void

to_string

• to_string(): string

  Serializes a tag list to a string.

  Returns string

  a newly-allocated string. The string must be freed with g_free() when no longer needed.

unref

• unref(): void

  Unref a Gst.TagList, and and free all its memory when the refcount reaches 0.

  Returns void

Staticcopy_value

• copy_value(list: TagList, tag: string): [boolean, unknown]

  Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. You must g_value_unset() the value after use.

  Parameters

  • list: TagList

    list to get the tag from

  • tag: string

    tag to read out

  Returns [boolean, unknown]

Staticnew_empty

• new_empty(): TagList

  Returns TagList

Staticnew_from_string

• new_from_string(str: string): TagList

  Parameters

  • str: string

  Returns TagList

Staticreplace

• replace(
      old_taglist: TagList | null,
      new_taglist: TagList | null,
  ): [boolean, TagList | null]

  Modifies a pointer to a Gst.TagList to point to a different Gst.TagList. The modification is done atomically (so this is useful for ensuring thread safety in some cases), and the reference counts are updated appropriately (the old tag list is unreffed, the new is reffed).

  Either new_taglist or the Gst.TagList pointed to by old_taglist may be null.

  Parameters

  • old_taglist: TagList | null

    pointer to a pointer to a Gst.TagList to be replaced.

  • new_taglist: TagList | null

    pointer to a Gst.TagList that will replace the tag list pointed to by old_taglist.

  Returns [boolean, TagList | null]

Statictake

• take(old_taglist: TagList, new_taglist: TagList | null): [boolean, TagList]

  Modifies a pointer to a Gst.TagList to point to a different Gst.TagList. This function is similar to gst_tag_list_replace() except that it takes ownership of new_taglist.

  Parameters

  • old_taglist: TagList

    pointer to a pointer to a Gst.TagList to be replaced.

  • new_taglist: TagList | null

    pointer to a Gst.TagList that will replace the taglist pointed to by old_taglist.

  Returns [boolean, TagList]