Package com.sedmelluq.discord.lavaplayer.track.playback

Class TerminatorAudioFrame

java.lang.Object

com.sedmelluq.discord.lavaplayer.track.playback.TerminatorAudioFrame

All Implemented Interfaces:

AudioFrame

public class TerminatorAudioFrame
extends java.lang.Object
implements AudioFrame

Audio frame where isTerminator() is true.

Field Summary

Fields

Modifier and Type	Field	Description
static TerminatorAudioFrame	INSTANCE

Constructor Summary

Constructors

Constructor	Description
TerminatorAudioFrame()

Method Summary

Modifier and Type	Method	Description
byte[]	getData()
void	getData(byte[] buffer, int offset)	Before calling this method, the caller should verify that the data fits in the buffer using AudioFrame.getDataLength().
int	getDataLength()
AudioDataFormat	getFormat()
long	getTimecode()
int	getVolume()
boolean	isTerminator()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final TerminatorAudioFrame INSTANCE

Constructor Detail

TerminatorAudioFrame

public TerminatorAudioFrame()

Method Detail

getTimecode

public long getTimecode()

Specified by:

getTimecode in interface AudioFrame

Returns:

Absolute timecode of the frame in milliseconds.

getVolume

public int getVolume()

Specified by:

getVolume in interface AudioFrame

Returns:

Volume of the current frame.

getDataLength

public int getDataLength()

Specified by:

getDataLength in interface AudioFrame

Returns:

Length of the data of this frame.

getData

public byte[] getData()

Specified by:

getData in interface AudioFrame

Returns:

Byte array with the frame data.

getData

public void getData(byte[] buffer,
                    int offset)

Description copied from interface: AudioFrame

Before calling this method, the caller should verify that the data fits in the buffer using AudioFrame.getDataLength().

Specified by:

getData in interface AudioFrame

Parameters:

buffer - Buffer to write the frame data to.

offset - Offset in the buffer to start writing at.

getFormat

public AudioDataFormat getFormat()

Specified by:

getFormat in interface AudioFrame

Returns:

The data format of this buffer.

isTerminator

public boolean isTerminator()

Specified by:

isTerminator in interface AudioFrame

Returns:

Whether this frame is a terminator. This is an internal concept of the player and should never be true in any frames received by the user.