alexaClientSDK::alexaLiveViewControllerInterfaces Namespace Reference

Classes
struct	AudioProperties
struct	Camera
struct	Configuration
struct	DisplayProperties
class	LiveViewControllerInterface
class	LiveViewControllerObserverInterface
struct	Participants
struct	Target
struct	Viewer
struct	ViewerExperience

Enumerations
enum	AudioState { AudioState::UNMUTED, AudioState::MUTED, AudioState::DISABLED, AudioState::UNKNOWN }
enum	CameraState {   CameraState::CONNECTING, CameraState::CONNECTED, CameraState::DISCONNECTED, CameraState::ERROR,   CameraState::UNKNOWN }
enum	MotionCapability { MotionCapability::PHYSICAL_PAN, MotionCapability::PHYSICAL_TILT, MotionCapability::PHYSICAL_ZOOM, MotionCapability::UNKNOWN }
enum	ConcurrentTwoWayTalkState { ConcurrentTwoWayTalkState::ENABLED, ConcurrentTwoWayTalkState::DISABLED, ConcurrentTwoWayTalkState::UNKNOWN }
enum	DisplayMode { DisplayMode::FULL_SCREEN, DisplayMode::OVERLAY, DisplayMode::UNKNOWN }
enum	LiveViewTrigger { LiveViewTrigger::USER_ACTION, LiveViewTrigger::AUTOMATED_EVENT, LiveViewTrigger::UNKNOWN }
enum	OverlayPosition {   OverlayPosition::TOP_RIGHT, OverlayPosition::TOP_LEFT, OverlayPosition::BOTTOM_RIGHT, OverlayPosition::BOTTOM_LEFT,   OverlayPosition::UNKNOWN }
enum	OverlayType { OverlayType::PICTURE_IN_PICTURE, OverlayType::NONE, OverlayType::UNKNOWN }
enum	Role { Role::CAMERA, Role::VIEWER, Role::UNKNOWN }
enum	Status {   Status::STOP_LIVE_VIEW_REQUESTED, Status::MEDIA_SOURCE_NOT_FOUND, Status::UNAUTHORIZED, Status::BATTERY_LEVEL_TOO_LOW,   Status::MEDIA_SOURCE_ASLEEP, Status::MEDIA_SOURCE_TURNED_OFF }
enum	TalkMode { TalkMode::NO_SUPPORT, TalkMode::PRESS_AND_HOLD, TalkMode::TAP, TalkMode::UNKNOWN }

Functions
std::string	audioStateToString (AudioState audioState)
bool	audioStateToMicrophoneState (AudioState audioState)
AudioState	microphoneStateToAudioState (bool microphoneState)
std::string	motionCapabilityToString (MotionCapability motionCapability)
std::string	concurrentTwoWayTalkStateToString (ConcurrentTwoWayTalkState concurrentTwoWayTalkState)
std::string	displayModeToString (DisplayMode displayMode)
std::string	liveViewTriggerToString (LiveViewTrigger liveViewTrigger)
std::string	overlayPositionToString (OverlayPosition overlayPosition)
std::string	overlayTypeToString (OverlayType overlayType)
std::string	roleToString (Role role)
std::string	talkModeToString (TalkMode talkMode)
std::string	viewerStateToString (Viewer::ViewerState viewerState)
std::string	targetTypeToString (Target::TargetType targetType)

Enumeration Type Documentation

AudioState

enum alexaClientSDK::alexaLiveViewControllerInterfaces::AudioState

strong

Enumeration of audio state properties. Defines the state of the microphone and speaker when the streaming session starts.

Enumerator
UNMUTED	For microphone, this enables the microphone on the viewing device. For speaker, this enables audio from the camera to the viewing device.
MUTED	For microphone, this mutes the microphone on the viewing device. For speaker, this disables audio from the camera to the viewing device.
DISABLED	Indicates that camera doesn't support audio communication. In this state, the viewing device doesn't display the microphone and speaker.
UNKNOWN	Any other audio state not covered by the ones above.

CameraState

enum alexaClientSDK::alexaLiveViewControllerInterfaces::CameraState

strong

Enumeration of camera state known by the LiveViewController CA.

