AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Enumerations | Functions
alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces Namespace Reference

Classes

class  AlexaPlaybackControllerInterface
 
class  AlexaPlaybackControllerObserverInterface
 

Enumerations

enum  PlaybackOperation {
  PlaybackOperation::PLAY, PlaybackOperation::PAUSE, PlaybackOperation::STOP, PlaybackOperation::START_OVER,
  PlaybackOperation::PREVIOUS, PlaybackOperation::NEXT, PlaybackOperation::REWIND, PlaybackOperation::FAST_FORWARD
}
 
enum  PlaybackState { PlaybackState::PLAYING, PlaybackState::PAUSED, PlaybackState::STOPPED }
 

Functions

std::string playbackOperationToString (PlaybackOperation playbackOperation)
 
std::string playbackStateToString (PlaybackState playbackState)
 

Enumeration Type Documentation

◆ PlaybackOperation

The PlaybackOperation enumeration carries out playback controller actions such as play, pause and stop audio or video content.

Enumerator
PLAY 

Play audio or video content.

PAUSE 

Pause audio or video content.

STOP 

Stop audio or video content.

START_OVER 

Restart audio or video content.

PREVIOUS 

Go to the previous audio or video content.

NEXT 

Go to the next audio or video content.

REWIND 

Rewind the audio or video content.

FAST_FORWARD 

Fast forward the audio or video content.

◆ PlaybackState

The enumeration representing the playback status of the media played on a device reported understood by Alexa interfaces. https://developer.amazon.com/en-US/docs/alexa/device-apis/alexa-property-schemas.html#playbackstate

Enumerator
PLAYING 

Media content is playing.

PAUSED 

Media content is paused.

STOPPED 

Media content is not playing.

Function Documentation

◆ playbackOperationToString()

std::string alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::playbackOperationToString ( PlaybackOperation  playbackOperation)

Convert a PlaybackOperation enum to its corresponding string value. Note that any PlaybackOperation that does not map to PlaybackOperation enum value will return an empty string.

Parameters
playbackOperationThe playback operation value to convert.
Returns
The corresponding string value for PlaybackOperation. Returns an empty string if PlaybackOperation does not map to a PlaybackOperation enum.

◆ playbackStateToString()

std::string alexaClientSDK::acsdkAlexaPlaybackControllerInterfaces::playbackStateToString ( PlaybackState  playbackState)

Convert a PlaybackState enum to its corresponding string value. Note that any PlaybackState that does not map to PlaybackState enum value will return an empty string.

Parameters
playbackStateThe playback state value to convert.
Returns
The corresponding string value for PlaybackState. Returns an empty string if PlaybackState does not map to a PlaybackState enum.

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