Skip to main content
Where the clients of a broadcast path connect. Reach it as client.relays on a QumoClient.

​
place

Returns the relays a client of a broadcast path should connect to, best first. It needs no token or session, so an app that signs its own credentials can call it from the client that is about to connect: the region nearest that client then comes first. The order is a first guess from geography, not a measurement. Try the relays in order and move to the next when one does not answer; a client that can time its connections may prefer the fastest. Whichever relay a publisher and a viewer end up on, the broadcast reaches the viewer: the managed relays pass it between themselves. This throws when the control plane does not answer. To connect whether or not it does, use RelaysResource.resolve. Types: PlaceRelaysParams, RelayPlacement

​
resolve

Returns the relay addresses (host:port) a client should try, in order, and always returns some: discovery is optional, the hostname is not. It asks RelaysResource.place for the relays nearest the client and ends the list with hostname. When discovery fails, answers an error or takes longer than timeoutMs, the list is hostname alone. A session never needs the control plane to be reachable, only DNS. Types: ResolveRelaysParams