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

#include <MediaPlayerState.h>

Collaboration diagram for alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState:
Collaboration graph
[legend]

Classes

struct  MediaPlayerProtection
 

Public Member Functions

 MediaPlayerState ()
 
 MediaPlayerState (std::chrono::milliseconds offsetInMs, std::chrono::milliseconds duration_=DURATION_UNKNOWN)
 
 MediaPlayerState (std::chrono::milliseconds offsetInMs, const MediaPlayerProtection &mediaPlayerProtection_, std::chrono::milliseconds duration_=DURATION_UNKNOWN)
 
 MediaPlayerState (std::chrono::milliseconds offsetInMs, const MediaPlayerProtection &mediaPlayerProtection_, const std::string &playlistType_, std::chrono::milliseconds duration_=DURATION_UNKNOWN)
 
bool operator== (const MediaPlayerState &other) const
 

Public Attributes

std::chrono::milliseconds offset
 Offset in milliseconds. More...
 
std::chrono::milliseconds duration
 Duration. More...
 
Optional< MediaPlayerProtectionmediaPlayerProtection
 Optional: MediaPlayerProtection information. More...
 
Optional< std::string > playlistType
 

Detailed Description

Structure to hold metadata about the MediaPlayerState

Constructor & Destructor Documentation

◆ MediaPlayerState() [1/4]

alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState::MediaPlayerState ( )
inline

Default Constructor, initializes the offset to zero.

◆ MediaPlayerState() [2/4]

alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState::MediaPlayerState ( std::chrono::milliseconds  offsetInMs,
std::chrono::milliseconds  duration_ = DURATION_UNKNOWN 
)
inline

Constructor.

◆ MediaPlayerState() [3/4]

alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState::MediaPlayerState ( std::chrono::milliseconds  offsetInMs,
const MediaPlayerProtection mediaPlayerProtection_,
std::chrono::milliseconds  duration_ = DURATION_UNKNOWN 
)
inline

Constructor.

◆ MediaPlayerState() [4/4]

alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState::MediaPlayerState ( std::chrono::milliseconds  offsetInMs,
const MediaPlayerProtection mediaPlayerProtection_,
const std::string &  playlistType_,
std::chrono::milliseconds  duration_ = DURATION_UNKNOWN 
)
inline

Constructor.

Member Function Documentation

◆ operator==()

bool alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState::operator== ( const MediaPlayerState other) const
inline

Overload the == operator for equality checks

Parameters
otherThe other MediaPlayerState to compare
Returns
Whether this is equivalent to other

Member Data Documentation

◆ duration

std::chrono::milliseconds alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState::duration

Duration.

◆ mediaPlayerProtection

Optional<MediaPlayerProtection> alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState::mediaPlayerProtection

◆ offset

std::chrono::milliseconds alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState::offset

Offset in milliseconds.

◆ playlistType

Optional<std::string> alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerState::playlistType

Optional: Playlist type, HLS, DASH, etc., of the current track. Empty when adpative streaming is not in use for the current track.


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