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

#include <AudioPlayerInterface.h>

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

Public Member Functions

virtual ~AudioPlayerInterface ()=default
 
virtual void addObserver (std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface > observer)=0
 
virtual void removeObserver (std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface > observer)=0
 
virtual void stopPlayback ()=0
 

Detailed Description

This class provides an interface to the AudioPlayer.

Constructor & Destructor Documentation

◆ ~AudioPlayerInterface()

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

Destructor

Member Function Documentation

◆ addObserver()

virtual void alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerInterface::addObserver ( std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface observer)
pure virtual

This function adds an observer to AudioPlayer so that it will get notified for AudioPlayer state changes.

Parameters
observerThe AudioPlayerObserverInterface

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer.

◆ removeObserver()

virtual void alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerInterface::removeObserver ( std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface observer)
pure virtual

This function removes an observer from AudioPlayer so that it will no longer be notified of AudioPlayer state changes.

Parameters
observerThe AudioPlayerObserverInterface

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer.

◆ stopPlayback()

virtual void alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerInterface::stopPlayback ( )
pure virtual

This function stops playback of the current song.

Deprecated:
Use LocalPlayerControlInterface.playbackStop instead

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer.


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