Gjsify LogoGjsify Logo

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

Index

Constructors

Properties

miniObject: Gst.MiniObject

the parent type

field
name: string

Methods

  • 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

  • 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

  • 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

    Returns void

  • getBoolean(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]

  • getBooleanIndex(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]

  • getDate(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]

  • getDateIndex(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]

  • 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(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]

  • getDouble(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]

  • getDoubleIndex(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]

  • getFloat(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]

  • getFloatIndex(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]

  • getInt(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]

  • getInt64(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]

  • getInt64Index(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]

  • getIntIndex(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]

  • getPointer(tag: string): [boolean, object]
  • 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(tag: string, index: number): [boolean, object]
  • 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(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]

  • getSampleIndex(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]

  • getString(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]

  • getStringIndex(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]

  • getTagSize(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

  • getUint(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]

  • getUint64(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]

  • getUint64Index(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]

  • getUintIndex(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]

  • getValueIndex(tag: string, index: number): 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 any

  • isEmpty(): boolean
  • 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

    Returns Gst.TagList

  • nTags(): number
  • nthTagName(index: number): string
  • Get the name of the tag in list at index.

    Parameters

    • index: number

      the index

    Returns string

  • peekStringIndex(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]

  • removeTag(tag: string): void
  • Removes the given tag from the taglist.

    Parameters

    • tag: string

      tag to remove

    Returns void

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

    Parameters

    Returns void

  • toString(): string
  • copyValue(list: Gst.TagList, 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. 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]

  • Deserializes a tag list.

    Parameters

    • str: string

      a string created with gst_tag_list_to_string()

    Returns Gst.TagList

  • 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]

  • 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]

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method