org.freedesktop.gstreamer

Enum BufferFlags

java.lang.Object

java.lang.Enum<BufferFlags>

org.freedesktop.gstreamer.BufferFlags

All Implemented Interfaces:

Serializable, Comparable<BufferFlags>, NativeEnum<BufferFlags>, NativeFlags<BufferFlags>

public enum BufferFlags
extends Enum<BufferFlags>
implements NativeFlags<BufferFlags>

A set of buffer flags used to describe properties of a Buffer.

Enum Constant Summary

Enum Constants

Enum Constant and 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 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 he buffer contains header information that is needed to decode the following data.
LAST
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 and Description
int	intValue() Get the integer value of the enum.
static BufferFlags	valueOf(String name) Returns the enum constant of this type with the specified name.
static BufferFlags[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.freedesktop.gstreamer.glib.NativeFlags

fromInt, toInt, toInt

Methods inherited from interface org.freedesktop.gstreamer.glib.NativeEnum

fromInt, fromInt

Enum Constant Detail

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 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 typically the end of a frame boundary, for audio this is usually the start of a talkspurt.

HEADER

public static final BufferFlags HEADER

he buffer contains header information that is needed to decode the following data.

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

@Gst.Since(minor=14)
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

Method Detail

values

public static BufferFlags[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BufferFlags c : BufferFlags.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BufferFlags valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

intValue

public final int intValue()

Get the integer value of the enum.

Specified by:

intValue in interface NativeEnum<BufferFlags>

Returns:

The integer value for this enum.