Public Types
enum	ViewerState { ViewerState::CONNECTED, ViewerState::CONNECTING, ViewerState::UNKNOWN }

Public Member Functions
bool	operator< (const Viewer &anotherViewer) const

Public Attributes
std::string	name
	Friendly name of the viewing device, such as "Kitchen Echo Show." Maximum length is 512 characters. More...

bool	hasCameraControl

ViewerState	state

Detailed Description

Viewer object. Defines details of the Alexa device used to view the streaming session.

Member Enumeration Documentation

strong

Enum class for the connection state of the viewing device. In the connected state, the user can see the camera feed.

Enumerator
CONNECTED	Viewing device is connected, which means the user can see the camera feed.
CONNECTING	Viewing device is connecting, which means the user can not see the camera feed yet.
UNKNOWN	Any other state that is not covered by the viewer states above.

bool alexaClientSDK::alexaLiveViewControllerInterfaces::Viewer::operator< ( const Viewer & anotherViewer ) const

inline

Comparison with another viewer for inserting into set of viewers.

Parameters

anotherViewer Other viewer instance this viewer is compared against.

Returns: true if this viewer should be inserted before anotherViewer, false otherwise.

bool alexaClientSDK::alexaLiveViewControllerInterfaces::Viewer::hasCameraControl

Indicates whether the viewing device has control over the camera. In a list of viewing devices, one device can control the camera at any one time.

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::Viewer::name

Friendly name of the viewing device, such as "Kitchen Echo Show." Maximum length is 512 characters.

ViewerState alexaClientSDK::alexaLiveViewControllerInterfaces::Viewer::state

Connection state of the viewing device. In the connected state, the user can see the camera feed.

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

/workplace/avs-device-sdk/capabilities/LiveViewController/AlexaLiveViewControllerInterfaces/include/acsdk/AlexaLiveViewControllerInterfaces/LiveViewControllerTypes.h