Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Description

sm-control

Your Orchestration Server URL, e.g. wss://example.com:8080

You have to set the ​sm-control​ field in your JWT to point to your Orchestration server. The video host then makes an outbound WebSocket connection to the specified address.

It is also possible to make this a localhost address, so you can just have a locally running Orchestration server which is useful for debugging, etc.  To do this you need to have the sm-control-via-browser​ flag set to "True" in the JWT, and the

 

production flag set to "False" on the server.​

Once the connection is established, messages flow back and forth over the WebSocket. The protocol for these messages is the same as the protocol which underlies the Web SDK, but some extra messages are permitted (mainly startSpeaking).  

sm-control-via-browser

Flag to permit control via browser. Only allowed in Development environments.

sm-control-cookie-header

Field is set as Cookie header on the Orchestration server connection. This can be useful when working with components like load balancers which can act on headers.

iss

Issuer – the assigned ID for your JWT, e.g. “sm-abcdef123456789”

nbf

Not before timestamp. The time of issue with a small leeway for clock skew.

exp

Expires at timestamp.

iat

Issued at timestamp.

...