Get Live WebRTC Offer

Retrieve a WebRTC Offer to view an AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is an Accessory. live stream. This call will return an object containing TURN authentication parameters as well as the SDP itself. Query parameters can be used to request a full stream supporting Push-To-Talk, receive only stream, audio only stream, or receive only audio stream. After placing this call you have up to 30 seconds to provide the Answer via Provide Live WebRTC Answer Async.

Using this call first is the preferred mechanism for establishing a Live View, as it allows the Logitech Servers to select a TURN server geo-located closest to the camera for topologies where peer-to-peer can't be established. However, a caller can use Provide Live WebRTC Offer and Get Answer to have a synchronous call setup.

Permissions

Requires a Permissions scope of: circle:live

Response Body

Name

Type

Description

iceServers

array of objects

An array of iceServers and its configuration. This field must be set as the iceServers key within the RTCConfiguration object passed to the RTCPeerConnection() constructor in your WebRTC stack.

iceTransportPolicy

string

The current ICE transport policy. This field must be set as the iceTransportPolicy key within the RTCConfiguration object passed to the RTCPeerConnection() constructor in your WebRTC stack.Valid values are:

all - (default) All ICE candidates will be considered.
relay - Only ICE candidates from TURN servers, will be considered.

sdp

string

A full WebRTC compliant SDP blob. This should be passed directly to the Javascript or Native API's which consume Offers such as RTCPeerConnection.setRemoteDescription()

sessionId

string

The SDP session Id which must be passed back in the call to Provide Live WebRTC Answer Async. This param is how the Offer and Answer are associated. This is the same value as found in the o= line of the SDP.

Language
Authentication
OAuth2