Enum Class BufferFlags

java.lang.Object
java.lang.Enum<BufferFlags>
org.freedesktop.gstreamer.gst.BufferFlags
All Implemented Interfaces:
Serializable, Comparable<BufferFlags>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum BufferFlags extends Enum<BufferFlags> implements Enumeration
A set of buffer flags used to describe properties of a GstBuffer.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CORRUPTED
    the buffer data is corrupted.
    DECODE_ONLY
    the buffer contains data that should be dropped because it will be clipped against the segment boundaries or because it does not contain data that should be shown to the user.
    DELTA_UNIT
    this unit cannot be decoded independently.
    DISCONT
    the buffer marks a data discontinuity in the stream.
    DROPPABLE
    the buffer can be dropped without breaking the stream, for example to reduce bandwidth.
    GAP
    the buffer has been created to fill a gap in the stream and contains media neutral data (elements can switch to optimized code path that ignores the buffer content).
    HEADER
    the buffer contains header information that is needed to decode the following data.
    LAST
    additional media specific flags can be added starting from this flag.
    LIVE
    the buffer is live data and should be discarded in the PAUSED state.
    MARKER
    the buffer contains a media specific marker.
    NON_DROPPABLE
    This buffer is important and should not be dropped.
    RESYNC
    the buffer timestamps might have a discontinuity and this buffer is a good point to resynchronize.
    SYNC_AFTER
    Elements which write to disk or permanent storage should ensure the data is synced after writing the contents of this buffer.
    TAG_MEMORY
    this flag is set when memory of the buffer is added/removed

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable Type
    getType()
    Get the GType of the BufferFlags class.
    int
    getValue()
    Get the numeric value of this enum
    static Set<BufferFlags>
    of(int flags)
    Create a new EnumSet<BufferFlags> for the provided bitfield
    static Set<BufferFlags>
    of(MemorySegment address)
    Create a new EnumSet<BufferFlags> for the bitfield in the provided memory address.
    static BufferFlags
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static BufferFlags[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • LIVE

      public static final BufferFlags LIVE
      the buffer is live data and should be discarded in the PAUSED state.

    • DECODE_ONLY

      public static final BufferFlags DECODE_ONLY
      the buffer contains data that should be dropped because it will be clipped against the segment boundaries or because it does not contain data that should be shown to the user.

    • DISCONT

      public static final BufferFlags DISCONT
      the buffer marks a data discontinuity in the stream. This typically occurs after a seek or a dropped buffer from a live or network source.

    • RESYNC

      public static final BufferFlags RESYNC
      the buffer timestamps might have a discontinuity and this buffer is a good point to resynchronize.

    • CORRUPTED

      public static final BufferFlags CORRUPTED
      the buffer data is corrupted.

    • MARKER

      public static final BufferFlags MARKER
      the buffer contains a media specific marker. for video this is the end of a frame boundary, for audio this is the start of a talkspurt. for RTP packets this matches the marker flag in the RTP packet header.

    • GAP

      public static final BufferFlags GAP
      the buffer has been created to fill a gap in the stream and contains media neutral data (elements can switch to optimized code path that ignores the buffer content).

    • DROPPABLE

      public static final BufferFlags DROPPABLE
      the buffer can be dropped without breaking the stream, for example to reduce bandwidth.

    • DELTA_UNIT

      public static final BufferFlags DELTA_UNIT
      this unit cannot be decoded independently.

    • TAG_MEMORY

      public static final BufferFlags TAG_MEMORY
      this flag is set when memory of the buffer is added/removed

    • SYNC_AFTER

      public static final BufferFlags SYNC_AFTER
      Elements which write to disk or permanent storage should ensure the data is synced after writing the contents of this buffer.
      Since:
      1.6

    • NON_DROPPABLE

      public static final BufferFlags NON_DROPPABLE

      This buffer is important and should not be dropped.

      This can be used to mark important buffers, e.g. to flag RTP packets carrying keyframes or codec setup data for RTP Forward Error Correction purposes, or to prevent still video frames from being dropped by elements due to QoS.

      Since:
      1.14

    • LAST

      public static final BufferFlags LAST
      additional media specific flags can be added starting from this flag.

  • Method Details

    • values

      public static BufferFlags[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static BufferFlags valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Get the numeric value of this enum
      Specified by:
      getValue in interface Enumeration
      Returns:
      the enum value

    • of

      public static Set<BufferFlags> of(int flags)
      Create a new EnumSet<BufferFlags> for the provided bitfield
      Parameters:
      flags - the BufferFlags bitfield
      Returns:
      the EnumSet for the provided bitfield

    • of

      public static Set<BufferFlags> of(MemorySegment address)
      Create a new EnumSet<BufferFlags> for the bitfield in the provided memory address.
      Parameters:
      address - the memory address holding a bitfield value
      Returns:
      the EnumSet for the bitfield in the provided memory address

    • getType

      public static @Nullable Type getType()
      Get the GType of the BufferFlags class.
      Returns:
      the GType