alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer Namespace Reference

Classes
struct	AdapterPlaybackState
struct	AdapterSessionState
class	AdapterState
class	ExternalMediaAdapterInterface
class	ExternalMediaPlayerObserverInterface
struct	ObservablePlaybackStateProperties
struct	ObservableSessionProperties

Enumerations
enum	RequestType {   RequestType::INIT, RequestType::DEINIT, RequestType::LOGIN, RequestType::LOGOUT,   RequestType::PLAY, RequestType::RESUME, RequestType::PAUSE, RequestType::STOP,   RequestType::PAUSE_RESUME_TOGGLE, RequestType::NEXT, RequestType::PREVIOUS, RequestType::START_OVER,   RequestType::FAST_FORWARD, RequestType::REWIND, RequestType::ENABLE_REPEAT_ONE, RequestType::DISABLE_REPEAT_ONE,   RequestType::ENABLE_REPEAT, RequestType::DISABLE_REPEAT, RequestType::ENABLE_SHUFFLE, RequestType::DISABLE_SHUFFLE,   RequestType::FAVORITE, RequestType::DESELECT_FAVORITE, RequestType::UNFAVORITE, RequestType::DESELECT_UNFAVORITE,   RequestType::SEEK, RequestType::ADJUST_SEEK, RequestType::SET_VOLUME, RequestType::ADJUST_VOLUME,   RequestType::SET_MUTE, RequestType::SET_DISPLAY_NAME, RequestType::GET_INFO, RequestType::ADD_USER,   RequestType::RESET_USER, RequestType::NONE }
	Enum class for the different Request Types that an ExternalMediaAdapter handles. More...
enum	SupportedPlaybackOperation {   SupportedPlaybackOperation::PLAY, SupportedPlaybackOperation::RESUME, SupportedPlaybackOperation::PAUSE, SupportedPlaybackOperation::STOP,   SupportedPlaybackOperation::NEXT, SupportedPlaybackOperation::PREVIOUS, SupportedPlaybackOperation::START_OVER, SupportedPlaybackOperation::FAST_FORWARD,   SupportedPlaybackOperation::REWIND, SupportedPlaybackOperation::ENABLE_REPEAT, SupportedPlaybackOperation::ENABLE_REPEAT_ONE, SupportedPlaybackOperation::DISABLE_REPEAT,   SupportedPlaybackOperation::ENABLE_SHUFFLE, SupportedPlaybackOperation::DISABLE_SHUFFLE, SupportedPlaybackOperation::FAVORITE, SupportedPlaybackOperation::UNFAVORITE,   SupportedPlaybackOperation::SEEK, SupportedPlaybackOperation::ADJUST_SEEK }
enum	ChangeCauseType {   ChangeCauseType::VOICE_INTERACTION, ChangeCauseType::PHYSICAL_INTERACTION, ChangeCauseType::APP_INTERACTION, ChangeCauseType::RULE_TRIGGER,   ChangeCauseType::PERIODIC_POLL }
enum	Favorites { Favorites::FAVORITED, Favorites::UNFAVORITED, Favorites::NOT_RATED }
enum	MediaType {   MediaType::TRACK, MediaType::PODCAST, MediaType::STATION, MediaType::AD,   MediaType::SAMPLE, MediaType::OTHER }

Functions
std::string	SupportedPlaybackOperationToString (SupportedPlaybackOperation operation)
std::string	ChangeTriggerToString (ChangeCauseType changeType)
std::string	RatingToString (Favorites rating)
std::string	MediaTypeToString (MediaType mediaType)
std::string	SHUFFLE_STATUS_STRING (bool shuffleEnabled)
std::string	REPEAT_STATUS_STRING (bool repeatEnabled)
bool	operator== (const ObservableSessionProperties &observableSessionPropertiesA, const ObservableSessionProperties &observableSessionPropertiesB)
bool	operator== (const ObservablePlaybackStateProperties &observableA, const ObservablePlaybackStateProperties &observableB)

Enumeration Type Documentation

ChangeCauseType

enum alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::ChangeCauseType

strong

Enum which identifies how a state change was triggered.

Enumerator
VOICE_INTERACTION	The state change was triggered as result of voice interaction.
PHYSICAL_INTERACTION	Change was triggered by a physical interaction.
APP_INTERACTION	Change was triggered by an app interaction.
RULE_TRIGGER	Change was triggered by a rule.
PERIODIC_POLL	Change was triggered by periodic polling.

Favorites

enum alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::Favorites

strong

Enum which identifies the ratings of a track.

Enumerator
FAVORITED	Favorite rating.
UNFAVORITED	Unfavorite rating.
NOT_RATED	track not rated.

MediaType

enum alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::MediaType

strong

Enum which identifies the media type.

