AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::audio::SystemSoundAudioFactoryInterface Class Referenceabstract

#include <SystemSoundAudioFactoryInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::audio::SystemSoundAudioFactoryInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~SystemSoundAudioFactoryInterface ()=default
 
virtual std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >)> endSpeechTone () const =0
 
virtual std::function< std::pair< std::unique_ptr< std::istream >, const avsCommon::utils::MediaType >)> wakeWordNotificationTone () const =0
 

Detailed Description

This is an interface to produce streams of the system sound audio resources.

Constructor & Destructor Documentation

◆ ~SystemSoundAudioFactoryInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::audio::SystemSoundAudioFactoryInterface::~SystemSoundAudioFactoryInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ endSpeechTone()

virtual std::function<std::pair<std::unique_ptr<std::istream>, const avsCommon::utils::MediaType>)> alexaClientSDK::avsCommon::sdkInterfaces::audio::SystemSoundAudioFactoryInterface::endSpeechTone ( ) const
pure virtual

Returns an audio stream to play for the end speech tone.

Returns
audio stream of the end speech tone.

Implemented in alexaClientSDK::applicationUtilities::resources::audio::SystemSoundAudioFactory.

◆ wakeWordNotificationTone()

virtual std::function<std::pair<std::unique_ptr<std::istream>, const avsCommon::utils::MediaType>)> alexaClientSDK::avsCommon::sdkInterfaces::audio::SystemSoundAudioFactoryInterface::wakeWordNotificationTone ( ) const
pure virtual

Returns an audio stream to play for the wake word notification tone.

Returns
audio stream of the wake word notification tone.

Implemented in alexaClientSDK::applicationUtilities::resources::audio::SystemSoundAudioFactory.


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

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