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

#include <AudioPlayerObserverInterface.h>

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

Classes

struct  Context
 The context of the AudioPlayer when the observer is notified of the PlayerActivity state change. More...
 

Public Member Functions

virtual ~AudioPlayerObserverInterface ()=default
 
virtual void onPlayerActivityChanged (avsCommon::avs::PlayerActivity state, const Context &context)=0
 

Detailed Description

This class allows any observers of the AudioPlayer to be notified of changes in the AudioPlayer audio state.

Constructor & Destructor Documentation

◆ ~AudioPlayerObserverInterface()

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

Destructor

Member Function Documentation

◆ onPlayerActivityChanged()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::AudioPlayerObserverInterface::onPlayerActivityChanged ( avsCommon::avs::PlayerActivity  state,
const Context context 
)
pure virtual

Used to notify the observer when the AudioPlayer has a change in PlayerActivity.

Parameters
stateThe PlayerActivity of the AudioPlayer.
contextThe Context of the AudioPlayer.

Implemented in alexaClientSDK::capabilityAgents::audioPlayer::test::TestAudioPlayerObserver, and alexaClientSDK::diagnostics::DevicePropertyAggregator.


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

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