Package com.sedmelluq.discord.lavaplayer.format

Class AudioDataFormat

java.lang.Object

com.sedmelluq.discord.lavaplayer.format.AudioDataFormat

Direct Known Subclasses:

OpusAudioDataFormat, Pcm16AudioDataFormat

public abstract class AudioDataFormat
extends java.lang.Object

Describes the format for audio with fixed chunk size.

Field Summary

Fields

Modifier and Type	Field	Description
int	channelCount	Number of channels.
int	chunkSampleCount	Number of samples in one chunk.
int	sampleRate	Sample rate (frequency).

Constructor Summary

Constructors

Constructor	Description
AudioDataFormat(int channelCount, int sampleRate, int chunkSampleCount)

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String	codecName()
abstract AudioChunkDecoder	createDecoder()
abstract AudioChunkEncoder	createEncoder(AudioConfiguration configuration)
boolean	equals(java.lang.Object o)
abstract int	expectedChunkSize()
long	frameDuration()
int	hashCode()
abstract int	maximumChunkSize()
abstract byte[]	silenceBytes()
int	totalSampleCount()

Methods inherited from class java.lang.Object

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

Field Detail

channelCount

public final int channelCount

Number of channels.

sampleRate

public final int sampleRate

Sample rate (frequency).

chunkSampleCount

public final int chunkSampleCount

Number of samples in one chunk.

Constructor Detail

AudioDataFormat

public AudioDataFormat(int channelCount,
                       int sampleRate,
                       int chunkSampleCount)

Parameters:

channelCount - Number of channels.

sampleRate - Sample rate (frequency).

chunkSampleCount - Number of samples in one chunk.

Method Detail

totalSampleCount

public int totalSampleCount()

Returns:

Total number of samples in one frame.

frameDuration

public long frameDuration()

Returns:

The duration in milliseconds of one frame in this format.

codecName

public abstract java.lang.String codecName()

Returns:

Name of the codec.

silenceBytes

public abstract byte[] silenceBytes()

Returns:

Byte array representing a frame of silence in this format.

expectedChunkSize

public abstract int expectedChunkSize()

Returns:

Generally expected average size of a frame in this format.

maximumChunkSize

public abstract int maximumChunkSize()

Returns:

Maximum size of a frame in this format.

createDecoder

public abstract AudioChunkDecoder createDecoder()

Returns:

Decoder to convert data in this format to short PCM.

createEncoder

public abstract AudioChunkEncoder createEncoder(AudioConfiguration configuration)

Parameters:

configuration - Configuration to use for encoding.

Returns:

Encoder to convert data in short PCM format to this format.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object