Gjsify LogoGjsify Logo

Namespace Gst

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

ClockID

ClockID: object

ClockTime

ClockTime: number

ClockTimeDiff

ClockTimeDiff: number

ElementFactoryListType

ElementFactoryListType: number

Variables

Const ALLOCATOR_SYSMEM

ALLOCATOR_SYSMEM: string

The allocator name for the default system memory allocator

Const BUFFER_COPY_ALL

BUFFER_COPY_ALL: Gst.BufferCopyFlags

Combination of all possible fields that can be copied with gst_buffer_copy_into().

Const BUFFER_COPY_METADATA

BUFFER_COPY_METADATA: Gst.BufferCopyFlags

Combination of all possible metadata fields that can be copied with gst_buffer_copy_into().

Const BUFFER_OFFSET_NONE

BUFFER_OFFSET_NONE: number

Constant for no-offset return results.

Const CAN_INLINE

CAN_INLINE: number

Const CAPS_FEATURE_MEMORY_SYSTEM_MEMORY

CAPS_FEATURE_MEMORY_SYSTEM_MEMORY: string

Const CLOCK_TIME_NONE

CLOCK_TIME_NONE: Gst.ClockTime

Constant to define an undefined clock time.

Const DEBUG_BG_MASK

DEBUG_BG_MASK: number

Const DEBUG_FG_MASK

DEBUG_FG_MASK: number

Const DEBUG_FORMAT_MASK

DEBUG_FORMAT_MASK: number

Const ELEMENT_FACTORY_KLASS_DECODER

ELEMENT_FACTORY_KLASS_DECODER: string

Const ELEMENT_FACTORY_KLASS_DECRYPTOR

ELEMENT_FACTORY_KLASS_DECRYPTOR: string

Const ELEMENT_FACTORY_KLASS_DEMUXER

ELEMENT_FACTORY_KLASS_DEMUXER: string

Const ELEMENT_FACTORY_KLASS_DEPAYLOADER

ELEMENT_FACTORY_KLASS_DEPAYLOADER: string

Const ELEMENT_FACTORY_KLASS_ENCODER

ELEMENT_FACTORY_KLASS_ENCODER: string

Const ELEMENT_FACTORY_KLASS_ENCRYPTOR

ELEMENT_FACTORY_KLASS_ENCRYPTOR: string

Const ELEMENT_FACTORY_KLASS_FORMATTER

ELEMENT_FACTORY_KLASS_FORMATTER: string

Const ELEMENT_FACTORY_KLASS_HARDWARE

ELEMENT_FACTORY_KLASS_HARDWARE: string

Elements interacting with hardware devices should specify this classifier in their metadata. You may need to put the element in "READY" state to test if the hardware is present in the system.

Const ELEMENT_FACTORY_KLASS_MEDIA_AUDIO

ELEMENT_FACTORY_KLASS_MEDIA_AUDIO: string

Const ELEMENT_FACTORY_KLASS_MEDIA_IMAGE

ELEMENT_FACTORY_KLASS_MEDIA_IMAGE: string

Const ELEMENT_FACTORY_KLASS_MEDIA_METADATA

ELEMENT_FACTORY_KLASS_MEDIA_METADATA: string

Const ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE

ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE: string

Const ELEMENT_FACTORY_KLASS_MEDIA_VIDEO

ELEMENT_FACTORY_KLASS_MEDIA_VIDEO: string

Const ELEMENT_FACTORY_KLASS_MUXER

ELEMENT_FACTORY_KLASS_MUXER: string

Const ELEMENT_FACTORY_KLASS_PARSER

ELEMENT_FACTORY_KLASS_PARSER: string

Const ELEMENT_FACTORY_KLASS_PAYLOADER

ELEMENT_FACTORY_KLASS_PAYLOADER: string

Const ELEMENT_FACTORY_KLASS_SINK

ELEMENT_FACTORY_KLASS_SINK: string

Const ELEMENT_FACTORY_KLASS_SRC

ELEMENT_FACTORY_KLASS_SRC: string

Const ELEMENT_FACTORY_TYPE_ANY

ELEMENT_FACTORY_TYPE_ANY: ElementFactoryListType

Elements of any of the defined GST_ELEMENT_FACTORY_LIST types

Const ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS

ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS: ElementFactoryListType

All sinks handling audio, video or image media types

Const ELEMENT_FACTORY_TYPE_AUDIO_ENCODER

ELEMENT_FACTORY_TYPE_AUDIO_ENCODER: ElementFactoryListType

All encoders handling audio media types

Const ELEMENT_FACTORY_TYPE_DECODABLE

ELEMENT_FACTORY_TYPE_DECODABLE: ElementFactoryListType

All elements used to 'decode' streams (decoders, demuxers, parsers, depayloaders)

Const ELEMENT_FACTORY_TYPE_DECODER

ELEMENT_FACTORY_TYPE_DECODER: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_DECRYPTOR

ELEMENT_FACTORY_TYPE_DECRYPTOR: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_DEMUXER

ELEMENT_FACTORY_TYPE_DEMUXER: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_DEPAYLOADER

ELEMENT_FACTORY_TYPE_DEPAYLOADER: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_ENCODER

ELEMENT_FACTORY_TYPE_ENCODER: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_ENCRYPTOR

ELEMENT_FACTORY_TYPE_ENCRYPTOR: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_FORMATTER

ELEMENT_FACTORY_TYPE_FORMATTER: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_HARDWARE

ELEMENT_FACTORY_TYPE_HARDWARE: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_MAX_ELEMENTS

ELEMENT_FACTORY_TYPE_MAX_ELEMENTS: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_MEDIA_ANY

ELEMENT_FACTORY_TYPE_MEDIA_ANY: ElementFactoryListType

Elements matching any of the defined GST_ELEMENT_FACTORY_TYPE_MEDIA types

Note: Do not use this if you wish to not filter against any of the defined media types. If you wish to do this, simply don't specify any GST_ELEMENT_FACTORY_TYPE_MEDIA flag.

Const ELEMENT_FACTORY_TYPE_MEDIA_AUDIO

ELEMENT_FACTORY_TYPE_MEDIA_AUDIO: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_MEDIA_IMAGE

ELEMENT_FACTORY_TYPE_MEDIA_IMAGE: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_MEDIA_METADATA

ELEMENT_FACTORY_TYPE_MEDIA_METADATA: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE

ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_MEDIA_VIDEO

ELEMENT_FACTORY_TYPE_MEDIA_VIDEO: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_MUXER

ELEMENT_FACTORY_TYPE_MUXER: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_PARSER

ELEMENT_FACTORY_TYPE_PARSER: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_PAYLOADER

ELEMENT_FACTORY_TYPE_PAYLOADER: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_SINK

ELEMENT_FACTORY_TYPE_SINK: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_SRC

ELEMENT_FACTORY_TYPE_SRC: ElementFactoryListType

Const ELEMENT_FACTORY_TYPE_VIDEO_ENCODER

ELEMENT_FACTORY_TYPE_VIDEO_ENCODER: ElementFactoryListType

All encoders handling video or image media types

Const ELEMENT_METADATA_AUTHOR

ELEMENT_METADATA_AUTHOR: string

Name and contact details of the author(s). Use \n to separate multiple author details. E.g: "Joe Bloggs <joe.blogs at foo.com>"

Const ELEMENT_METADATA_DESCRIPTION

ELEMENT_METADATA_DESCRIPTION: string

Sentence describing the purpose of the element. E.g: "Write stream to a file"

Const ELEMENT_METADATA_DOC_URI

ELEMENT_METADATA_DOC_URI: string

Set uri pointing to user documentation. Applications can use this to show help for e.g. effects to users.

Const ELEMENT_METADATA_ICON_NAME

ELEMENT_METADATA_ICON_NAME: string

Elements that bridge to certain other products can include an icon of that used product. Application can show the icon in menus/selectors to help identifying specific elements.

Const ELEMENT_METADATA_KLASS

ELEMENT_METADATA_KLASS: string

String describing the type of element, as an unordered list separated with slashes ('/'). See draft-klass.txt of the design docs for more details and common types. E.g: "Sink/File"

Const ELEMENT_METADATA_LONGNAME

ELEMENT_METADATA_LONGNAME: string

The long English name of the element. E.g. "File Sink"

Const EVENT_NUM_SHIFT

EVENT_NUM_SHIFT: number

Const EVENT_TYPE_BOTH

EVENT_TYPE_BOTH: Gst.EventTypeFlags

The same thing as #GST_EVENT_TYPE_UPSTREAM | #GST_EVENT_TYPE_DOWNSTREAM.

Const FLAG_SET_MASK_EXACT

FLAG_SET_MASK_EXACT: number

A mask value with all bits set, for use as a GstFlagSet mask where all flag bits must match exactly

Const FORMAT_PERCENT_MAX

FORMAT_PERCENT_MAX: number

The PERCENT format is between 0 and this value

Const FORMAT_PERCENT_SCALE

FORMAT_PERCENT_SCALE: number

The value used to scale down the reported PERCENT format value to its real value.

Const GROUP_ID_INVALID

GROUP_ID_INVALID: number

A value which is guaranteed to never be returned by gst_util_group_id_next().

Can be used as a default value in variables used to store group_id.

Const LICENSE_UNKNOWN

LICENSE_UNKNOWN: string

To be used in GST_PLUGIN_DEFINE if unsure about the licence.

Const LOCK_FLAG_READWRITE

LOCK_FLAG_READWRITE: LockFlags

GstLockFlags value alias for GST_LOCK_FLAG_READ | GST_LOCK_FLAG_WRITE

Const MAP_READWRITE

MAP_READWRITE: Gst.MapFlags

GstMapFlags value alias for GST_MAP_READ | GST_MAP_WRITE

Const META_TAG_MEMORY_STR

META_TAG_MEMORY_STR: string

This metadata stays relevant as long as memory layout is unchanged.

Const MSECOND

MSECOND: Gst.ClockTimeDiff

Constant that defines one GStreamer millisecond.

Const NSECOND

NSECOND: Gst.ClockTimeDiff

Constant that defines one GStreamer nanosecond

Const PARAM_CONDITIONALLY_AVAILABLE

PARAM_CONDITIONALLY_AVAILABLE: number

