Constants

Details

Gst.ALLOCATOR_SYSMEM = 'SystemMemory'

The allocator name for the default system memory allocator

Gst.BUFFER_OFFSET_NONE = 18446744073709551615

Constant for no-offset return results.

Gst.CAN_INLINE = 1
Gst.CAPS_FEATURE_MEMORY_SYSTEM_MEMORY = 'memory:SystemMemory'
Gst.CLOCK_TIME_NONE = 18446744073709551615

Constant to define an undefined clock time.

Gst.DEBUG_BG_MASK = 240
Gst.DEBUG_FG_MASK = 15
Gst.DEBUG_FORMAT_MASK = 65280
Gst.ELEMENT_FACTORY_KLASS_DECODER = 'Decoder'
Gst.ELEMENT_FACTORY_KLASS_DECRYPTOR = 'Decryptor'
Gst.ELEMENT_FACTORY_KLASS_DEMUXER = 'Demuxer'
Gst.ELEMENT_FACTORY_KLASS_DEPAYLOADER = 'Depayloader'
Gst.ELEMENT_FACTORY_KLASS_ENCODER = 'Encoder'
Gst.ELEMENT_FACTORY_KLASS_ENCRYPTOR = 'Encryptor'
Gst.ELEMENT_FACTORY_KLASS_FORMATTER = 'Formatter'
Gst.ELEMENT_FACTORY_KLASS_HARDWARE = 'Hardware'

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.

New in version 1.16.

Gst.ELEMENT_FACTORY_KLASS_MEDIA_AUDIO = 'Audio'
Gst.ELEMENT_FACTORY_KLASS_MEDIA_IMAGE = 'Image'
Gst.ELEMENT_FACTORY_KLASS_MEDIA_METADATA = 'Metadata'
Gst.ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE = 'Subtitle'
Gst.ELEMENT_FACTORY_KLASS_MEDIA_VIDEO = 'Video'
Gst.ELEMENT_FACTORY_KLASS_MUXER = 'Muxer'
Gst.ELEMENT_FACTORY_KLASS_PARSER = 'Parser'
Gst.ELEMENT_FACTORY_KLASS_PAYLOADER = 'Payloader'
Gst.ELEMENT_FACTORY_KLASS_SINK = 'Sink'
Gst.ELEMENT_FACTORY_KLASS_SRC = 'Source'
Gst.ELEMENT_FACTORY_TYPE_ANY = 562949953421311

Elements of any of the defined GST_ELEMENT_FACTORY_LIST types

Gst.ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS = 3940649673949188

All sinks handling audio, video or image media types

Gst.ELEMENT_FACTORY_TYPE_AUDIO_ENCODER = 1125899906842626

All encoders handling audio media types

Gst.ELEMENT_FACTORY_TYPE_DECODABLE = 1377

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

Gst.ELEMENT_FACTORY_TYPE_DECODER = 1
Gst.ELEMENT_FACTORY_TYPE_DECRYPTOR = 1024
Gst.ELEMENT_FACTORY_TYPE_DEMUXER = 32
Gst.ELEMENT_FACTORY_TYPE_DEPAYLOADER = 256
Gst.ELEMENT_FACTORY_TYPE_ENCODER = 2
Gst.ELEMENT_FACTORY_TYPE_ENCRYPTOR = 2048
Gst.ELEMENT_FACTORY_TYPE_FORMATTER = 512
Gst.ELEMENT_FACTORY_TYPE_HARDWARE = 4096
Gst.ELEMENT_FACTORY_TYPE_MAX_ELEMENTS = 281474976710656
Gst.ELEMENT_FACTORY_TYPE_MEDIA_ANY = 18446462598732840960

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.

