Readonly
closedTrue when connector is closed, in other words when onClose event is fired
Readonly
codecsIndicate codecs supported, should be set before than onOpen happen
Start a log
a Log object with the levels of log to call
Readonly
openedTrue when connector is opened, in other words when onOpen event is fired
Optional
Readonly
streamMedia Stream description delivred from the server if we are player, or build from the local camera if we are the streamer.
Readonly
streamStream name, for example as+bc3f535f-37f3-458b-8171-b4c5e77a6137
Close the connector
Optional
error: ConnectorErrorthe error reason if is not a proper close
Request connections infos with caching option to save loading cost
Optional
cacheDuration: numberindicate how many time we can cache the last connection informations
Promise with a ConnectionInfos on success
Event subscription
Name of event without the on
prefix (ex: log
to onLog
event declared)
Subscriber Function
Optional
options: { Optional
signal?: AbortSignalOptional AbortSignal
to stop this or multiple subscriptions in same time
Event subscription only one time, once time fired it's automatically unsubscribe
Name of event without the on
prefix (ex: log
to onLog
event declared)
Subscriber Function
Optional
options: { Optional
signal?: AbortSignalCall when connector is closed
Optional
error: ConnectorErrorerror description on an improper closure
Generated using TypeDoc
IConnector is a common interface for representing a stream connection with the server.
This interface can serve the both roles: player or streamer.