Enumerator
CONNECTING	Camera is connecting currently which means RTCSC session is being initialized.
CONNECTED	Camera is currently connected which means RTCSC is ready to deliver the live camera stream.
DISCONNECTED	Camera is disconnected which means it cannot get the live camera stream anymore.
ERROR	Camera has encountered an error which means it needs to reestablish the RTCSC session.
UNKNOWN	Camera is in an unknown state.

ConcurrentTwoWayTalkState

enum alexaClientSDK::alexaLiveViewControllerInterfaces::ConcurrentTwoWayTalkState

strong

Enumeration of concurrent two way talk state properties. Indicates whether the camera supports two-way communication with the viewing device.

Enumerator
ENABLED	Camera supports two-way audio communication with the viewing device.
DISABLED	Camera doesn't support two-way audio communication with the viewing device.
UNKNOWN	Any other concurrent two-way talk state not covered by the ones above.

DisplayMode

enum alexaClientSDK::alexaLiveViewControllerInterfaces::DisplayMode

strong

Enumeration of display mode properties. Defines the supported modes to render the stream.

Enumerator
FULL_SCREEN	The camera live feed stream displays on the entire screen.
OVERLAY	The camera live feed stream displays on top of other streams.
UNKNOWN	Any other display mode not covered by the ones above.

LiveViewTrigger

enum alexaClientSDK::alexaLiveViewControllerInterfaces::LiveViewTrigger

strong

Enumeration of live view trigger properties. Defines the reason that the live view session started.

Enumerator
USER_ACTION	The user started the live view streaming session.
AUTOMATED_EVENT	An automated event, such as a doorbell press, triggered the streaming session.
UNKNOWN	Any other live view trigger mode not covered by the ones above.

MotionCapability

enum alexaClientSDK::alexaLiveViewControllerInterfaces::MotionCapability

strong

Enumeration of motion capability properties of a camera.

Enumerator
PHYSICAL_PAN	Camera supports physical panning.
PHYSICAL_TILT	Camera can tilt on the vertical axis.
PHYSICAL_ZOOM	Camera supports optical zoom.
UNKNOWN	Motion capability unknown.

OverlayPosition

enum alexaClientSDK::alexaLiveViewControllerInterfaces::OverlayPosition

strong

Enumeration of overlay position properties. Defines the position on the screen to display the overlay.

Enumerator
TOP_RIGHT	Directs the viewing device to display the overlay on the top right of the screen.
TOP_LEFT	Directs the viewing device to display the overlay on the top left of the screen.
BOTTOM_RIGHT	Directs the viewing device to display the overlay on the bottom right of the screen.
BOTTOM_LEFT	Directs the viewing device to display the overlay on the bottom left of the screen.
UNKNOWN	Any other overlay position not covered by the ones above.

OverlayType

enum alexaClientSDK::alexaLiveViewControllerInterfaces::OverlayType

strong

Enumeration of overlay type properties. Defines the type of overlay supported by the viewing device.

Enumerator
PICTURE_IN_PICTURE	The viewing device supports picture-in-picture display mode.
NONE	The viewing device doesn't support overlay mode.
UNKNOWN	Any other overlay type not covered by the ones above.

Role

enum alexaClientSDK::alexaLiveViewControllerInterfaces::Role

strong

Enumeration of role properties. Role property is used to specify the role of the device for the streaming session. The device can act as a security camera or a viewer of a security camera stream.

Enumerator
CAMERA	The device acts as a camera. There can be one camera per streaming session.
VIEWER	The device acts as a viewer of the security camera streaming session. There can be multiple viewing devices in a streaming session.
UNKNOWN	Any other role type not covered by the ones above.

Status

enum alexaClientSDK::alexaLiveViewControllerInterfaces::Status

strong

Enumeration of status properties. Indicates the reason for the Alexa.StopLiveView directive being received or the Alexa.LiveViewStopped event being sent in their payloads.

Enumerator
STOP_LIVE_VIEW_REQUESTED	User requested to stop the live view session.
MEDIA_SOURCE_NOT_FOUND	Alexa can't find the media source.
UNAUTHORIZED	Device isn't authorized to access the live view feature.
BATTERY_LEVEL_TOO_LOW	Device battery is too low to support the live stream.
MEDIA_SOURCE_ASLEEP	Media source is asleep.
MEDIA_SOURCE_TURNED_OFF	Media source is turned off.

TalkMode

enum alexaClientSDK::alexaLiveViewControllerInterfaces::TalkMode

strong