Gst.ELEMENT_FACTORY_TYPE_MEDIA_AUDIO = 1125899906842624
Gst.ELEMENT_FACTORY_TYPE_MEDIA_IMAGE = 2251799813685248
Gst.ELEMENT_FACTORY_TYPE_MEDIA_METADATA = 9007199254740992
Gst.ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE = 4503599627370496
Gst.ELEMENT_FACTORY_TYPE_MEDIA_VIDEO = 562949953421312
Gst.ELEMENT_FACTORY_TYPE_MUXER = 16
Gst.ELEMENT_FACTORY_TYPE_PARSER = 64
Gst.ELEMENT_FACTORY_TYPE_PAYLOADER = 128
Gst.ELEMENT_FACTORY_TYPE_SINK = 4
Gst.ELEMENT_FACTORY_TYPE_SRC = 8
Gst.ELEMENT_FACTORY_TYPE_TIMESTAMPER = 8192

Timestamp correcting elements

New in version 1.24.

Gst.ELEMENT_FACTORY_TYPE_VIDEO_ENCODER = 2814749767106562

All encoders handling video or image media types

Gst.ELEMENT_METADATA_AUTHOR = 'author'

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

Gst.ELEMENT_METADATA_DESCRIPTION = 'description'

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

Gst.ELEMENT_METADATA_DOC_URI = 'doc-uri'

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

Gst.ELEMENT_METADATA_ICON_NAME = 'icon-name'

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.

Gst.ELEMENT_METADATA_KLASS = 'klass'

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”

Gst.ELEMENT_METADATA_LONGNAME = 'long-name'

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

Gst.EVENT_NUM_SHIFT = 8
Gst.FLAG_SET_MASK_EXACT = 4294967295

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

New in version 1.6.

Gst.FORMAT_PERCENT_MAX = 1000000

The PERCENT format is between 0 and this value

Gst.FORMAT_PERCENT_SCALE = 10000

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

Gst.GROUP_ID_INVALID = 0

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.

New in version 1.14.

Gst.LICENSE_UNKNOWN = 'unknown'

To be used in GST_PLUGIN_DEFINE if unsure about the licence.

Gst.META_TAG_MEMORY_REFERENCE_STR = 'memory-reference'

This metadata stays relevant until a deep copy is made.

New in version 1.20.4.

Gst.META_TAG_MEMORY_STR = 'memory'

This metadata stays relevant as long as memory layout is unchanged. In hindsight, this tag should have been called “memory-layout”.

New in version 1.2.

Gst.MSECOND = 1000000

Constant that defines one GStreamer millisecond.

Gst.NSECOND = 1

Constant that defines one GStreamer nanosecond

Gst.PARAM_CONDITIONALLY_AVAILABLE = 16384

Use this flag on GObject.Object properties of Gst.Object 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 Gst.Object is able to support it.

New in version 1.18.

Gst.PARAM_CONTROLLABLE = 512

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

Gst.PARAM_DOC_SHOW_DEFAULT = 8192

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

New in version 1.18.

Gst.PARAM_MUTABLE_PAUSED = 2048

Use this flag on GObject.Object 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.

Gst.PARAM_MUTABLE_PLAYING = 4096

Use this flag on GObject.Object 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.

Gst.PARAM_MUTABLE_READY = 1024

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

Gst.PARAM_USER_SHIFT = 65536

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

Gst.PROTECTION_SYSTEM_ID_CAPS_FIELD = 'protection-system'

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

New in version 1.6.

Gst.PROTECTION_UNSPECIFIED_SYSTEM_ID = 'unspecified-system-id'

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.

New in version 1.16.

Gst.QUERY_NUM_SHIFT = 8
Gst.SECOND = 1000000000

Constant that defines one GStreamer second.

Gst.SEGMENT_INSTANT_FLAGS = 912
Gst.SEQNUM_INVALID = 0

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.

New in version 1.14.

Gst.TAG_ALBUM = 'album'

album containing this data (string)

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

Gst.TAG_ALBUM_ARTIST = 'album-artist'

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

Gst.TAG_ALBUM_ARTIST_SORTNAME = 'album-artist-sortname'

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

Gst.TAG_ALBUM_GAIN = 'replaygain-album-gain'

album gain in db (double)

Gst.TAG_ALBUM_PEAK = 'replaygain-album-peak'

peak of the album (double)

Gst.TAG_ALBUM_SORTNAME = 'album-sortname'

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

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

Gst.TAG_ALBUM_VOLUME_COUNT = 'album-disc-count'

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

