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

#include <ExternalMediaPlayerInterface.h>

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

Public Member Functions

virtual ~ExternalMediaPlayerInterface ()=default
 
virtual void setPlayerInFocus (const std::string &playerInFocus)=0
 

Detailed Description

This class provides an interface to the ExternalMediaPlayer. Currently it provides an interface for adapters to set the player in focus when they acquire focus.

Constructor & Destructor Documentation

◆ ~ExternalMediaPlayerInterface()

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

Destructor

Member Function Documentation

◆ setPlayerInFocus()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::ExternalMediaPlayerInterface::setPlayerInFocus ( const std::string &  playerInFocus)
pure virtual

Method to set the player in focus after an adapter has acquired the channel.

Parameters
playerInFocusThe business name of the adapter that has currently acquired focus.
Note
This function should not be called during the callback in ExternalMediaAdapterInterface.

Implemented in alexaClientSDK::capabilityAgents::externalMediaPlayer::ExternalMediaPlayer.


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

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