AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::MediaPropertiesInterface Class Referenceabstract

#include <MediaPropertiesInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::MediaPropertiesInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~MediaPropertiesInterface ()=default
 
virtual std::chrono::milliseconds getAudioItemOffset ()=0
 
virtual std::chrono::milliseconds getAudioItemDuration ()
 

Detailed Description

This class provides an interface to query the properties of a media from a player.

Constructor & Destructor Documentation

◆ ~MediaPropertiesInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::MediaPropertiesInterface::~MediaPropertiesInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ getAudioItemDuration()

virtual std::chrono::milliseconds alexaClientSDK::avsCommon::sdkInterfaces::MediaPropertiesInterface::getAudioItemDuration ( )
inlinevirtual

Returns the duration of the current AudioItem the player is handling.

Returns
returns the duration.

Reimplemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer, and alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaPlayer.

◆ getAudioItemOffset()

virtual std::chrono::milliseconds alexaClientSDK::avsCommon::sdkInterfaces::MediaPropertiesInterface::getAudioItemOffset ( )
pure virtual

This function retrieves the offset of the current AudioItem the player is handling.

Returns
This returns the offset in milliseconds.

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer, and alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaPlayer.


The documentation for this class 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