#include <ExternalMediaAdapterInterface.h>

Public Member Functions
	AdapterSessionState ()

Public Attributes
std::string	playerId

std::string	localPlayerId

std::string	endpointId
	The unique device endpoint. More...

bool	loggedIn
	Flag that identifies if a user is currently logged in or not. More...

std::string	userName

bool	isGuest
	Flag that identifies if the user currently logged in is a guest or not. More...

bool	launched
	Flag that identifies if an application has been launched or not. More...

bool	active

std::string	spiVersion
	The service provider interface (SPI) version. More...

std::string	playerCookie
	The playerCookie to select version-specific content or actions. More...

std::string	skillToken

std::string	playbackSessionId

std::string	accessToken

std::chrono::milliseconds	tokenRefreshInterval
	The validity period of the token in milliseconds. More...

Detailed Description

struct that represents the session state of an adapter.

Constructor & Destructor Documentation

◆ AdapterSessionState()

alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::AdapterSessionState ( )

inline

Member Data Documentation

◆ accessToken

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::accessToken

The accessToken used to login a user. The access token may also be used as a bearer token if the adapter makes an authenticated Web API to the music provider.

◆ active

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::active

Flag that identifies if the application is currently active or not. This could mean different things for different applications.

◆ endpointId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::endpointId

The unique device endpoint.

◆ isGuest

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::isGuest

Flag that identifies if the user currently logged in is a guest or not.

◆ launched

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::launched

Flag that identifies if an application has been launched or not.

◆ localPlayerId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::localPlayerId

The localPlayerId of an adapter which is the pre-negotiated business id for a partner music provider.

◆ loggedIn

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::loggedIn

Flag that identifies if a user is currently logged in or not.

◆ playbackSessionId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::playbackSessionId

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

◆ playerCookie

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::playerCookie

The playerCookie to select version-specific content or actions.

◆ playerId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::playerId

The playerId of an adapter which is the pre-negotiated business id for a partner music provider.

◆ skillToken

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::skillToken

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

◆ spiVersion

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::spiVersion

The service provider interface (SPI) version.

◆ tokenRefreshInterval

std::chrono::milliseconds alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::tokenRefreshInterval

The validity period of the token in milliseconds.

◆ userName

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterSessionState::userName

The userName of the user currently logged in via a Login directive from the AVS.

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

/workplace/avs-device-sdk/capabilities/ExternalMediaPlayer/acsdkExternalMediaPlayerInterfaces/include/acsdkExternalMediaPlayerInterfaces/ExternalMediaAdapterInterface.h

Public Member Functions

Public Attributes