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::TimingAdapterFactory Class Reference

#include <TimingAdapterFactory.h>

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

Public Member Functions

 TimingAdapterFactory (std::shared_ptr< DelayInterface > delayInterface=nullptr)
 
virtual ~TimingAdapterFactory ()=default
 
virtual std::shared_ptr< CaptionTimingAdapterInterfacegetTimingAdapter (std::shared_ptr< CaptionPresenterInterface > presenter) const
 

Detailed Description

Generator class to produce instances of CaptionTimingAdapter on demand.

Constructor & Destructor Documentation

◆ TimingAdapterFactory()

alexaClientSDK::captions::TimingAdapterFactory::TimingAdapterFactory ( std::shared_ptr< DelayInterface delayInterface = nullptr)

Constructor.

Parameters
delayInterfaceThe timing interface that is used to delay calls to the presenter. Defaults to a call to the std::this_thread::sleep_for function. Override this value if custom timing is desired.

◆ ~TimingAdapterFactory()

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

Destructor.

Member Function Documentation

◆ getTimingAdapter()

std::shared_ptr< CaptionTimingAdapterInterface > alexaClientSDK::captions::TimingAdapterFactory::getTimingAdapter ( std::shared_ptr< CaptionPresenterInterface presenter) const
virtual

Factory function that returns ready-to-use timing adapters.

Parameters
presenterThe presenter instance to be used when producing timing adapters.
Returns
an instance of CaptionTimingAdapter as a std::shared_ptr.

Reimplemented in alexaClientSDK::captions::test::TestTimingAdapterFactory.


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

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