alexaClientSDK::integration::test::TestClient Class Reference

A test observer that mocks out the ChannelObserverInterface#onFocusChanged() call. More...

Inheritance diagram for alexaClientSDK::integration::test::TestClient:

Collaboration diagram for alexaClientSDK::integration::test::TestClient:

Public Member Functions
	TestClient ()
void	onFocusChanged (FocusState focusState, MixingBehavior behavior) override
FocusState	waitForFocusChange (std::chrono::milliseconds timeout, bool *focusChanged)
	TestClient ()
void	onFocusChanged (FocusState focusState, MixingBehavior behavior) override
FocusState	waitForFocusChange (std::chrono::milliseconds timeout)
	TestClient ()
void	onFocusChanged (FocusState focusState, MixingBehavior behavior) override
FocusState	waitForFocusChange (std::chrono::milliseconds timeout, bool *focusChanged)
	TestClient ()
void	onFocusChanged (FocusState focusState, MixingBehavior behavior) override
FocusState	waitForFocusChange (std::chrono::milliseconds timeout)
FocusState	getCurrentFocusState ()
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface
virtual	~ChannelObserverInterface ()=default

Detailed Description

A test observer that mocks out the ChannelObserverInterface#onFocusChanged() call.

Constructor & Destructor Documentation

TestClient() [1/4]

alexaClientSDK::integration::test::TestClient::TestClient ( )

inline

Constructor.

TestClient() [2/4]

alexaClientSDK::integration::test::TestClient::TestClient ( )

inline

Constructor.

TestClient() [3/4]

alexaClientSDK::integration::test::TestClient::TestClient ( )

inline

Constructor.

TestClient() [4/4]

alexaClientSDK::integration::test::TestClient::TestClient ( )

inline

Constructor.

Member Function Documentation

getCurrentFocusState()

FocusState alexaClientSDK::integration::test::TestClient::getCurrentFocusState ( )

inline

onFocusChanged() [1/4]

void alexaClientSDK::integration::test::TestClient::onFocusChanged ( FocusState  focusState, MixingBehavior  behavior  )

inlineoverridevirtual

Implementation of the ChannelObserverInterface#onFocusChanged() callback.

Parameters

focusState	The new focus state of the Channel observer.
behavior	The new MixingBehavior of the Channel observer.

Implements alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface.

onFocusChanged() [2/4]

void alexaClientSDK::integration::test::TestClient::onFocusChanged ( FocusState  focusState, MixingBehavior  behavior  )

inlineoverridevirtual

Implementation of the ChannelObserverInterface#onFocusChanged() callback.

Parameters

focusState	The new focus state of the Channel observer.
behavior	The new MixingBehavior of the Channel observer.

Implements alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface.

onFocusChanged() [3/4]

void alexaClientSDK::integration::test::TestClient::onFocusChanged ( FocusState  focusState, MixingBehavior  behavior  )

inlineoverridevirtual

Implementation of the ChannelObserverInterface#onFocusChanged() callback.

Parameters

focusState	The new focus state of the Channel observer.
behavior	The new MixingBehavior of the Channel observer.

Implements alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface.

onFocusChanged() [4/4]

void alexaClientSDK::integration::test::TestClient::onFocusChanged ( FocusState  focusState, MixingBehavior  behavior  )

inlineoverridevirtual

Implementation of the ChannelObserverInterface#onFocusChanged() callback.

Parameters

focusState	The new focus state of the Channel observer.
behavior	The new MixingBehavior of the Channel observer.

Implements alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface.

waitForFocusChange() [1/4]

FocusState alexaClientSDK::integration::test::TestClient::waitForFocusChange ( std::chrono::milliseconds  timeout )

inline

Waits for the ChannelObserverInterface#onFocusChanged() callback.

Parameters

timeout	The amount of time to wait for the callback.
focusChanged	An output parameter that notifies the caller whether a callback occurred.

Returns

Returns true if the callback occured within the timeout period and false otherwise.

waitForFocusChange() [2/4]

FocusState alexaClientSDK::integration::test::TestClient::waitForFocusChange ( std::chrono::milliseconds  timeout )

inline

Waits for the ChannelObserverInterface#onFocusChanged() callback.

Parameters

timeout	The amount of time to wait for the callback.
focusChanged	An output parameter that notifies the caller whether a callback occurred.

Returns

Returns true if the callback occured within the timeout period and false otherwise.

waitForFocusChange() [3/4]

FocusState alexaClientSDK::integration::test::TestClient::waitForFocusChange ( std::chrono::milliseconds  timeout, bool *  focusChanged  )

inline

Waits for the ChannelObserverInterface#onFocusChanged() callback.

Parameters

timeout	The amount of time to wait for the callback.
focusChanged	An output parameter that notifies the caller whether a callback occurred.

Returns

Returns true if the callback occurred within the timeout period and false otherwise.

waitForFocusChange() [4/4]

FocusState alexaClientSDK::integration::test::TestClient::waitForFocusChange ( std::chrono::milliseconds  timeout, bool *  focusChanged  )

inline

Waits for the ChannelObserverInterface#onFocusChanged() callback.

Parameters

timeout	The amount of time to wait for the callback.
focusChanged	An output parameter that notifies the caller whether a callback occurred.

Returns

Returns true if the callback occured within the timeout period and false otherwise.

---

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

• /workplace/avs-device-sdk/Integration/test/AlertsIntegrationTest.cpp
• /workplace/avs-device-sdk/Integration/test/AudioInputProcessorIntegrationTest.cpp
• /workplace/avs-device-sdk/Integration/test/AudioPlayerIntegrationTest.cpp
• /workplace/avs-device-sdk/Integration/test/SpeechSynthesizerIntegrationTest.cpp