Interface IConnector

IConnector is a common interface for representing a stream connection with the server.

This interface can serve the both roles: player or streamer.

Hierarchy

Implemented by

Properties

closed codecs log opened stream? streamName

Methods

close connectionInfos off on once replaceTrack

Events

onClose onOpen

Properties

Readonly closed

closed: boolean

True when connector is closed, in other words when onClose event is fired

Readonly codecs

codecs: Set<string>

Indicate codecs supported, should be set before than onOpen happen

log

log: ILog

Start a log

Param

Returns

a Log object with the levels of log to call

Readonly opened

opened: boolean

True when connector is opened, in other words when onOpen event is fired

Optional Readonly stream

stream?: MediaStream

Media Stream description delivred from the server if we are player, or build from the local camera if we are the streamer.

Readonly streamName

streamName: string

Stream name, for example as+bc3f535f-37f3-458b-8171-b4c5e77a6137

Methods

close

connectionInfos

  • Request connections infos with caching option to save loading cost

    Parameters

    • Optional cacheDuration: number

      indicate how many time we can cache the last connection informations

    Returns Promise<ConnectionInfos>

    Promise with a ConnectionInfos on success

off

  • Event unsubscription

    Parameters

    • name: "open" | "close" | "Close" | "Open"

      Name of event without the 'on' prefix (ex: 'log' to 'onLog' event declared)

    • event: Function

      Unsubscriber Function, must be the one passed to on or once subscription methods

    Returns boolean

on

  • Event subscription

    Parameters

    • name: "open" | "close" | "Close" | "Open"

      Name of event without the on prefix (ex: log to onLog event declared)

    • event: Function

      Subscriber Function

    • Optional options: {
          signal?: AbortSignal;
      }
      • Optional signal?: AbortSignal

        Optional AbortSignal to stop this or multiple subscriptions in same time

    Returns void

once

  • Event subscription only one time, once time fired it's automatically unsubscribe

    Parameters

    • name: "open" | "close" | "Close" | "Open"

      Name of event without the on prefix (ex: log to onLog event declared)

    • event: Function

      Subscriber Function

    • Optional options: {
          signal?: AbortSignal;
      }
      • Optional signal?: AbortSignal

        Optional AbortSignal to stop this or multiple subscriptions in same time

    Returns void

replaceTrack

  • Parameters

    • kind: "audio" | "video"

      'video' or 'audio' to replace the track of the given kind

    • track: null | MediaStreamTrack

    Returns Promise<void>

    Promise that resolves when the track is replaced

    Throws

    Error if the kind is not supported or if the operation fails

    This method allows to replace the current track of the given kind with a new one. If the track is null, it will remove the current track of that kind.

Events

onClose

onOpen

  • Call when connector is open

    Parameters

    • stream: MediaStream

      MediaStream description provided from the server if we are the player, or build from the local camera if we are the streamer.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc