Receive an offer

If you are joining a room where another user is waiting for you, the app needs to receive an offer (a session description in SDP format) from the caller (the person initiating the call). The app expects this offer to be stored inside a structured data with an ID based on the name of the room. The call recipient then responds with an answer message, which also contains an SDP description.

Contents

Get data identifier handle

The app fetches a data identifier handle for the structured data that contains the offer.

Get data ID handle

POST /data-id/structured-data
store.js
safeDataId.getStructuredDataHandle(ACCESS_TOKEN, address, 500)

The address of the structured data is based on the app ID (example.signaling.v1) and the name of the room. The structured data is unversioned (type 500).

store.js
const address = btoa(`${APP_ID}-${item}`)

Get structured data handle

The app fetches a structured data handle using the data identifier handle of the offer.

Get structured data handle

GET /structured-data/handle/:dataIdHandle
store.js
safeStructuredData.getHandle(ACCESS_TOKEN, dataHandleId)

Drop data identifier handle

The app drops the data identifier handle of the offer.

Drop data ID handle

DELETE /data-id/:handleId
store.js
safeDataId.dropHandle(ACCESS_TOKEN, dataHandleId)

Fetch the structured data

The app fetches the content of the structured data using the structured data handle.

Read structured data

GET /structured-data/:handleId/:version?
store.js
safeStructuredData.readData(ACCESS_TOKEN, handleId)

Drop the structured data handle

The app drops the structured data handle of the offer.

Drop structured data handle

DELETE /structured-data/handle/:handleId
store.js
safeStructuredData.dropHandle(ACCESS_TOKEN, handleId)

results matching ""

    No results matching ""