Enumerator
TRACK	The media is track.
PODCAST	The media is a podcast.
STATION	The media is a station.
AD	The media is an ad.
SAMPLE	The media is a sample.
OTHER	The media type is something other than track/podcast/station/ad/sample.

RequestType

enum alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::RequestType

strong

Enum class for the different Request Types that an ExternalMediaAdapter handles.

Enumerator
INIT	Initialization.
DEINIT	DeInitialization.
LOGIN	Login.
LOGOUT	Logout.
PLAY	Play.
RESUME	Resume.
PAUSE	Pause.
STOP	Stop.
PAUSE_RESUME_TOGGLE	Pause or Resume depending on current state.
NEXT	Next.
PREVIOUS	Previous.
START_OVER	Starover from the beginning.
FAST_FORWARD	Fast-forward.
REWIND	rewind
ENABLE_REPEAT_ONE	Enable Repeat of a track.
DISABLE_REPEAT_ONE	Disable Repeat of a track.
ENABLE_REPEAT	Enable Loop on.
DISABLE_REPEAT	Disable loop on.
ENABLE_SHUFFLE	Enable shuffle.
DISABLE_SHUFFLE	Disable shuffle.
FAVORITE	Mark a track as favorite.(thumbs up true)
DESELECT_FAVORITE	Unmark a track as favorite.(thumbs up false)
UNFAVORITE	Mark a track as not a favorite.(thumbs down true)
DESELECT_UNFAVORITE	Unmark a track as not a favorite.(thumbs down false)
SEEK	Seek to a given offset.
ADJUST_SEEK	Seek to an offset relative to the current offset.
SET_VOLUME	Set volume level to a given volume.
ADJUST_VOLUME	Adjust volume level relative to the existing volume.
SET_MUTE	Set mute to true/false.
SET_DISPLAY_NAME	Set the name the external media player will show for this device.
GET_INFO	Get Info.
ADD_USER	Add User Message.
RESET_USER	Reset User Message.
NONE	None means there are no pending requests.

SupportedPlaybackOperation

enum alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::SupportedPlaybackOperation

strong

Enumerator
PLAY	Play.
RESUME	Resume.
PAUSE	Pause.
STOP	Stop.
NEXT	Next.
PREVIOUS	Previous.
START_OVER	Start over a track from the beginning.
FAST_FORWARD	Fast-forward.
REWIND	rewind
ENABLE_REPEAT	Enable Loop on.
ENABLE_REPEAT_ONE	Enable repeat of a track .
DISABLE_REPEAT	Disable loop on.
ENABLE_SHUFFLE	Enable shuffle.
DISABLE_SHUFFLE	Disable shuffle.
FAVORITE	Mark a track as favorite.(thumbs up)
UNFAVORITE	Mark a track as not a favorite.(thumbs down)
SEEK	Seek to a given offset.
ADJUST_SEEK	Seek to an offset relative to the current offset.

Function Documentation

ChangeTriggerToString()

std::string alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::ChangeTriggerToString ( ChangeCauseType  changeType )

inline

Convert a ChangeCauseType to an AVS-compliant std::string.

Parameters

changeType

The ChangeCauseType to convert.

Returns

The AVS-compliant string representation of changeType.

MediaTypeToString()

std::string alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::MediaTypeToString ( MediaType  mediaType )

inline

Convert a Favorites to an AVS-compliant std::string.

Parameters

mediaType

The MediaType to convert.

Returns

The AVS-compliant string representation of mediaType.

operator==() [1/2]

bool alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::operator== ( const ObservableSessionProperties &  observableSessionPropertiesA, const ObservableSessionProperties &  observableSessionPropertiesB  )

inline

operator==() [2/2]

bool alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::operator== ( const ObservablePlaybackStateProperties &  observableA, const ObservablePlaybackStateProperties &  observableB  )

inline

RatingToString()

std::string alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::RatingToString ( Favorites  rating )

inline

Convert a Favorites to an AVS-compliant std::string.

Parameters

rating

The ChangeCauseType to convert.

Returns

The AVS-compliant string representation of rating.

REPEAT_STATUS_STRING()

std::string alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::REPEAT_STATUS_STRING ( bool  repeatEnabled )

inline

SHUFFLE_STATUS_STRING()

std::string alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::SHUFFLE_STATUS_STRING ( bool  shuffleEnabled )

inline

SupportedPlaybackOperationToString()

std::string alexaClientSDK::avsCommon::sdkInterfaces::externalMediaPlayer::SupportedPlaybackOperationToString ( SupportedPlaybackOperation  operation )

inline

Convert a SupportedPlaybackOperation to an AVS-compliant std::string.

Parameters

operation

The SupportedPlaybackOperation to convert.

Returns

The AVS-compliant string representation of operation.