Class TagList

List of tags and values used to describe media metadata.

Strings in structures must be ASCII or UTF-8 encoded. Other encodings are not allowed. Strings must not be empty or %NULL.

record

Hierarchy

TagList

Constructors

constructor

new TagList(): Gst.TagList

Returns Gst.TagList

Properties

mini_object

mini_object: Gst.MiniObject

the parent type

field

Static name

name: string

Methods

add_value

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23069
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(): Gst.TagList

- Defined in @types/Gjs/Gst-1.0.d.ts:23081
Creates a new #GstTagList 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 Gst.TagList

foreach

foreach(func: Gst.TagForeachFunc): void

- Defined in @types/Gjs/Gst-1.0.d.ts:23087
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: Gst.TagForeachFunc
  
  function to be called for each tag
Returns void

get_boolean

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23093
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]

get_boolean_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23100
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]

get_date

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23109
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]

get_date_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23119
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]

get_date_time

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23128
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]

get_date_time_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23138
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]

get_double

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23144
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]

get_double_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23151
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]

get_float

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23157
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]

get_float_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23164
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]

get_int

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23170
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]

get_int64

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23176
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]

get_int64_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23183
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]

get_int_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23190
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]

get_pointer

get_pointer(tag: string): [boolean, object]

- Defined in @types/Gjs/Gst-1.0.d.ts:23196
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, object]

get_pointer_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23203
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, object]

get_sample

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23214
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]

get_sample_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23226
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]

get_scope

get_scope(): TagScope

- Defined in @types/Gjs/Gst-1.0.d.ts:23230
Gets the scope of list.

Returns TagScope

get_string

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23245
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]

get_string_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23258
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]

get_tag_size

get_tag_size(tag: string): number

- Defined in @types/Gjs/Gst-1.0.d.ts:23263
Checks how many value are stored in this tag list for the given tag.

Parameters
- tag: string
  
  the tag to query
Returns number

get_uint

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23269
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]

get_uint64

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23275
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]

get_uint64_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23282
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]

get_uint_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23289
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]

get_value_index

get_value_index(tag: string, index: number): any

- Defined in @types/Gjs/Gst-1.0.d.ts:23296
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 any

insert

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23302
Inserts the tags of the from list into the first list using the given mode.

Parameters
- from: Gst.TagList
  
  list to merge from
- mode: Gst.TagMergeMode
  
  the mode to use
Returns void

is_empty

is_empty(): boolean

- Defined in @types/Gjs/Gst-1.0.d.ts:23306
Checks if the given taglist is empty.

Returns boolean

is_equal

is_equal(list2: Gst.TagList): boolean

- Defined in @types/Gjs/Gst-1.0.d.ts:23311
Checks if the two given taglists are equal.

Parameters
- list2: Gst.TagList
  
  a #GstTagList.
Returns boolean

merge

merge(list2: Gst.TagList, mode: Gst.TagMergeMode): Gst.TagList

- Defined in @types/Gjs/Gst-1.0.d.ts:23320
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: Gst.TagList
  
  second list to merge
- mode: Gst.TagMergeMode
  
  the mode to use
Returns Gst.TagList

n_tags

n_tags(): number

- Defined in @types/Gjs/Gst-1.0.d.ts:23324
Get the number of tags in list.

Returns number

nth_tag_name

nth_tag_name(index: number): string

- Defined in @types/Gjs/Gst-1.0.d.ts:23329
Get the name of the tag in list at index.

Parameters
- index: number
  
  the index
Returns string

peek_string_index

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

- Defined in @types/Gjs/Gst-1.0.d.ts:23340
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]

remove_tag

remove_tag(tag: string): void

- Defined in @types/Gjs/Gst-1.0.d.ts:23345
Removes the given tag from the taglist.

Parameters
- tag: string
  
  tag to remove
Returns void

set_scope

set_scope(scope: TagScope): void

- Defined in @types/Gjs/Gst-1.0.d.ts:23351
Sets the scope of list to scope. By default the scope of a taglist is stream scope.

Parameters
- scope: TagScope
  
  new scope for list
Returns void

to_string

to_string(): string

- Defined in @types/Gjs/Gst-1.0.d.ts:23355
Serializes a tag list to a string.

Returns string

Static copy_value

copy_value(list: Gst.TagList, tag: string): [boolean, any]

- Defined in @types/Gjs/Gst-1.0.d.ts:23394
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: Gst.TagList
  
  list to get the tag from
- tag: string
  
  tag to read out
Returns [boolean, any]

Static new_empty

new_empty(): Gst.TagList

- Defined in @types/Gjs/Gst-1.0.d.ts:23379
Creates a new empty GstTagList.

Free-function: gst_tag_list_unref

Returns Gst.TagList

Static new_from_string

new_from_string(str: string): Gst.TagList

- Defined in @types/Gjs/Gst-1.0.d.ts:23385
Deserializes a tag list.

Parameters
- str: string
  
  a string created with gst_tag_list_to_string()
Returns Gst.TagList

Static replace

replace(old_taglist: Gst.TagList, new_taglist: Gst.TagList): [boolean, Gst.TagList]

- Defined in @types/Gjs/Gst-1.0.d.ts:23406
Modifies a pointer to a #GstTagList to point to a different #GstTagList. 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 #GstTagList pointed to by old_taglist may be %NULL.

Parameters
- old_taglist: Gst.TagList
  
  pointer to a pointer to a #GstTagList to be replaced.
- new_taglist: Gst.TagList
  
  pointer to a #GstTagList that will replace the tag list pointed to by old_taglist.
Returns [boolean, Gst.TagList]

Static take

take(old_taglist: Gst.TagList, new_taglist: Gst.TagList): [boolean, Gst.TagList]

- Defined in @types/Gjs/Gst-1.0.d.ts:23414
Modifies a pointer to a #GstTagList to point to a different #GstTagList. This function is similar to gst_tag_list_replace() except that it takes ownership of new_taglist.

Parameters
- old_taglist: Gst.TagList
  
  pointer to a pointer to a #GstTagList to be replaced.
- new_taglist: Gst.TagList
  
  pointer to a #GstTagList that will replace the taglist pointed to by old_taglist.
Returns [boolean, Gst.TagList]

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Gst.TagList

Properties

mini_object

Static name

Methods

add_value

Parameters

mode: Gst.TagMergeMode

tag: string

value: any

Returns void

copy

Returns Gst.TagList

foreach

Parameters

func: Gst.TagForeachFunc

Returns void

get_boolean

Parameters

tag: string

Returns [boolean, boolean]

get_boolean_index

Parameters

tag: string

index: number

Returns [boolean, boolean]

get_date

Parameters

tag: string

Returns [boolean, GLib.Date]

get_date_index

Parameters

tag: string

index: number

Returns [boolean, GLib.Date]

get_date_time

Parameters

tag: string

Returns [boolean, Gst.DateTime]

get_date_time_index

Parameters

tag: string

index: number

Returns [boolean, Gst.DateTime]

get_double

Parameters

tag: string

Returns [boolean, number]

get_double_index

Parameters

tag: string

index: number

Returns [boolean, number]

get_float

Parameters

tag: string

Returns [boolean, number]

get_float_index

Parameters

tag: string

index: number

Returns [boolean, number]

get_int

Parameters

tag: string

Returns [boolean, number]

get_int64

Parameters

tag: string

Returns [boolean, number]

get_int64_index

Parameters

tag: string