Class Gst

java.lang.Object
org.freedesktop.gstreamer.gst.Gst
@Generated("org.javagi.JavaGI") public final class Gst extends Object
Constants and functions that are declared in the global Gst namespace.

  • Field Details

    • ALLOCATOR_SYSMEM

      public static final String ALLOCATOR_SYSMEM
      The allocator name for the default system memory allocator
      See Also:

    • BUFFER_COPY_ALL

      public static final Set<BufferCopyFlags> BUFFER_COPY_ALL
      Combination of all possible fields that can be copied with gst_buffer_copy_into().

    • BUFFER_COPY_METADATA

      public static final Set<BufferCopyFlags> BUFFER_COPY_METADATA
      Combination of all possible metadata fields that can be copied with gst_buffer_copy_into().

    • BUFFER_OFFSET_NONE

      public static final long BUFFER_OFFSET_NONE
      Constant for no-offset return results.
      See Also:

    • CAN_INLINE

      public static final int CAN_INLINE
      See Also:

    • CAPS_FEATURE_MEMORY_SYSTEM_MEMORY

      public static final String CAPS_FEATURE_MEMORY_SYSTEM_MEMORY
      See Also:

    • CLOCK_TIME_NONE

      public static final ClockTime CLOCK_TIME_NONE
      Constant to define an undefined clock time.

    • DEBUG_BG_MASK

      public static final int DEBUG_BG_MASK
      See Also:

    • DEBUG_FG_MASK

      public static final int DEBUG_FG_MASK
      See Also:

    • DEBUG_FORMAT_MASK

      public static final int DEBUG_FORMAT_MASK
      See Also:

    • ELEMENT_FACTORY_KLASS_DECODER

      public static final String ELEMENT_FACTORY_KLASS_DECODER
      See Also:

    • ELEMENT_FACTORY_KLASS_DECRYPTOR

      public static final String ELEMENT_FACTORY_KLASS_DECRYPTOR
      See Also:

    • ELEMENT_FACTORY_KLASS_DEMUXER

      public static final String ELEMENT_FACTORY_KLASS_DEMUXER
      See Also:

    • ELEMENT_FACTORY_KLASS_DEPAYLOADER

      public static final String ELEMENT_FACTORY_KLASS_DEPAYLOADER
      See Also:

    • ELEMENT_FACTORY_KLASS_ENCODER

      public static final String ELEMENT_FACTORY_KLASS_ENCODER
      See Also:

    • ELEMENT_FACTORY_KLASS_ENCRYPTOR

      public static final String ELEMENT_FACTORY_KLASS_ENCRYPTOR
      See Also:

    • ELEMENT_FACTORY_KLASS_FORMATTER

      public static final String ELEMENT_FACTORY_KLASS_FORMATTER
      See Also:

    • ELEMENT_FACTORY_KLASS_HARDWARE

      public static final String ELEMENT_FACTORY_KLASS_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.
      Since:
      1.16
      See Also:

    • ELEMENT_FACTORY_KLASS_MEDIA_AUDIO

      public static final String ELEMENT_FACTORY_KLASS_MEDIA_AUDIO
      See Also:

    • ELEMENT_FACTORY_KLASS_MEDIA_IMAGE

      public static final String ELEMENT_FACTORY_KLASS_MEDIA_IMAGE
      See Also:

    • ELEMENT_FACTORY_KLASS_MEDIA_METADATA

      public static final String ELEMENT_FACTORY_KLASS_MEDIA_METADATA
      See Also:

    • ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE

      public static final String ELEMENT_FACTORY_KLASS_MEDIA_SUBTITLE
      See Also:

    • ELEMENT_FACTORY_KLASS_MEDIA_VIDEO

      public static final String ELEMENT_FACTORY_KLASS_MEDIA_VIDEO
      See Also:

    • ELEMENT_FACTORY_KLASS_MUXER

      public static final String ELEMENT_FACTORY_KLASS_MUXER
      See Also:

    • ELEMENT_FACTORY_KLASS_PARSER

      public static final String ELEMENT_FACTORY_KLASS_PARSER
      See Also:

    • ELEMENT_FACTORY_KLASS_PAYLOADER

      public static final String ELEMENT_FACTORY_KLASS_PAYLOADER
      See Also:

    • ELEMENT_FACTORY_KLASS_SINK

      public static final String ELEMENT_FACTORY_KLASS_SINK
      See Also:

    • ELEMENT_FACTORY_KLASS_SRC

      public static final String ELEMENT_FACTORY_KLASS_SRC
      See Also:

    • ELEMENT_FACTORY_TYPE_ANY

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_ANY
      Elements of any of the defined GST_ELEMENT_FACTORY_LIST types

    • ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS
      All sinks handling audio, video or image media types

    • ELEMENT_FACTORY_TYPE_AUDIO_ENCODER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_AUDIO_ENCODER
      All encoders handling audio media types

    • ELEMENT_FACTORY_TYPE_DECODABLE

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_DECODABLE
      All elements used to 'decode' streams (decoders, demuxers, parsers, depayloaders)

    • ELEMENT_FACTORY_TYPE_DECODER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_DECODER

    • ELEMENT_FACTORY_TYPE_DECRYPTOR

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_DECRYPTOR

    • ELEMENT_FACTORY_TYPE_DEMUXER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_DEMUXER

    • ELEMENT_FACTORY_TYPE_DEPAYLOADER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_DEPAYLOADER

    • ELEMENT_FACTORY_TYPE_ENCODER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_ENCODER

    • ELEMENT_FACTORY_TYPE_ENCRYPTOR

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_ENCRYPTOR

    • ELEMENT_FACTORY_TYPE_FORMATTER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_FORMATTER

    • ELEMENT_FACTORY_TYPE_HARDWARE

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_HARDWARE

    • ELEMENT_FACTORY_TYPE_MAX_ELEMENTS

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_MAX_ELEMENTS

    • ELEMENT_FACTORY_TYPE_MEDIA_ANY

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_MEDIA_ANY

      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.

    • ELEMENT_FACTORY_TYPE_MEDIA_AUDIO

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_MEDIA_AUDIO

    • ELEMENT_FACTORY_TYPE_MEDIA_IMAGE

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_MEDIA_IMAGE

    • ELEMENT_FACTORY_TYPE_MEDIA_METADATA

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_MEDIA_METADATA

    • ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_MEDIA_SUBTITLE

    • ELEMENT_FACTORY_TYPE_MEDIA_VIDEO

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_MEDIA_VIDEO

    • ELEMENT_FACTORY_TYPE_MUXER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_MUXER

    • ELEMENT_FACTORY_TYPE_PARSER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_PARSER

    • ELEMENT_FACTORY_TYPE_PAYLOADER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_PAYLOADER

    • ELEMENT_FACTORY_TYPE_SINK

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_SINK

    • ELEMENT_FACTORY_TYPE_SRC

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_SRC

    • ELEMENT_FACTORY_TYPE_TIMESTAMPER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_TIMESTAMPER
      Timestamp correcting elements
      Since:
      1.24

    • ELEMENT_FACTORY_TYPE_VIDEO_ENCODER

      public static final ElementFactoryListType ELEMENT_FACTORY_TYPE_VIDEO_ENCODER
      All encoders handling video or image media types

    • ELEMENT_METADATA_AUTHOR

      public static final String ELEMENT_METADATA_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>"
      See Also:

    • ELEMENT_METADATA_DESCRIPTION

      public static final String ELEMENT_METADATA_DESCRIPTION
      Sentence describing the purpose of the element. E.g: "Write stream to a file"
      See Also:

    • ELEMENT_METADATA_DOC_URI

      public static final String ELEMENT_METADATA_DOC_URI
      Set uri pointing to user documentation. Applications can use this to show help for e.g. effects to users.
      See Also:

    • ELEMENT_METADATA_ICON_NAME

      public static final String ELEMENT_METADATA_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.
      See Also:

    • ELEMENT_METADATA_KLASS

      public static final String ELEMENT_METADATA_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"
      See Also:

    • ELEMENT_METADATA_LONGNAME

      public static final String ELEMENT_METADATA_LONGNAME
      The long English name of the element. E.g. "File Sink"
      See Also:

    • ERROR_SYSTEM

      public static final String ERROR_SYSTEM
      Builds a string using errno describing the previously failed system call. To be used as the debug argument in GST_ELEMENT_ERROR.
      See Also:

    • EVENT_NUM_SHIFT

      public static final int EVENT_NUM_SHIFT
      See Also:

    • EVENT_TYPE_BOTH

      public static final Set<EventTypeFlags> EVENT_TYPE_BOTH
      The same thing as GST_EVENT_TYPE_UPSTREAM | GST_EVENT_TYPE_DOWNSTREAM.

    • FLAG_SET_MASK_EXACT

      public static final int FLAG_SET_MASK_EXACT
      A mask value with all bits set, for use as a GstFlagSet mask where all flag bits must match exactly
      Since:
      1.6
      See Also:

    • FORMAT_PERCENT_MAX

      public static final long FORMAT_PERCENT_MAX
      The PERCENT format is between 0 and this value
      See Also:

    • FORMAT_PERCENT_SCALE

      public static final long FORMAT_PERCENT_SCALE
      The value used to scale down the reported PERCENT format value to its real value.
      See Also:

    • FOURCC_FORMAT

      public static final String FOURCC_FORMAT

      Can be used together with GST_FOURCC_ARGS to properly output a guint32 fourcc value in a printf\()-style text message.

      printf ("fourcc: %" GST_FOURCC_FORMAT "\\n", GST_FOURCC_ARGS (fcc));
      See Also:

    • GROUP_ID_INVALID

      public static final int GROUP_ID_INVALID

      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.

      Since:
      1.14
      See Also:

    • LICENSE_UNKNOWN

      public static final String LICENSE_UNKNOWN
      To be used in GST_PLUGIN_DEFINE if unsure about the licence.
      See Also:

    • LOCK_FLAG_READWRITE

      public static final Set<LockFlags> LOCK_FLAG_READWRITE
      GstLockFlags value alias for GST_LOCK_FLAG_READ | GST_LOCK_FLAG_WRITE

    • MAP_READWRITE

      public static final int MAP_READWRITE
      GstMapFlags value alias for GST_MAP_READ | GST_MAP_WRITE
      See Also:

    • META_TAG_MEMORY_REFERENCE_STR

      public static final String META_TAG_MEMORY_REFERENCE_STR
      This metadata stays relevant until a deep copy is made.
      Since:
      1.20.4
      See Also:

    • META_TAG_MEMORY_STR

      public static final String META_TAG_MEMORY_STR
      This metadata stays relevant as long as memory layout is unchanged. In hindsight, this tag should have been called "memory-layout".
      Since:
      1.2
      See Also:

    • MSECOND

      public static final ClockTimeDiff MSECOND
      Constant that defines one GStreamer millisecond.

    • NSECOND

      public static final ClockTimeDiff NSECOND
      Constant that defines one GStreamer nanosecond

    • PARAM_CONDITIONALLY_AVAILABLE

      public static final int PARAM_CONDITIONALLY_AVAILABLE
      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.
      Since:
      1.18
      See Also:

    • PARAM_CONTROLLABLE

      public static final int PARAM_CONTROLLABLE
      Use this flag on GObject properties to signal they can make sense to be. controlled over time. This hint is used by the GstController.
      See Also:

    • PARAM_DOC_SHOW_DEFAULT

      public static final int PARAM_DOC_SHOW_DEFAULT
      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.
      Since:
      1.18
      See Also:

    • PARAM_MUTABLE_PAUSED

      public static final int PARAM_MUTABLE_PAUSED
      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.
      See Also:

    • PARAM_MUTABLE_PLAYING

      public static final int PARAM_MUTABLE_PLAYING
      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.
      See Also:

    • PARAM_MUTABLE_READY

      public static final int PARAM_MUTABLE_READY
      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.
      See Also:

    • PARAM_USER_SHIFT

      public static final int PARAM_USER_SHIFT
      Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party applications.
      See Also:

    • PROTECTION_SYSTEM_ID_CAPS_FIELD

      public static final String PROTECTION_SYSTEM_ID_CAPS_FIELD
      The field name in a GstCaps that is used to signal the UUID of the protection system.
      Since:
      1.6
      See Also:

    • PROTECTION_UNSPECIFIED_SYSTEM_ID

      public static final String PROTECTION_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.

      Since:
      1.16
      See Also:

    • PTR_FORMAT

      public static final String PTR_FORMAT

      printf format type used to debug GStreamer types. You can use this in combination with GStreamer's debug logging system as well as the functions gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() to pretty-print the following types: GstCaps, GstStructure, GstCapsFeatures, GstTagList, GstDateTime, GstBuffer, GstBufferList, GstMessage, GstEvent, GstQuery, GstContext, GstPad, GstObject. All GObject types will be printed as typename plus pointer, and everything else will simply be printed as pointer address.

      This can only be used on types whose size is >= sizeof(gpointer).

      See Also:

    • QUERY_NUM_SHIFT

      public static final int QUERY_NUM_SHIFT
      See Also:

    • QUERY_TYPE_BOTH

      public static final Set<QueryTypeFlags> QUERY_TYPE_BOTH
      The same thing as GST_QUERY_TYPE_UPSTREAM | GST_QUERY_TYPE_DOWNSTREAM.

    • SECOND

      public static final ClockTimeDiff SECOND
      Constant that defines one GStreamer second.

    • SEGMENT_FORMAT

      public static final String SEGMENT_FORMAT
      printf format type used to debug GStreamer segments. You can use this in combination with GStreamer's debug logging system as well as the functions gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() to pretty-print GstSegment structures. This can only be used on pointers to GstSegment structures.
      See Also:

    • SEGMENT_INSTANT_FLAGS

      public static final int SEGMENT_INSTANT_FLAGS
      See Also:

    • SEQNUM_INVALID

      public static final int SEQNUM_INVALID

      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.

      Since:
      1.14
      See Also:

    • STIMEP_FORMAT

      public static final String STIMEP_FORMAT
      printf format type used to debug GStreamer signed time value pointers. You can use this in combination with GStreamer's debug logging system as well as the functions gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() to pretty-print signed time (pointers to GstClockTimeDiff or gint64).
      Since:
      1.18
      See Also:

    • STIME_FORMAT

      public static final String STIME_FORMAT

      A string that can be used in printf-like format strings to display a signed GstClockTimeDiff or gint64 value in h:m:s format. Use GST_TIME_ARGS() to construct the matching arguments.

      Example:

      printf("%" GST_STIME_FORMAT "\\n", GST_STIME_ARGS(ts));
      Since:
      1.6
      See Also:

    • TAG_ALBUM

      public static final String TAG_ALBUM

      album containing this data (string)

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

      See Also:

    • TAG_ALBUM_ARTIST

      public static final String TAG_ALBUM_ARTIST
      The artist of the entire album, as it should be displayed.
      See Also:

    • TAG_ALBUM_ARTIST_SORTNAME

      public static final String TAG_ALBUM_ARTIST_SORTNAME
      The artist of the entire album, as it should be sorted.
      See Also:

    • TAG_ALBUM_GAIN

      public static final String TAG_ALBUM_GAIN
      album gain in db (double)
      See Also:

    • TAG_ALBUM_PEAK

      public static final String TAG_ALBUM_PEAK
      peak of the album (double)
      See Also:

    • TAG_ALBUM_SORTNAME

      public static final String TAG_ALBUM_SORTNAME

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

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

      See Also:

    • TAG_ALBUM_VOLUME_COUNT

      public static final String TAG_ALBUM_VOLUME_COUNT
      count of discs inside collection this disc belongs to (unsigned integer)
      See Also:

    • TAG_ALBUM_VOLUME_NUMBER

      public static final String TAG_ALBUM_VOLUME_NUMBER
      disc number inside a collection (unsigned integer)
      See Also:

    • TAG_APPLICATION_DATA

      public static final String TAG_APPLICATION_DATA

      Arbitrary application data (sample)

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

      See Also:

    • TAG_APPLICATION_NAME

      public static final String TAG_APPLICATION_NAME
      Name of the application used to create the media (string)
      See Also:

    • TAG_ARTIST

      public static final String TAG_ARTIST

      person(s) responsible for the recording (string)

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

      See Also:

    • TAG_ARTIST_SORTNAME

      public static final String TAG_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'

      See Also:

    • TAG_ATTACHMENT

      public static final String TAG_ATTACHMENT
      generic file attachment (sample) (sample taglist should specify the content type and if possible set "filename" to the file name of the attachment)
      See Also:

    • TAG_AUDIO_CODEC

      public static final String TAG_AUDIO_CODEC
      codec the audio data is stored in (string)
      See Also:

    • TAG_BEATS_PER_MINUTE

      public static final String TAG_BEATS_PER_MINUTE
      number of beats per minute in audio (double)
      See Also:

    • TAG_BITRATE

      public static final String TAG_BITRATE
      exact or average bitrate in bits/s (unsigned integer)
      See Also:

    • TAG_CODEC

      public static final String TAG_CODEC
      codec the data is stored in (string)
      See Also:

    • TAG_COMMENT

      public static final String TAG_COMMENT
      free text commenting the data (string)
      See Also:

    • TAG_COMPOSER

      public static final String TAG_COMPOSER
      person(s) who composed the recording (string)
      See Also:

    • TAG_COMPOSER_SORTNAME

      public static final String TAG_COMPOSER_SORTNAME
      The composer's name, used for sorting (string)
      See Also:

    • TAG_CONDUCTOR

      public static final String TAG_CONDUCTOR
      conductor/performer refinement (string)
      Since:
      1.8
      See Also:

    • TAG_CONTACT

      public static final String TAG_CONTACT
      contact information (string)
      See Also:

    • TAG_CONTAINER_FORMAT

      public static final String TAG_CONTAINER_FORMAT
      container format the data is stored in (string)
      See Also:

    • TAG_CONTAINER_SPECIFIC_TRACK_ID

      public static final String TAG_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.
      Since:
      1.24
      See Also:

    • TAG_DATE

      public static final String TAG_DATE
      date the data was created (GDate structure)
      See Also:

    • TAG_DATE_TIME

      public static final String TAG_DATE_TIME
      date and time the data was created (GstDateTime structure)
      See Also:

    • TAG_DESCRIPTION

      public static final String TAG_DESCRIPTION
      short text describing the content of the data (string)
      See Also:

    • TAG_DEVICE_MANUFACTURER

      public static final String TAG_DEVICE_MANUFACTURER
      Manufacturer of the device used to create the media (string)
      See Also:

    • TAG_DEVICE_MODEL

      public static final String TAG_DEVICE_MODEL
      Model of the device used to create the media (string)
      See Also:

    • TAG_DURATION

      public static final String TAG_DURATION
      length in GStreamer time units (nanoseconds) (unsigned 64-bit integer)
      See Also:

    • TAG_ENCODED_BY

      public static final String TAG_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.

      See Also:

    • TAG_ENCODER

      public static final String TAG_ENCODER
      encoder used to encode this stream (string)
      See Also:

    • TAG_ENCODER_VERSION

      public static final String TAG_ENCODER_VERSION
      version of the encoder used to encode this stream (unsigned integer)
      See Also:

    • TAG_EXTENDED_COMMENT

      public static final String TAG_EXTENDED_COMMENT

      key/value text commenting the data (string)

      Must be in the form of 'key=comment' or 'key

      invalid reference 
      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.

      See Also:

    • TAG_GENRE

      public static final String TAG_GENRE
      genre this data belongs to (string)
      See Also:

    • TAG_GEO_LOCATION_CAPTURE_DIRECTION

      public static final String TAG_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

      See Also:

    • TAG_GEO_LOCATION_CITY

      public static final String TAG_GEO_LOCATION_CITY
      The city (english name) where the media has been produced (string).
      See Also:

    • TAG_GEO_LOCATION_COUNTRY

      public static final String TAG_GEO_LOCATION_COUNTRY
      The country (english name) where the media has been produced (string).
      See Also:

    • TAG_GEO_LOCATION_ELEVATION

      public static final String TAG_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).
      See Also:

    • TAG_GEO_LOCATION_HORIZONTAL_ERROR

      public static final String TAG_GEO_LOCATION_HORIZONTAL_ERROR
      Represents the expected error on the horizontal positioning in meters (double).
      See Also:

    • TAG_GEO_LOCATION_LATITUDE

      public static final String TAG_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).
      See Also:

    • TAG_GEO_LOCATION_LONGITUDE

      public static final String TAG_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).
      See Also:

    • TAG_GEO_LOCATION_MOVEMENT_DIRECTION

      public static final String TAG_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

      See Also:

    • TAG_GEO_LOCATION_MOVEMENT_SPEED

      public static final String TAG_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

      See Also:

    • TAG_GEO_LOCATION_NAME

      public static final String TAG_GEO_LOCATION_NAME
      human readable descriptive location of where the media has been recorded or produced. (string).
      See Also:

    • TAG_GEO_LOCATION_SUBLOCATION

      public static final String TAG_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.

      See Also:

    • TAG_GROUPING

      public static final String TAG_GROUPING
      Groups together media that are related and spans multiple tracks. An example are multiple pieces of a concerto. (string)
      See Also:

    • TAG_HOMEPAGE

      public static final String TAG_HOMEPAGE
      Homepage for this media (i.e. artist or movie homepage) (string)
      See Also:

    • TAG_IMAGE

      public static final String TAG_IMAGE
      image (sample) (sample taglist should specify the content type and preferably also set "image-type" field as GstTagImageType)
      See Also:

    • TAG_IMAGE_ORIENTATION

      public static final String TAG_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.

      See Also:

    • TAG_INTERPRETED_BY

      public static final String TAG_INTERPRETED_BY
      Information about the people behind a remix and similar interpretations of another existing piece (string)
      Since:
      1.2
      See Also:

    • TAG_ISRC

      public static final String TAG_ISRC
      International Standard Recording Code - see http://www.ifpi.org/isrc/ (string)
      See Also:

    • TAG_KEYWORDS

      public static final String TAG_KEYWORDS
      comma separated keywords describing the content (string).
      See Also:

    • TAG_LANGUAGE_CODE

      public static final String TAG_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()

      See Also:

    • TAG_LANGUAGE_NAME

      public static final String TAG_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.

      See Also:

    • TAG_LICENSE

      public static final String TAG_LICENSE
      license of data (string)
      See Also:

    • TAG_LICENSE_URI

      public static final String TAG_LICENSE_URI
      URI to location where license details can be found (string)
      See Also:

    • TAG_LOCATION

      public static final String TAG_LOCATION
      Origin of media as a URI (location, where the original of the file or stream is hosted) (string)
      See Also:

    • TAG_LYRICS

      public static final String TAG_LYRICS
      The lyrics of the media (string)
      See Also:

    • TAG_MAXIMUM_BITRATE

      public static final String TAG_MAXIMUM_BITRATE
      maximum bitrate in bits/s (unsigned integer)
      See Also:

    • TAG_MIDI_BASE_NOTE

      public static final String TAG_MIDI_BASE_NOTE
      Midi note number of the audio track. This is useful for sample instruments and in particular for multi-samples.
      Since:
      1.4
      See Also:

    • TAG_MINIMUM_BITRATE

      public static final String TAG_MINIMUM_BITRATE
      minimum bitrate in bits/s (unsigned integer)
      See Also:

    • TAG_NOMINAL_BITRATE

      public static final String TAG_NOMINAL_BITRATE
      nominal bitrate in bits/s (unsigned integer). The actual bitrate might be different from this target bitrate.
      See Also:

    • TAG_ORGANIZATION

      public static final String TAG_ORGANIZATION
      organization (string)
      See Also:

    • TAG_PERFORMER

      public static final String TAG_PERFORMER
      person(s) performing (string)
      See Also:

    • TAG_PREVIEW_IMAGE

      public static final String TAG_PREVIEW_IMAGE
      image that is meant for preview purposes, e.g. small icon-sized version (sample) (sample taglist should specify the content type)
      See Also:

    • TAG_PRIVATE_DATA

      public static final String TAG_PRIVATE_DATA

      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.

      Since:
      1.8
      See Also:

    • TAG_PUBLISHER

      public static final String TAG_PUBLISHER
      Name of the label or publisher (string)
      Since:
      1.2
      See Also:

    • TAG_REFERENCE_LEVEL

      public static final String TAG_REFERENCE_LEVEL
      reference level of track and album gain values (double)
      See Also:

    • TAG_SERIAL

      public static final String TAG_SERIAL
      serial number of track (unsigned integer)
      See Also:

    • TAG_SHOW_EPISODE_NUMBER

      public static final String TAG_SHOW_EPISODE_NUMBER
      Number of the episode within a season/show (unsigned integer)
      See Also:

    • TAG_SHOW_NAME

      public static final String TAG_SHOW_NAME
      Name of the show, used for displaying (string)
      See Also:

    • TAG_SHOW_SEASON_NUMBER

      public static final String TAG_SHOW_SEASON_NUMBER
      Number of the season of a show/series (unsigned integer)
      See Also:

    • TAG_SHOW_SORTNAME

      public static final String TAG_SHOW_SORTNAME
      Name of the show, used for sorting (string)
      See Also:

    • TAG_SUBTITLE_CODEC

      public static final String TAG_SUBTITLE_CODEC
      codec/format the subtitle data is stored in (string)
      See Also:

    • TAG_TITLE

      public static final String TAG_TITLE

      commonly used title (string)

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

      See Also:

    • TAG_TITLE_SORTNAME

      public static final String TAG_TITLE_SORTNAME

      commonly used title, as used for sorting (string)

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

      See Also:

    • TAG_TRACK_COUNT

      public static final String TAG_TRACK_COUNT
      count of tracks inside collection this track belongs to (unsigned integer)
      See Also:

    • TAG_TRACK_GAIN

      public static final String TAG_TRACK_GAIN
      track gain in db (double)
      See Also:

    • TAG_TRACK_NUMBER

      public static final String TAG_TRACK_NUMBER
      track number inside a collection (unsigned integer)
      See Also:

    • TAG_TRACK_PEAK

      public static final String TAG_TRACK_PEAK
      peak of the track (double)
      See Also:

    • TAG_USER_RATING

      public static final String TAG_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)
      See Also:

    • TAG_VERSION

      public static final String TAG_VERSION
      version of this data (string)
      See Also:

    • TAG_VIDEO_CODEC

      public static final String TAG_VIDEO_CODEC
      codec the video data is stored in (string)
      See Also:

    • TIMEP_FORMAT

      public static final String TIMEP_FORMAT
      printf format type used to debug GStreamer ClockTime pointers. You can use this in combination with GStreamer's debug logging system as well as the functions gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() to pretty-print GstClockTime pointers. This can only be used on pointers to GstClockTime values.
      Since:
      1.18
      See Also:

    • TIME_FORMAT

      public static final String TIME_FORMAT

      A string that can be used in printf-like format strings to display a GstClockTime value in h:m:s format. Use GST_TIME_ARGS() to construct the matching arguments.

      Example:

      printf("%" GST_TIME_FORMAT "\\n", GST_TIME_ARGS(ts));
      See Also:

    • TOC_REPEAT_COUNT_INFINITE

      public static final int TOC_REPEAT_COUNT_INFINITE
      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.
      Since:
      1.4
      See Also:

    • URI_NO_PORT

      public static final int URI_NO_PORT
      Value for GstUri.port to indicate no port number.
      See Also:

    • USECOND

      public static final ClockTimeDiff USECOND
      Constant that defines one GStreamer microsecond.

    • VALUE_EQUAL

      public static final int VALUE_EQUAL
      Indicates that the first value provided to a comparison function (gst_value_compare()) is equal to the second one.
      See Also:

    • VALUE_GREATER_THAN

      public static final int VALUE_GREATER_THAN
      Indicates that the first value provided to a comparison function (gst_value_compare()) is greater than the second one.
      See Also:

    • VALUE_LESS_THAN

      public static final int VALUE_LESS_THAN
      Indicates that the first value provided to a comparison function (gst_value_compare()) is lesser than the second one.
      See Also:

    • VALUE_UNORDERED

      public static final int VALUE_UNORDERED
      Indicates that the comparison function (gst_value_compare()) can not determine a order for the two provided values.
      See Also:

    • VERSION_MAJOR

      public static final int VERSION_MAJOR
      The major version of GStreamer at compile time:
      See Also:

    • VERSION_MICRO

      public static final int VERSION_MICRO
      The micro version of GStreamer at compile time:
      See Also:

    • VERSION_MINOR

      public static final int VERSION_MINOR
      The minor version of GStreamer at compile time:
      See Also:

    • VERSION_NANO

      public static final int VERSION_NANO
      The nano version of GStreamer at compile time: Actual releases have 0, GIT versions have 1, prerelease versions have 2-...
      See Also:

    • MAP_READ

      public static final int MAP_READ
      map for read access
      See Also:

    • MAP_WRITE

      public static final int MAP_WRITE
      map for write access
      See Also:

    • MAP_FLAG_LAST

      public static final int MAP_FLAG_LAST
      first flag that can be used for custom purposes
      See Also:

  • Constructor Details

    • Gst

      public Gst()

  • Method Details

    • javagi$ensureInitialized

      public static void javagi$ensureInitialized()

    • calculateLinearRegression

      public static boolean calculateLinearRegression(MemorySegment xy, MemorySegment temp, int n, ClockTime mNum, ClockTime mDenom, ClockTime b, ClockTime xbase, Out<Double> rSquared)

      Calculates the linear regression of the values xy and places the result in mNum, mDenom, b and xbase, representing the function y(x) = m_num/m_denom * (x - xbase) + b that has the least-square distance from all points x and y.

      rSquared will contain the remaining error.

      If temp is not null, it will be used as temporary space for the function, in which case the function works without any allocation at all. If temp is null, an allocation will take place. temp should have at least the same amount of memory allocated as xy, i.e. 2nsizeof(GstClockTime).

      This function assumes (x,y) values with reasonable large differences between them. It will not calculate the exact results if the differences between neighbouring values are too small due to not being able to represent sub-integer values during the calculations.

      Parameters:
      xy - Pairs of (x,y) values
      temp - Temporary scratch space used by the function
      n - number of (x,y) pairs
      mNum - numerator of calculated slope
      mDenom - denominator of calculated slope
      b - Offset at Y-axis
      xbase - Offset at X-axis
      rSquared - R-squared
      Returns:
      true if the linear regression was successfully calculated
      Since:
      1.12

    • clearBuffer

      public static void clearBuffer(Buffer[] bufPtr)

      Clears a reference to a GstBuffer.

      bufPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the buffer is decreased and the pointer is set to null.

      Parameters:
      bufPtr - a pointer to a GstBuffer reference
      Since:
      1.16

    • clearBufferList

      public static void clearBufferList(BufferList[] listPtr)

      Clears a reference to a GstBufferList.

      listPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the list is decreased and the pointer is set to null.

      Parameters:
      listPtr - a pointer to a GstBufferList reference
      Since:
      1.16

    • clearCaps

      public static void clearCaps(Caps[] capsPtr)

      Clears a reference to a GstCaps.

      capsPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the caps is decreased and the pointer is set to null.

      Parameters:
      capsPtr - a pointer to a GstCaps reference
      Since:
      1.16

    • clearContext

      public static void clearContext(Context[] contextPtr)

      Clears a reference to a GstContext.

      contextPtr must not be NULL.

      If the reference is NULL then this function does nothing. Otherwise, the reference count of the context is decreased and the pointer is set to NULL.

      Parameters:
      contextPtr - a pointer to a GstContext reference
      Since:
      1.24

    • clearEvent

      public static void clearEvent(Event[] eventPtr)

      Clears a reference to a GstEvent.

      eventPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the event is decreased and the pointer is set to null.

      Parameters:
      eventPtr - a pointer to a GstEvent reference
      Since:
      1.16

    • clearMessage

      public static void clearMessage(Message[] msgPtr)

      Clears a reference to a GstMessage.

      msgPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the message is decreased and the pointer is set to null.

      Parameters:
      msgPtr - a pointer to a GstMessage reference
      Since:
      1.16

    • clearMiniObject

      public static void clearMiniObject(MiniObject[] objectPtr)

      Clears a reference to a GstMiniObject.

      objectPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the object is decreased using gst_mini_object_unref() and the pointer is set to null.

      A macro is also included that allows this function to be used without pointer casts.

      Parameters:
      objectPtr - a pointer to a GstMiniObject reference
      Since:
      1.16

    • clearObject

      public static void clearObject(GstObject[] objectPtr)

      Clears a reference to a GstObject.

      objectPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the object is decreased using gst_object_unref() and the pointer is set to null.

      A macro is also included that allows this function to be used without pointer casts.

      Parameters:
      objectPtr - a pointer to a GstObject reference
      Since:
      1.16

    • clearPromise

      public static void clearPromise(Promise[] promisePtr)

      Clears a reference to a GstPromise.

      promisePtr must not be NULL.

      If the reference is NULL then this function does nothing. Otherwise, the reference count of the promise is decreased and the pointer is set to NULL.

      Parameters:
      promisePtr - a pointer to a GstPromise reference
      Since:
      1.24

    • clearQuery

      public static void clearQuery(Query[] queryPtr)

      Clears a reference to a GstQuery.

      queryPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the query is decreased and the pointer is set to null.

      Parameters:
      queryPtr - a pointer to a GstQuery reference
      Since:
      1.16

    • clearSample

      public static void clearSample(Sample[] samplePtr)

      Clears a reference to a GstSample

      samplePtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the sample is decreased and the pointer is set to null.

      Parameters:
      samplePtr - a pointer to a GstSample reference
      Since:
      1.24

    • clearStructure

      public static void clearStructure(Structure[] structurePtr)

      Clears a reference to a GstStructure.

      structurePtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the structure is free'd using gst_structure_free() and the pointer is set to null.

      A macro is also included that allows this function to be used without pointer casts.

      Parameters:
      structurePtr - a pointer to a GstStructure reference
      Since:
      1.16

    • clearTagList

      public static void clearTagList(TagList[] taglistPtr)

      Clears a reference to a GstTagList.

      taglistPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the taglist is decreased and the pointer is set to null.

      Parameters:
      taglistPtr - a pointer to a GstTagList reference
      Since:
      1.16

    • clearUri

      public static void clearUri(Uri[] uriPtr)

      Clears a reference to a GstUri.

      uriPtr must not be null.

      If the reference is null then this function does nothing. Otherwise, the reference count of the uri is decreased and the pointer is set to null.

      Parameters:
      uriPtr - a pointer to a GstUri reference
      Since:
      1.18

    • debugAddLogFunction

      public static void debugAddLogFunction(@Nullable LogFunction func)
      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:
      func - the function to use

    • debugAddRingBufferLogger

      public static void debugAddRingBufferLogger(int maxSizePerThread, int threadTimeout)

      Adds a memory ringbuffer based debug logger that stores up to maxSizePerThread bytes of logs per thread and times out threads after threadTimeout 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:
      maxSizePerThread - Maximum size of log per thread in bytes
      threadTimeout - Timeout for threads in seconds
      Since:
      1.14

    • debugBinToDotData

      public static String debugBinToDotData(Bin bin, Set<DebugGraphDetails> details)
      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:
      bin - the top-level pipeline that should be analyzed
      details - type of GstDebugGraphDetails to use
      Returns:
      a string containing the pipeline in graphviz dot format.

    • debugBinToDotData

      public static String debugBinToDotData(Bin bin, DebugGraphDetails... details)
      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:
      bin - the top-level pipeline that should be analyzed
      details - type of GstDebugGraphDetails to use
      Returns:
      a string containing the pipeline in graphviz dot format.

    • debugBinToDotFile

      public static void debugBinToDotFile(Bin bin, Set<DebugGraphDetails> details, String fileName)

      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 - the top-level pipeline that should be analyzed
      details - type of GstDebugGraphDetails to use
      fileName - output base filename (e.g. "myplayer")

    • debugBinToDotFile

      public static void debugBinToDotFile(Bin bin, DebugGraphDetails details, String fileName)

      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 - the top-level pipeline that should be analyzed
      details - type of GstDebugGraphDetails to use
      fileName - output base filename (e.g. "myplayer")

    • debugBinToDotFileWithTs

      public static void debugBinToDotFileWithTs(Bin bin, Set<DebugGraphDetails> details, String fileName)
      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 - the top-level pipeline that should be analyzed
      details - type of GstDebugGraphDetails to use
      fileName - output base filename (e.g. "myplayer")

    • debugBinToDotFileWithTs

      public static void debugBinToDotFileWithTs(Bin bin, DebugGraphDetails details, String fileName)
      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 - the top-level pipeline that should be analyzed
      details - type of GstDebugGraphDetails to use
      fileName - output base filename (e.g. "myplayer")

    • debugConstructTermColor

      public static String debugConstructTermColor(int colorinfo)
      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 - the color info
      Returns:
      a string containing the color definition

    • debugConstructWinColor

      public static int debugConstructWinColor(int colorinfo)

      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 - the color info
      Returns:
      an integer containing the color definition

    • debugGetAllCategories

      public static SList<DebugCategory> debugGetAllCategories()
      Returns a snapshot of a all categories that are currently in use . This list may change anytime. The caller has to free the list after use.
      Returns:
      the list of debug categories

    • debugGetColorMode

      public static DebugColorMode debugGetColorMode()
      Changes the coloring mode for debug output.
      Returns:
      see GstDebugColorMode for possible values.
      Since:
      1.2

    • debugGetDefaultThreshold

      public static DebugLevel debugGetDefaultThreshold()
      Returns the default threshold that is used for new categories.
      Returns:
      the default threshold level

    • debugGetStackTrace

      public static @Nullable String debugGetStackTrace(Set<StackTraceFlags> flags)

    • debugGetStackTrace

      public static @Nullable String debugGetStackTrace(StackTraceFlags... flags)

    • debugIsActive

      public static boolean debugIsActive()
      Checks if debugging output is activated.
      Returns:
      true, if debugging is activated

    • debugIsColored

      public static boolean debugIsColored()
      Checks if the debugging output should be colored.
      Returns:
      true, if the debug output should be colored.

    • debugLog

      public static void debugLog(DebugCategory category, DebugLevel level, String file, String function, int line, @Nullable GObject object, String format, Object... varargs)
      Logs the given message using the currently registered debugging handlers.
      Parameters:
      category - category to log
      level - level of the message is in
      file - the file that emitted the message, usually the FILE identifier
      function - the function that emitted the message
      line - the line from that the message was emitted, usually LINE
      object - the object this message relates to, or null if none
      format - a printf style format string
      varargs - optional arguments for the format

    • debugLogDefault

      public static void debugLogDefault(DebugCategory category, DebugLevel level, String file, String function, int line, @Nullable GObject object, DebugMessage message, @Nullable MemorySegment userData)

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

      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 - category to log
      level - level of the message
      file - the file that emitted the message, usually the FILE identifier
      function - the function that emitted the message
      line - the line from that the message was emitted, usually LINE
      object - the object this message relates to, or null if none
      message - the actual message
      userData - the FILE* to log to

    • debugLogGetLine

      public static String debugLogGetLine(DebugCategory category, DebugLevel level, String file, String function, int line, @Nullable GObject object, DebugMessage message)
      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 - category to log
      level - level of the message
      file - the file that emitted the message, usually the FILE identifier
      function - the function that emitted the message
      line - the line from that the message was emitted, usually LINE
      object - the object this message relates to, or null if none
      message - the actual message
      Since:
      1.18

    • debugLogId

      public static void debugLogId(DebugCategory category, DebugLevel level, String file, String function, int line, @Nullable String id, String format, Object... varargs)
      Logs the given message using the currently registered debugging handlers.
      Parameters:
      category - category to log
      level - level of the message is in
      file - the file that emitted the message, usually the FILE identifier
      function - the function that emitted the message
      line - the line from that the message was emitted, usually LINE
      id - the identifier of the object this message relates to, or null if none.
      format - a printf style format string
      varargs - optional arguments for the format
      Since:
      1.22

    • debugLogIdLiteral

      public static void debugLogIdLiteral(DebugCategory category, DebugLevel level, String file, String function, int line, @Nullable String id, String messageString)
      Logs the given message using the currently registered debugging handlers.
      Parameters:
      category - category to log
      level - level of the message is in
      file - the file that emitted the message, usually the FILE identifier
      function - the function that emitted the message
      line - the line from that the message was emitted, usually LINE
      id - the identifier of the object this message relates to or null if none
      messageString - a message string
      Since:
      1.22

    • debugLogLiteral

      public static void debugLogLiteral(DebugCategory category, DebugLevel level, String file, String function, int line, @Nullable GObject object, String messageString)
      Logs the given message using the currently registered debugging handlers.
      Parameters:
      category - category to log
      level - level of the message is in
      file - the file that emitted the message, usually the FILE identifier
      function - the function that emitted the message
      line - the line from that the message was emitted, usually LINE
      object - the object this message relates to, or null if none
      messageString - a message string
      Since:
      1.20

    • debugPrintObject

      public static String debugPrintObject(@Nullable MemorySegment ptr)

      Returns a string that represents ptr. This is safe to call with GstStructure, GstCapsFeatures, GstMiniObject s (e.g. GstCaps, GstBuffer or GstMessage), and GObjects (e.g. GstElement or GstPad).

      The string representation is meant to be used for debugging purposes and might change between GStreamer versions.

      Passing other kind of pointers might or might not work and is generally unsafe to do.

      Parameters:
      ptr - the object
      Returns:
      a string containing a string representation of the object
      Since:
      1.26

    • debugPrintSegment

      public static String debugPrintSegment(@Nullable Segment segment)

      Returns a string that represents segments.

      The string representation is meant to be used for debugging purposes and might change between GStreamer versions.

      Parameters:
      segment - the GstSegment
      Returns:
      a string containing a string representation of the segment
      Since:
      1.26

    • debugPrintStackTrace

      public static void debugPrintStackTrace()
      If libunwind, glibc backtrace or DbgHelp are present a stack trace is printed.

    • debugRemoveLogFunction

      public static int debugRemoveLogFunction(@Nullable LogFunction func)
      Removes all registered instances of the given logging functions.
      Parameters:
      func - the log function to remove, or null to remove the default log function
      Returns:
      How many instances of the function were removed

    • debugRemoveLogFunctionByData

      public static int debugRemoveLogFunctionByData(@Nullable MemorySegment data)
      Removes all registered instances of log functions with the given user data.
      Parameters:
      data - user data of the log function to remove
      Returns:
      How many instances of the function were removed

    • debugRemoveRingBufferLogger

      public static void debugRemoveRingBufferLogger()
      Removes any previously added ring buffer logger with gst_debug_add_ring_buffer_logger().
      Since:
      1.14

    • debugRingBufferLoggerGetLogs

      public static String[] debugRingBufferLoggerGetLogs()
      Fetches the current logs per thread from the ring buffer logger. See gst_debug_add_ring_buffer_logger() for details.
      Returns:
      NULL-terminated array of strings with the debug output per thread
      Since:
      1.14

    • debugSetActive

      public static void debugSetActive(boolean active)

      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 - Whether to use debugging output or not

    • debugSetColorMode

      public static void debugSetColorMode(DebugColorMode mode)

      Changes the coloring mode for debug output.

      This function may be called before gst_init().

      Parameters:
      mode - The coloring mode for debug output. See GstDebugColorMode.
      Since:
      1.2

    • debugSetColorModeFromString

      public static void debugSetColorModeFromString(String mode)

      Changes the coloring mode for debug output.

      This function may be called before gst_init().

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

    • debugSetColored

      public static void debugSetColored(boolean colored)

      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 - Whether to use colored output or not

    • debugSetDefaultThreshold

      public static void debugSetDefaultThreshold(DebugLevel level)

      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:
      level - level to set

    • debugSetThresholdForName

      public static void debugSetThresholdForName(String name, DebugLevel level)
      Sets all categories which match the given glob style pattern to the given level.
      Parameters:
      name - name of the categories to set
      level - level to set them to

    • debugSetThresholdFromString

      public static void debugSetThresholdFromString(String list, boolean reset)
      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 - comma-separated list of "category:level" pairs to be used as debug logging levels
      reset - 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.
      Since:
      1.2

    • debugUnsetThresholdForName

      public static void debugUnsetThresholdForName(String name)
      Resets all categories with the given name back to the default level.
      Parameters:
      name - name of the categories to set

    • deinit

      public static void deinit()

      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.

    • dynamicTypeRegister

      public static boolean dynamicTypeRegister(Plugin plugin, Type type)
      Registers a new GstDynamicTypeFactory in the registry
      Parameters:
      plugin - The GstPlugin to register dynType for
      type - The GType to register dynamically
      Since:
      1.12

    • errorGetMessage

      public static String errorGetMessage(Quark domain, int code)
      Get a string describing the error message in the current locale.
      Parameters:
      domain - the GStreamer error domain this error belongs to.
      code - the error code belonging to the domain.
      Returns:
      a newly allocated string describing the error message (in UTF-8 encoding)

    • filenameToUri

      public static @Nullable String filenameToUri(String filename) throws GErrorException

      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 - absolute or relative file name path
      Returns:
      newly-allocated URI string, or NULL on error. The caller must free the URI string with g_free() when no longer needed.
      Throws:
      GErrorException - see GError

    • flowGetName

      public static String flowGetName(FlowReturn ret)
      Gets a string representing the given flow return.
      Parameters:
      ret - a GstFlowReturn to get the name of.
      Returns:
      a static string with the name of the flow return.

    • flowToQuark

      public static Quark flowToQuark(FlowReturn ret)
      Get the unique quark for the given GstFlowReturn.
      Parameters:
      ret - a GstFlowReturn to get the quark of.
      Returns:
      the quark associated with the flow return or 0 if an invalid return was specified.

    • formatsContains

      public static boolean formatsContains(@Nullable Format @Nullable [] formats, Format format)
      See if the given format is inside the format array.
      Parameters:
      formats - The format array to search
      format - the format to find
      Returns:
      true if the format is found inside the array

    • getMainExecutablePath

      public static @Nullable String getMainExecutablePath()

      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:
      The path of the executable that initialized GStreamer, or null if it could not be determined.
      Since:
      1.14

    • infoStrdupPrintf

      public static @Nullable String infoStrdupPrintf(String format, Object... varargs)

      Allocates, fills and returns a 0-terminated string from the printf style format string and corresponding arguments.

      See gst_info_vasprintf() for when this function is required.

      Free with g_free().

      Parameters:
      format - a printf style format string
      varargs - the printf arguments for format
      Returns:
      a newly allocated null terminated string or null on any error
      Since:
      1.8

    • init

      public static void init(@Nullable Out<String[]> argv)

      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.

      Parameters:
      argv - pointer to application's argv

    • initCheck

      public static boolean initCheck(@Nullable Out<String[]> argv) throws GErrorException

      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 - pointer to application's argv
      Returns:
      true if GStreamer could be initialized.
      Throws:
      GErrorException - see GError

    • initGetOptionGroup

      public static @Nullable OptionGroup initGetOptionGroup()

      Returns a GOptionGroup with GStreamer's argument specifications. The group is set up to use standard GOption callbacks, so when using this group in combination with GOption parsing methods, all argument parsing and initialization is automated.

      This function is useful if you want to integrate GStreamer with other libraries that use GOption (see g_option_context_add_group() ).

      If you use this function, you should make sure you initialise the GLib threading system as one of the very first things in your program (see the example at the beginning of this section).

      Returns:
      a pointer to GStreamer's option group.

    • isCapsFeatures

      public static boolean isCapsFeatures(@Nullable MemorySegment obj)
      Checks if obj is a GstCapsFeatures
      Returns:
      true if obj is a GstCapsFeatures false otherwise

    • isInitialized

      public static boolean isInitialized()
      Use this function to check if GStreamer has been initialized with gst_init() or gst_init_check().
      Returns:
      true if initialization has been done, false otherwise.

    • makeElementMessageDetails

      public static Structure makeElementMessageDetails(String name, Object... varargs)
      Create a GstStructure to be used with gst_element_message_full_with_details. null terminator required.
      Parameters:
      name - Name of the first field to set
      varargs - variable arguments in the same form as GstStructure
      Since:
      1.10

    • paramSpecArray

      public static ParamSpec paramSpecArray(String name, String nick, String blurb, ParamSpec elementSpec, Set<ParamFlags> flags)
      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 - canonical name of the property specified
      nick - nick name for the property specified
      blurb - description of the property specified
      elementSpec - GParamSpec of the array
      flags - flags for the property specified
      Returns:
      a newly created parameter specification
      Since:
      1.14

    • paramSpecArray

      public static ParamSpec paramSpecArray(String name, String nick, String blurb, ParamSpec elementSpec, ParamFlags... flags)
      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 - canonical name of the property specified
      nick - nick name for the property specified
      blurb - description of the property specified
      elementSpec - GParamSpec of the array
      flags - flags for the property specified
      Returns:
      a newly created parameter specification
      Since:
      1.14

    • paramSpecFraction

      public static @Nullable ParamSpec paramSpecFraction(String name, String nick, String blurb, int minNum, int minDenom, int maxNum, int maxDenom, int defaultNum, int defaultDenom, Set<ParamFlags> flags)
      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 - canonical name of the property specified
      nick - nick name for the property specified
      blurb - description of the property specified
      minNum - minimum value (fraction numerator)
      minDenom - minimum value (fraction denominator)
      maxNum - maximum value (fraction numerator)
      maxDenom - maximum value (fraction denominator)
      defaultNum - default value (fraction numerator)
      defaultDenom - default value (fraction denominator)
      flags - flags for the property specified
      Returns:
      a newly created parameter specification

    • paramSpecFraction

      public static @Nullable ParamSpec paramSpecFraction(String name, String nick, String blurb, int minNum, int minDenom, int maxNum, int maxDenom, int defaultNum, int defaultDenom, ParamFlags... flags)
      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 - canonical name of the property specified
      nick - nick name for the property specified
      blurb - description of the property specified
      minNum - minimum value (fraction numerator)
      minDenom - minimum value (fraction denominator)
      maxNum - maximum value (fraction numerator)
      maxDenom - maximum value (fraction denominator)
      defaultNum - default value (fraction numerator)
      defaultDenom - default value (fraction denominator)
      flags - flags for the property specified
      Returns:
      a newly created parameter specification

    • parentBufferMetaApiGetType

      public static Type parentBufferMetaApiGetType()

    • parseBinFromDescription

      public static Bin parseBinFromDescription(String binDescription, boolean ghostUnlinkedPads) throws GErrorException
      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:
      binDescription - command line describing the bin
      ghostUnlinkedPads - whether to automatically create ghost pads for unlinked source or sink pads within the bin
      Returns:
      a newly-created bin, or null if an error occurred.
      Throws:
      GErrorException - see GError

    • parseBinFromDescriptionFull

      public static Element parseBinFromDescriptionFull(String binDescription, boolean ghostUnlinkedPads, @Nullable ParseContext context, Set<ParseFlags> flags) throws GErrorException
      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:
      binDescription - command line describing the bin
      ghostUnlinkedPads - whether to automatically create ghost pads for unlinked source or sink pads within the bin
      context - a parse context allocated with gst_parse_context_new(), or null
      flags - parsing options, or GST_PARSE_FLAG_NONE
      Returns:
      a newly-created element, which is guaranteed to be a bin unless GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS was passed, or null if an error occurred.
      Throws:
      GErrorException - see GError

    • parseBinFromDescriptionFull

      public static Element parseBinFromDescriptionFull(String binDescription, boolean ghostUnlinkedPads, @Nullable ParseContext context, ParseFlags... flags) throws GErrorException
      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:
      binDescription - command line describing the bin
      ghostUnlinkedPads - whether to automatically create ghost pads for unlinked source or sink pads within the bin
      context - a parse context allocated with gst_parse_context_new(), or null
      flags - parsing options, or GST_PARSE_FLAG_NONE
      Returns:
      a newly-created element, which is guaranteed to be a bin unless GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS was passed, or null if an error occurred.
      Throws:
      GErrorException - see GError

    • parseLaunch

      public static Element parseLaunch(String pipelineDescription) throws GErrorException

      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:
      pipelineDescription - the command line describing the pipeline
      Returns:
      a new element on success, null on failure. If more than one toplevel element is specified by the pipelineDescription, all elements are put into a GstPipeline, which than is returned.
      Throws:
      GErrorException - see GError

    • parseLaunchFull

      public static Element parseLaunchFull(String pipelineDescription, @Nullable ParseContext context, Set<ParseFlags> flags) throws GErrorException

      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:
      pipelineDescription - the command line describing the pipeline
      context - a parse context allocated with gst_parse_context_new(), or null
      flags - parsing options, or GST_PARSE_FLAG_NONE
      Returns:
      a new element on success, null on failure. If more than one toplevel element is specified by the pipelineDescription, all elements are put into a GstPipeline, which then is returned (unless the GST_PARSE_FLAG_PLACE_IN_BIN flag is set, in which case they are put in a GstBin instead).
      Throws:
      GErrorException - see GError

    • parseLaunchFull

      public static Element parseLaunchFull(String pipelineDescription, @Nullable ParseContext context, ParseFlags... flags) throws GErrorException

      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:
      pipelineDescription - the command line describing the pipeline
      context - a parse context allocated with gst_parse_context_new(), or null
      flags - parsing options, or GST_PARSE_FLAG_NONE
      Returns:
      a new element on success, null on failure. If more than one toplevel element is specified by the pipelineDescription, all elements are put into a GstPipeline, which then is returned (unless the GST_PARSE_FLAG_PLACE_IN_BIN flag is set, in which case they are put in a GstBin instead).
      Throws:
      GErrorException - see GError

    • parseLaunchv

      public static Element parseLaunchv(@Nullable String @Nullable [] argv) throws GErrorException
      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 - null-terminated array of arguments
      Returns:
      a new element on success and null on failure.
      Throws:
      GErrorException - see GError

    • parseLaunchvFull

      public static Element parseLaunchvFull(@Nullable String @Nullable [] argv, @Nullable ParseContext context, Set<ParseFlags> flags) throws GErrorException
      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 - null-terminated array of arguments
      context - a parse context allocated with gst_parse_context_new(), or null
      flags - parsing options, or GST_PARSE_FLAG_NONE
      Returns:
      a new element on success; on failure, either null or a partially-constructed bin or element will be returned and error will be set (unless you passed GST_PARSE_FLAG_FATAL_ERRORS in flags, then null will always be returned on failure)
      Throws:
      GErrorException - see GError

    • parseLaunchvFull

      public static Element parseLaunchvFull(@Nullable String @Nullable [] argv, @Nullable ParseContext context, ParseFlags... flags) throws GErrorException
      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 - null-terminated array of arguments
      context - a parse context allocated with gst_parse_context_new(), or null
      flags - parsing options, or GST_PARSE_FLAG_NONE
      Returns:
      a new element on success; on failure, either null or a partially-constructed bin or element will be returned and error will be set (unless you passed GST_PARSE_FLAG_FATAL_ERRORS in flags, then null will always be returned on failure)
      Throws:
      GErrorException - see GError

    • print

      public static void print(String format, Object... varargs)

      Outputs a formatted message via the GLib print handler. The default print handler simply outputs the message to stdout.

      This function will not append a new-line character at the end, unlike gst_println() which will.

      All strings must be in ASCII or UTF-8 encoding.

      This function differs from g_print() in that it supports all the additional printf specifiers that are supported by GStreamer's debug logging system, such as GST_PTR_FORMAT and GST_SEGMENT_FORMAT.

      This function is primarily for printing debug output.

      Parameters:
      format - a printf style format string
      varargs - the printf arguments for format
      Since:
      1.12

    • printerr

      public static void printerr(String format, Object... varargs)

      Outputs a formatted message via the GLib error message handler. The default handler simply outputs the message to stderr.

      This function will not append a new-line character at the end, unlike gst_printerrln() which will.

      All strings must be in ASCII or UTF-8 encoding.

      This function differs from g_printerr() in that it supports the additional printf specifiers that are supported by GStreamer's debug logging system, such as GST_PTR_FORMAT and GST_SEGMENT_FORMAT.

      This function is primarily for printing debug output.

      Parameters:
      format - a printf style format string
      varargs - the printf arguments for format
      Since:
      1.12

    • printerrln

      public static void printerrln(String format, Object... varargs)

      Outputs a formatted message via the GLib error message handler. The default handler simply outputs the message to stderr.

      This function will append a new-line character at the end, unlike gst_printerr() which will not.

      All strings must be in ASCII or UTF-8 encoding.

      This function differs from g_printerr() in that it supports the additional printf specifiers that are supported by GStreamer's debug logging system, such as GST_PTR_FORMAT and GST_SEGMENT_FORMAT.

      This function is primarily for printing debug output.

      Parameters:
      format - a printf style format string
      varargs - the printf arguments for format
      Since:
      1.12

    • println

      public static void println(String format, Object... varargs)

      Outputs a formatted message via the GLib print handler. The default print handler simply outputs the message to stdout.

      This function will append a new-line character at the end, unlike gst_print() which will not.

      All strings must be in ASCII or UTF-8 encoding.

      This function differs from g_print() in that it supports all the additional printf specifiers that are supported by GStreamer's debug logging system, such as GST_PTR_FORMAT and GST_SEGMENT_FORMAT.

      This function is primarily for printing debug output.

      Parameters:
      format - a printf style format string
      varargs - the printf arguments for format
      Since:
      1.12

    • protectionFilterSystemsByAvailableDecryptors

      public static @Nullable String @Nullable [] protectionFilterSystemsByAvailableDecryptors(@Nullable String @Nullable [] systemIdentifiers)
      Iterates the supplied list of UUIDs and checks the GstRegistry for all the decryptors supporting one of the supplied UUIDs.
      Parameters:
      systemIdentifiers - A null terminated array of strings that contains the UUID values of each protection system that is to be checked.
      Returns:
      A null terminated array containing all the systemIdentifiers supported by the set of available decryptors, or null if no matches were found.
      Since:
      1.14

    • protectionMetaApiGetType

      public static Type protectionMetaApiGetType()

    • protectionSelectSystem

      public static @Nullable String protectionSelectSystem(@Nullable String @Nullable [] systemIdentifiers)
      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:
      systemIdentifiers - A null terminated array of strings that contains the UUID values of each protection system that is to be checked.
      Returns:
      One of the strings from systemIdentifiers that indicates the highest ranked element that implements the protection system indicated by that system ID, or null if no element has been found.
      Since:
      1.6

    • referenceTimestampMetaApiGetType

      public static Type referenceTimestampMetaApiGetType()

    • segtrapIsEnabled

      public static boolean segtrapIsEnabled()

      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:
      true if GStreamer is allowed to install a custom SIGSEGV handler.

    • segtrapSetEnabled

      public static void segtrapSetEnabled(boolean enabled)
      Applications might want to disable/enable the SIGSEGV handling of the GStreamer core. See gst_segtrap_is_enabled() for more information.
      Parameters:
      enabled - whether a custom SIGSEGV handler should be installed.

    • tagExists

      public static boolean tagExists(String tag)
      Checks if the given type is already registered.
      Parameters:
      tag - name of the tag
      Returns:
      true if the type is already registered

    • tagGetDescription

      public static String tagGetDescription(String tag)
      Returns the human-readable description of this tag, You must not change or free this string.
      Parameters:
      tag - the tag
      Returns:
      the human-readable description of this tag

    • tagGetFlag

      public static TagFlag tagGetFlag(String tag)
      Gets the flag of tag.
      Parameters:
      tag - the tag
      Returns:
      the flag of this tag.

    • tagGetNick

      public static String tagGetNick(String tag)
      Returns the human-readable name of this tag, You must not change or free this string.
      Parameters:
      tag - the tag
      Returns:
      the human-readable name of this tag

    • tagGetType

      public static Type tagGetType(String tag)
      Gets the GType used for this tag.
      Parameters:
      tag - the tag
      Returns:
      the GType of this tag

    • tagIsFixed

      public static boolean tagIsFixed(String tag)
      Checks if the given tag is fixed. A fixed tag can only contain one value. Unfixed tags can contain lists of values.
      Parameters:
      tag - tag to check
      Returns:
      true, if the given tag is fixed.

    • tagMergeStringsWithComma

      public static void tagMergeStringsWithComma(Value dest, Value src)
      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:
      dest - uninitialized GValue to store result in
      src - GValue to copy from

    • tagMergeUseFirst

      public static void tagMergeUseFirst(Value dest, Value src)
      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:
      dest - uninitialized GValue to store result in
      src - GValue to copy from

    • tagRegister

      public static void tagRegister(String name, TagFlag flag, Type type, String nick, String blurb, @Nullable TagMergeFunc func)

      Registers a new tag type for the use with GStreamer's type system. If a type with that name is already registered, that one is used. The old registration may have used a different type however. So don't rely on your supplied values.

      Important: if you do not supply a merge function the implication will be that there can only be one single value for this tag in a tag list and any additional values will silently be discarded when being added (unless GST_TAG_MERGE_REPLACE, GST_TAG_MERGE_REPLACE_ALL, or GST_TAG_MERGE_PREPEND is used as merge mode, in which case the new value will replace the old one in the list).

      The merge function will be called from gst_tag_list_copy_value() when it is required that one or more values for a tag be condensed into one single value. This may happen from gst_tag_list_get_string(), gst_tag_list_get_int(), gst_tag_list_get_double() etc. What will happen exactly in that case depends on how the tag was registered and if a merge function was supplied and if so which one.

      Two default merge functions are provided: gst_tag_merge_use_first() and gst_tag_merge_strings_with_comma().

      Parameters:
      name - the name or identifier string
      flag - a flag describing the type of tag info
      type - the type this data is in
      nick - human-readable name
      blurb - a human-readable description about this tag
      func - function for merging multiple values of this tag, or null

    • tagRegisterStatic

      public static void tagRegisterStatic(String name, TagFlag flag, Type type, String nick, String blurb, @Nullable TagMergeFunc func)

      Registers a new tag type for the use with GStreamer's type system.

      Same as gst_tag_register(), but name, nick, and blurb must be static strings or inlined strings, as they will not be copied. (GStreamer plugins will be made resident once loaded, so this function can be used even from dynamically loaded plugins.)

      Parameters:
      name - the name or identifier string (string constant)
      flag - a flag describing the type of tag info
      type - the type this data is in
      nick - human-readable name or short description (string constant)
      blurb - a human-readable description for this tag (string constant)
      func - function for merging multiple values of this tag, or null

    • tracingGetActiveTracers

      public static List<Tracer> tracingGetActiveTracers()
      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:
      A GList of GstTracer objects
      Since:
      1.18

    • tracingRegisterHook

      public static void tracingRegisterHook(Tracer tracer, String detail, @Nullable Callback func)
      Register func to be called when the trace hook detail is getting invoked. Use null for detail to register to all hooks.
      Parameters:
      tracer - the tracer
      detail - the detailed hook
      func - the callback
      Since:
      1.8

    • typeIsPluginApi

      public static boolean typeIsPluginApi(Type type, @Nullable Out<Set<PluginAPIFlags>> flags)
      Checks if type is plugin API. See gst_type_mark_as_plugin_api() for details.
      Parameters:
      type - a GType
      flags - What GstPluginAPIFlags the plugin was marked with
      Returns:
      true if type is plugin API or false otherwise.
      Since:
      1.18

    • typeMarkAsPluginApi

      public static void typeMarkAsPluginApi(Type type, Set<PluginAPIFlags> flags)

      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 - a GType
      flags - a set of GstPluginAPIFlags to further inform cache generation.
      Since:
      1.18

    • typeMarkAsPluginApi

      public static void typeMarkAsPluginApi(Type type, PluginAPIFlags... flags)

      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 - a GType
      flags - a set of GstPluginAPIFlags to further inform cache generation.
      Since:
      1.18

    • updateRegistry

      public static boolean updateRegistry()

      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:
      true if the registry has been updated successfully (does not imply that there were changes), otherwise false.

    • utilArrayBinarySearch

      public static @Nullable MemorySegment utilArrayBinarySearch(@Nullable MemorySegment array, int numElements, long elementSize, @Nullable CompareDataFunc searchFunc, SearchMode mode, @Nullable MemorySegment searchData)

      Searches inside array for searchData by using the comparison function searchFunc. array must be sorted ascending.

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

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

      Parameters:
      array - the sorted input array
      numElements - number of elements in the array
      elementSize - size of every element in bytes
      searchFunc - function to compare two elements, searchData will always be passed as second argument
      mode - search mode that should be used
      searchData - element that should be found
      Returns:
      The address of the found element or null if nothing was found

    • utilCeilLog2

      public static int utilCeilLog2(int v)
      Returns smallest integral value not less than log2(v).
      Parameters:
      v - a guint32 value.
      Returns:
      a computed guint val.
      Since:
      1.24

    • utilDoubleToFraction

      public static void utilDoubleToFraction(double src, Out<Integer> destN, Out<Integer> destD)
      Transforms a gdouble to a fraction and simplifies the result.
      Parameters:
      src - gdouble to transform
      destN - pointer to a gint to hold the result numerator
      destD - pointer to a gint to hold the result denominator

    • utilDumpBuffer

      public static void utilDumpBuffer(Buffer buf)
      Dumps the buffer memory into a hex representation. Useful for debugging.
      Parameters:
      buf - a GstBuffer whose memory to dump
      Since:
      1.14

    • utilDumpMem

      public static void utilDumpMem(@Nullable byte @Nullable [] mem)
      Dumps the memory block into a hex representation. Useful for debugging.
      Parameters:
      mem - a pointer to the memory to dump

    • utilFilenameCompare

      public static int utilFilenameCompare(String a, String b)
      Compares the given filenames using natural ordering.
      Parameters:
      a - a filename to compare with b
      b - a filename to compare with a
      Since:
      1.24

    • utilFloorLog2

      public static int utilFloorLog2(int v)
      Returns smallest integral value not bigger than log2(v).
      Parameters:
      v - a guint32 value.
      Returns:
      a computed guint val.
      Since:
      1.26

    • utilFractionAdd

      public static boolean utilFractionAdd(int aN, int aD, int bN, int bD, Out<Integer> resN, Out<Integer> resD)
      Adds the fractions aD and bD and stores the result in resN and resD.
      Parameters:
      aN - Numerator of first value
      aD - Denominator of first value
      bN - Numerator of second value
      bD - Denominator of second value
      resN - Pointer to gint to hold the result numerator
      resD - Pointer to gint to hold the result denominator
      Returns:
      false on overflow, true otherwise.

    • utilFractionCompare

      public static int utilFractionCompare(int aN, int aD, int bN, int bD)
      Compares the fractions aD and bD and returns -1 if a < b, 0 if a = b and 1 if a > b.
      Parameters:
      aN - Numerator of first value
      aD - Denominator of first value
      bN - Numerator of second value
      bD - Denominator of second value
      Returns:
      -1 if a < b; 0 if a = b; 1 if a > b.

    • utilFractionMultiply

      public static boolean utilFractionMultiply(int aN, int aD, int bN, int bD, Out<Integer> resN, Out<Integer> resD)
      Multiplies the fractions aD and bD and stores the result in resN and resD.
      Parameters:
      aN - Numerator of first value
      aD - Denominator of first value
      bN - Numerator of second value
      bD - Denominator of second value
      resN - Pointer to gint to hold the result numerator
      resD - Pointer to gint to hold the result denominator
      Returns:
      false on overflow, true otherwise.

    • utilFractionMultiplyInt64

      public static boolean utilFractionMultiplyInt64(long aN, long aD, long bN, long bD, Out<Long> resN, Out<Long> resD)
      Multiplies the fractions aD and bD and stores the result in resN and resD.
      Parameters:
      aN - Numerator of first value
      aD - Denominator of first value
      bN - Numerator of second value
      bD - Denominator of second value
      resN - Pointer to gint to hold the result numerator
      resD - Pointer to gint to hold the result denominator
      Returns:
      false on overflow, true otherwise.
      Since:
      1.26

    • utilFractionToDouble

      public static void utilFractionToDouble(int srcN, int srcD, Out<Double> dest)
      Transforms a fraction to a gdouble.
      Parameters:
      srcN - Fraction numerator as gint
      srcD - Fraction denominator gint
      dest - pointer to a gdouble for the result

    • utilGdoubleToGuint64

      public static long utilGdoubleToGuint64(double value)

    • utilGetObjectArray

      public static boolean utilGetObjectArray(GObject object, String name, Out<ValueArray> 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 - the object to set the array to
      name - the name of the property to set
      array - a return GValueArray
      Since:
      1.12

    • utilGetTimestamp

      public static ClockTime utilGetTimestamp()
      Get a timestamp as GstClockTime to be used for interval measurements. The timestamp should not be interpreted in any other way.
      Returns:
      the timestamp

    • utilGreatestCommonDivisor

      public static int utilGreatestCommonDivisor(int a, int b)
      Calculates the greatest common divisor of a and b.
      Parameters:
      a - First value as gint
      b - Second value as gint
      Returns:
      Greatest common divisor of a and b

    • utilGreatestCommonDivisorInt64

      public static long utilGreatestCommonDivisorInt64(long a, long b)
      Calculates the greatest common divisor of a and b.
      Parameters:
      a - First value as gint64
      b - Second value as gint64
      Returns:
      Greatest common divisor of a and b

    • utilGroupIdNext

      public static int utilGroupIdNext()

      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:
      A constantly incrementing unsigned integer, which might overflow back to 0 at some point.

    • utilGuint64ToGdouble

      public static double utilGuint64ToGdouble(long value)

    • utilSeqnumCompare

      public static int utilSeqnumCompare(int s1, int s2)

      Compare two sequence numbers, handling wraparound.

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

      Parameters:
      s1 - A sequence number.
      s2 - Another sequence number.
      Returns:
      A negative number if s1 is before s2, 0 if they are equal, or a positive number if s1 is after s2.

    • utilSeqnumNext

      public static int utilSeqnumNext()

      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:
      A constantly incrementing 32-bit unsigned integer, which might overflow at some point. Use gst_util_seqnum_compare() to make sure you handle wraparound correctly.

    • utilSetObjectArg

      public static void utilSetObjectArg(GObject object, String name, String value)

      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 - the object to set the argument of
      name - the name of the argument to set
      value - the string value to set

    • utilSetObjectArray

      public static boolean utilSetObjectArray(GObject object, String name, ValueArray 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 - the object to set the array to
      name - the name of the property to set
      array - a GValueArray containing the values
      Since:
      1.12

    • utilSetValueFromString

      public static void utilSetValueFromString(Value value, String valueStr)

      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 - the value to set
      valueStr - the string to get the value from

    • utilSimplifyFraction

      public static void utilSimplifyFraction(MemorySegment numerator, MemorySegment denominator, int nTerms, int threshold)

      Calculates the simpler representation of numerator and denominator and update both values with the resulting simplified fraction.

      Simplify a fraction using a simple continued fraction decomposition. The idea here is to convert fractions such as 333333/10000000 to 1/30 using 32 bit arithmetic only. The algorithm is not perfect and relies upon two arbitrary parameters to remove non-significative terms from the simple continued fraction decomposition. Using 8 and 333 for nTerms and threshold respectively seems to give nice results.

      Parameters:
      numerator - First value as gint
      denominator - Second value as gint
      nTerms - non-significative terms (typical value: 8)
      threshold - threshold (typical value: 333)
      Since:
      1.24

    • utilUint64Scale

      public static long utilUint64Scale(long val, long num, long denom)

      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 - the number to scale
      num - the numerator of the scale ratio
      denom - the denominator of the scale ratio
      Returns:
      val * num / denom. In the case of an overflow, this function returns G_MAXUINT64. If the result is not exactly representable as an integer it is truncated. See also gst_util_uint64_scale_round(), gst_util_uint64_scale_ceil(), gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(), gst_util_uint64_scale_int_ceil().

    • utilUint64ScaleCeil

      public static long utilUint64ScaleCeil(long val, long num, long denom)

      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 - the number to scale
      num - the numerator of the scale ratio
      denom - the denominator of the scale ratio
      Returns:
      val * num / denom. In the case of an overflow, this function returns G_MAXUINT64. If the result is not exactly representable as an integer, it is rounded up. See also gst_util_uint64_scale(), gst_util_uint64_scale_round(), gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(), gst_util_uint64_scale_int_ceil().

    • utilUint64ScaleInt

      public static long utilUint64ScaleInt(long val, int num, int denom)
      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 - guint64 (such as a GstClockTime) to scale.
      num - numerator of the scale factor.
      denom - denominator of the scale factor.
      Returns:
      val * num / denom. In the case of an overflow, this function returns G_MAXUINT64. If the result is not exactly representable as an integer, it is truncated. See also gst_util_uint64_scale_int_round(), gst_util_uint64_scale_int_ceil(), gst_util_uint64_scale(), gst_util_uint64_scale_round(), gst_util_uint64_scale_ceil().

    • utilUint64ScaleIntCeil

      public static long utilUint64ScaleIntCeil(long val, int num, int denom)
      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 - guint64 (such as a GstClockTime) to scale.
      num - numerator of the scale factor.
      denom - denominator of the scale factor.
      Returns:
      val * num / denom. In the case of an overflow, this function returns G_MAXUINT64. If the result is not exactly representable as an integer, it is rounded up. See also gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(), gst_util_uint64_scale(), gst_util_uint64_scale_round(), gst_util_uint64_scale_ceil().

    • utilUint64ScaleIntRound

      public static long utilUint64ScaleIntRound(long val, int num, int denom)
      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 - guint64 (such as a GstClockTime) to scale.
      num - numerator of the scale factor.
      denom - denominator of the scale factor.
      Returns:
      val * num / denom. In the case of an overflow, this function returns G_MAXUINT64. If the result is not exactly representable as an integer, it is rounded to the nearest integer (half-way cases are rounded up). See also gst_util_uint64_scale_int(), gst_util_uint64_scale_int_ceil(), gst_util_uint64_scale(), gst_util_uint64_scale_round(), gst_util_uint64_scale_ceil().

    • utilUint64ScaleRound

      public static long utilUint64ScaleRound(long val, long num, long denom)

      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 - the number to scale
      num - the numerator of the scale ratio
      denom - the denominator of the scale ratio
      Returns:
      val * num / denom. In the case of an overflow, this function returns G_MAXUINT64. If the result is not exactly representable as an integer, it is rounded to the nearest integer (half-way cases are rounded up). See also gst_util_uint64_scale(), gst_util_uint64_scale_ceil(), gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(), gst_util_uint64_scale_int_ceil().

    • valueCanCompare

      public static boolean valueCanCompare(Value value1, Value value2)
      Determines if value1 and value2 can be compared.
      Parameters:
      value1 - a value to compare
      value2 - another value to compare
      Returns:
      true if the values can be compared

    • valueCanIntersect

      public static boolean valueCanIntersect(Value value1, Value value2)
      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 - a value to intersect
      value2 - another value to intersect
      Returns:
      true if the values can intersect

    • valueCanSubtract

      public static boolean valueCanSubtract(Value minuend, Value subtrahend)
      Checks if it's possible to subtract subtrahend from minuend.
      Parameters:
      minuend - the value to subtract from
      subtrahend - the value to subtract
      Returns:
      true if a subtraction is possible

    • valueCanUnion

      public static boolean valueCanUnion(Value value1, Value value2)
      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 - a value to union
      value2 - another value to union
      Returns:
      true if there is a function allowing the two values to be unioned.

    • valueCompare

      public static int valueCompare(Value value1, Value value2)
      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 - a value to compare
      value2 - another value to compare
      Returns:
      comparison result

    • valueDeserialize

      public static boolean valueDeserialize(Value dest, String src)
      Tries to deserialize a string into the type specified by the given GValue. If the operation succeeds, true is returned, false otherwise.
      Parameters:
      dest - GValue to fill with contents of deserialization
      src - string to deserialize
      Returns:
      true on success

    • valueDeserializeWithPspec

      public static boolean valueDeserializeWithPspec(Value dest, String src, @Nullable ParamSpec pspec)
      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:
      dest - GValue to fill with contents of deserialization
      src - string to deserialize
      pspec - the GParamSpec describing the expected value
      Returns:
      true on success
      Since:
      1.20

    • valueFixate

      public static boolean valueFixate(Value dest, Value src)
      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 - the GValue destination
      src - the GValue to fixate
      Returns:
      true if dest contains a fixated version of src.

    • valueFractionMultiply

      public static boolean valueFractionMultiply(Value product, Value factor1, Value factor2)
      Multiplies the two GValue items containing a GST_TYPE_FRACTION and sets product to the product of the two fractions.
      Parameters:
      product - a GValue initialized to GST_TYPE_FRACTION
      factor1 - a GValue initialized to GST_TYPE_FRACTION
      factor2 - a GValue initialized to GST_TYPE_FRACTION
      Returns:
      false in case of an error (like integer overflow), true otherwise.

    • valueFractionSubtract

      public static boolean valueFractionSubtract(Value dest, Value minuend, Value subtrahend)
      Subtracts the subtrahend from the minuend and sets dest to the result.
      Parameters:
      dest - a GValue initialized to GST_TYPE_FRACTION
      minuend - a GValue initialized to GST_TYPE_FRACTION
      subtrahend - a GValue initialized to GST_TYPE_FRACTION
      Returns:
      false in case of an error (like integer overflow), true otherwise.

    • valueGetBitmask

      public static long valueGetBitmask(Value value)
      Gets the bitmask specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_BITMASK
      Returns:
      the bitmask.

    • valueGetCaps

      public static Caps valueGetCaps(Value value)
      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 - a GValue initialized to GST_TYPE_CAPS
      Returns:
      the contents of value

    • valueGetCapsFeatures

      public static CapsFeatures valueGetCapsFeatures(Value value)
      Gets the contents of value.
      Parameters:
      value - a GValue initialized to GST_TYPE_CAPS_FEATURES
      Returns:
      the contents of value

    • valueGetDoubleRangeMax

      public static double valueGetDoubleRangeMax(Value value)
      Gets the maximum of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_DOUBLE_RANGE
      Returns:
      the maximum of the range

    • valueGetDoubleRangeMin

      public static double valueGetDoubleRangeMin(Value value)
      Gets the minimum of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_DOUBLE_RANGE
      Returns:
      the minimum of the range

    • valueGetFlagsetFlags

      public static int valueGetFlagsetFlags(Value value)
      Retrieve the flags field of a GstFlagSet value.
      Parameters:
      value - a GValue initialized to GST_TYPE_FLAG_SET
      Returns:
      the flags field of the flagset instance.
      Since:
      1.6

    • valueGetFlagsetMask

      public static int valueGetFlagsetMask(Value value)
      Retrieve the mask field of a GstFlagSet value.
      Parameters:
      value - a GValue initialized to GST_TYPE_FLAG_SET
      Returns:
      the mask field of the flagset instance.
      Since:
      1.6

    • valueGetFractionDenominator

      public static int valueGetFractionDenominator(Value value)
      Gets the denominator of the fraction specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_FRACTION
      Returns:
      the denominator of the fraction.

    • valueGetFractionNumerator

      public static int valueGetFractionNumerator(Value value)
      Gets the numerator of the fraction specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_FRACTION
      Returns:
      the numerator of the fraction.

    • valueGetFractionRangeMax

      public static @Nullable Value valueGetFractionRangeMax(Value value)
      Gets the maximum of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_FRACTION_RANGE
      Returns:
      the maximum of the range

    • valueGetFractionRangeMin

      public static @Nullable Value valueGetFractionRangeMin(Value value)
      Gets the minimum of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_FRACTION_RANGE
      Returns:
      the minimum of the range

    • valueGetInt64RangeMax

      public static long valueGetInt64RangeMax(Value value)
      Gets the maximum of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT64_RANGE
      Returns:
      the maximum of the range

    • valueGetInt64RangeMin

      public static long valueGetInt64RangeMin(Value value)
      Gets the minimum of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT64_RANGE
      Returns:
      the minimum of the range

    • valueGetInt64RangeStep

      public static long valueGetInt64RangeStep(Value value)
      Gets the step of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT64_RANGE
      Returns:
      the step of the range

    • valueGetIntRangeMax

      public static int valueGetIntRangeMax(Value value)
      Gets the maximum of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT_RANGE
      Returns:
      the maximum of the range

    • valueGetIntRangeMin

      public static int valueGetIntRangeMin(Value value)
      Gets the minimum of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT_RANGE
      Returns:
      the minimum of the range

    • valueGetIntRangeStep

      public static int valueGetIntRangeStep(Value value)
      Gets the step of the range specified by value.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT_RANGE
      Returns:
      the step of the range

    • valueGetStructure

      public static Structure valueGetStructure(Value value)
      Gets the contents of value.
      Parameters:
      value - a GValue initialized to GST_TYPE_STRUCTURE
      Returns:
      the contents of value

    • valueInitAndCopy

      public static void valueInitAndCopy(Value dest, Value src)
      Initialises the target value to be of the same type as source and then copies the contents from source to target.
      Parameters:
      dest - the target value
      src - the source value

    • valueIntersect

      public static boolean valueIntersect(@Nullable Value dest, Value value1, Value value2)
      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:
      dest - a uninitialized GValue that will hold the calculated intersection value. May be null if the resulting set if not needed.
      value1 - a value to intersect
      value2 - another value to intersect
      Returns:
      true if the intersection is non-empty

    • valueIsFixed

      public static boolean valueIsFixed(Value value)
      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 - the GValue to check
      Returns:
      true if the value is "fixed".

    • valueIsSubset

      public static boolean valueIsSubset(Value value1, Value value2)
      Check that value1 is a subset of value2.
      Parameters:
      value1 - a GValue
      value2 - a GValue
      Returns:
      true is value1 is a subset of value2

    • valueRegister

      public static void valueRegister(ValueTable table)
      Registers functions to perform calculations on GValue items of a given type. Each type can only be added once.
      Parameters:
      table - structure containing functions to register

    • valueSerialize

      public static @Nullable String valueSerialize(Value value)

      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 - a GValue to serialize
      Returns:
      the serialization for value or null if none exists

    • valueSetBitmask

      public static void valueSetBitmask(Value value, long bitmask)
      Sets value to the bitmask specified by bitmask.
      Parameters:
      value - a GValue initialized to GST_TYPE_BITMASK
      bitmask - the bitmask

    • valueSetCaps

      public static void valueSetCaps(Value value, Caps caps)
      Sets the contents of value to caps. A reference to the provided caps will be taken by the value.
      Parameters:
      value - a GValue initialized to GST_TYPE_CAPS
      caps - the caps to set the value to

    • valueSetCapsFeatures

      public static void valueSetCapsFeatures(Value value, CapsFeatures features)
      Sets the contents of value to features.
      Parameters:
      value - a GValue initialized to GST_TYPE_CAPS_FEATURES
      features - the features to set the value to

    • valueSetDoubleRange

      public static void valueSetDoubleRange(Value value, double start, double end)
      Sets value to the range specified by start and end.
      Parameters:
      value - a GValue initialized to GST_TYPE_DOUBLE_RANGE
      start - the start of the range
      end - the end of the range

    • valueSetFlagset

      public static void valueSetFlagset(Value value, int flags, int mask)
      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 - a GValue initialized to GST_TYPE_FLAG_SET
      flags - The value of the flags set or unset
      mask - The mask indicate which flags bits must match for comparisons
      Since:
      1.6

    • valueSetFraction

      public static void valueSetFraction(Value value, int numerator, int denominator)
      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 - a GValue initialized to GST_TYPE_FRACTION
      numerator - the numerator of the fraction
      denominator - the denominator of the fraction

    • valueSetFractionRange

      public static void valueSetFractionRange(Value value, Value start, Value end)
      Sets value to the range specified by start and end.
      Parameters:
      value - a GValue initialized to GST_TYPE_FRACTION_RANGE
      start - the start of the range (a GST_TYPE_FRACTION GValue)
      end - the end of the range (a GST_TYPE_FRACTION GValue)

    • valueSetFractionRangeFull

      public static void valueSetFractionRangeFull(Value value, int numeratorStart, int denominatorStart, int numeratorEnd, int denominatorEnd)
      Sets value to the range specified by denominatorStart and denominatorEnd.
      Parameters:
      value - a GValue initialized to GST_TYPE_FRACTION_RANGE
      numeratorStart - the numerator start of the range
      denominatorStart - the denominator start of the range
      numeratorEnd - the numerator end of the range
      denominatorEnd - the denominator end of the range

    • valueSetInt64Range

      public static void valueSetInt64Range(Value value, long start, long end)
      Sets value to the range specified by start and end.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT64_RANGE
      start - the start of the range
      end - the end of the range

    • valueSetInt64RangeStep

      public static void valueSetInt64RangeStep(Value value, long start, long end, long step)
      Sets value to the range specified by start, end and step.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT64_RANGE
      start - the start of the range
      end - the end of the range
      step - the step of the range

    • valueSetIntRange

      public static void valueSetIntRange(Value value, int start, int end)
      Sets value to the range specified by start and end.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT_RANGE
      start - the start of the range
      end - the end of the range

    • valueSetIntRangeStep

      public static void valueSetIntRangeStep(Value value, int start, int end, int step)
      Sets value to the range specified by start, end and step.
      Parameters:
      value - a GValue initialized to GST_TYPE_INT_RANGE
      start - the start of the range
      end - the end of the range
      step - the step of the range

    • valueSetStructure

      public static void valueSetStructure(Value value, Structure structure)
      Sets the contents of value to structure.
      Parameters:
      value - a GValue initialized to GST_TYPE_STRUCTURE
      structure - the structure to set the value to

    • valueSubtract

      public static boolean valueSubtract(@Nullable Value dest, Value minuend, Value subtrahend)
      Subtracts subtrahend from minuend and stores the result in dest. Note that this means subtraction as in sets, not as in mathematics.
      Parameters:
      dest - the destination value for the result if the subtraction is not empty. May be null, in which case the resulting set will not be computed, which can give a fair speedup.
      minuend - the value to subtract from
      subtrahend - the value to subtract
      Returns:
      true if the subtraction is not empty

    • valueUnion

      public static boolean valueUnion(Value dest, Value value1, Value value2)
      Creates a GValue corresponding to the union of value1 and value2.
      Parameters:
      dest - the destination value
      value1 - a value to union
      value2 - another value to union
      Returns:
      true if the union succeeded.

    • version

      public static void version(Out<Integer> major, Out<Integer> minor, Out<Integer> micro, Out<Integer> nano)
      Gets the version number of the GStreamer library.
      Parameters:
      major - pointer to a guint to store the major version number
      minor - pointer to a guint to store the minor version number
      micro - pointer to a guint to store the micro version number
      nano - pointer to a guint to store the nano version number

    • versionString

      public static String versionString()
      This function returns a string that is useful for describing this version of GStreamer to the outside world: user agent strings, logging, ...
      Returns:
      a newly allocated string describing this version of GStreamer.

    • macosMain

      public static int macosMain(@Nullable MainFunc mainFunc, @Nullable String @Nullable [] argv)

      Starts an NSApplication on the main thread before calling the provided main() function on a secondary thread.

      This ensures that GStreamer can correctly perform actions such as creating a GL window, which require a Cocoa main loop to be running on the main thread.

      Do not call this function more than once - especially while another one is still running - as that will cause unpredictable behaviour and most likely completely fail.

      Parameters:
      mainFunc - pointer to the main function to be called
      argv - an array of arguments to be passed to the main function
      Returns:
      the return value of the provided main_func
      Since:
      1.22

    • macosMainSimple

      public static int macosMainSimple(@Nullable MainFuncSimple mainFunc)
      Simplified variant of gst_macos_main(), meant to be used with bindings for languages which do not have to pass argc and argv like C does. See gst_macos_main() for a more detailed description.
      Parameters:
      mainFunc - pointer to the main function to be called
      Returns:
      the return value of the provided main_func
      Since:
      1.22