AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::test::MockSpeaker Class Reference

#include <MockSpeakerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::test::MockSpeaker:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::sdkInterfaces::test::MockSpeaker:
Collaboration graph
[legend]

Public Member Functions

bool setVolume (int8_t volume) override
 
bool setMute (bool mute) override
 
bool getSpeakerSettings (SpeakerInterface::SpeakerSettings *settings) override
 
 MockSpeaker ()
 Constructor. More...
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface
virtual ~SpeakerInterface ()=default
 

Constructor & Destructor Documentation

◆ MockSpeaker()

alexaClientSDK::avsCommon::sdkInterfaces::test::MockSpeaker::MockSpeaker ( )
inline

Constructor.

Member Function Documentation

◆ getSpeakerSettings()

bool alexaClientSDK::avsCommon::sdkInterfaces::test::MockSpeaker::getSpeakerSettings ( SpeakerInterface::SpeakerSettings settings)
inlineoverridevirtual

Return a SpeakerSettings object to indicate the current settings of the SpeakerInterface.

Parameters
[out]settingsA SpeakerSettings object if successful.
Returns
Whether the operation was successful.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface.

◆ setMute()

bool alexaClientSDK::avsCommon::sdkInterfaces::test::MockSpeaker::setMute ( bool  mute)
inlineoverridevirtual

Set the mute of the speaker.

Parameters
muteRepresents whether the speaker should be muted (true) or unmuted (false).
Returns
Whether the operation was successful.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface.

◆ setVolume()

bool alexaClientSDK::avsCommon::sdkInterfaces::test::MockSpeaker::setVolume ( int8_t  volume)
inlineoverridevirtual

Set the absolute volume of the speaker. volume will be [AVS_SET_VOLUME_MIN, AVS_SET_VOLUME_MAX], and implementers of the interface must normalize the volume to fit the needs of their drivers.

Parameters
volumeA volume to set the speaker to.
Returns
Whether the operation was successful.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeakerInterface.


The documentation for this class 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