Privacy Mode

During privacy

Set Privacy Mode Configuration

Topic

Publish to: api_client/<client_name>/<location_id>/<device_id>/privacy_mode/settings/set

Payload

{
  "audio": "disabled" | "enabled",
  "video": "disabled" | { "blurRadius": 10 } | { "overlay": "<img>" | null }
}

• audio: can be either disabled or enabled.
• video: can be either disabled, or an object with either a blurRadius or an overlay property.
  • The blurRadius is the radius of the blur effect in pixels.
  • The optional overlay is an base64-encoded JPG image that will be displayed instead of the video feed. Max image size is 1MB and the image will be resized to fit the video feed. If no overlay is provided, Livy’s default privacy image will be used.

Get Privacy Mode Configuration

Topics

Subscribe to: api_client/<client_name>/<location_id>/<device_id>/privacy_mode/settings Publish to: api_client/<client_name>/<location_id>/<device_id>/privacy_mode/settings/get

Payload

Publish with an empty payload.

Reponse

Not Retained
QoS: 1

Same as the payload of the Set Privacy Mode Configuration topic.

Activate Privacy Mode

Topic

Publish to: api_client/<client_name>/<location_id>/<device_id>/command/privacy_mode_start

Payload

Publish with an empty payload.

Deactivate Privacy Mode

Topic

Publish to: api_client/<client_name>/<location_id>/<device_id>/command/privacy_mode_end

Payload

Publish with an empty payload.

Get Privacy Mode

Topics

Subscribe to: api_client/<client_name>/<location_id>/<device_id>/privacy_mode Publish to: api_client/<client_name>/<location_id>/<device_id>/privacy_mode/get

Payload

Publish with an empty payload.

Response

Not Retained
QoS: 1

{
  "active": true
}

• active: whether privacy mode is active or not