alexaClientSDK::mediaPlayer::android::PlaybackConfiguration Class Reference

#include <PlaybackConfiguration.h>

Public Types
enum	ChannelLayout { ChannelLayout::LAYOUT_MONO, ChannelLayout::LAYOUT_STEREO, ChannelLayout::LAYOUT_SURROUND, ChannelLayout::LAYOUT_5POINT1 }
enum	SampleFormat { SampleFormat::UNSIGNED_8 = 8, SampleFormat::SIGNED_16 = 16, SampleFormat::SIGNED_32 = 32 }

Public Member Functions
bool	isLittleEndian () const
size_t	sampleRate () const
SampleFormat	sampleFormat () const
ChannelLayout	channelLayout () const
size_t	numberChannels () const
size_t	sampleSizeBytes () const
	~PlaybackConfiguration ()=default
	PlaybackConfiguration ()
	PlaybackConfiguration (const bool isLittleEndian, const size_t sampleRate, const ChannelLayout layout, const SampleFormat sampleFormat)

Detailed Description

An object of this class holds information about the playback configuration used by the Android media player.

By default, the playback configuration is:

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

To change the default configuration, user can either:

• Provide a ConfigurationNode to create method. All the configurations found in the node will override the default values.
• Create the playback configuration object with explicit configuration values for all fields.

Member Enumeration Documentation

ChannelLayout

enum alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::ChannelLayout

strong

Enum with the supported channel layouts.

Enumerator
LAYOUT_MONO
LAYOUT_STEREO
LAYOUT_SURROUND
LAYOUT_5POINT1

SampleFormat

enum alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::SampleFormat

strong

The sample format related to signess and number of bits.

Note

: DO NOT use the enum underlying values. This is for internal usage and it may change in the future.

Enumerator
UNSIGNED_8
SIGNED_16
SIGNED_32

Constructor & Destructor Documentation

~PlaybackConfiguration()

alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::~PlaybackConfiguration ( )

default

Destructor.

PlaybackConfiguration() [1/2]

alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::PlaybackConfiguration

(

)

Constructor where the new object will have default configuration values.

PlaybackConfiguration() [2/2]

alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::PlaybackConfiguration	(	const bool	isLittleEndian,
		const size_t	sampleRate,
		const ChannelLayout	layout,
		const SampleFormat	sampleFormat
	)

Configurable constructor that can be used to set custom configuration values.

Member Function Documentation

channelLayout()

PlaybackConfiguration::ChannelLayout alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::channelLayout ( ) const

inline

Get the channel layout.

Returns

The channel layout.

isLittleEndian()

bool alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::isLittleEndian ( ) const

inline

Check whether the configuration is little endian.

Returns

true if endianness is little endian and if big endian.

numberChannels()

size_t alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::numberChannels ( ) const

inline

Get the number of channels used.

Returns

The number of channels.

sampleFormat()

PlaybackConfiguration::SampleFormat alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::sampleFormat ( ) const

inline

Get the sample format.

Returns

The sample format.

sampleRate()

size_t alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::sampleRate ( ) const

inline

Get the sample rate in Hz.

Returns

The sample rate.

sampleSizeBytes()

size_t alexaClientSDK::mediaPlayer::android::PlaybackConfiguration::sampleSizeBytes ( ) const

inline

Get the number of bytes per sample.

---

The documentation for this class was generated from the following file:

• /workplace/avs-device-sdk/MediaPlayer/AndroidSLESMediaPlayer/include/AndroidSLESMediaPlayer/PlaybackConfiguration.h