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

#include <LocalPlaybackHandlerInterface.h>

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

Public Types

enum  PlaybackOperation { STOP_PLAYBACK, PAUSE_PLAYBACK, RESUME_PLAYBACK }
 Available local operations. More...
 

Public Member Functions

virtual ~LocalPlaybackHandlerInterface ()=default
 
virtual bool localOperation (PlaybackOperation op)=0
 
virtual bool localSeekTo (std::chrono::milliseconds location, bool fromStart)=0
 

Detailed Description

This class allows a local UI to request playback actions using local control

Member Enumeration Documentation

◆ PlaybackOperation

Available local operations.

Enumerator
STOP_PLAYBACK 
PAUSE_PLAYBACK 
RESUME_PLAYBACK 

Constructor & Destructor Documentation

◆ ~LocalPlaybackHandlerInterface()

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

Destructor.

Member Function Documentation

◆ localOperation()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::LocalPlaybackHandlerInterface::localOperation ( PlaybackOperation  op)
pure virtual

Request the handler to perform a local playback operation.

Parameters
opOperation to request
Returns
true if successful, false if the operation cannot be performed locally.

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer, and alexaClientSDK::capabilityAgents::externalMediaPlayer::ExternalMediaPlayer.

◆ localSeekTo()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::LocalPlaybackHandlerInterface::localSeekTo ( std::chrono::milliseconds  location,
bool  fromStart 
)
pure virtual

Request the handler to perform a local seek operation.

Parameters
locationPosition to seek to
fromStarttrue to seek to absolute location, false to seek reletive to current location.
Returns
true if successful, false if the operation cannot be performed locally.

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer, and 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