com.amazonaws.mobileconnectors.lex.interactionkit.internal.audio.encoder

Interface AudioEncoder

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

BufferedAudioEncoder, L16PcmEncoder, OpusEncoder

public interface AudioEncoder
extends java.io.Closeable

Interface for AudioEncoders.

Method Summary

Modifier and Type	Method and Description
void	close() Release encoder resources.
byte[]	encode(short[] samples, int numSamples) Encode PCM samples to compressed audio bytes.
int	getFrameSize() Get the frame size in PCM samples of this audio codec.
com.google.common.net.MediaType	getMediaType() The MediaType of the compressed audio.
int	getPacketSize() Get the packet size of this audio codec for optimizing transmission.
AudioEncoder	newEncoder() Make a new encoder with the same configuration.

Method Detail

encode

byte[] encode(short[] samples,
              int numSamples)
       throws AudioEncoderException

Encode PCM samples to compressed audio bytes.

Parameters:

samples - the samples to compress.

numSamples - the number of samples int the buffer to compress.

Returns:

the compressed audio bytes.

Throws:

AudioEncoderException - when there's an error encoding the audio.

getMediaType

com.google.common.net.MediaType getMediaType()

The MediaType of the compressed audio.

Returns:

the media type.

getFrameSize

int getFrameSize()

Get the frame size in PCM samples of this audio codec.

Returns:

the frame size in PCM samples.

getPacketSize

int getPacketSize()

Get the packet size of this audio codec for optimizing transmission.

Returns:

the packet size in bytes.

close

void close()

Release encoder resources.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

newEncoder

AudioEncoder newEncoder()

Make a new encoder with the same configuration.

Returns:

the new encoder.