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

#include <SpeakerManagerObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerObserverInterface:
Inheritance graph
[legend]

Public Types

enum  Source { Source::DIRECTIVE, Source::LOCAL_API, Source::EXTERNAL_CLIENT }
 Indicates whether the source of the call is from an AVS Directive or through a Local API call. More...
 

Public Member Functions

virtual void onSpeakerSettingsChanged (const Source &source, const ChannelVolumeInterface::Type &type, const SpeakerInterface::SpeakerSettings &settings)=0
 
virtual ~SpeakerManagerObserverInterface ()=default
 

Detailed Description

This interface is for observing changes to ChannelVolumeInterfaces that are made by the SpeakerManager.

Observers of the SpeakerManager are notified using the SpeakerManagers internal thread. The callback function must exit as quickly as possible and perform minimal calculations. Not doing so can cause delays in the SpeakerManager. No other SpeakerManager methods which utilize that thread must be called from this callback.

Member Enumeration Documentation

◆ Source

Indicates whether the source of the call is from an AVS Directive or through a Local API call.

Enumerator
DIRECTIVE 
LOCAL_API 
EXTERNAL_CLIENT 

Constructor & Destructor Documentation

◆ ~SpeakerManagerObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerObserverInterface::~SpeakerManagerObserverInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ onSpeakerSettingsChanged()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerObserverInterface::onSpeakerSettingsChanged ( const Source source,
const ChannelVolumeInterface::Type type,
const SpeakerInterface::SpeakerSettings settings 
)
pure virtual

A callback for when the SpeakerInterface::SpeakerSettings successfully changes.

Parameters
source.This indicates the origin of the call.
type.This indicates the type of ChannelVolumeInterface that was modified.
settings.This indicates the current settings after the change.

Implemented in alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaAdapterHandler, alexaClientSDK::acsdkAlerts::AlertsCapabilityAgent, alexaClientSDK::capabilityAgents::mrm::MRMCapabilityAgent, alexaClientSDK::diagnostics::DevicePropertyAggregator, and alexaClientSDK::sampleApp::UIManager.


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

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