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

miniObject

miniObject: Gst.MiniObject

the parent type

field

Static name

name: string

Methods

addValue

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

- Defined in Gst-1.0.d.ts:22577
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 Gst-1.0.d.ts:22589
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 Gst-1.0.d.ts:22595
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

getBoolean

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

- Defined in Gst-1.0.d.ts:22601
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]

getBooleanIndex

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

- Defined in Gst-1.0.d.ts:22608
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]

getDate

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

- Defined in Gst-1.0.d.ts:22617
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]

getDateIndex

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

- Defined in Gst-1.0.d.ts:22627
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]

getDateTime

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

- Defined in Gst-1.0.d.ts:22636
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]

getDateTimeIndex

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

- Defined in Gst-1.0.d.ts:22646
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]

getDouble

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

- Defined in Gst-1.0.d.ts:22652
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]

getDoubleIndex

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

- Defined in Gst-1.0.d.ts:22659
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]

getFloat

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

- Defined in Gst-1.0.d.ts:22665
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]

getFloatIndex

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

- Defined in Gst-1.0.d.ts:22672
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]

getInt

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

- Defined in Gst-1.0.d.ts:22678
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]

getInt64

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

- Defined in Gst-1.0.d.ts:22684
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]

getInt64Index

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

- Defined in Gst-1.0.d.ts:22691
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]

getIntIndex

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

- Defined in Gst-1.0.d.ts:22698
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]

getPointer

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

- Defined in Gst-1.0.d.ts:22704
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]

getPointerIndex

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

- Defined in Gst-1.0.d.ts:22711
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]

getSample

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

- Defined in Gst-1.0.d.ts:22722
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]

getSampleIndex

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

- Defined in Gst-1.0.d.ts:22734
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]

getScope

getScope(): TagScope

- Defined in Gst-1.0.d.ts:22738
Gets the scope of list.

Returns TagScope

getString

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

- Defined in Gst-1.0.d.ts:22753
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]

getStringIndex

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

- Defined in Gst-1.0.d.ts:22766
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]

getTagSize

getTagSize(tag: string): number

- Defined in Gst-1.0.d.ts:22771
Checks how many value are stored in this tag list for the given tag.

Parameters
- tag: string
  
  the tag to query
Returns number

getUint

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

- Defined in Gst-1.0.d.ts:22777
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]

getUint64

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

- Defined in Gst-1.0.d.ts:22783
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]

getUint64Index

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

- Defined in Gst-1.0.d.ts:22790
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]

getUintIndex

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

- Defined in Gst-1.0.d.ts:22797
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]

getValueIndex

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

- Defined in Gst-1.0.d.ts:22804
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 Gst-1.0.d.ts:22810
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

isEmpty

isEmpty(): boolean

- Defined in Gst-1.0.d.ts:22814
Checks if the given taglist is empty.

Returns boolean

isEqual

isEqual(list2: Gst.TagList): boolean

- Defined in Gst-1.0.d.ts:22819
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 Gst-1.0.d.ts:22828
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

nTags

nTags(): number

- Defined in Gst-1.0.d.ts:22832
Get the number of tags in list.

Returns number

nthTagName

nthTagName(index: number): string

- Defined in Gst-1.0.d.ts:22837
Get the name of the tag in list at index.

Parameters
- index: number
  
  the index
Returns string

peekStringIndex

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

- Defined in Gst-1.0.d.ts:22848
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]

removeTag

removeTag(tag: string): void

- Defined in Gst-1.0.d.ts:22853
Removes the given tag from the taglist.

Parameters
- tag: string
  
  tag to remove
Returns void

setScope

setScope(scope: TagScope): void

- Defined in Gst-1.0.d.ts:22859
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

toString

toString(): string

- Defined in Gst-1.0.d.ts:22863
Serializes a tag list to a string.

Returns string

Static copyValue

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

- Defined in Gst-1.0.d.ts:22902
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 newEmpty

newEmpty(): Gst.TagList

- Defined in Gst-1.0.d.ts:22887
Creates a new empty GstTagList.

Free-function: gst_tag_list_unref

Returns Gst.TagList

Static newFromString

newFromString(str: string): Gst.TagList

- Defined in Gst-1.0.d.ts:22893
Deserializes a tag list.

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

Static replace

replace(oldTaglist: Gst.TagList, newTaglist: Gst.TagList): [boolean, Gst.TagList]

- Defined in Gst-1.0.d.ts:22914
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
- oldTaglist: Gst.TagList
  
  pointer to a pointer to a #GstTagList to be replaced.
- newTaglist: Gst.TagList
  
  pointer to a #GstTagList that will replace the tag list pointed to by old_taglist.
Returns [boolean, Gst.TagList]

Static take

take(oldTaglist: Gst.TagList, newTaglist: Gst.TagList): [boolean, Gst.TagList]

- Defined in Gst-1.0.d.ts:22922
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
- oldTaglist: Gst.TagList
  
  pointer to a pointer to a #GstTagList to be replaced.
- newTaglist: 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

miniObject

Static name

Methods

addValue

Parameters

mode: Gst.TagMergeMode

tag: string

value: any

Returns void

copy

Returns Gst.TagList

foreach

Parameters

func: Gst.TagForeachFunc

Returns void

getBoolean

Parameters

tag: string

Returns [boolean, boolean]

getBooleanIndex

Parameters

tag: string

index: number

Returns [boolean, boolean]

getDate

Parameters

tag: string

Returns [boolean, GLib.Date]

getDateIndex

Parameters

tag: string

index: number

Returns [boolean, GLib.Date]

getDateTime

Parameters

tag: string

Returns [boolean, Gst.DateTime]

getDateTimeIndex

Parameters

tag: string

index: number

Returns [boolean, Gst.DateTime]

getDouble

Parameters

tag: string

Returns [boolean, number]

getDoubleIndex

Parameters

tag: string

index: number

Returns [boolean, number]

getFloat

Parameters

tag: string

Returns [boolean, number]

getFloatIndex

Parameters

tag: string

index: number

Returns [boolean, number]

getInt

Parameters

tag: string

Returns [boolean, number]

getInt64

Parameters

tag: string

Returns [boolean, number]

getInt64Index

Parameters

tag: string