GlueGen v2.6.0-rc-20250712
GlueGen, Native Binding Generator for Java™ (public API).
com.jogamp.common.av.AudioSink.AudioFrame Class Referenceabstract

Abstract audio frame containing multiple audio samples per channel, tracking TimeFrameI pts and size in bytes. More...

Inheritance diagram for com.jogamp.common.av.AudioSink.AudioFrame:
Collaboration diagram for com.jogamp.common.av.AudioSink.AudioFrame:

Public Member Functions

 AudioFrame ()
 Ctor w/ zero duration, INVALID_PTS and zero byte size. More...
 
 AudioFrame (final int pts, final int duration, final int byteCount)
 Create a new instance. More...
 
final int getByteSize ()
 Get this frame's size in bytes. More...
 
final void setByteSize (final int size)
 Set this frame's size in bytes. More...
 
String toString ()
 
- Public Member Functions inherited from com.jogamp.common.av.TimeFrameI
 TimeFrameI ()
 Ctor w/ zero duration and INVALID_PTS. More...
 
 TimeFrameI (final int pts, final int duration)
 Create a new instance. More...
 
final int getPTS ()
 Returns this frame's presentation timestamp (PTS) in milliseconds. More...
 
final void setPTS (final int pts)
 Set this frame's presentation timestamp (PTS) in milliseconds. More...
 
final int getDuration ()
 Get this frame's duration in milliseconds. More...
 
final void setDuration (final int duration)
 Set this frame's duration in milliseconds. More...
 
String toString ()
 

Protected Attributes

int byteSize
 
- Protected Attributes inherited from com.jogamp.common.av.TimeFrameI
int pts
 
int duration
 

Additional Inherited Members

- Static Public Attributes inherited from com.jogamp.common.av.TimeFrameI
static final int INVALID_PTS = 0x80000000
 Constant marking an invalid PTS, i.e. More...
 
static final int END_OF_STREAM_PTS = 0x7FFFFFFF
 Constant marking the end of the stream PTS, i.e. More...
 

Detailed Description

Abstract audio frame containing multiple audio samples per channel, tracking TimeFrameI pts and size in bytes.

One AudioFrame may contain multiple pairs of samples per channel, i.e. this AudioFrame does not limit a frame to be one sample per channel. See its application in AudioSink#enqueueData(int, ByteBuffer, int).

Implementations may assign actual data to queue frames from streaming, see AudioDataFrame.

See also
AudioSink::enqueueData(int, ByteBuffer, int)

Definition at line 61 of file AudioSink.java.

Constructor & Destructor Documentation

◆ AudioFrame() [1/2]

com.jogamp.common.av.AudioSink.AudioFrame.AudioFrame ( )

Ctor w/ zero duration, INVALID_PTS and zero byte size.

Definition at line 67 of file AudioSink.java.

◆ AudioFrame() [2/2]

com.jogamp.common.av.AudioSink.AudioFrame.AudioFrame ( final int  pts,
final int  duration,
final int  byteCount 
)

Create a new instance.

Parameters
ptsframe pts in milliseconds
durationframe duration in milliseconds
byteCountsize in bytes

Definition at line 76 of file AudioSink.java.

Member Function Documentation

◆ getByteSize()

final int com.jogamp.common.av.AudioSink.AudioFrame.getByteSize ( )

Get this frame's size in bytes.

Definition at line 82 of file AudioSink.java.

◆ setByteSize()

final void com.jogamp.common.av.AudioSink.AudioFrame.setByteSize ( final int  size)

Set this frame's size in bytes.

Definition at line 84 of file AudioSink.java.

◆ toString()

String com.jogamp.common.av.AudioSink.AudioFrame.toString ( )

Reimplemented from com.jogamp.common.av.TimeFrameI.

Reimplemented in com.jogamp.common.av.AudioSink.AudioDataFrame.

Definition at line 87 of file AudioSink.java.

Member Data Documentation

◆ byteSize

int com.jogamp.common.av.AudioSink.AudioFrame.byteSize
protected

Definition at line 62 of file AudioSink.java.


The documentation for this class was generated from the following file: