org.freedesktop.gstreamer

Class Buffer

java.lang.Object

org.freedesktop.gstreamer.glib.NativeObject

org.freedesktop.gstreamer.glib.RefCountedObject

org.freedesktop.gstreamer.MiniObject

org.freedesktop.gstreamer.Buffer

All Implemented Interfaces:

AutoCloseable

public class Buffer
extends MiniObject

Buffers are the basic unit of data transfer in GStreamer. They contain the timing and offset along with other arbitrary metadata that is associated with the GstMemory blocks that the buffer contains.

See upstream documentation at https://gstreamer.freedesktop.org/data/doc/gstreamer/stable/gstreamer/html/GstBuffer.html

Nested Class Summary

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject

NativeObject.Initializer, NativeObject.TypeProvider, NativeObject.TypeRegistration<T extends NativeObject>

Field Summary

Fields

Modifier and Type	Field and Description
static String	GTYPE_NAME

Constructor Summary

Constructors

Constructor and Description
Buffer() Creates a newly allocated buffer without any data.
Buffer(int size) Creates a newly allocated buffer with data of the given size.

Method Summary

Modifier and Type	Method and Description
long	getDecodeTimestamp() Gets the timestamps of this buffer.
long	getDuration() Gets the duration of this buffer.
EnumSet<BufferFlags>	getFlags() Get the GstBufferFlags describing this buffer.
long	getOffset() Get the offset (media-specific) of this buffer
long	getOffsetEnd() Get the offset (media-specific) of this buffer
long	getPresentationTimestamp() Gets the timestamps of this buffer.
ByteBuffer	map(boolean writable) Gets a ByteBuffer that can access the native memory associated with this Buffer, with the option of ensuring the memory is writable.
void	setDecodeTimestamp(long val) Set the decode timestamp of the Buffer
void	setDuration(long val) Set the duration of this buffer.
boolean	setFlags(EnumSet<BufferFlags> flags) Set some of the GstBufferFlags describing this buffer.
void	setOffset(long val) Set the offset (media-specific) of this buffer
void	setOffsetEnd(long val) Set the offset (media-specific) of this buffer
void	setPresentationTimestamp(long val) Set the presentation timestamp of the Buffer
void	unmap() Release the memory previously mapped with map(boolean)
boolean	unsetFlags(EnumSet<BufferFlags> flags) unset the GstBufferFlags describing this buffer.

Methods inherited from class org.freedesktop.gstreamer.MiniObject

copy, getRefCount, isWritable, makeWritable

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject

close, disown, dispose, equals, getPointer, getRawPointer, hashCode, invalidate, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GTYPE_NAME

public static final String GTYPE_NAME

See Also:

Constant Field Values

Constructor Detail

Buffer

public Buffer()

Creates a newly allocated buffer without any data.

Buffer

public Buffer(int size)

Creates a newly allocated buffer with data of the given size. The buffer memory is not cleared. If the requested amount of memory cannot be allocated, an exception will be thrown. Note that when size == 0, the buffer data pointer will be NULL.

Parameters:

size -

Method Detail

map

public ByteBuffer map(boolean writable)

Gets a ByteBuffer that can access the native memory associated with this Buffer, with the option of ensuring the memory is writable.

When requesting a writable buffer, if the buffer is writable but the underlying memory isn't, a writable copy will automatically be created and returned. The readonly copy of the buffer memory will then also be replaced with this writable copy.

The Buffer should be unmapped with unmap() after usage.

Parameters:

writable -

Returns:

A ByteBuffer that can access this Buffer's data.

unmap

public void unmap()

Release the memory previously mapped with map(boolean)

getDecodeTimestamp

public long getDecodeTimestamp()

Gets the timestamps of this buffer. The buffer DTS refers to the timestamp when the buffer should be decoded and is usually monotonically increasing.

Returns:

a long representing the timestamp or ClockTime.NONE when the timestamp is not known or relevant.

setDecodeTimestamp

public void setDecodeTimestamp(long val)

Set the decode timestamp of the Buffer

Parameters:

val - a long representing the timestamp or ClockTime.NONE when the timestamp is not known or relevant.

getPresentationTimestamp

public long getPresentationTimestamp()

Gets the timestamps of this buffer. The buffer PTS refers to the timestamp when the buffer content should be presented to the user and is not always monotonically increasing.

Returns:

a long representing the timestamp or ClockTime.NONE when the timestamp is not known or relevant.

setPresentationTimestamp

public void setPresentationTimestamp(long val)

Set the presentation timestamp of the Buffer

Parameters:

val - a long representing the timestamp or ClockTime.NONE when the timestamp is not known or relevant.

getDuration

public long getDuration()

Gets the duration of this buffer.

Returns:

a ClockTime representing the timestamp or ClockTime.NONE when the timestamp is not known or relevant.

setDuration

public void setDuration(long val)

Set the duration of this buffer.

Parameters:

val - a long representing the duration or ClockTime.NONE when the timestamp is not known or relevant.

getOffset

public long getOffset()

Get the offset (media-specific) of this buffer

Returns:

a media specific offset for the buffer data. For video frames, this is the frame number of this buffer. For audio samples, this is the offset of the first sample in this buffer. For file data or compressed data this is the byte offset of the first byte in this buffer.

setOffset

public void setOffset(long val)

Set the offset (media-specific) of this buffer

Parameters:

val - a media specific offset for the buffer data. For video frames, this is the frame number of this buffer. For audio samples, this is the offset of the first sample in this buffer. For file data or compressed data this is the byte offset of the first byte in this buffer.

getOffsetEnd

public long getOffsetEnd()

Get the offset (media-specific) of this buffer

Returns:

a media specific offset for the buffer data. For video frames, this is the frame number of this buffer. For audio samples, this is the offset of the first sample in this buffer. For file data or compressed data this is the byte offset of the first byte in this buffer.

setOffsetEnd

public void setOffsetEnd(long val)

Set the offset (media-specific) of this buffer

Parameters:

val - a media specific offset for the buffer data. For video frames, this is the frame number of this buffer. For audio samples, this is the offset of the first sample in this buffer. For file data or compressed data this is the byte offset of the first byte in this buffer.

getFlags

@Gst.Since(minor=10)
public EnumSet<BufferFlags> getFlags()

Get the GstBufferFlags describing this buffer. Since GStreamer 1.10

Returns:

an EnumSet of BufferFlags

setFlags

@Gst.Since(minor=10)
public boolean setFlags(EnumSet<BufferFlags> flags)

Set some of the GstBufferFlags describing this buffer. This is a union operation and does not clear flags that are not mentioned. Since GStreamer 1.10

Parameters:

flags - an EnumSet of BufferFlags to be set on the buffer.

Returns:

true if flags were successfully set on this buffer

unsetFlags

@Gst.Since(minor=10)
public boolean unsetFlags(EnumSet<BufferFlags> flags)

unset the GstBufferFlags describing this buffer. This is a difference operation and does not clear flags that are not mentioned. Since GStreamer 1.10

Parameters:

flags - an EnumSet of BufferFlags to be cleared on the buffer.

Returns:

true if flags were successfully cleared on this buffer