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

#include <ProgressTimer.h>

Inheritance diagram for alexaClientSDK::acsdkAudioPlayer::ProgressTimer::ContextInterface:
Inheritance graph
[legend]

Public Member Functions

virtual void requestProgress ()=0
 
virtual void onProgressReportDelayElapsed ()=0
 
virtual void onProgressReportIntervalElapsed ()=0
 
virtual void onProgressReportIntervalUpdated ()=0
 
virtual ~ContextInterface ()=default
 

Detailed Description

Interface to the context within which ProgressTimer operates. This interface provides a way to get the current offset of playback, and methods to trigger sending progress callbacks.

Constructor & Destructor Documentation

◆ ~ContextInterface()

virtual alexaClientSDK::acsdkAudioPlayer::ProgressTimer::ContextInterface::~ContextInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ onProgressReportDelayElapsed()

virtual void alexaClientSDK::acsdkAudioPlayer::ProgressTimer::ContextInterface::onProgressReportDelayElapsed ( )
pure virtual

Notification that it is time to send a ProgressReportDelayElapsed event.

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer.

◆ onProgressReportIntervalElapsed()

virtual void alexaClientSDK::acsdkAudioPlayer::ProgressTimer::ContextInterface::onProgressReportIntervalElapsed ( )
pure virtual

Notification that it is time to send a ProgressReportIntervalElapsed event.

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer.

◆ onProgressReportIntervalUpdated()

virtual void alexaClientSDK::acsdkAudioPlayer::ProgressTimer::ContextInterface::onProgressReportIntervalUpdated ( )
pure virtual

Notification that it is time to send a ProgressReportIntervalUpdated event.

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer.

◆ requestProgress()

virtual void alexaClientSDK::acsdkAudioPlayer::ProgressTimer::ContextInterface::requestProgress ( )
pure virtual

Request a (potentially asynchronous) callback to onProgress() with the current progress.

Implemented in alexaClientSDK::acsdkAudioPlayer::AudioPlayer.


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