AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::AlexaForBusiness::Model::Audio Class Reference

#include <Audio.h>

Public Member Functions

 Audio ()
 
 Audio (Aws::Utils::Json::JsonView jsonValue)
 
Audiooperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const LocaleGetLocale () const
 
bool LocaleHasBeenSet () const
 
void SetLocale (const Locale &value)
 
void SetLocale (Locale &&value)
 
AudioWithLocale (const Locale &value)
 
AudioWithLocale (Locale &&value)
 
const Aws::StringGetLocation () const
 
bool LocationHasBeenSet () const
 
void SetLocation (const Aws::String &value)
 
void SetLocation (Aws::String &&value)
 
void SetLocation (const char *value)
 
AudioWithLocation (const Aws::String &value)
 
AudioWithLocation (Aws::String &&value)
 
AudioWithLocation (const char *value)
 

Detailed Description

The audio message. There is a 1 MB limit on the audio file input and the only supported format is MP3. To convert your MP3 audio files to an Alexa-friendly,

required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter software. One option for this is a command-line tool, FFmpeg. For more information, see FFmpeg. The following command converts the provided <input-file> to an MP3 file that is played in the announcement:

ffmpeg -i <input-file> -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000 <output-file.mp3>

See Also:

AWS API Reference

Definition at line 40 of file Audio.h.

Constructor & Destructor Documentation

◆ Audio() [1/2]

Aws::AlexaForBusiness::Model::Audio::Audio ( )

◆ Audio() [2/2]

Aws::AlexaForBusiness::Model::Audio::Audio ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetLocale()

const Locale& Aws::AlexaForBusiness::Model::Audio::GetLocale ( ) const
inline

The locale of the audio message. Currently, en-US is supported.

Definition at line 52 of file Audio.h.

◆ GetLocation()

const Aws::String& Aws::AlexaForBusiness::Model::Audio::GetLocation ( ) const
inline

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

Definition at line 86 of file Audio.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::AlexaForBusiness::Model::Audio::Jsonize ( ) const

◆ LocaleHasBeenSet()

bool Aws::AlexaForBusiness::Model::Audio::LocaleHasBeenSet ( ) const
inline

The locale of the audio message. Currently, en-US is supported.

Definition at line 57 of file Audio.h.

◆ LocationHasBeenSet()

bool Aws::AlexaForBusiness::Model::Audio::LocationHasBeenSet ( ) const
inline

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

Definition at line 94 of file Audio.h.

◆ operator=()

Audio& Aws::AlexaForBusiness::Model::Audio::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetLocale() [1/2]

void Aws::AlexaForBusiness::Model::Audio::SetLocale ( const Locale value)
inline

The locale of the audio message. Currently, en-US is supported.

Definition at line 62 of file Audio.h.

◆ SetLocale() [2/2]

void Aws::AlexaForBusiness::Model::Audio::SetLocale ( Locale &&  value)
inline

The locale of the audio message. Currently, en-US is supported.

Definition at line 67 of file Audio.h.

◆ SetLocation() [1/3]

void Aws::AlexaForBusiness::Model::Audio::SetLocation ( const Aws::String value)
inline

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

Definition at line 102 of file Audio.h.

◆ SetLocation() [2/3]

void Aws::AlexaForBusiness::Model::Audio::SetLocation ( Aws::String &&  value)
inline

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

Definition at line 110 of file Audio.h.

◆ SetLocation() [3/3]

void Aws::AlexaForBusiness::Model::Audio::SetLocation ( const char *  value)
inline

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

Definition at line 118 of file Audio.h.

◆ WithLocale() [1/2]

Audio& Aws::AlexaForBusiness::Model::Audio::WithLocale ( const Locale value)
inline

The locale of the audio message. Currently, en-US is supported.

Definition at line 72 of file Audio.h.

◆ WithLocale() [2/2]

Audio& Aws::AlexaForBusiness::Model::Audio::WithLocale ( Locale &&  value)
inline

The locale of the audio message. Currently, en-US is supported.

Definition at line 77 of file Audio.h.

◆ WithLocation() [1/3]

Audio& Aws::AlexaForBusiness::Model::Audio::WithLocation ( const Aws::String value)
inline

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

Definition at line 126 of file Audio.h.

◆ WithLocation() [2/3]

Audio& Aws::AlexaForBusiness::Model::Audio::WithLocation ( Aws::String &&  value)
inline

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

Definition at line 134 of file Audio.h.

◆ WithLocation() [3/3]

Audio& Aws::AlexaForBusiness::Model::Audio::WithLocation ( const char *  value)
inline

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

Definition at line 142 of file Audio.h.


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