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

#include <AudioPlayerObserverInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface:
Inheritance graph
[legend]

Classes

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

Public Types

enum  SeekStatus { SeekStatus::SEEK_START, SeekStatus::SEEK_COMPLETE }
 Enum representing Seek activities. More...
 

Public Member Functions

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

Detailed Description

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

Member Enumeration Documentation

◆ SeekStatus

Enum representing Seek activities.

Enumerator
SEEK_START 

Initiating a seek to another play position within the current track.

SEEK_COMPLETE 

Finished seeking within the current track.

Constructor & Destructor Documentation

◆ ~AudioPlayerObserverInterface()

virtual alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface::~AudioPlayerObserverInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ onPlayerActivityChanged()

virtual void alexaClientSDK::acsdkAudioPlayerInterfaces::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::acsdkAudioPlayer::test::TestAudioPlayerObserver, and alexaClientSDK::diagnostics::DevicePropertyAggregator.

◆ onSeekActivity()

void alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface::onSeekActivity ( const SeekStatus  seekStatus,
const Context context 
)
inlinevirtual

Used to notify the observer when the AudioPlayer is seeking within the current track.

Parameters
seekStatusType of activity being performed, represented by SeekStatus
contextThe Context of the AudioPlayer at the time of the seek activity.

Reimplemented in alexaClientSDK::acsdkAudioPlayer::test::TestAudioPlayerObserver.


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

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