Gst.TAG_ALBUM_VOLUME_NUMBER = 'album-disc-number'

disc number inside a collection (unsigned integer)

Gst.TAG_APPLICATION_DATA = 'application-data'

Arbitrary application data (sample)

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

Gst.TAG_APPLICATION_NAME = 'application-name'

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

Gst.TAG_ARTIST = 'artist'

person(s) responsible for the recording (string)

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

Gst.TAG_ARTIST_SORTNAME = 'artist-sortname'

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’

Gst.TAG_ATTACHMENT = 'attachment'

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

Gst.TAG_AUDIO_CODEC = 'audio-codec'

codec the audio data is stored in (string)

Gst.TAG_BEATS_PER_MINUTE = 'beats-per-minute'

number of beats per minute in audio (double)

Gst.TAG_BITRATE = 'bitrate'

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

Gst.TAG_CODEC = 'codec'

codec the data is stored in (string)

Gst.TAG_COMMENT = 'comment'

free text commenting the data (string)

Gst.TAG_COMPOSER = 'composer'

person(s) who composed the recording (string)

Gst.TAG_COMPOSER_SORTNAME = 'composer-sortname'

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

Gst.TAG_CONDUCTOR = 'conductor'

conductor/performer refinement (string)

New in version 1.8.

Gst.TAG_CONTACT = 'contact'

contact information (string)

Gst.TAG_CONTAINER_FORMAT = 'container-format'

container format the data is stored in (string)

Gst.TAG_CONTAINER_SPECIFIC_TRACK_ID = 'container-specific-track-id'

Unique identifier for the audio, video or text track this tag is associated with. The mappings for several container formats are defined in the Sourcing In-band Media Resource Tracks from Media Containers into HTML specification.

New in version 1.24.

copyright notice of the data (string)

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

Gst.TAG_DATE = 'date'

date the data was created (GLib.Date structure)

Gst.TAG_DATE_TIME = 'datetime'

date and time the data was created (Gst.DateTime structure)

Gst.TAG_DESCRIPTION = 'description'

short text describing the content of the data (string)

Gst.TAG_DEVICE_MANUFACTURER = 'device-manufacturer'

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

Gst.TAG_DEVICE_MODEL = 'device-model'

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

Gst.TAG_DURATION = 'duration'

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

Gst.TAG_ENCODED_BY = 'encoded-by'

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.

Gst.TAG_ENCODER = 'encoder'

encoder used to encode this stream (string)

Gst.TAG_ENCODER_VERSION = 'encoder-version'

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

Gst.TAG_EXTENDED_COMMENT = 'extended-comment'

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.

Gst.TAG_GENRE = 'genre'

genre this data belongs to (string)

Gst.TAG_GEO_LOCATION_CAPTURE_DIRECTION = 'geo-location-capture-direction'

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

Gst.TAG_GEO_LOCATION_CITY = 'geo-location-city'

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

Gst.TAG_GEO_LOCATION_COUNTRY = 'geo-location-country'

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

Gst.TAG_GEO_LOCATION_ELEVATION = 'geo-location-elevation'

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

Gst.TAG_GEO_LOCATION_HORIZONTAL_ERROR = 'geo-location-horizontal-error'

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

Gst.TAG_GEO_LOCATION_LATITUDE = 'geo-location-latitude'

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).

Gst.TAG_GEO_LOCATION_LONGITUDE = 'geo-location-longitude'

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).

Gst.TAG_GEO_LOCATION_MOVEMENT_DIRECTION = 'geo-location-movement-direction'

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

Gst.TAG_GEO_LOCATION_MOVEMENT_SPEED = 'geo-location-movement-speed'

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

See also Gst.TAG_GEO_LOCATION_MOVEMENT_DIRECTION

Gst.TAG_GEO_LOCATION_NAME = 'geo-location-name'

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

Gst.TAG_GEO_LOCATION_SUBLOCATION = 'geo-location-sublocation'

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.

Gst.TAG_GROUPING = 'grouping'

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

Gst.TAG_HOMEPAGE = 'homepage'

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

Gst.TAG_IMAGE = 'image'

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

Gst.TAG_IMAGE_ORIENTATION = 'image-orientation'

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.

