AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::captions::test::TestTimingAdapterFactory Class Reference

#include <TestTimingAdapterFactory.h>

Inheritance diagram for alexaClientSDK::captions::test::TestTimingAdapterFactory:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::captions::test::TestTimingAdapterFactory:
Collaboration graph
[legend]

Public Member Functions

 TestTimingAdapterFactory ()
 
 ~TestTimingAdapterFactory ()
 
std::shared_ptr< MockCaptionTimingAdaptergetMockTimingAdapter ()
 
CaptionParserInterface methods
std::shared_ptr< CaptionTimingAdapterInterfacegetTimingAdapter (std::shared_ptr< CaptionPresenterInterface > presenter) const
 
- Public Member Functions inherited from alexaClientSDK::captions::TimingAdapterFactory
 TimingAdapterFactory (std::shared_ptr< DelayInterface > delayInterface=nullptr)
 
virtual ~TimingAdapterFactory ()=default
 

Detailed Description

A concrete implementation of TimingAdapterFactory that returns a MockCaptionTimingAdapter that is known ahead of time for testing purposes.

Constructor & Destructor Documentation

◆ TestTimingAdapterFactory()

alexaClientSDK::captions::test::TestTimingAdapterFactory::TestTimingAdapterFactory ( )
inline

◆ ~TestTimingAdapterFactory()

alexaClientSDK::captions::test::TestTimingAdapterFactory::~TestTimingAdapterFactory ( )

Member Function Documentation

◆ getMockTimingAdapter()

std::shared_ptr< MockCaptionTimingAdapter > alexaClientSDK::captions::test::TestTimingAdapterFactory::getMockTimingAdapter ( )

Getter for the mock timing adapter that would be returned by the TimingAdapterFactory instance. If the mock adapter is null, then one is created and then returned. This function is provided so that the EXPECT_CALL can be used on the mock that is later going to be used by the getTimingAdapter function.

Returns
The mock timing adapter.

◆ getTimingAdapter()

std::shared_ptr< CaptionTimingAdapterInterface > alexaClientSDK::captions::test::TestTimingAdapterFactory::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 from alexaClientSDK::captions::TimingAdapterFactory.


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

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