Use this flag on GObject properties of GstObject to indicate that they might not be available depending on environment such as OS, device, etc, so such properties will be installed conditionally only if the GstObject is able to support it.

Const PARAM_CONTROLLABLE

PARAM_CONTROLLABLE: number

Use this flag on GObject properties to signal they can make sense to be. controlled over time. This hint is used by the GstController.

Const PARAM_DOC_SHOW_DEFAULT

PARAM_DOC_SHOW_DEFAULT: number

Use this flag on GObject properties of GstObject to indicate that during gst-inspect and friends, the default value should be used as default instead of the current value.

Const PARAM_MUTABLE_PAUSED

PARAM_MUTABLE_PAUSED: number

Use this flag on GObject properties of GstElements to indicate that they can be changed when the element is in the PAUSED or lower state. This flag implies GST_PARAM_MUTABLE_READY.

Const PARAM_MUTABLE_PLAYING

PARAM_MUTABLE_PLAYING: number

Use this flag on GObject properties of GstElements to indicate that they can be changed when the element is in the PLAYING or lower state. This flag implies GST_PARAM_MUTABLE_PAUSED.

Const PARAM_MUTABLE_READY

PARAM_MUTABLE_READY: number

Use this flag on GObject properties of GstElements to indicate that they can be changed when the element is in the READY or lower state.

Const PARAM_USER_SHIFT

PARAM_USER_SHIFT: number

Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party applications.

Const PROTECTION_SYSTEM_ID_CAPS_FIELD

PROTECTION_SYSTEM_ID_CAPS_FIELD: string

The field name in a GstCaps that is used to signal the UUID of the protection system.

Const PROTECTION_UNSPECIFIED_SYSTEM_ID

PROTECTION_UNSPECIFIED_SYSTEM_ID: string

The protection system value of the unspecified UUID. In some cases the system protection ID is not present in the contents or in their metadata, as encrypted WebM. This define is used to set the value of the "system_id" field in GstProtectionEvent, with this value, the application will use an external information to choose which protection system to use.

Example: The matroskademux uses this value in the case of encrypted WebM, the application will choose the appropriate protection system based on the information received through EME API.

Const QUERY_NUM_SHIFT

QUERY_NUM_SHIFT: number

Const QUERY_TYPE_BOTH

QUERY_TYPE_BOTH: QueryTypeFlags

The same thing as #GST_QUERY_TYPE_UPSTREAM | #GST_QUERY_TYPE_DOWNSTREAM.

Const SECOND

SECOND: Gst.ClockTimeDiff

Constant that defines one GStreamer second.

Const SEGMENT_INSTANT_FLAGS

SEGMENT_INSTANT_FLAGS: number

Const SEQNUM_INVALID

SEQNUM_INVALID: number

A value which is guaranteed to never be returned by gst_util_seqnum_next().

Can be used as a default value in variables used to store seqnum.

Const TAG_ALBUM

TAG_ALBUM: string

album containing this data (string)

The album name as it should be displayed, e.g. 'The Jazz Guitar'

Const TAG_ALBUM_ARTIST

TAG_ALBUM_ARTIST: string

The artist of the entire album, as it should be displayed.

Const TAG_ALBUM_ARTIST_SORTNAME

TAG_ALBUM_ARTIST_SORTNAME: string

The artist of the entire album, as it should be sorted.

Const TAG_ALBUM_GAIN

TAG_ALBUM_GAIN: string

album gain in db (double)

Const TAG_ALBUM_PEAK

TAG_ALBUM_PEAK: string

peak of the album (double)

Const TAG_ALBUM_SORTNAME

TAG_ALBUM_SORTNAME: string

album containing this data, as used for sorting (string)

The album name as it should be sorted, e.g. 'Jazz Guitar, The'

Const TAG_ALBUM_VOLUME_COUNT

TAG_ALBUM_VOLUME_COUNT: string

count of discs inside collection this disc belongs to (unsigned integer)

Const TAG_ALBUM_VOLUME_NUMBER

TAG_ALBUM_VOLUME_NUMBER: string

disc number inside a collection (unsigned integer)

Const TAG_APPLICATION_DATA

TAG_APPLICATION_DATA: string

Arbitrary application data (sample)

Some formats allow applications to add their own arbitrary data into files. This data is application dependent.

Const TAG_APPLICATION_NAME

TAG_APPLICATION_NAME: string

Name of the application used to create the media (string)

Const TAG_ARTIST

TAG_ARTIST: string

person(s) responsible for the recording (string)

The artist name as it should be displayed, e.g. 'Jimi Hendrix' or 'The Guitar Heroes'

Const TAG_ARTIST_SORTNAME

TAG_ARTIST_SORTNAME: string

person(s) responsible for the recording, as used for sorting (string)

The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or 'Guitar Heroes, The'

Const TAG_ATTACHMENT

TAG_ATTACHMENT: string

generic file attachment (sample) (sample taglist should specify the content type and if possible set "filename" to the file name of the attachment)

Const TAG_AUDIO_CODEC

TAG_AUDIO_CODEC: string

codec the audio data is stored in (string)

Const TAG_BEATS_PER_MINUTE

TAG_BEATS_PER_MINUTE: string

number of beats per minute in audio (double)

Const TAG_BITRATE

TAG_BITRATE: string

exact or average bitrate in bits/s (unsigned integer)

Const TAG_CODEC

TAG_CODEC: string

codec the data is stored in (string)

Const TAG_COMMENT

TAG_COMMENT: string

free text commenting the data (string)

Const TAG_COMPOSER

TAG_COMPOSER: string

person(s) who composed the recording (string)

Const TAG_COMPOSER_SORTNAME

TAG_COMPOSER_SORTNAME: string

The composer's name, used for sorting (string)

Const TAG_CONDUCTOR

TAG_CONDUCTOR: string

conductor/performer refinement (string)

Const TAG_CONTACT

TAG_CONTACT: string

contact information (string)

Const TAG_CONTAINER_FORMAT

TAG_CONTAINER_FORMAT: string

container format the data is stored in (string)

Const TAG_COPYRIGHT

TAG_COPYRIGHT: string

copyright notice of the data (string)

Const TAG_COPYRIGHT_URI

TAG_COPYRIGHT_URI: string

URI to location where copyright details can be found (string)

Const TAG_DATE

TAG_DATE: string

