alexaClientSDK::avsCommon::sdkInterfaces::SystemSoundPlayerInterface Class Reference

#include <SystemSoundPlayerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::SystemSoundPlayerInterface:

Public Types
enum	Tone { Tone::WAKEWORD_NOTIFICATION, Tone::END_SPEECH }
	The different system sounds supported. More...

Public Member Functions
virtual	~SystemSoundPlayerInterface ()=default
virtual std::shared_future< bool >	playTone (Tone tone)=0

Detailed Description

This class allows the playback of various system sounds.

Member Enumeration Documentation

Tone

enum alexaClientSDK::avsCommon::sdkInterfaces::SystemSoundPlayerInterface::Tone

strong

The different system sounds supported.

Enumerator
WAKEWORD_NOTIFICATION	The sound to notify wake word has been detected.
END_SPEECH	The sound to notify when Alexa is done recording speech.

Constructor & Destructor Documentation

~SystemSoundPlayerInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::SystemSoundPlayerInterface::~SystemSoundPlayerInterface ( )

virtualdefault

Destructor

Member Function Documentation

playTone()

virtual std::shared_future<bool> alexaClientSDK::avsCommon::sdkInterfaces::SystemSoundPlayerInterface::playTone ( Tone  tone )

pure virtual

Method to play a system sound.

Parameters

tone	The tone to play.

Returns

A future that will return true on successful playback and false on error.

Implemented in alexaClientSDK::applicationUtilities::systemSoundPlayer::SystemSoundPlayer.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/SystemSoundPlayerInterface.h