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

#include <ExternalMediaPlayerCommon.h>

Inheritance diagram for alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PlayerInfo:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PlayerInfo:
Collaboration graph
[legend]

Public Member Functions

 PlayerInfo (const std::string &localPlayerId="", const std::string &spiVersion="", bool supported=false)
 

Public Attributes

std::string playerId
 The cloud provided playerID. More...
 
std::string skillToken
 An opaque token for the domain or skill that is presently associated with this player. More...
 
std::string playbackSessionId
 A universally unique identifier (UUID) generated to the RFC 4122 specification. More...
 
bool playerSupported
 
- Public Attributes inherited from alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PlayerInfoBase
std::string localPlayerId
 The opaque token that uniquely identifies the local external player app. More...
 
std::string spiVersion
 The service provider interface (SPI) version. More...
 

Detailed Description

Describes the information and status for a player

Constructor & Destructor Documentation

◆ PlayerInfo()

alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PlayerInfo::PlayerInfo ( const std::string &  localPlayerId = "",
const std::string &  spiVersion = "",
bool  supported = false 
)
inline

Constructor

Parameters
localPlayerIdThe local player ID
spiVersionThe SPI Version
supportedWhether the player is supported as an External Media Player

Member Data Documentation

◆ playbackSessionId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PlayerInfo::playbackSessionId

A universally unique identifier (UUID) generated to the RFC 4122 specification.

◆ playerId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PlayerInfo::playerId

The cloud provided playerID.

◆ playerSupported

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PlayerInfo::playerSupported

Whether this player is supported and permitted to act as an External Media Player, if a player is not supported then no state updates should be sent, and no playback controls will be received

◆ skillToken

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::PlayerInfo::skillToken

An opaque token for the domain or skill that is presently associated with this player.


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

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