#include <DecoderInterface.h>

Inheritance diagram for alexaClientSDK::mediaPlayer::android::DecoderInterface:

Public Types
enum	Status { Status::OK, Status::DONE, Status::ERROR }
	Represent the decoder read status. More...

using	Byte = uint8_t
	Represents one byte of data. More...

Public Member Functions
virtual std::pair< Status, size_t >	read (Byte *buffer, size_t size)=0

virtual void	abort ()=0

virtual	~DecoderInterface ()=default

Detailed Description

A provides a method to fill up buffers with raw audio. The read method shall respect the audio frame boundaries, i.e., one frame shall not be split into more than one buffer.

The output should always be:

16bit Linear PCM
48kHz sample rate
2 channels (Left | Right)
Native-endianness

Member Typedef Documentation

◆ Byte

using alexaClientSDK::mediaPlayer::android::DecoderInterface::Byte = uint8_t

Represents one byte of data.

Member Enumeration Documentation

◆ Status

enum alexaClientSDK::mediaPlayer::android::DecoderInterface::Status

strong

Represent the decoder read status.

Enumerator
OK	The read request was successful and there is still more data to be read.
DONE	The decoder has decoded the entire input and there is no more data left to be read.
ERROR	The decoder found an error.

Constructor & Destructor Documentation

◆ ~DecoderInterface()

virtual alexaClientSDK::mediaPlayer::android::DecoderInterface::~DecoderInterface ( )

virtualdefault

Virtual destructor.

Member Function Documentation

◆ abort()

virtual void alexaClientSDK::mediaPlayer::android::DecoderInterface::abort ( )

pure virtual

Abort the decoding process.

This method can be called in parallel with read. The read will fail in this case. Future reads will also fail.

Implemented in alexaClientSDK::mediaPlayer::android::FFmpegDecoder.

◆ read()

virtual std::pair<Status, size_t> alexaClientSDK::mediaPlayer::android::DecoderInterface::read	(	Byte *	buffer,
		size_t	size
	)