Enumeration of talk mode properties. Defines the audio communication supported by the camera.

Enumerator
NO_SUPPORT	Camera doesn't support audio communication.
PRESS_AND_HOLD	The camera supports two-way communication in the style of a walkie-talkie. The user pushes the microphone on the viewing device to talk, and then releases to listen.
TAP	The camera supports two-way audio communication. The user taps the microphone on the viewing device to unmute and talk, and then taps to mute the microphone.
UNKNOWN	Any other talk mode not covered by the ones above.

Function Documentation

audioStateToMicrophoneState()

bool alexaClientSDK::alexaLiveViewControllerInterfaces::audioStateToMicrophoneState ( AudioState  audioState )

inline

Converts an AudioState value to a boolean representing the microphone state.

Parameters

audioState

The audio state value to convert to the microphone state.

Returns

true if audioState is unmuted, false otherwise.

false

audioStateToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::audioStateToString ( AudioState  audioState )

inline

Converts an AudioState value to an AVS-compliant string.

Parameters

audioState

The audio state value to convert to a string.

Returns

The std::string conversion of the AudioState value.

concurrentTwoWayTalkStateToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::concurrentTwoWayTalkStateToString ( ConcurrentTwoWayTalkState  concurrentTwoWayTalkState )

inline

Converts a ConcurrentTwoWayTalkState value to an AVS-compliant string.

Parameters

concurrentTwoWayTalkState

The concurrent two-way talk state value to convert to a string.

Returns

The std::string conversion of the ConcurrentTwoWayTalkState value.

displayModeToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::displayModeToString ( DisplayMode  displayMode )

inline

Converts a DisplayMode value to an AVS-compliant string.

Parameters

displayMode

The display mode value to convert to a string.

Returns

The std::string conversion of the DisplayMode value.

liveViewTriggerToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::liveViewTriggerToString ( LiveViewTrigger  liveViewTrigger )

inline

Converts a LiveViewTrigger value to an AVS-compliant string.

Parameters

liveViewTrigger

The live view trigger value to convert to a string.

Returns

The std::string conversion of the LiveViewTrigger value.

microphoneStateToAudioState()

AudioState alexaClientSDK::alexaLiveViewControllerInterfaces::microphoneStateToAudioState ( bool  microphoneState )

inline

Converts a microphone state in boolean (true if unmuted, false otherwise) to an AudioState.

Parameters

microphoneState

The microphone state value to convert to the audio state.

Returns

AudioState::UNMUTED if microphoneState is true, AudioState::MUTED otherwise.

motionCapabilityToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::motionCapabilityToString ( MotionCapability  motionCapability )

inline

Converts a MotionCapability value to an AVS-compliant string.

Parameters

motionCapability

The motion capability value to convert to a string.

Returns

The std::string conversion of the MotionCapability value.

overlayPositionToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::overlayPositionToString ( OverlayPosition  overlayPosition )

inline

Converts an OverlayPosition value to an AVS-compliant string.

Parameters

overlayPosition

The overlay position value to convert to a string.

Returns

The std::string conversion of the OverlayPosition value.

overlayTypeToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::overlayTypeToString ( OverlayType  overlayType )

inline

Converts an OverlayType value to an AVS-compliant string.

Parameters

overlayType

The overlay type value to convert to a string.

Returns

The std::string conversion of the OverlayType value.

roleToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::roleToString ( Role  role )

inline

Converts a Role value to an AVS-compliant string.

Parameters

role	The role value to convert to a string.

Returns

The std::string conversion of the Role value.

talkModeToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::talkModeToString ( TalkMode  talkMode )

inline

Converts a TalkMode value to an AVS-compliant string.

Parameters

talkMode

The talk mode value to convert to a string.

Returns

The std::string conversion of the TalkMode value.

targetTypeToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::targetTypeToString ( Target::TargetType  targetType )

inline

Converts a TargetType value to an AVS-compliant string.

Parameters

targetType

The target type value to convert to a string.

Returns

The std::string conversion of the TargetType value.

viewerStateToString()

std::string alexaClientSDK::alexaLiveViewControllerInterfaces::viewerStateToString ( Viewer::ViewerState  viewerState )

inline

Converts a ViewerState value to an AVS-compliant string.

Parameters

viewerState

The viewer state value to convert to a string.

Returns

The std::string conversion of the ViewerState value.