AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ObservablePlaybackStateProperties Struct Reference

#include <ExternalMediaPlayerObserverInterface.h>

Collaboration diagram for alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ObservablePlaybackStateProperties:
Collaboration graph
[legend]

Public Member Functions

 ObservablePlaybackStateProperties ()
 
 ObservablePlaybackStateProperties (const std::string &state, const std::string &trackName, const avsCommon::avs::PlayRequestor &playRequestor)
 

Public Attributes

std::string state
 The players current state. More...
 
std::string trackName
 The display name for the currently playing trackname of the track. More...
 
avsCommon::avs::PlayRequestor playRequestor
 The playRequestor object. More...
 

Detailed Description

struct that includes the PlaybackState properties exposed to observers

Constructor & Destructor Documentation

◆ ObservablePlaybackStateProperties() [1/2]

alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ObservablePlaybackStateProperties::ObservablePlaybackStateProperties ( )
inline

Default Constructor.

◆ ObservablePlaybackStateProperties() [2/2]

alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ObservablePlaybackStateProperties::ObservablePlaybackStateProperties ( const std::string &  state,
const std::string &  trackName,
const avsCommon::avs::PlayRequestor playRequestor 
)
inline

Constructor

Parameters
stateThe state of the player. State values are "IDLE", "PLAYING", "PAUSED", "STOPPED", "FINISHED".
trackNameThe display name for the playing track.
playRequestorThe playReqestor object in the Play directive.

Member Data Documentation

◆ playRequestor

avsCommon::avs::PlayRequestor alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ObservablePlaybackStateProperties::playRequestor

The playRequestor object.

◆ state

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ObservablePlaybackStateProperties::state

The players current state.

◆ trackName

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ObservablePlaybackStateProperties::trackName

The display name for the currently playing trackname of the track.


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

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