Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

TAG_ACOUSTID_FINGERPRINT: string

AcoustID Fingerprint (Chromaprint)

TAG_ACOUSTID_ID: string

AcoustID Identifier

TAG_CAPTURING_CONTRAST: string

Direction of contrast processing applied when capturing an image. (string)

The allowed values are: "normal" "soft" "hard"

TAG_CAPTURING_DIGITAL_ZOOM_RATIO: string

Digital zoom ratio used when capturing an image. (double)

TAG_CAPTURING_EXPOSURE_COMPENSATION: string

Exposure compensation using when capturing an image in EV. (double)

TAG_CAPTURING_EXPOSURE_MODE: string

Exposure mode used when capturing an image. (string)

The allowed values are: "auto-exposure" "manual-exposure" "auto-bracket"

TAG_CAPTURING_EXPOSURE_PROGRAM: string

Type of exposure control used when capturing an image. (string)

The allowed values are: "undefined" "manual" "normal" - automatically controlled "aperture-priority" - user selects aperture value "shutter-priority" - user selects shutter speed "creative" - biased towards depth of field "action" - biased towards fast shutter speed "portrait" - closeup, leaving background out of focus "landscape" - landscape photos, background in focus

TAG_CAPTURING_FLASH_FIRED: string

If flash was fired during the capture of an image. (boolean)

Note that if this tag isn't present, it should not be assumed that the flash did not fire. It should be treated as unknown.

TAG_CAPTURING_FLASH_MODE: string

The flash mode selected during the capture of an image. (string)

The allowed values are: "auto" "always" "never"

TAG_CAPTURING_FOCAL_LENGTH: string

Focal length used when capturing an image, in mm. (double)

TAG_CAPTURING_FOCAL_LENGTH_35_MM: string

35 mm equivalent focal length used when capturing an image, in mm. (double)

TAG_CAPTURING_FOCAL_RATIO: string

Focal ratio (f-number) used when capturing an image. (double)

The value stored is the denominator of the focal ratio (f-number). For example, if this tag value is 2, the focal ratio is f/2.

TAG_CAPTURING_GAIN_ADJUSTMENT: string

Gain adjustment applied to an image. (string)

The allowed values are: "none" "low-gain-up" "high-gain-up" "low-gain-down" "high-gain-down"

TAG_CAPTURING_ISO_SPEED: string

ISO speed used when capturing an image. (integer)

TAG_CAPTURING_METERING_MODE: string

Defines the way a camera determines the exposure. (string)

The allowed values are: "unknown" "average" "center-weighted-average" "spot" "multi-spot" "pattern" "partial" "other"

TAG_CAPTURING_SATURATION: string

Direction of saturation processing applied when capturing an image. (string)

The allowed values are: "normal" "low-saturation" "high-saturation"

TAG_CAPTURING_SCENE_CAPTURE_TYPE: string

Scene mode used when capturing an image. (string)

The allowed values are: "standard" "landscape" "portrait" "night-scene"

TAG_CAPTURING_SHARPNESS: string

Direction of sharpness processing applied when capturing an image. (string)

The allowed values are: "normal" "soft" "hard"

TAG_CAPTURING_SHUTTER_SPEED: string

Shutter speed used when capturing an image, in seconds. (fraction)

TAG_CAPTURING_SOURCE: string

Indicates the source of capture. The device/medium used to do the capture. (string)

Allowed values are: "dsc" (= digital still camera) "transparent-scanner" "reflex-scanner" "other"

TAG_CAPTURING_WHITE_BALANCE: string

White balance mode used when capturing an image. (string)

The allowed values are: "auto" "manual" "daylight" "cloudy" "tungsten" "fluorescent" "fluorescent h" (newer daylight-calibrated fluorescents) "flash"

TAG_CDDA_CDDB_DISCID: string

CDDB disc id in its short form (e.g. 'aa063d0f')

TAG_CDDA_CDDB_DISCID_FULL: string

CDDB disc id including all details

TAG_CDDA_MUSICBRAINZ_DISCID: string

Musicbrainz disc id (e.g. 'ahg7JUcfR3vCYBphSDIogOOWrr0-')

TAG_CDDA_MUSICBRAINZ_DISCID_FULL: string

Musicbrainz disc id details

TAG_CMML_CLIP: string

Annodex CMML clip element tag

TAG_CMML_HEAD: string

Annodex CMML head element tag

TAG_CMML_STREAM: string

Annodex CMML stream element tag

TAG_ID3V2_HEADER_SIZE: number

ID3V2 header size considered minimum input for some functions such as gst_tag_list_from_id3v2_tag() and gst_tag_get_id3v2_tag_size() for example.

