AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Types | Public Attributes | List of all members
alexaClientSDK::avsCommon::utils::AudioFormat Struct Reference

#include <AudioFormat.h>

Public Types

enum  Encoding { Encoding::LPCM, Encoding::OPUS }
 
enum  Layout { Layout::NON_INTERLEAVED, Layout::INTERLEAVED }
 
enum  Endianness { Endianness::LITTLE, Endianness::BIG }
 

Public Attributes

Encoding encoding
 The encoding of the data. More...
 
Endianness endianness
 The endianness of the data. More...
 
unsigned int sampleRateHz
 The number of samples recorded or played per second. More...
 
unsigned int sampleSizeInBits
 The bits per sample. More...
 
unsigned int numChannels
 The number of channels. More...
 
bool dataSigned
 true if the data is signed false otherwise. More...
 
Layout layout
 The layout of format for cases where numChannels > 1. More...
 

Detailed Description

The format of audio data.

Member Enumeration Documentation

◆ Encoding

An enum class used to represent the encoding of audio data.

Enumerator
LPCM 

Represents LPCM (Linear pulse code modulation) encoding.

OPUS 

Represents OPUS encoding.

◆ Endianness

An enum class used to represent the endianness of audio data.

Enumerator
LITTLE 

Represents little endianness.

BIG 

Represents big endianness.

◆ Layout

An enum class to represent layout of audio files for streams with more than one channel.

Enumerator
NON_INTERLEAVED 

Non-Interleaved : The L and R are separated in different streams.

INTERLEAVED 

Interleaved : The L and R sides of a stereo recording are interleaved.

Member Data Documentation

◆ dataSigned

bool alexaClientSDK::avsCommon::utils::AudioFormat::dataSigned

true if the data is signed false otherwise.

◆ encoding

Encoding alexaClientSDK::avsCommon::utils::AudioFormat::encoding

The encoding of the data.

◆ endianness

Endianness alexaClientSDK::avsCommon::utils::AudioFormat::endianness

The endianness of the data.

◆ layout

Layout alexaClientSDK::avsCommon::utils::AudioFormat::layout

The layout of format for cases where numChannels > 1.

◆ numChannels

unsigned int alexaClientSDK::avsCommon::utils::AudioFormat::numChannels

The number of channels.

◆ sampleRateHz

unsigned int alexaClientSDK::avsCommon::utils::AudioFormat::sampleRateHz

The number of samples recorded or played per second.

◆ sampleSizeInBits

unsigned int alexaClientSDK::avsCommon::utils::AudioFormat::sampleSizeInBits

The bits per sample.


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

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0