Gst.TAG_INTERPRETED_BY = 'interpreted-by'

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

New in version 1.2.

Gst.TAG_ISRC = 'isrc'

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

Gst.TAG_KEYWORDS = 'keywords'

comma separated keywords describing the content (string).

Gst.TAG_LANGUAGE_CODE = 'language-code'

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()

Gst.TAG_LANGUAGE_NAME = 'language-name'

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.

Gst.TAG_LICENSE = 'license'

license of data (string)

Gst.TAG_LICENSE_URI = 'license-uri'

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

Gst.TAG_LOCATION = 'location'

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

Gst.TAG_LYRICS = 'lyrics'

The lyrics of the media (string)

Gst.TAG_MAXIMUM_BITRATE = 'maximum-bitrate'

maximum bitrate in bits/s (unsigned integer)

Gst.TAG_MIDI_BASE_NOTE = 'midi-base-note'

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

New in version 1.4.

Gst.TAG_MINIMUM_BITRATE = 'minimum-bitrate'

minimum bitrate in bits/s (unsigned integer)

Gst.TAG_NOMINAL_BITRATE = 'nominal-bitrate'

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

Gst.TAG_ORGANIZATION = 'organization'

organization (string)

Gst.TAG_PERFORMER = 'performer'

person(s) performing (string)

Gst.TAG_PREVIEW_IMAGE = 'preview-image'

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

Gst.TAG_PRIVATE_DATA = 'private-data'

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

It is represented by Gst.Sample in which Gst.Buffer contains the binary data and the sample’s info Gst.Structure 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 Gst.Structure will be named “ID3PrivateFrame” and contain a field named “owner” of type string which contains the owner-identification string from the tag.

New in version 1.8.

Gst.TAG_PUBLISHER = 'publisher'

Name of the label or publisher (string)

New in version 1.2.

Gst.TAG_REFERENCE_LEVEL = 'replaygain-reference-level'

reference level of track and album gain values (double)

Gst.TAG_SERIAL = 'serial'

serial number of track (unsigned integer)

Gst.TAG_SHOW_EPISODE_NUMBER = 'show-episode-number'

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

Gst.TAG_SHOW_NAME = 'show-name'

Name of the show, used for displaying (string)

Gst.TAG_SHOW_SEASON_NUMBER = 'show-season-number'

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

Gst.TAG_SHOW_SORTNAME = 'show-sortname'

Name of the show, used for sorting (string)

Gst.TAG_SUBTITLE_CODEC = 'subtitle-codec'

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

Gst.TAG_TITLE = 'title'

commonly used title (string)

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

Gst.TAG_TITLE_SORTNAME = 'title-sortname'

commonly used title, as used for sorting (string)

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

Gst.TAG_TRACK_COUNT = 'track-count'

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

Gst.TAG_TRACK_GAIN = 'replaygain-track-gain'

track gain in db (double)

Gst.TAG_TRACK_NUMBER = 'track-number'

track number inside a collection (unsigned integer)

Gst.TAG_TRACK_PEAK = 'replaygain-track-peak'

peak of the track (double)

Gst.TAG_USER_RATING = 'user-rating'

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)

Gst.TAG_VERSION = 'version'

version of this data (string)

Gst.TAG_VIDEO_CODEC = 'video-codec'

codec the video data is stored in (string)

Gst.TOC_REPEAT_COUNT_INFINITE = -1

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

New in version 1.4.

Gst.URI_NO_PORT = 0

Value for Gst.Uri .port to indicate no port number.

Gst.USECOND = 1000

Constant that defines one GStreamer microsecond.

Gst.VALUE_EQUAL = 0

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

Gst.VALUE_GREATER_THAN = 1

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

Gst.VALUE_LESS_THAN = -1

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

Gst.VALUE_UNORDERED = 2

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

Gst.VERSION_MAJOR = 1

The major version of GStreamer at compile time:

Gst.VERSION_MICRO = 5

The micro version of GStreamer at compile time:

Gst.VERSION_MINOR = 24

The minor version of GStreamer at compile time:

Gst.VERSION_NANO = 0

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