LiveViewCamera 1
The LiveViewCamera
interface exposes directives and events to provide the inter-process communication (IPC) Client control of an Alexa LiveViewController
(LVC) or Real-Time-Communication-SessionController (RTCSC) camera stream.
Header
{
"namespace": "LiveViewCamera",
"version": 1
}
Directives
Outbound messages from the Alexa client about the control and presentation of the LVC or RTCSC-based cameras.
renderCamera
Informs the IPC Client to present the live view camera stream and the User Interface.
Example message
{ "header": { "version": 1 "namespace": "LiveViewCamera", "name": "renderCamera" }, "payload": { "startLiveViewPayload": "{{OBJECT}}" } }
Payload parameters
Parameter | Description | Type |
---|---|---|
startLiveViewPayload |
Payload of the corresponding StartLiveView directive. |
object |
setCameraState
Informs the IPC Client of changes in the state of the active live view camera.
Example message
{ "header": { "version": 1 "namespace": "LiveViewCamera", "name": "setCameraState" }, "payload": { "state": "{{STRING}}" } }
Payload parameters
Parameter | Description | Type |
---|---|---|
state |
Enumerated live view camera state. | Valid values:CONNECTING CONNECTED DISCONNECTED ERROR |
clearCamera
Informs the IPC Client to clear the active live view camera.
Example message
{
"header": {
"version": 1
"namespace": "LiveViewCamera",
"name": "clearCamera"
},
"payload": {}
}
Payload parameters
The payload is an empty object.
Events
Inbound messages from the IPC Client about control of the active live view camera.
cameraMicrophoneStateChanged
Send this event to inform the Alexa client that the IPC client has changed the state of the camera microphone used for two-way communication.
Example message
{ "header": { "version": 1 "namespace": "LiveViewCamera", "name": "cameraMicrophoneStateChanged" }, "payload": { "enabled": {{BOOLEAN}} } }
Payload parameters
Parameter | Description | Type |
---|---|---|
enabled |
Camera microphone state - TRUE if enabled. |
Boolean |
cameraFirstFrameRendered
Send this event to inform the Alexa client that the first frame of the live view camera has rendered.
Example message
{
"header": {
"version": 1
"namespace": "LiveViewCamera",
"name": "cameraFirstFrameRendered"
},
"payload": {}
}
Payload parameters
The payload is an empty object.
windowIdReport
Send this event to report the windowId
used for displaying LiveViewCamera
to the Alexa client.
Example message
{ "header": { "version": 1 "namespace": "LiveViewCamera", "name": "windowIdReport" }, "payload": { "windowId": "{{STRING}}" } }
Payload parameters
Parameter | Description | Type |
---|---|---|
windowId |
Window ID for the LiveViewCamera , used for presentation tracking. |
string |
Related topics
Last updated: Apr 11, 2022