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::templateRuntimeInterfaces::TemplateRuntimeObserverInterface::AudioPlayerInfo Struct Reference

#include <TemplateRuntimeObserverInterface.h>

Public Member Functions

 AudioPlayerInfo ()

Public Attributes

avsCommon::avs::PlayerActivity audioPlayerState
std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::MediaPropertiesInterfacemediaProperties

Detailed Description

The AudioPlayerInfo contains information that is useful for rendering a PlayerInfo display card. AudioPlayerInfo is passed to the observers as a parameter in the renderPlayerInfoCard callback.

Constructor & Destructor Documentation

◆ AudioPlayerInfo()

alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeObserverInterface::AudioPlayerInfo::AudioPlayerInfo ( )

Default constructor.

Member Data Documentation

◆ audioPlayerState

avsCommon::avs::PlayerActivity alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeObserverInterface::AudioPlayerInfo::audioPlayerState

The state of the AudioPlayer. This information is useful for implementing the progress bar in the display card. It is assumed that the client is responsible for progressing the progress bar when the AudioPlayer is in PLAYING state.

◆ mediaProperties

std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::MediaPropertiesInterface> alexaClientSDK::templateRuntimeInterfaces::TemplateRuntimeObserverInterface::AudioPlayerInfo::mediaProperties

The properties for the media that AudioPlayer is handling. This information is useful for implementation of the progress bar.

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

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