com.github.hoary.javaav

Class AudioFrame

java.lang.Object

com.github.hoary.javaav.MediaFrame

com.github.hoary.javaav.AudioFrame

public class AudioFrame
extends MediaFrame

An AudioFrame contains audio samples with a specific AudioFormat that describes the characteristics of the samples. Depending on how many channels the audio of this frame has, each channel can be accessed with getPlane().

Author:

Alex Andres

Nested Class Summary

Nested classes/interfaces inherited from class com.github.hoary.javaav.MediaFrame

MediaFrame.Type

Constructor Summary

Constructors

Constructor and Description
AudioFrame(AudioFormat format, int samples) Creates a new AudioFrame with descriptive format and allocates memory for the specified amount of samples.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Free the memory of sample buffers.
AudioFormat	getAudioFormat() Get the audio format of containing samples.
int	getBufferSize() Get buffer size per plane.
com.googlecode.javacpp.PointerPointer	getData() Get sample data pointers.
com.googlecode.javacpp.BytePointer	getPlane(int index) Get pointer to audio plane at specified index.
int	getPlaneCount() Get the number of audio planes/channels.
com.googlecode.javacpp.BytePointer[]	getPlanes() Get pointers to all audio planes.
int	getSampleCount() Get the number of samples in this frame.
MediaFrame.Type	getType()
boolean	hasFrame()
void	setSampleCount(int samples) Set the number of samples in this frame.

Methods inherited from class com.github.hoary.javaav.MediaFrame

getTimestamp, isKeyFrame, setKeyFrame, setTimestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AudioFrame

public AudioFrame(AudioFormat format,
          int samples)

Creates a new AudioFrame with descriptive format and allocates memory for the specified amount of samples.

Parameters:

format - the format of the samples.

samples - the amount of samples.

Method Detail

getAudioFormat

public AudioFormat getAudioFormat()

Get the audio format of containing samples.

Returns:

the audio format.

getData

public com.googlecode.javacpp.PointerPointer getData()

Get sample data pointers.

Returns:

pointers to samples.

getBufferSize

public int getBufferSize()

Get buffer size per plane.

Returns:

buffer size per plane.

getPlanes

public com.googlecode.javacpp.BytePointer[] getPlanes()

Get pointers to all audio planes.

Returns:

pointers to all audio planes.

getPlane

public com.googlecode.javacpp.BytePointer getPlane(int index)

Get pointer to audio plane at specified index.

Parameters:

index - the plane index.

Returns:

pointer to an audio plane.

getPlaneCount

public int getPlaneCount()

Get the number of audio planes/channels.

Returns:

number of planes.

setSampleCount

public void setSampleCount(int samples)

Set the number of samples in this frame.

Parameters:

samples - the number of samples to set.

getSampleCount

public int getSampleCount()

Get the number of samples in this frame.

Returns:

number of samples in this frame.

getType

public MediaFrame.Type getType()

Overrides:

getType in class MediaFrame

hasFrame

public boolean hasFrame()

Overrides:

hasFrame in class MediaFrame

clear

public void clear()

Free the memory of sample buffers.