AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface Class Reference
Inheritance diagram for alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface:
Collaboration graph
[legend]

Public Member Functions

 MOCK_METHOD1 (startMock, Response(StartLiveViewRequest *))
 
 MOCK_METHOD0 (stopMock, Response())
 
 MOCK_METHOD1 (setCameraStateMock, Response(CameraState cameraState))
 
 MOCK_METHOD0 (getConfigurationMock, Configuration())
 
 MOCK_METHOD1 (addObserver, bool(std::weak_ptr< LiveViewControllerObserverInterface > observer))
 
 MOCK_METHOD1 (removeObserver, void(std::weak_ptr< LiveViewControllerObserverInterface > observer))
 
Response start (std::unique_ptr< StartLiveViewRequest > request)
 
Response stop ()
 
Response setCameraState (CameraState cameraState)
 
Configuration getConfiguration ()
 
- Public Member Functions inherited from alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface
virtual ~LiveViewControllerInterface ()=default
 
virtual bool addObserver (std::weak_ptr< LiveViewControllerObserverInterface > observer)=0
 
virtual void removeObserver (std::weak_ptr< LiveViewControllerObserverInterface > observer)=0
 

Member Function Documentation

◆ getConfiguration()

Configuration alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::getConfiguration ( )
inlinevirtual

Returns the LiveViewController configuration.

Returns
A Configuration object that contains the supported display modes, overlay types and overlay positions.

Implements alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface.

◆ MOCK_METHOD0() [1/2]

alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::MOCK_METHOD0 ( stopMock  ,
Response()   
)

◆ MOCK_METHOD0() [2/2]

alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::MOCK_METHOD0 ( getConfigurationMock  ,
Configuration()   
)

◆ MOCK_METHOD1() [1/4]

alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::MOCK_METHOD1 ( startMock  ,
Response(StartLiveViewRequest *)   
)

◆ MOCK_METHOD1() [2/4]

alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::MOCK_METHOD1 ( setCameraStateMock  ,
Response(CameraState cameraState)   
)

◆ MOCK_METHOD1() [3/4]

alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::MOCK_METHOD1 ( addObserver  ,
bool(std::weak_ptr< LiveViewControllerObserverInterface > observer)   
)

◆ MOCK_METHOD1() [4/4]

alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::MOCK_METHOD1 ( removeObserver  ,
void(std::weak_ptr< LiveViewControllerObserverInterface > observer)   
)

◆ setCameraState()

Response alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::setCameraState ( CameraState  cameraState)
inlinevirtual

Update the camera state based on the LiveViewController interaction with other components.

Parameters
cameraStateIncoming camera state.
Returns
Whether camera state has been updated successfully, or if an error was encountered in the process. LiveViewControllerInterface::Response.type should return SUCCESS if no errors were encountered. Otherwise, LiveViewControllerInterface::Response.type should contain the corresponding error code along with a log message in LiveViewControllerInterface::Response.errorMessage.

Implements alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface.

◆ start()

Response alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::start ( std::unique_ptr< StartLiveViewRequest request)
inlinevirtual

Start camera live view stream based on the user request.

Parameters
requestThe request for the StartLiveView directive.
Returns
whether camera live view stream has been started successfully, or if an error was encountered in the process. LiveViewControllerInterface::Response.type should return SUCCESS if no errors were encountered. Otherwise, LiveViewControllerInterface::Response.type should contain the corresponding error code along with a log message in LiveViewControllerInterface::Response.errorMessage.

Implements alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface.

◆ stop()

Response alexaClientSDK::alexaLiveViewController::test::MockAlexaLiveViewControllerInterface::stop ( )
inlinevirtual

Stop camera live view stream.

Returns
whether camera live view stream has been stopped successfully, or if an error was encountered in the process. LiveViewControllerInterface::Response.type should return SUCCESS if no errors were encountered. Otherwise, LiveViewControllerInterface::Response.type should contain the corresponding error code along with a log message in LiveViewControllerInterface::Response.errorMessage.

Implements alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewControllerInterface.


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

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