date the data was created (#GDate structure)

Const TAG_DATE_TIME

TAG_DATE_TIME: string

date and time the data was created (#GstDateTime structure)

Const TAG_DESCRIPTION

TAG_DESCRIPTION: string

short text describing the content of the data (string)

Const TAG_DEVICE_MANUFACTURER

TAG_DEVICE_MANUFACTURER: string

Manufacturer of the device used to create the media (string)

Const TAG_DEVICE_MODEL

TAG_DEVICE_MODEL: string

Model of the device used to create the media (string)

Const TAG_DURATION

TAG_DURATION: string

length in GStreamer time units (nanoseconds) (unsigned 64-bit integer)

Const TAG_ENCODED_BY

TAG_ENCODED_BY: string

name of the person or organisation that encoded the file. May contain a copyright message if the person or organisation also holds the copyright (string)

Note: do not use this field to describe the encoding application. Use #GST_TAG_APPLICATION_NAME or #GST_TAG_COMMENT for that.

Const TAG_ENCODER

TAG_ENCODER: string

encoder used to encode this stream (string)

Const TAG_ENCODER_VERSION

TAG_ENCODER_VERSION: string

version of the encoder used to encode this stream (unsigned integer)

Const TAG_EXTENDED_COMMENT

TAG_EXTENDED_COMMENT: string

key/value text commenting the data (string)

Must be in the form of 'key=comment' or 'key[lc]=comment' where 'lc' is an ISO-639 language code.

This tag is used for unknown Vorbis comment tags, unknown APE tags and certain ID3v2 comment fields.

Const TAG_GENRE

TAG_GENRE: string

genre this data belongs to (string)

Const TAG_GEO_LOCATION_CAPTURE_DIRECTION

TAG_GEO_LOCATION_CAPTURE_DIRECTION: string

Indicates the direction the device is pointing to when capturing a media. It is represented as degrees in floating point representation, 0 means the geographic north, and increases clockwise (double from 0 to 360)

See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION

Const TAG_GEO_LOCATION_CITY

TAG_GEO_LOCATION_CITY: string

The city (english name) where the media has been produced (string).

Const TAG_GEO_LOCATION_COUNTRY

TAG_GEO_LOCATION_COUNTRY: string

The country (english name) where the media has been produced (string).

Const TAG_GEO_LOCATION_ELEVATION

TAG_GEO_LOCATION_ELEVATION: string

geo elevation of where the media has been recorded or produced in meters according to WGS84 (zero is average sea level) (double).

Const TAG_GEO_LOCATION_HORIZONTAL_ERROR

TAG_GEO_LOCATION_HORIZONTAL_ERROR: string

Represents the expected error on the horizontal positioning in meters (double).

Const TAG_GEO_LOCATION_LATITUDE

TAG_GEO_LOCATION_LATITUDE: string

geo latitude location of where the media has been recorded or produced in degrees according to WGS84 (zero at the equator, negative values for southern latitudes) (double).

Const TAG_GEO_LOCATION_LONGITUDE

TAG_GEO_LOCATION_LONGITUDE: string

geo longitude location of where the media has been recorded or produced in degrees according to WGS84 (zero at the prime meridian in Greenwich/UK, negative values for western longitudes). (double).

Const TAG_GEO_LOCATION_MOVEMENT_DIRECTION

TAG_GEO_LOCATION_MOVEMENT_DIRECTION: string

Indicates the movement direction of the device performing the capture of a media. It is represented as degrees in floating point representation, 0 means the geographic north, and increases clockwise (double from 0 to 360)

See also #GST_TAG_GEO_LOCATION_CAPTURE_DIRECTION

Const TAG_GEO_LOCATION_MOVEMENT_SPEED

TAG_GEO_LOCATION_MOVEMENT_SPEED: string

Speed of the capturing device when performing the capture. Represented in m/s. (double)

See also #GST_TAG_GEO_LOCATION_MOVEMENT_DIRECTION

Const TAG_GEO_LOCATION_NAME

TAG_GEO_LOCATION_NAME: string

human readable descriptive location of where the media has been recorded or produced. (string).

Const TAG_GEO_LOCATION_SUBLOCATION

TAG_GEO_LOCATION_SUBLOCATION: string

A location 'smaller' than GST_TAG_GEO_LOCATION_CITY that specifies better where the media has been produced. (e.g. the neighborhood) (string).

This tag has been added as this is how it is handled/named in XMP's Iptc4xmpcore schema.

Const TAG_GROUPING

TAG_GROUPING: string

Groups together media that are related and spans multiple tracks. An example are multiple pieces of a concerto. (string)

Const TAG_HOMEPAGE

TAG_HOMEPAGE: string

Homepage for this media (i.e. artist or movie homepage) (string)

Const TAG_IMAGE

TAG_IMAGE: string

image (sample) (sample taglist should specify the content type and preferably also set "image-type" field as GstTagImageType)

Const TAG_IMAGE_ORIENTATION

TAG_IMAGE_ORIENTATION: string

Represents the 'Orientation' tag from EXIF. Defines how the image should be rotated and mirrored for display. (string)

This tag has a predefined set of allowed values: "rotate-0" "rotate-90" "rotate-180" "rotate-270" "flip-rotate-0" "flip-rotate-90" "flip-rotate-180" "flip-rotate-270"

The naming is adopted according to a possible transformation to perform on the image to fix its orientation, obviously equivalent operations will yield the same result.

Rotations indicated by the values are in clockwise direction and 'flip' means an horizontal mirroring.

Const TAG_INTERPRETED_BY

TAG_INTERPRETED_BY: string

Information about the people behind a remix and similar interpretations of another existing piece (string)

Const TAG_ISRC

TAG_ISRC: string

International Standard Recording Code - see http://www.ifpi.org/isrc/ (string)

Const TAG_KEYWORDS

TAG_KEYWORDS: string

comma separated keywords describing the content (string).

Const TAG_LANGUAGE_CODE

TAG_LANGUAGE_CODE: string

ISO-639-2 or ISO-639-1 code for the language the content is in (string)

There is utility API in libgsttag in gst-plugins-base to obtain a translated language name from the language code: gst_tag_get_language_name()

Const TAG_LANGUAGE_NAME

TAG_LANGUAGE_NAME: string

Name of the language the content is in (string)

Free-form name of the language the content is in, if a language code is not available. This tag should not be set in addition to a language code. It is undefined what language or locale the language name is in.

Const TAG_LICENSE

TAG_LICENSE: string

license of data (string)

Const TAG_LICENSE_URI

TAG_LICENSE_URI: string

URI to location where license details can be found (string)

Const TAG_LOCATION

TAG_LOCATION: string

Origin of media as a URI (location, where the original of the file or stream is hosted) (string)

Const TAG_LYRICS

TAG_LYRICS: string

The lyrics of the media (string)

Const TAG_MAXIMUM_BITRATE

TAG_MAXIMUM_BITRATE: string

maximum bitrate in bits/s (unsigned integer)

Const TAG_MIDI_BASE_NOTE

TAG_MIDI_BASE_NOTE: string

Midi note number of the audio track. This is useful for sample instruments and in particular for multi-samples.

Const TAG_MINIMUM_BITRATE

TAG_MINIMUM_BITRATE: string

minimum bitrate in bits/s (unsigned integer)

Const TAG_NOMINAL_BITRATE

TAG_NOMINAL_BITRATE: string

nominal bitrate in bits/s (unsigned integer). The actual bitrate might be different from this target bitrate.

Const TAG_ORGANIZATION

TAG_ORGANIZATION: string

organization (string)

Const TAG_PERFORMER

TAG_PERFORMER: string

person(s) performing (string)

Const TAG_PREVIEW_IMAGE

TAG_PREVIEW_IMAGE: string

image that is meant for preview purposes, e.g. small icon-sized version (sample) (sample taglist should specify the content type)

Const TAG_PRIVATE_DATA

TAG_PRIVATE_DATA: string

Any private data that may be contained in tags (sample).

It is represented by #GstSample in which #GstBuffer contains the binary data and the sample's info #GstStructure may contain any extra information that identifies the origin or meaning of the data.

Private frames in ID3v2 tags ('PRIV' frames) will be represented using this tag, in which case the GstStructure will be named "ID3PrivateFrame" and contain a field named "owner" of type string which contains the owner-identification string from the tag.

Const TAG_PUBLISHER

TAG_PUBLISHER: string

Name of the label or publisher (string)

Const TAG_REFERENCE_LEVEL

TAG_REFERENCE_LEVEL: string

reference level of track and album gain values (double)

Const TAG_SERIAL

TAG_SERIAL: string

serial number of track (unsigned integer)

Const TAG_SHOW_EPISODE_NUMBER

TAG_SHOW_EPISODE_NUMBER: string

Number of the episode within a season/show (unsigned integer)

Const TAG_SHOW_NAME

TAG_SHOW_NAME: string

Name of the show, used for displaying (string)

Const TAG_SHOW_SEASON_NUMBER

TAG_SHOW_SEASON_NUMBER: string

Number of the season of a show/series (unsigned integer)

Const TAG_SHOW_SORTNAME

TAG_SHOW_SORTNAME: string

Name of the show, used for sorting (string)

Const TAG_SUBTITLE_CODEC

TAG_SUBTITLE_CODEC: string

codec/format the subtitle data is stored in (string)

Const TAG_TITLE

TAG_TITLE: string

commonly used title (string)

The title as it should be displayed, e.g. 'The Doll House'

Const TAG_TITLE_SORTNAME

TAG_TITLE_SORTNAME: string

commonly used title, as used for sorting (string)

The title as it should be sorted, e.g. 'Doll House, The'

Const TAG_TRACK_COUNT

TAG_TRACK_COUNT: string

count of tracks inside collection this track belongs to (unsigned integer)

Const TAG_TRACK_GAIN

TAG_TRACK_GAIN: string

track gain in db (double)

Const TAG_TRACK_NUMBER

TAG_TRACK_NUMBER: string

track number inside a collection (unsigned integer)

Const TAG_TRACK_PEAK

TAG_TRACK_PEAK: string

peak of the track (double)

Const TAG_USER_RATING

TAG_USER_RATING: string

Rating attributed by a person (likely the application user). The higher the value, the more the user likes this media (unsigned int from 0 to 100)

Const TAG_VERSION

TAG_VERSION: string

version of this data (string)

Const TAG_VIDEO_CODEC

TAG_VIDEO_CODEC: string

codec the video data is stored in (string)

Const TOC_REPEAT_COUNT_INFINITE

TOC_REPEAT_COUNT_INFINITE: number

Special value for the repeat_count set in gst_toc_entry_set_loop() or returned by gst_toc_entry_set_loop() to indicate infinite looping.

Const URI_NO_PORT

URI_NO_PORT: number

Value for #GstUri.port to indicate no port number.

Const USECOND

USECOND: Gst.ClockTimeDiff

Constant that defines one GStreamer microsecond.

Const VALUE_EQUAL

VALUE_EQUAL: number

Indicates that the first value provided to a comparison function (gst_value_compare()) is equal to the second one.

Const VALUE_GREATER_THAN

VALUE_GREATER_THAN: number

Indicates that the first value provided to a comparison function (gst_value_compare()) is greater than the second one.

Const VALUE_LESS_THAN

VALUE_LESS_THAN: number

Indicates that the first value provided to a comparison function (gst_value_compare()) is lesser than the second one.

Const VALUE_UNORDERED

VALUE_UNORDERED: number

Indicates that the comparison function (gst_value_compare()) can not determine a order for the two provided values.

Const VERSION_MAJOR

VERSION_MAJOR: number

The major version of GStreamer at compile time:

Const VERSION_MICRO

VERSION_MICRO: number

The micro version of GStreamer at compile time:

Const VERSION_MINOR

VERSION_MINOR: number

The minor version of GStreamer at compile time:

Const VERSION_NANO

VERSION_NANO: number

The nano version of GStreamer at compile time: Actual releases have 0, GIT versions have 1, prerelease versions have 2-...

Functions

buffer_get_max_memory

  • buffer_get_max_memory(): number

  • Gets the maximum amount of memory blocks that a buffer can hold. This is a compile time constant that can be queried with the function.

    When more memory blocks are added, existing memory blocks will be merged together to make room for the new block.

    Returns number

buffer_list_replace

  • Modifies a pointer to a #GstBufferList to point to a different #GstBufferList. 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 buffer list is unreffed, the new is reffed).

    Either new_list or the #GstBufferList pointed to by old_list may be %NULL.

    Parameters

    • old_list: Gst.BufferList

      pointer to a pointer to a #GstBufferList to be replaced.

    • new_list: Gst.BufferList

      pointer to a #GstBufferList that will replace the buffer list pointed to by old_list.

    Returns [boolean, Gst.BufferList | null]

buffer_list_take

  • Modifies a pointer to a #GstBufferList to point to a different #GstBufferList. This function is similar to gst_buffer_list_replace() except that it takes ownership of new_list.

    Parameters

    • old_list: Gst.BufferList

      pointer to a pointer to a #GstBufferList to be replaced.

    • new_list: Gst.BufferList

      pointer to a #GstBufferList that will replace the bufferlist pointed to by old_list.

    Returns [boolean, Gst.BufferList]

caps_features_from_string

  • caps_features_from_string(features: string): CapsFeatures | null

caps_from_string

  • caps_from_string(string: string): Gst.Caps | null

  • Converts caps from a string representation.

    The implementation of serialization up to 1.20 would lead to unexpected results when there were nested #GstCaps / #GstStructure deeper than one level.

    Parameters

    • string: string

      a string to convert to #GstCaps

    Returns Gst.Caps | null

context_replace

  • Modifies a pointer to a #GstContext to point to a different #GstContext. 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 context is unreffed, the new one is reffed).

    Either new_context or the #GstContext pointed to by old_context may be %NULL.

    Parameters

    • old_context: Gst.Context

      pointer to a pointer to a #GstContext to be replaced.

    • new_context: Gst.Context

      pointer to a #GstContext that will replace the context pointed to by old_context.

    Returns [boolean, Gst.Context]

core_error_quark

  • core_error_quark(): Quark

debug_add_log_function

  • Adds the logging function to the list of logging functions. Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.

    Parameters

    Returns void

debug_add_ring_buffer_logger

  • debug_add_ring_buffer_logger(max_size_per_thread: number, thread_timeout: number): void

  • Adds a memory ringbuffer based debug logger that stores up to max_size_per_thread bytes of logs per thread and times out threads after thread_timeout seconds of inactivity.

    Logs can be fetched with gst_debug_ring_buffer_logger_get_logs() and the logger can be removed again with gst_debug_remove_ring_buffer_logger(). Only one logger at a time is possible.

    Parameters

    • max_size_per_thread: number

      Maximum size of log per thread in bytes

    • thread_timeout: number

      Timeout for threads in seconds

    Returns void

debug_bin_to_dot_data

  • To aid debugging applications one can use this method to obtain the whole network of gstreamer elements that form the pipeline into a dot file. This data can be processed with graphviz to get an image.

    Parameters

    Returns string

debug_bin_to_dot_file

  • To aid debugging applications one can use this method to write out the whole network of gstreamer elements that form the pipeline into a dot file. This file can be processed with graphviz to get an image.

     dot -Tpng -oimage.png graph_lowlevel.dot

    Parameters

    • bin: Gst.Bin

      the top-level pipeline that should be analyzed

    • details: Gst.DebugGraphDetails

      type of #GstDebugGraphDetails to use

    • file_name: string

      output base filename (e.g. "myplayer")

    Returns void

debug_bin_to_dot_file_with_ts

  • This works like gst_debug_bin_to_dot_file(), but adds the current timestamp to the filename, so that it can be used to take multiple snapshots.

    Parameters

    • bin: Gst.Bin

      the top-level pipeline that should be analyzed

    • details: Gst.DebugGraphDetails

      type of #GstDebugGraphDetails to use

    • file_name: string

      output base filename (e.g. "myplayer")

    Returns void

debug_construct_term_color

  • debug_construct_term_color(colorinfo: number): string

  • Constructs a string that can be used for getting the desired color in color terminals. You need to free the string after use.

    Parameters

    • colorinfo: number

      the color info

    Returns string

debug_construct_win_color

  • debug_construct_win_color(colorinfo: number): number

  • Constructs an integer that can be used for getting the desired color in windows' terminals (cmd.exe). As there is no mean to underline, we simply ignore this attribute.

    This function returns 0 on non-windows machines.

    Parameters

    • colorinfo: number

      the color info

    Returns number

debug_get_all_categories

debug_get_color_mode

debug_get_default_threshold

debug_get_stack_trace

debug_is_active

  • debug_is_active(): boolean

debug_is_colored

  • debug_is_colored(): boolean

debug_level_get_name

debug_log_default

  • The default logging handler used by GStreamer. Logging functions get called whenever a macro like GST_DEBUG or similar is used. By default this function is setup to output the message and additional info to stderr (or the log file specified via the GST_DEBUG_FILE environment variable) as received via user_data.

    You can add other handlers by using gst_debug_add_log_function(). And you can remove this handler by calling gst_debug_remove_log_function(gst_debug_log_default);

    Parameters

    • category: Gst.DebugCategory

      category to log

    • level: Gst.DebugLevel

      level of the message

    • file: string

      the file that emitted the message, usually the FILE identifier

    • function_: string

      the function that emitted the message

    • line: number

      the line from that the message was emitted, usually LINE

    • object: GObject.Object

      the object this message relates to, or %NULL if none

    • message: Gst.DebugMessage

      the actual message

    • user_data: object

      the FILE* to log to

    Returns void

debug_log_get_line

  • Returns the string representation for the specified debug log message formatted in the same way as gst_debug_log_default() (the default handler), without color. The purpose is to make it easy for custom log output handlers to get a log output that is identical to what the default handler would write out.

    Parameters

    • category: Gst.DebugCategory

      category to log

    • level: Gst.DebugLevel

      level of the message

    • file: string

      the file that emitted the message, usually the FILE identifier

    • function_: string

      the function that emitted the message

    • line: number

      the line from that the message was emitted, usually LINE

    • object: GObject.Object

      the object this message relates to, or %NULL if none

    • message: Gst.DebugMessage

      the actual message

    Returns string

debug_log_literal

  • Logs the given message using the currently registered debugging handlers.

    Parameters

    • category: Gst.DebugCategory

      category to log

    • level: Gst.DebugLevel

      level of the message is in

    • file: string

      the file that emitted the message, usually the FILE identifier

    • function_: string

      the function that emitted the message

    • line: number

      the line from that the message was emitted, usually LINE

    • object: GObject.Object

      the object this message relates to, or %NULL if none

    • message_string: string

      a message string

    Returns void

debug_print_stack_trace

  • debug_print_stack_trace(): void

debug_remove_log_function

  • Removes all registered instances of the given logging functions.

    Parameters

    • func: Gst.LogFunction

      the log function to remove, or %NULL to remove the default log function

    Returns number

debug_remove_log_function_by_data

  • debug_remove_log_function_by_data(data: object): number

  • Removes all registered instances of log functions with the given user data.

    Parameters

    • data: object

      user data of the log function to remove

    Returns number

debug_remove_ring_buffer_logger

  • debug_remove_ring_buffer_logger(): void

  • Removes any previously added ring buffer logger with gst_debug_add_ring_buffer_logger().

    Returns void

debug_ring_buffer_logger_get_logs

  • debug_ring_buffer_logger_get_logs(): string[]

  • Fetches the current logs per thread from the ring buffer logger. See gst_debug_add_ring_buffer_logger() for details.

    Returns string[]

debug_set_active

  • debug_set_active(active: boolean): void

  • If activated, debugging messages are sent to the debugging handlers. It makes sense to deactivate it for speed issues.

    This function is not threadsafe. It makes sense to only call it during initialization.

    Parameters

    • active: boolean

      Whether to use debugging output or not

    Returns void

debug_set_color_mode

  • Changes the coloring mode for debug output.

    This function may be called before gst_init().

    Parameters

    • mode: DebugColorMode

      The coloring mode for debug output. See GstDebugColorMode.

    Returns void

debug_set_color_mode_from_string

  • debug_set_color_mode_from_string(mode: string): void

  • Changes the coloring mode for debug output.

    This function may be called before gst_init().

    Parameters

    • mode: string

      The coloring mode for debug output. One of the following: "on", "auto", "off", "disable", "unix".

    Returns void

debug_set_colored

  • debug_set_colored(colored: boolean): void

  • Sets or unsets the use of coloured debugging output. Same as gst_debug_set_color_mode () with the argument being being GST_DEBUG_COLOR_MODE_ON or GST_DEBUG_COLOR_MODE_OFF.

    This function may be called before gst_init().

    Parameters

    • colored: boolean

      Whether to use colored output or not

    Returns void

debug_set_default_threshold

  • Sets the default threshold to the given level and updates all categories to use this threshold.

    This function may be called before gst_init().

    Parameters

    Returns void

debug_set_threshold_for_name

  • debug_set_threshold_for_name(name: string, level: Gst.DebugLevel): void

  • Sets all categories which match the given glob style pattern to the given level.

    Parameters

    • name: string

      name of the categories to set

    • level: Gst.DebugLevel

      level to set them to

    Returns void

debug_set_threshold_from_string

  • debug_set_threshold_from_string(list: string, reset: boolean): void

  • Sets the debug logging wanted in the same form as with the GST_DEBUG environment variable. You can use wildcards such as '*', but note that the order matters when you use wild cards, e.g. "foosrc:6,src:3,:2" sets everything to log level 2.

    Parameters

    • list: string

      comma-separated list of "category:level" pairs to be used as debug logging levels

    • reset: boolean

      %TRUE to clear all previously-set debug levels before setting new thresholds %FALSE if adding the threshold described by list to the one already set.

    Returns void

debug_unset_threshold_for_name

  • debug_unset_threshold_for_name(name: string): void

  • Resets all categories with the given name back to the default level.

    Parameters

    • name: string

      name of the categories to set

    Returns void

deinit

  • deinit(): void

  • Clean up any resources created by GStreamer in gst_init().

    It is normally not needed to call this function in a normal application as the resources will automatically be freed when the program terminates. This function is therefore mostly used by testsuites and other memory profiling tools.

    After this call GStreamer (including this method) should not be used anymore.

    Returns void

dynamic_type_register

  • dynamic_type_register(plugin: Gst.Plugin, type: GType<unknown>): boolean

  • Registers a new #GstDynamicTypeFactory in the registry

    Parameters

    • plugin: Gst.Plugin

      The #GstPlugin to register dyn_type for

    • type: GType<unknown>

      The #GType to register dynamically

    Returns boolean

error_get_message

  • error_get_message(domain: number, code: number): string

  • Get a string describing the error message in the current locale.

    Parameters

    • domain: number

      the GStreamer error domain this error belongs to.

    • code: number

      the error code belonging to the domain.

    Returns string

event_type_get_flags

event_type_get_name

event_type_to_quark

filename_to_uri

  • filename_to_uri(filename: string): string

  • Similar to g_filename_to_uri(), but attempts to handle relative file paths as well. Before converting filename into an URI, it will be prefixed by the current working directory if it is a relative path, and then the path will be canonicalised so that it doesn't contain any './' or '../' segments.

    On Windows filename should be in UTF-8 encoding.

    Parameters

    • filename: string

      absolute or relative file name path

    Returns string

flow_get_name

flow_to_quark

format_get_by_nick

format_get_details

format_get_name

  • format_get_name(format: Gst.Format): string | null

format_iterate_definitions

format_register

  • format_register(nick: string, description: string): Gst.Format

  • Create a new GstFormat based on the nick or return an already registered format with that nick.

    Parameters

    • nick: string

      The nick of the new format

    • description: string

      The description of the new format

    Returns Gst.Format

format_to_quark

formats_contains

get_main_executable_path

  • get_main_executable_path(): string | null

  • This helper is mostly helpful for plugins that need to inspect the folder of the main executable to determine their set of features.

    When a plugin is initialized from the gst-plugin-scanner external process, the returned path will be the same as from the parent process.

    Returns string | null

init

  • init(argv: string[]): string[] | null

  • Initializes the GStreamer library, setting up internal path lists, registering built-in elements, and loading standard plugins.

    Unless the plugin registry is disabled at compile time, the registry will be loaded. By default this will also check if the registry cache needs to be updated and rescan all plugins if needed. See gst_update_registry() for details and section

    Running GStreamer Applications for how to disable automatic registry updates.

    WARNING: This function will terminate your program if it was unable to initialize GStreamer for some reason. If you want your program to fall back, use gst_init_check() instead.

    WARNING: This function does not work in the same way as corresponding functions in other glib-style libraries, such as gtk_init(). In particular, unknown command line options cause this function to abort program execution.

    Parameters

    • argv: string[]

      pointer to application's argv

    Returns string[] | null

init_check

  • init_check(argv: string[]): [boolean, string[] | null]

  • Initializes the GStreamer library, setting up internal path lists, registering built-in elements, and loading standard plugins.

    This function will return %FALSE if GStreamer could not be initialized for some reason. If you want your program to fail fatally, use gst_init() instead.

    Parameters

    • argv: string[]

      pointer to application's argv

    Returns [boolean, string[] | null]

is_caps_features

  • is_caps_features(obj: object): boolean

is_initialized

  • is_initialized(): boolean

  • Use this function to check if GStreamer has been initialized with gst_init() or gst_init_check().

    Returns boolean

library_error_quark

  • library_error_quark(): Quark

message_take

  • Modifies a pointer to a #GstMessage to point to a different #GstMessage. This function is similar to gst_message_replace() except that it takes ownership of new_message.

    Parameters

    • old_message: Gst.Message

      pointer to a pointer to a #GstMessage to be replaced.

    • new_message: Gst.Message

      pointer to a #GstMessage that will replace the message pointed to by old_message.

    Returns [boolean, Gst.Message]

message_type_get_name

message_type_to_quark

meta_api_type_get_tags

  • meta_api_type_get_tags(api: GType<unknown>): string[]

meta_api_type_has_tag

  • meta_api_type_has_tag(api: GType<unknown>, tag: number): boolean

meta_api_type_register

  • meta_api_type_register(api: string, tags: string[]): GType

  • Register and return a GType for the api and associate it with tags.

    Parameters

    • api: string

      an API to register

    • tags: string[]

      tags for api

    Returns GType

meta_get_info

meta_register

  • Register a new #GstMeta implementation.

    The same info can be retrieved later with gst_meta_get_info() by using impl as the key.

    Parameters

    • api: GType<unknown>

      the type of the #GstMeta API

    • impl: string

      the name of the #GstMeta implementation

    • size: number

      the size of the #GstMeta structure

    • init_func: MetaInitFunction

      a #GstMetaInitFunction

    • free_func: MetaFreeFunction

      a #GstMetaFreeFunction

    • transform_func: MetaTransformFunction

      a #GstMetaTransformFunction

    Returns Gst.MetaInfo

meta_register_custom

  • Register a new custom #GstMeta implementation, backed by an opaque structure holding a #GstStructure.

    The registered info can be retrieved later with gst_meta_get_info() by using name as the key.

    The backing #GstStructure can be retrieved with gst_custom_meta_get_structure(), its mutability is conditioned by the writability of the buffer the meta is attached to.

    When transform_func is %NULL, the meta and its backing #GstStructure will always be copied when the transform operation is copy, other operations are discarded, copy regions are ignored.

    Parameters

    • name: string

      the name of the #GstMeta implementation

    • tags: string[]

      tags for api

    • transform_func: CustomMetaTransformFunction

      a #GstMetaTransformFunction

    Returns Gst.MetaInfo

mini_object_replace

  • Atomically modifies a pointer to point to a new mini-object. The reference count of olddata is decreased and the reference count of newdata is increased.

    Either newdata and the value pointed to by olddata may be %NULL.

    Parameters

    Returns [boolean, Gst.MiniObject | null]

mini_object_take

  • Modifies a pointer to point to a new mini-object. The modification is done atomically. This version is similar to gst_mini_object_replace() except that it does not increase the refcount of newdata and thus takes ownership of newdata.

    Either newdata and the value pointed to by olddata may be %NULL.

    Parameters

    Returns [boolean, Gst.MiniObject]

pad_mode_get_name

  • pad_mode_get_name(mode: PadMode): string

param_spec_array

  • This function creates a GstArray GParamSpec for use by objects/elements that want to expose properties of GstArray type. This function is typically * used in connection with g_object_class_install_property() in a GObjects's instance_init function.

    Parameters

    • name: string

      canonical name of the property specified

    • nick: string

      nick name for the property specified

    • blurb: string

      description of the property specified

    • element_spec: ParamSpec

      GParamSpec of the array

    • flags: GObject.ParamFlags

      flags for the property specified

    Returns ParamSpec

param_spec_fraction

  • param_spec_fraction(name: string, nick: string, blurb: string, min_num: number, min_denom: number, max_num: number, max_denom: number, default_num: number, default_denom: number, flags: GObject.ParamFlags): ParamSpec | null

  • This function creates a fraction GParamSpec for use by objects/elements that want to expose properties of fraction type. This function is typically used in connection with g_object_class_install_property() in a GObjects's instance_init function.

    Parameters

    • name: string

      canonical name of the property specified

    • nick: string

      nick name for the property specified

    • blurb: string

      description of the property specified

    • min_num: number

      minimum value (fraction numerator)

    • min_denom: number

      minimum value (fraction denominator)

    • max_num: number

      maximum value (fraction numerator)

    • max_denom: number

      maximum value (fraction denominator)

    • default_num: number

      default value (fraction numerator)

    • default_denom: number

      default value (fraction denominator)

    • flags: GObject.ParamFlags

      flags for the property specified

    Returns ParamSpec | null

parent_buffer_meta_api_get_type

  • parent_buffer_meta_api_get_type(): GType

parent_buffer_meta_get_info

parse_bin_from_description

  • parse_bin_from_description(bin_description: string, ghost_unlinked_pads: boolean): Gst.Bin

  • This is a convenience wrapper around gst_parse_launch() to create a #GstBin from a gst-launch-style pipeline description. See gst_parse_launch() and the gst-launch man page for details about the syntax. Ghost pads on the bin for unlinked source or sink pads within the bin can automatically be created (but only a maximum of one ghost pad for each direction will be created; if you expect multiple unlinked source pads or multiple unlinked sink pads and want them all ghosted, you will have to create the ghost pads yourself).

    Parameters

    • bin_description: string

      command line describing the bin

    • ghost_unlinked_pads: boolean

      whether to automatically create ghost pads for unlinked source or sink pads within the bin

    Returns Gst.Bin

parse_bin_from_description_full

  • This is a convenience wrapper around gst_parse_launch() to create a #GstBin from a gst-launch-style pipeline description. See gst_parse_launch() and the gst-launch man page for details about the syntax. Ghost pads on the bin for unlinked source or sink pads within the bin can automatically be created (but only a maximum of one ghost pad for each direction will be created; if you expect multiple unlinked source pads or multiple unlinked sink pads and want them all ghosted, you will have to create the ghost pads yourself).

    Parameters

    • bin_description: string

      command line describing the bin

    • ghost_unlinked_pads: boolean

      whether to automatically create ghost pads for unlinked source or sink pads within the bin

    • context: Gst.ParseContext

      a parse context allocated with gst_parse_context_new(), or %NULL

    • flags: Gst.ParseFlags

      parsing options, or #GST_PARSE_FLAG_NONE

    Returns Gst.Element

parse_error_quark

  • parse_error_quark(): Quark

parse_launch

  • parse_launch(pipeline_description: string): Gst.Element

  • Create a new pipeline based on command line syntax. Please note that you might get a return value that is not %NULL even though the error is set. In this case there was a recoverable parsing error and you can try to play the pipeline.

    To create a sub-pipeline (bin) for embedding into an existing pipeline use gst_parse_bin_from_description().

    Parameters

    • pipeline_description: string

      the command line describing the pipeline

    Returns Gst.Element

parse_launch_full

  • Create a new pipeline based on command line syntax. Please note that you might get a return value that is not %NULL even though the error is set. In this case there was a recoverable parsing error and you can try to play the pipeline.

    To create a sub-pipeline (bin) for embedding into an existing pipeline use gst_parse_bin_from_description_full().

    Parameters

    • pipeline_description: string

      the command line describing the pipeline

    • context: Gst.ParseContext

      a parse context allocated with gst_parse_context_new(), or %NULL

    • flags: Gst.ParseFlags

      parsing options, or #GST_PARSE_FLAG_NONE

    Returns Gst.Element

parse_launchv

  • Create a new element based on command line syntax. error will contain an error message if an erroneous pipeline is specified. An error does not mean that the pipeline could not be constructed.

    Parameters

    • argv: string[]

      null-terminated array of arguments

    Returns Gst.Element

parse_launchv_full

  • Create a new element based on command line syntax. error will contain an error message if an erroneous pipeline is specified. An error does not mean that the pipeline could not be constructed.

    Parameters

    • argv: string[]

      null-terminated array of arguments

    • context: Gst.ParseContext

      a parse context allocated with gst_parse_context_new(), or %NULL

    • flags: Gst.ParseFlags

      parsing options, or #GST_PARSE_FLAG_NONE

    Returns Gst.Element

plugin_error_quark

  • plugin_error_quark(): Quark

preset_get_app_dir

  • preset_get_app_dir(): string | null

  • Gets the directory for application specific presets if set by the application.

    Returns string | null

preset_set_app_dir

  • preset_set_app_dir(app_dir: string): boolean

  • Sets an extra directory as an absolute path that should be considered when looking for presets. Any presets in the application dir will shadow the system presets.

    Parameters

    • app_dir: string

      the application specific preset dir

    Returns boolean

protection_filter_systems_by_available_decryptors

  • protection_filter_systems_by_available_decryptors(system_identifiers: string[]): string[] | null

  • Iterates the supplied list of UUIDs and checks the GstRegistry for all the decryptors supporting one of the supplied UUIDs.

    Parameters

    • system_identifiers: string[]

      A null terminated array of strings that contains the UUID values of each protection system that is to be checked.

    Returns string[] | null

protection_meta_api_get_type

  • protection_meta_api_get_type(): GType

protection_meta_get_info

protection_select_system

  • protection_select_system(system_identifiers: string[]): string | null

  • Iterates the supplied list of UUIDs and checks the GstRegistry for an element that supports one of the supplied UUIDs. If more than one element matches, the system ID of the highest ranked element is selected.

    Parameters

    • system_identifiers: string[]

      A null terminated array of strings that contains the UUID values of each protection system that is to be checked.

    Returns string | null

query_take

  • Modifies a pointer to a #GstQuery to point to a different #GstQuery. This function is similar to gst_query_replace() except that it takes ownership of new_query.

    Either new_query or the #GstQuery pointed to by old_query may be %NULL.

    Parameters

    • old_query: Gst.Query

      pointer to a pointer to a #GstQuery to be stolen.

    • new_query: Gst.Query

      pointer to a #GstQuery that will replace the query pointed to by old_query.

    Returns [boolean, Gst.Query | null]

query_type_get_flags

query_type_get_name

query_type_to_quark

reference_timestamp_meta_api_get_type

  • reference_timestamp_meta_api_get_type(): GType

reference_timestamp_meta_get_info

resource_error_quark

  • resource_error_quark(): Quark

segtrap_is_enabled

  • segtrap_is_enabled(): boolean

  • Some functions in the GStreamer core might install a custom SIGSEGV handler to better catch and report errors to the application. Currently this feature is enabled by default when loading plugins.

    Applications might want to disable this behaviour with the gst_segtrap_set_enabled() function. This is typically done if the application wants to install its own handler without GStreamer interfering.

    Returns boolean

segtrap_set_enabled

  • segtrap_set_enabled(enabled: boolean): void

  • Applications might want to disable/enable the SIGSEGV handling of the GStreamer core. See gst_segtrap_is_enabled() for more information.

    Parameters

    • enabled: boolean

      whether a custom SIGSEGV handler should be installed.

    Returns void

state_change_get_name

static_caps_get_type

  • static_caps_get_type(): GType

static_pad_template_get_type

  • static_pad_template_get_type(): GType

stream_error_quark

  • stream_error_quark(): Quark

stream_type_get_name

structure_take

  • Atomically modifies a pointer to point to a new structure. The #GstStructure oldstr_ptr is pointing to is freed and newstr is taken ownership over.

    Either newstr and the value pointed to by oldstr_ptr may be %NULL.

    It is a programming error if both newstr and the value pointed to by oldstr_ptr refer to the same, non-%NULL structure.

    Parameters

    Returns [boolean, Gst.Structure | null]

tag_exists

  • tag_exists(tag: string): boolean

  • Checks if the given type is already registered.

    Parameters

    • tag: string

      name of the tag

    Returns boolean

tag_get_description

  • tag_get_description(tag: string): string | null

  • Returns the human-readable description of this tag, You must not change or free this string.

    Parameters

    • tag: string

      the tag

    Returns string | null

tag_get_flag

tag_get_nick

  • tag_get_nick(tag: string): string | null

  • Returns the human-readable name of this tag, You must not change or free this string.

    Parameters

    • tag: string

      the tag

    Returns string | null

tag_get_type

  • tag_get_type(tag: string): GType

tag_is_fixed

  • tag_is_fixed(tag: string): boolean

  • Checks if the given tag is fixed. A fixed tag can only contain one value. Unfixed tags can contain lists of values.

    Parameters

    • tag: string

      tag to check

    Returns boolean

tag_list_copy_value

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

tag_list_replace

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

tag_list_take

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

tag_merge_strings_with_comma

  • tag_merge_strings_with_comma(src: any): any

  • This is a convenience function for the func argument of gst_tag_register(). It concatenates all given strings using a comma. The tag must be registered as a G_TYPE_STRING or this function will fail.

    Parameters

    • src: any

      GValue to copy from

    Returns any

tag_merge_use_first

  • tag_merge_use_first(src: any): any

  • This is a convenience function for the func argument of gst_tag_register(). It creates a copy of the first value from the list.

    Parameters

    • src: any

      GValue to copy from

    Returns any

toc_entry_type_get_nick

tracing_get_active_tracers

  • tracing_get_active_tracers(): Tracer[]

  • Get a list of all active tracer objects owned by the tracing framework for the entirety of the run-time of the process or till gst_deinit() is called.

    Returns Tracer[]

tracing_register_hook

  • Register func to be called when the trace hook detail is getting invoked. Use %NULL for detail to register to all hooks.

    Parameters

    Returns void

type_find_get_type

  • type_find_get_type(): GType

type_find_register

  • Registers a new typefind function to be used for typefinding. After registering this function will be available for typefinding. This function is typically called during an element's plugin initialization.

    Parameters

    • plugin: Gst.Plugin

      A #GstPlugin, or %NULL for a static typefind function

    • name: string

      The name for registering

    • rank: number

      The rank (or importance) of this typefind function

    • func: Gst.TypeFindFunction

      The #GstTypeFindFunction to use

    • extensions: string

      Optional comma-separated list of extensions that could belong to this type

    • possible_caps: Gst.Caps

      Optionally the caps that could be returned when typefinding succeeds

    Returns boolean

type_is_plugin_api

type_mark_as_plugin_api

  • Marks type as plugin API. This should be called in class_init of elements that expose new types (i.e. enums, flags or internal GObjects) via properties, signals or pad templates.

    Types exposed by plugins are not automatically added to the documentation as they might originate from another library and should in that case be documented via that library instead.

    By marking a type as plugin API it will be included in the documentation of the plugin that defines it.

    Parameters

    • type: GType<unknown>

      a GType

    • flags: PluginAPIFlags

      a set of #GstPluginAPIFlags to further inform cache generation.

    Returns void

update_registry

  • update_registry(): boolean

  • Forces GStreamer to re-scan its plugin paths and update the default plugin registry.

    Applications will almost never need to call this function, it is only useful if the application knows new plugins have been installed (or old ones removed) since the start of the application (or, to be precise, the first call to gst_init()) and the application wants to make use of any newly-installed plugins without restarting the application.

    Applications should assume that the registry update is neither atomic nor thread-safe and should therefore not have any dynamic pipelines running (including the playbin and decodebin elements) and should also not create any elements or access the GStreamer registry while the update is in progress.

    Note that this function may block for a significant amount of time.

    Returns boolean

uri_construct

  • uri_construct(protocol: string, location: string): string

  • Constructs a URI for a given valid protocol and location.

    Free-function: g_free

    Parameters

    • protocol: string

      Protocol for URI

    • location: string

      Location for URI

    Returns string

uri_error_quark

uri_from_string

  • uri_from_string(uri: string): Gst.Uri | null

  • Parses a URI string into a new #GstUri object. Will return NULL if the URI cannot be parsed.

    Parameters

    • uri: string

      The URI string to parse.

    Returns Gst.Uri | null

uri_from_string_escaped

  • uri_from_string_escaped(uri: string): Gst.Uri | null

  • Parses a URI string into a new #GstUri object. Will return NULL if the URI cannot be parsed. This is identical to gst_uri_from_string() except that the userinfo and fragment components of the URI will not be unescaped while parsing.

    Use this when you need to extract a username and password from the userinfo such as https://user:password`example`.com since either may contain a URI-escaped ':' character. gst_uri_from_string() will unescape the entire userinfo component, which will make it impossible to know which ':' delineates the username and password.

    The same applies to the fragment component of the URI, such as https://example.com/path#fragment which may contain a URI-escaped '#'.

    Parameters

    • uri: string

      The URI string to parse.

    Returns Gst.Uri | null

uri_get_location

  • uri_get_location(uri: string): string | null

  • Extracts the location out of a given valid URI, ie. the protocol and "://" are stripped from the URI, which means that the location returned includes the hostname if one is specified. The returned string must be freed using g_free().

    Free-function: g_free

    Parameters

    • uri: string

      A URI string

    Returns string | null

uri_get_protocol

  • uri_get_protocol(uri: string): string | null

  • Extracts the protocol out of a given valid URI. The returned string must be freed using g_free().

    Parameters

    • uri: string

      A URI string

    Returns string | null

uri_has_protocol

  • uri_has_protocol(uri: string, protocol: string): boolean

  • Checks if the protocol of a given valid URI matches protocol.

    Parameters

    • uri: string

      a URI string

    • protocol: string

      a protocol string (e.g. "http")

    Returns boolean

uri_is_valid

  • uri_is_valid(uri: string): boolean

  • Tests if the given string is a valid URI identifier. URIs start with a valid scheme followed by ":" and maybe a string identifying the location.

    Parameters

    • uri: string

      A URI string

    Returns boolean

uri_join_strings

  • uri_join_strings(base_uri: string, ref_uri: string): string

  • This is a convenience function to join two URI strings and return the result. The returned string should be g_free()'d after use.

    Parameters

    • base_uri: string

      The percent-encoded base URI.

    • ref_uri: string

      The percent-encoded reference URI to join to the base_uri.

    Returns string

uri_protocol_is_supported

  • uri_protocol_is_supported(type: Gst.URIType, protocol: string): boolean

  • Checks if an element exists that supports the given URI protocol. Note that a positive return value does not imply that a subsequent call to gst_element_make_from_uri() is guaranteed to work.

    Parameters

    • type: Gst.URIType

      Whether to check for a source or a sink

    • protocol: string

      Protocol that should be checked for (e.g. "http" or "smb")

    Returns boolean

uri_protocol_is_valid

  • uri_protocol_is_valid(protocol: string): boolean

  • Tests if the given string is a valid protocol identifier. Protocols must consist of alphanumeric characters, '+', '-' and '.' and must start with a alphabetic character. See RFC 3986 Section 3.1.

    Parameters

    • protocol: string

      A string

    Returns boolean

util_array_binary_search

  • util_array_binary_search(array: object, num_elements: number, element_size: number, search_func: CompareDataFunc, mode: Gst.SearchMode, search_data: object): object | null

  • Searches inside array for search_data by using the comparison function search_func. array must be sorted ascending.

    As search_data is always passed as second argument to search_func it's not required that search_data has the same type as the array elements.

    The complexity of this search function is O(log (num_elements)).

    Parameters

    • array: object

      the sorted input array

    • num_elements: number

      number of elements in the array

    • element_size: number

      size of every element in bytes

    • search_func: CompareDataFunc

      function to compare two elements, search_data will always be passed as second argument

    • mode: Gst.SearchMode

      search mode that should be used

    • search_data: object

      element that should be found

    Returns object | null

util_double_to_fraction

  • util_double_to_fraction(src: number): [number, number]

  • Transforms a #gdouble to a fraction and simplifies the result.

    Parameters

    • src: number

      #gdouble to transform

    Returns [number, number]

util_dump_buffer

  • Dumps the buffer memory into a hex representation. Useful for debugging.

    Parameters

    • buf: Gst.Buffer

      a #GstBuffer whose memory to dump

    Returns void

util_dump_mem

  • util_dump_mem(mem: Uint8Array): void

  • Dumps the memory block into a hex representation. Useful for debugging.

    Parameters

    • mem: Uint8Array

      a pointer to the memory to dump

    Returns void

util_fraction_add

  • util_fraction_add(a_n: number, a_d: number, b_n: number, b_d: number): [boolean, number, number]

  • Adds the fractions a_n/``a_d and b_n/``b_d and stores the result in res_n and res_d.

    Parameters

    • a_n: number

      Numerator of first value

    • a_d: number

      Denominator of first value

    • b_n: number

      Numerator of second value

    • b_d: number

      Denominator of second value

    Returns [boolean, number, number]

util_fraction_compare

  • util_fraction_compare(a_n: number, a_d: number, b_n: number, b_d: number): number

  • Compares the fractions a_n/``a_d and b_n/``b_d and returns -1 if a < b, 0 if a = b and 1 if a > b.

    Parameters

    • a_n: number

      Numerator of first value

    • a_d: number

      Denominator of first value

    • b_n: number

      Numerator of second value

    • b_d: number

      Denominator of second value

    Returns number

util_fraction_multiply

  • util_fraction_multiply(a_n: number, a_d: number, b_n: number, b_d: number): [boolean, number, number]

  • Multiplies the fractions a_n/``a_d and b_n/``b_d and stores the result in res_n and res_d.

    Parameters

    • a_n: number

      Numerator of first value

    • a_d: number

      Denominator of first value

    • b_n: number

      Numerator of second value

    • b_d: number

      Denominator of second value

    Returns [boolean, number, number]

util_fraction_to_double

  • util_fraction_to_double(src_n: number, src_d: number): number

  • Transforms a fraction to a #gdouble.

    Parameters

    • src_n: number

      Fraction numerator as #gint

    • src_d: number

      Fraction denominator #gint

    Returns number

util_gdouble_to_guint64

  • util_gdouble_to_guint64(value: number): number

util_get_object_array

  • Get a property of type %GST_TYPE_ARRAY and transform it into a #GValueArray. This allow language bindings to get GST_TYPE_ARRAY properties which are otherwise not an accessible type.

    Parameters

    • object: GObject.Object

      the object to set the array to

    • name: string

      the name of the property to set

    Returns [boolean, GObject.ValueArray]

util_get_timestamp

util_greatest_common_divisor

  • util_greatest_common_divisor(a: number, b: number): number

  • Calculates the greatest common divisor of a and b.

    Parameters

    • a: number

      First value as #gint

    • b: number

      Second value as #gint

    Returns number

util_greatest_common_divisor_int64

  • util_greatest_common_divisor_int64(a: number, b: number): number

  • Calculates the greatest common divisor of a and b.

    Parameters

    • a: number

      First value as #gint64

    • b: number

      Second value as #gint64

    Returns number

util_group_id_next

  • util_group_id_next(): number

  • Return a constantly incrementing group id.

    This function is used to generate a new group-id for the stream-start event.

    This function never returns %GST_GROUP_ID_INVALID (which is 0)

    Returns number

util_guint64_to_gdouble

  • util_guint64_to_gdouble(value: number): number

util_seqnum_compare

  • util_seqnum_compare(s1: number, s2: number): number

  • Compare two sequence numbers, handling wraparound.

    The current implementation just returns (gint32)(s1 - s2).

    Parameters

    • s1: number

      A sequence number.

    • s2: number

      Another sequence number.

    Returns number

util_seqnum_next

  • util_seqnum_next(): number

  • Return a constantly incrementing sequence number.

    This function is used internally to GStreamer to be able to determine which events and messages are "the same". For example, elements may set the seqnum on a segment-done message to be the same as that of the last seek event, to indicate that event and the message correspond to the same segment.

    This function never returns %GST_SEQNUM_INVALID (which is 0).

    Returns number

util_set_object_arg

  • util_set_object_arg(object: GObject.Object, name: string, value: string): void

  • Converts the string value to the type of the objects argument and sets the argument with it.

    Note that this function silently returns if object has no property named name or when value cannot be converted to the type of the property.

    Parameters

    • object: GObject.Object

      the object to set the argument of

    • name: string

      the name of the argument to set

    • value: string

      the string value to set

    Returns void

util_set_object_array

  • Transfer a #GValueArray to %GST_TYPE_ARRAY and set this value on the specified property name. This allow language bindings to set GST_TYPE_ARRAY properties which are otherwise not an accessible type.

    Parameters

    • object: GObject.Object

      the object to set the array to

    • name: string

      the name of the property to set

    • array: GObject.ValueArray

      a #GValueArray containing the values

    Returns boolean

util_set_value_from_string

  • util_set_value_from_string(value_str: string): any

  • Converts the string to the type of the value and sets the value with it.

    Note that this function is dangerous as it does not return any indication if the conversion worked or not.

    Parameters

    • value_str: string

      the string to get the value from

    Returns any

util_uint64_scale

  • util_uint64_scale(val: number, num: number, denom: number): number

  • Scale val by the rational number num / denom, avoiding overflows and underflows and without loss of precision.

    This function can potentially be very slow if val and num are both greater than G_MAXUINT32.

    Parameters

    • val: number

      the number to scale

    • num: number

      the numerator of the scale ratio

    • denom: number

      the denominator of the scale ratio

    Returns number

util_uint64_scale_ceil

  • util_uint64_scale_ceil(val: number, num: number, denom: number): number

  • Scale val by the rational number num / denom, avoiding overflows and underflows and without loss of precision.

    This function can potentially be very slow if val and num are both greater than G_MAXUINT32.

    Parameters

    • val: number

      the number to scale

    • num: number

      the numerator of the scale ratio

    • denom: number

      the denominator of the scale ratio

    Returns number

util_uint64_scale_int

  • util_uint64_scale_int(val: number, num: number, denom: number): number

  • Scale val by the rational number num / denom, avoiding overflows and underflows and without loss of precision. num must be non-negative and denom must be positive.

    Parameters

    • val: number

      guint64 (such as a #GstClockTime) to scale.

    • num: number

      numerator of the scale factor.

    • denom: number

      denominator of the scale factor.

    Returns number

util_uint64_scale_int_ceil

  • util_uint64_scale_int_ceil(val: number, num: number, denom: number): number

  • Scale val by the rational number num / denom, avoiding overflows and underflows and without loss of precision. num must be non-negative and denom must be positive.

    Parameters

    • val: number

      guint64 (such as a #GstClockTime) to scale.

    • num: number

      numerator of the scale factor.

    • denom: number

      denominator of the scale factor.

    Returns number

util_uint64_scale_int_round

  • util_uint64_scale_int_round(val: number, num: number, denom: number): number

  • Scale val by the rational number num / denom, avoiding overflows and underflows and without loss of precision. num must be non-negative and denom must be positive.

    Parameters

    • val: number

      guint64 (such as a #GstClockTime) to scale.

    • num: number

      numerator of the scale factor.

    • denom: number

      denominator of the scale factor.

    Returns number

util_uint64_scale_round

  • util_uint64_scale_round(val: number, num: number, denom: number): number

  • Scale val by the rational number num / denom, avoiding overflows and underflows and without loss of precision.

    This function can potentially be very slow if val and num are both greater than G_MAXUINT32.

    Parameters

    • val: number

      the number to scale

    • num: number

      the numerator of the scale ratio

    • denom: number

      the denominator of the scale ratio

    Returns number

value_can_compare

  • value_can_compare(value1: any, value2: any): boolean

  • Determines if value1 and value2 can be compared.

    Parameters

    • value1: any

      a value to compare

    • value2: any

      another value to compare

    Returns boolean

value_can_intersect

  • value_can_intersect(value1: any, value2: any): boolean

  • Determines if intersecting two values will produce a valid result. Two values will produce a valid intersection if they have the same type.

    Parameters

    • value1: any

      a value to intersect

    • value2: any

      another value to intersect

    Returns boolean

value_can_subtract

  • value_can_subtract(minuend: any, subtrahend: any): boolean

  • Checks if it's possible to subtract subtrahend from minuend.

    Parameters

    • minuend: any

      the value to subtract from

    • subtrahend: any

      the value to subtract

    Returns boolean

value_can_union

  • value_can_union(value1: any, value2: any): boolean

  • Determines if value1 and value2 can be non-trivially unioned. Any two values can be trivially unioned by adding both of them to a GstValueList. However, certain types have the possibility to be unioned in a simpler way. For example, an integer range and an integer can be unioned if the integer is a subset of the integer range. If there is the possibility that two values can be unioned, this function returns %TRUE.

    Parameters

    • value1: any

      a value to union

    • value2: any

      another value to union

    Returns boolean

value_compare

  • value_compare(value1: any, value2: any): number

  • Compares value1 and value2. If value1 and value2 cannot be compared, the function returns GST_VALUE_UNORDERED. Otherwise, if value1 is greater than value2, GST_VALUE_GREATER_THAN is returned. If value1 is less than value2, GST_VALUE_LESS_THAN is returned. If the values are equal, GST_VALUE_EQUAL is returned.

    Parameters

    • value1: any

      a value to compare

    • value2: any

      another value to compare

    Returns number

value_deserialize

  • value_deserialize(src: string): [boolean, any]

  • Tries to deserialize a string into the type specified by the given GValue. If the operation succeeds, %TRUE is returned, %FALSE otherwise.

    Parameters

    • src: string

      string to deserialize

    Returns [boolean, any]

value_deserialize_with_pspec

  • value_deserialize_with_pspec(src: string, pspec: ParamSpec): [boolean, any]

  • Tries to deserialize a string into the type specified by the given GValue. pspec may be used to guide the deserializing of nested members. If the operation succeeds, %TRUE is returned, %FALSE otherwise.

    Parameters

    • src: string

      string to deserialize

    • pspec: ParamSpec

      the #GParamSpec describing the expected value

    Returns [boolean, any]

value_fixate

  • value_fixate(dest: any, src: any): boolean

  • Fixate src into a new value dest. For ranges, the first element is taken. For lists and arrays, the first item is fixated and returned. If src is already fixed, this function returns %FALSE.

    Parameters

    • dest: any

      the #GValue destination

    • src: any

      the #GValue to fixate

    Returns boolean

value_fraction_multiply

  • value_fraction_multiply(product: any, factor1: any, factor2: any): boolean

  • Multiplies the two #GValue items containing a #GST_TYPE_FRACTION and sets product to the product of the two fractions.

    Parameters

    • product: any

      a GValue initialized to #GST_TYPE_FRACTION

    • factor1: any

      a GValue initialized to #GST_TYPE_FRACTION

    • factor2: any

      a GValue initialized to #GST_TYPE_FRACTION

    Returns boolean

value_fraction_subtract

  • value_fraction_subtract(dest: any, minuend: any, subtrahend: any): boolean

  • Subtracts the subtrahend from the minuend and sets dest to the result.

    Parameters

    • dest: any

      a GValue initialized to #GST_TYPE_FRACTION

    • minuend: any

      a GValue initialized to #GST_TYPE_FRACTION

    • subtrahend: any

      a GValue initialized to #GST_TYPE_FRACTION

    Returns boolean

value_get_bitmask

  • value_get_bitmask(value: any): number

  • Gets the bitmask specified by value.

    Parameters

    • value: any

      a GValue initialized to #GST_TYPE_BITMASK

    Returns number

value_get_caps

  • value_get_caps(value: any): Gst.Caps

  • Gets the contents of value. The reference count of the returned #GstCaps will not be modified, therefore the caller must take one before getting rid of the value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_CAPS

    Returns Gst.Caps

value_get_caps_features

value_get_double_range_max

  • value_get_double_range_max(value: any): number

  • Gets the maximum of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_DOUBLE_RANGE

    Returns number

value_get_double_range_min

  • value_get_double_range_min(value: any): number

  • Gets the minimum of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_DOUBLE_RANGE

    Returns number

value_get_flagset_flags

  • value_get_flagset_flags(value: any): number

  • Retrieve the flags field of a GstFlagSet value.

    Parameters

    • value: any

      a GValue initialized to #GST_TYPE_FLAG_SET

    Returns number

value_get_flagset_mask

  • value_get_flagset_mask(value: any): number

  • Retrieve the mask field of a GstFlagSet value.

    Parameters

    • value: any

      a GValue initialized to #GST_TYPE_FLAG_SET

    Returns number

value_get_fraction_denominator

  • value_get_fraction_denominator(value: any): number

  • Gets the denominator of the fraction specified by value.

    Parameters

    • value: any

      a GValue initialized to #GST_TYPE_FRACTION

    Returns number

value_get_fraction_numerator

  • value_get_fraction_numerator(value: any): number

  • Gets the numerator of the fraction specified by value.

    Parameters

    • value: any

      a GValue initialized to #GST_TYPE_FRACTION

    Returns number

value_get_fraction_range_max

  • value_get_fraction_range_max(value: any): any | null

  • Gets the maximum of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_FRACTION_RANGE

    Returns any | null

value_get_fraction_range_min

  • value_get_fraction_range_min(value: any): any | null

  • Gets the minimum of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_FRACTION_RANGE

    Returns any | null

value_get_int64_range_max

  • value_get_int64_range_max(value: any): number

  • Gets the maximum of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT64_RANGE

    Returns number

value_get_int64_range_min

  • value_get_int64_range_min(value: any): number

  • Gets the minimum of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT64_RANGE

    Returns number

value_get_int64_range_step

  • value_get_int64_range_step(value: any): number

  • Gets the step of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT64_RANGE

    Returns number

value_get_int_range_max

  • value_get_int_range_max(value: any): number

  • Gets the maximum of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT_RANGE

    Returns number

value_get_int_range_min

  • value_get_int_range_min(value: any): number

  • Gets the minimum of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT_RANGE

    Returns number

value_get_int_range_step

  • value_get_int_range_step(value: any): number

  • Gets the step of the range specified by value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT_RANGE

    Returns number

value_get_structure

value_init_and_copy

  • value_init_and_copy(src: any): any

  • Initialises the target value to be of the same type as source and then copies the contents from source to target.

    Parameters

    • src: any

      the source value

    Returns any

value_intersect

  • value_intersect(value1: any, value2: any): [boolean, any]

  • Calculates the intersection of two values. If the values have a non-empty intersection, the value representing the intersection is placed in dest, unless %NULL. If the intersection is non-empty, dest is not modified.

    Parameters

    • value1: any

      a value to intersect

    • value2: any

      another value to intersect

    Returns [boolean, any]

value_is_fixed

  • value_is_fixed(value: any): boolean

  • Tests if the given GValue, if available in a GstStructure (or any other container) contains a "fixed" (which means: one value) or an "unfixed" (which means: multiple possible values, such as data lists or data ranges) value.

    Parameters

    • value: any

      the #GValue to check

    Returns boolean

value_is_subset

  • value_is_subset(value1: any, value2: any): boolean

  • Check that value1 is a subset of value2.

    Parameters

    • value1: any

      a #GValue

    • value2: any

      a #GValue

    Returns boolean

value_register

  • Registers functions to perform calculations on #GValue items of a given type. Each type can only be added once.

    Parameters

    • table: Gst.ValueTable

      structure containing functions to register

    Returns void

value_serialize

  • value_serialize(value: any): string | null

  • tries to transform the given value into a string representation that allows getting back this string later on using gst_value_deserialize().

    Free-function: g_free

    Parameters

    • value: any

      a #GValue to serialize

    Returns string | null

value_set_bitmask

  • value_set_bitmask(value: any, bitmask: number): void

  • Sets value to the bitmask specified by bitmask.

    Parameters

    • value: any

      a GValue initialized to #GST_TYPE_BITMASK

    • bitmask: number

      the bitmask

    Returns void

value_set_caps

  • value_set_caps(value: any, caps: Gst.Caps): void

  • Sets the contents of value to caps. A reference to the provided caps will be taken by the value.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_CAPS

    • caps: Gst.Caps

      the caps to set the value to

    Returns void

value_set_caps_features

  • value_set_caps_features(value: any, features: CapsFeatures): void

  • Sets the contents of value to features.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_CAPS_FEATURES

    • features: CapsFeatures

      the features to set the value to

    Returns void

value_set_double_range

  • value_set_double_range(value: any, start: number, end: number): void

  • Sets value to the range specified by start and end.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_DOUBLE_RANGE

    • start: number

      the start of the range

    • end: number

      the end of the range

    Returns void

value_set_flagset

  • value_set_flagset(value: any, flags: number, mask: number): void

  • Sets value to the flags and mask values provided in flags and mask. The flags value indicates the values of flags, the mask represents which bits in the flag value have been set, and which are "don't care"

    Parameters

    • value: any

      a GValue initialized to %GST_TYPE_FLAG_SET

    • flags: number

      The value of the flags set or unset

    • mask: number

      The mask indicate which flags bits must match for comparisons

    Returns void

value_set_fraction

  • value_set_fraction(value: any, numerator: number, denominator: number): void

  • Sets value to the fraction specified by numerator over denominator. The fraction gets reduced to the smallest numerator and denominator, and if necessary the sign is moved to the numerator.

    Parameters

    • value: any

      a GValue initialized to #GST_TYPE_FRACTION

    • numerator: number

      the numerator of the fraction

    • denominator: number

      the denominator of the fraction

    Returns void

value_set_fraction_range

  • value_set_fraction_range(value: any, start: any, end: any): void

  • Sets value to the range specified by start and end.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_FRACTION_RANGE

    • start: any

      the start of the range (a GST_TYPE_FRACTION GValue)

    • end: any

      the end of the range (a GST_TYPE_FRACTION GValue)

    Returns void

value_set_fraction_range_full

  • value_set_fraction_range_full(value: any, numerator_start: number, denominator_start: number, numerator_end: number, denominator_end: number): void

  • Sets value to the range specified by numerator_start/``denominator_start and numerator_end/``denominator_end.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_FRACTION_RANGE

    • numerator_start: number

      the numerator start of the range

    • denominator_start: number

      the denominator start of the range

    • numerator_end: number

      the numerator end of the range

    • denominator_end: number

      the denominator end of the range

    Returns void

value_set_int64_range

  • value_set_int64_range(value: any, start: number, end: number): void

  • Sets value to the range specified by start and end.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT64_RANGE

    • start: number

      the start of the range

    • end: number

      the end of the range

    Returns void

value_set_int64_range_step

  • value_set_int64_range_step(value: any, start: number, end: number, step: number): void

  • Sets value to the range specified by start, end and step.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT64_RANGE

    • start: number

      the start of the range

    • end: number

      the end of the range

    • step: number

      the step of the range

    Returns void

value_set_int_range

  • value_set_int_range(value: any, start: number, end: number): void

  • Sets value to the range specified by start and end.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT_RANGE

    • start: number

      the start of the range

    • end: number

      the end of the range

    Returns void

value_set_int_range_step

  • value_set_int_range_step(value: any, start: number, end: number, step: number): void

  • Sets value to the range specified by start, end and step.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_INT_RANGE

    • start: number

      the start of the range

    • end: number

      the end of the range

    • step: number

      the step of the range

    Returns void

value_set_structure

  • value_set_structure(value: any, structure: Gst.Structure): void

  • Sets the contents of value to structure.

    Parameters

    • value: any

      a GValue initialized to GST_TYPE_STRUCTURE

    • structure: Gst.Structure

      the structure to set the value to

    Returns void

value_subtract

  • value_subtract(minuend: any, subtrahend: any): [boolean, any]

  • Subtracts subtrahend from minuend and stores the result in dest. Note that this means subtraction as in sets, not as in mathematics.

    Parameters

    • minuend: any

      the value to subtract from

    • subtrahend: any

      the value to subtract

    Returns [boolean, any]

value_union

  • value_union(value1: any, value2: any): [boolean, any]

  • Creates a GValue corresponding to the union of value1 and value2.

    Parameters

    • value1: any

      a value to union

    • value2: any

      another value to union

    Returns [boolean, any]

version

  • version(): [number, number, number, number]

version_string

  • version_string(): string

  • This function returns a string that is useful for describing this version of GStreamer to the outside world: user agent strings, logging, ...

    Returns string

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

Generated using TypeDoc v0.22.17 Gjsify Theme v0.1.0