TAG_IMAGE_HORIZONTAL_PPI: string

Media (image/video) intended horizontal pixel density in ppi. (double)

TAG_IMAGE_VERTICAL_PPI: string

Media (image/video) intended vertical pixel density in ppi. (double)

TAG_MUSICAL_KEY: string

Musical key in which the sound starts. It is represented as a string with a maximum length of three characters. The ground keys are represented with "A","B","C","D","E", "F" and "G" and halfkeys represented with "b" and "#". Minor is represented as "m" (e.g. "Dbm"). Off key is represented with an "o" only. This notation might be extended in the future to support non-minor/major keys.

TAG_MUSICBRAINZ_ALBUMARTISTID: string

MusicBrainz album artist ID

TAG_MUSICBRAINZ_ALBUMID: string

MusicBrainz album ID

TAG_MUSICBRAINZ_ARTISTID: string

MusicBrainz artist ID

TAG_MUSICBRAINZ_RELEASEGROUPID: string

MusicBrainz Release Group ID

TAG_MUSICBRAINZ_RELEASETRACKID: string

MusicBrainz Release Track ID

TAG_MUSICBRAINZ_TRACKID: string

MusicBrainz track ID

TAG_MUSICBRAINZ_TRMID: string

MusicBrainz track TRM ID

Functions

  • tagCheckLanguageCode(langCode: string): boolean
  • Check if a given string contains a known ISO 639 language code.

    This is useful in situations where it's not clear whether a given string is a language code (which should be put into a #GST_TAG_LANGUAGE_CODE tag) or a free-form language name descriptor (which should be put into a #GST_TAG_LANGUAGE_NAME tag instead).

    Parameters

    • langCode: string

      ISO-639 language code (e.g. "deu" or "ger" or "de")

    Returns boolean

  • tagFreeformStringToUtf8(data: number[], envVars: string[]): string
  • Convenience function to read a string with unknown character encoding. If the string is already in UTF-8 encoding, it will be returned right away. If not it tries to detect byte-order-mark for UTF-16/32 cases and use that. Otherwise, the environment will be searched for a number of environment variables (whose names are specified in the NULL-terminated string array env_vars) containing a list of character encodings to try/use. If none 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).

    Parameters

    • data: number[]

      string data

    • envVars: string[]

      a NULL-terminated string array of environment variable names, or NULL

    Returns string

  • tagFromId3Tag(id3Tag: string): string
  • Looks up the GStreamer tag for a ID3v2 tag.

    Parameters

    • id3Tag: string

      ID3v2 tag to convert to GStreamer tag

    Returns string

  • tagFromId3UserTag(type: string, id3UserTag: string): string
  • Looks up the GStreamer tag for an ID3v2 user tag (e.g. description in TXXX frame or owner in UFID frame).

    Parameters

    • type: string

      the type of ID3v2 user tag (e.g. "TXXX" or "UDIF")

    • id3UserTag: string

      ID3v2 user tag to convert to GStreamer tag

    Returns string

  • tagFromVorbisTag(vorbisTag: string): string
  • Looks up the GStreamer tag for a vorbiscomment tag.

    Parameters

    • vorbisTag: string

      vorbiscomment tag to convert to GStreamer tag

    Returns string

  • tagGetId3v2TagSize(buffer: Gst.Buffer): number
  • Determines size of an ID3v2 tag on buffer containing at least ID3v2 header, i.e. at least #GST_TAG_ID3V2_HEADER_SIZE (10) bytes;

    Parameters

    • buffer: Gst.Buffer

      buffer holding ID3v2 tag (or at least the start of one)

    Returns number

  • tagGetLanguageCodeIso6391(langCode: string): string
  • Returns two-letter ISO-639-1 language code given a three-letter ISO-639-2 language code or two-letter ISO-639-1 language code (both are accepted for convenience).

    Language codes are case-sensitive and expected to be lower case.

    Parameters

    • langCode: string

      ISO-639 language code (e.g. "deu" or "ger" or "de")

    Returns string

  • tagGetLanguageCodeIso6392B(langCode: string): string
  • Returns three-letter ISO-639-2 "bibliographic" language code given a two-letter ISO-639-1 language code or a three-letter ISO-639-2 language code (both are accepted for convenience).

    The "bibliographic" code is derived from the English name of the language (e.g. "ger" for German instead of "de" or "deu"). In most scenarios, the "terminological" codes are preferred.

    Language codes are case-sensitive and expected to be lower case.

    Parameters

    • langCode: string

      ISO-639 language code (e.g. "deu" or "ger" or "de")

    Returns string

  • tagGetLanguageCodeIso6392T(langCode: string): string
  • Returns three-letter ISO-639-2 "terminological" language code given a two-letter ISO-639-1 language code or a three-letter ISO-639-2 language code (both are accepted for convenience).

    The "terminological" code is derived from the local name of the language (e.g. "deu" for German instead of "ger"). In most scenarios, the "terminological" codes are preferred over the "bibliographic" ones.

    Language codes are case-sensitive and expected to be lower case.

    Parameters

    • langCode: string

      ISO-639 language code (e.g. "deu" or "ger" or "de")

    Returns string

  • tagGetLanguageCodes(): string[]
  • Returns a list of known language codes (in form of two-letter ISO-639-1 codes). This is useful for UIs to build a list of available languages for tagging purposes (e.g. to tag an audio track appropriately in a video or audio editor).

    Returns string[]

  • tagGetLanguageName(languageCode: string): string
  • Returns the name of the language given an ISO-639 language code as found in a GST_TAG_LANGUAGE_CODE tag. The name will be translated according to the current locale (if the library was built against the iso-codes package, otherwise the English name will be returned).

    Language codes are case-sensitive and expected to be lower case.

    Parameters

    • languageCode: string

      two or three-letter ISO-639 language code

    Returns string

  • tagGetLicenseDescription(licenseRef: string): string
  • tagGetLicenseJurisdiction(licenseRef: string): string
  • Get the jurisdiction code of a license. This is usually a two-letter ISO 3166-1 alpha-2 code, but there is also the special case of Scotland, for which no code exists and which is thus represented as "scotland".

    Known jurisdictions: ar, at, au, be, bg, br, ca, ch, cl, cn, co, de, 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.

    Parameters

    Returns string

  • tagGetLicenseNick(licenseRef: string): string
  • tagGetLicenseTitle(licenseRef: string): string
  • tagGetLicenseVersion(licenseRef: string): string
  • tagGetLicenses(): string[]
  • Returns a list of known license references (in form of URIs). This is useful for UIs to build a list of available licenses for tagging purposes (e.g. to tag an audio track appropriately in a video or audio editor, or an image in a camera application).

    Returns string[]

  • tagId3GenreCount(): number
  • Gets the number of ID3v1 genres that can be identified. Winamp genres are included.

    Returns number

  • tagId3GenreGet(id: number): string
  • Gets the ID3v1 genre name for a given ID.

    Parameters

    • id: number

      ID of genre to query

    Returns string

  • Helper function for tag-reading plugins to create a #GstSample suitable to add to a #GstTagList as an image tag (such as #GST_TAG_IMAGE or #GST_TAG_PREVIEW_IMAGE) from the encoded image data and an (optional) image type.

    Background: cover art and other images in tags are usually stored as a blob of binary image data, often accompanied by a MIME type or some other content type string (e.g. 'png', 'jpeg', 'jpg'). Sometimes there is also an 'image type' to indicate what kind of image this is (e.g. front cover, back cover, artist, etc.). The image data may also be an URI to the image rather than the image itself.

    In GStreamer, image tags are #GstSamples containing the raw image data, with the sample caps describing the content type of the image (e.g. image/jpeg, image/png, text/uri-list). The sample info may contain an additional 'image-type' field of #GstTagImageType to describe the type of image (front cover, back cover etc.). #GST_TAG_PREVIEW_IMAGE tags should not carry an image type, their type is already indicated via the special tag name.

    This function will do various checks and typefind the encoded image data (we can't trust the declared mime type).

    Parameters

    • imageData: Uint8Array

      the (encoded) image

    • imageType: TagImageType

      type of the image, or #GST_TAG_IMAGE_TYPE_UNDEFINED. Pass #GST_TAG_IMAGE_TYPE_NONE if no image type should be set at all (e.g. for preview images)

    Returns Sample

  • tagListAddId3Image(tagList: Gst.TagList, imageData: Uint8Array, id3PictureType: number): boolean
  • Adds an image from an ID3 APIC frame (or similar, such as used in FLAC) to the given tag list. Also see gst_tag_image_data_to_image_sample() for more information on image tags in GStreamer.

    Parameters

    • tagList: Gst.TagList

      a tag list

    • imageData: Uint8Array

      the (encoded) image

    • id3PictureType: number

      picture type as per the ID3 (v2.4.0) specification for the APIC frame (0 = unknown/other)

    Returns boolean

  • Parses the IFD and IFD tags data contained in the buffer and puts it on a taglist. The base_offset is used to subtract from the offset in the tag entries and be able to get the offset relative to the buffer start

    Parameters

    • buffer: Gst.Buffer

      The exif buffer

    • byteOrder: number

      byte order of the data

    • baseOffset: number

      Offset from the tiff header to this buffer

    Returns Gst.TagList

  • tagListFromVorbiscomment(data: Uint8Array, idData: Uint8Array): [Gst.TagList, string]
  • Creates a new tag list that contains the information parsed out of a vorbiscomment packet.

    Parameters

    • data: Uint8Array

      data to convert

    • idData: Uint8Array

      identification data at start of stream

    Returns [Gst.TagList, string]

  • Creates a new tag list that contains the information parsed out of a vorbiscomment packet.

    Parameters

    • buffer: Gst.Buffer

      buffer to convert

    • idData: Uint8Array

      identification data at start of stream

    Returns [Gst.TagList, string]

  • tagListNewFromId3v1(data: Uint8Array): Gst.TagList
  • Parses the data containing an ID3v1 tag and returns a #GstTagList from the parsed data.

    Parameters

    • data: Uint8Array

      128 bytes of data containing the ID3v1 tag

    Returns Gst.TagList

  • Formats the tags in taglist on exif format. The resulting buffer contains the tags IFD and is followed by the data pointed by the tag entries.

    Parameters

    • taglist: Gst.TagList

      The taglist

    • byteOrder: number

      byte order used in writing (G_LITTLE_ENDIAN or G_BIG_ENDIAN)

    • baseOffset: number

      Offset from the tiff header first byte

    Returns Gst.Buffer

  • Formats the tags in taglist into exif structure, a tiff header is put in the beginning of the buffer.

    Parameters

    Returns Gst.Buffer

  • tagListToVorbiscommentBuffer(list: Gst.TagList, idData: Uint8Array, vendorString: string): Gst.Buffer
  • Creates a new vorbiscomment buffer from a tag list.

    Parameters

    • list: Gst.TagList

      tag list to convert

    • idData: Uint8Array

      identification data at start of stream

    • vendorString: string

      string that describes the vendor string or NULL

    Returns Gst.Buffer

  • Formats a taglist as a xmp packet using only the selected schemas. An empty list (%NULL) means that all schemas should be used

    Parameters

    • list: Gst.TagList

      tags

    • readOnly: boolean

      does the container forbid inplace editing

    • schemas: string[]

      %NULL terminated array of schemas to be used on serialization

    Returns Gst.Buffer

  • tagParseExtendedComment(extComment: string, failIfNoKey: boolean): [boolean, string | null, string | null, string]
  • Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and separate it into its components.

    If successful, key, lang and/or value will be set to newly allocated strings that you need to free with g_free() when done. key and lang may also be set to NULL by this function if there is no key or no language code in the extended comment string.

    Parameters

    • extComment: string

      an extended comment string, see #GST_TAG_EXTENDED_COMMENT

    • failIfNoKey: boolean

      whether to fail if strings are not in key=value form

    Returns [boolean, string | null, string | null, string]

  • tagRegisterMusicbrainzTags(): void
  • Registers additional musicbrainz-specific tags with the GStreamer tag system. Plugins and applications that use these tags should call this function before using them. Can be called multiple times.

    Returns void

  • tagToId3Tag(gstTag: string): string
  • Looks up the ID3v2 tag for a GStreamer tag.

    Parameters

    • gstTag: string

      GStreamer tag to convert to vorbiscomment tag

    Returns string

  • tagToVorbisComments(list: Gst.TagList, tag: string): string[]
  • Creates a new tag list that contains the information parsed out of a vorbiscomment packet.

    Parameters

    • list: Gst.TagList

      a #GstTagList

    • tag: string

      a GStreamer tag identifier, such as #GST_TAG_ARTIST

    Returns string[]

  • tagToVorbisTag(gstTag: string): string
  • Looks up the vorbiscomment tag for a GStreamer tag.

    Parameters

    • gstTag: string

      GStreamer tag to convert to vorbiscomment tag

    Returns string

  • tagXmpListSchemas(): string[]
  • Gets the list of supported schemas in the xmp lib

    Returns string[]

  • vorbisTagAdd(list: Gst.TagList, tag: string, value: string): void
  • Convenience function using gst_tag_from_vorbis_tag(), parsing a vorbis comment string into the right type and adding it to the given taglist list.

    Unknown vorbiscomment tags will be added to the tag list in form of a #GST_TAG_EXTENDED_COMMENT.

    Parameters

    • list: Gst.TagList

      a #GstTagList

    • tag: string

      a vorbiscomment tag string (key in key=value), must be valid UTF-8

    • value: string

      a vorbiscomment value string (value in key=value), must be valid UTF-8

    Returns void

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