AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::captions::CaptionTimingAdapterInterface Class Referenceabstract

#include <CaptionTimingAdapterInterface.h>

Inheritance diagram for alexaClientSDK::captions::CaptionTimingAdapterInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~CaptionTimingAdapterInterface ()=default
 
virtual void queueForDisplay (const CaptionFrame &captionFrame, bool autostart=true)=0
 
virtual void reset ()=0
 
virtual void start ()=0
 
virtual void stop ()=0
 
virtual void pause ()=0
 

Detailed Description

An abstract class that is responsible for handling the timed display of CaptionFrame objects. Each CaptionFrame's delay and duration values should be used with the DelayInterface to maintain this timing.

Implementations of this class must be thread-safe and allow for asynchronous calls to any of the provided methods.

Constructor & Destructor Documentation

◆ ~CaptionTimingAdapterInterface()

virtual alexaClientSDK::captions::CaptionTimingAdapterInterface::~CaptionTimingAdapterInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ pause()

virtual void alexaClientSDK::captions::CaptionTimingAdapterInterface::pause ( )
pure virtual

Pauses the playback of captions, keeping track of the last caption frame shown.

Implemented in alexaClientSDK::captions::CaptionTimingAdapter.

◆ queueForDisplay()

virtual void alexaClientSDK::captions::CaptionTimingAdapterInterface::queueForDisplay ( const CaptionFrame captionFrame,
bool  autostart = true 
)
pure virtual

Enqueues a CaptionFrame object for display. This method must begin the serial presentation of the enqueued caption frames if such presentation is not already taking place and autostart is true. The order of the caption frames must be maintained as first-in-first-out.

Parameters
captionFrameThe CaptionFrame object to be enqueued for display.
autostartDetermines if presentation should begin immediately if it has not already; defaults to true.

Implemented in alexaClientSDK::captions::CaptionTimingAdapter.

◆ reset()

virtual void alexaClientSDK::captions::CaptionTimingAdapterInterface::reset ( )
pure virtual

Resets the state of this adapter, in preparation for new captions content.

Implemented in alexaClientSDK::captions::CaptionTimingAdapter.

◆ start()

virtual void alexaClientSDK::captions::CaptionTimingAdapterInterface::start ( )
pure virtual

Resumes the playback of captions content, starting from the caption frame following the last one shown.

Implemented in alexaClientSDK::captions::CaptionTimingAdapter.

◆ stop()

virtual void alexaClientSDK::captions::CaptionTimingAdapterInterface::stop ( )
pure virtual

Stops the playback of captions, forgetting which caption frame was last shown.

Implemented in alexaClientSDK::captions::CaptionTimingAdapter.


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

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0