Class RtcSignalingClient

Hierarchy

  • FormantBaseClient
    • RtcSignalingClient

Constructors

constructor

Properties

endpoint headers onResponseError retries waitForConnectivity

Methods

addSignals createPeer createSession deleteSession fetch fetchVerbose getHeaders getIceServers getPeers getRetries getSessions refreshPeer refreshSession takeSignals

Constructors

constructor

  • new RtcSignalingClient(endpoint, options?): RtcSignalingClient

  • Parameters

    • endpoint: string
    • Optional options: {
          timeoutMs?: number;
      }
      • Optional timeoutMs?: number

    Returns RtcSignalingClient

Properties

Protected endpoint

endpoint: string

Static headers

headers: {
    [_: string]: string;
}

Type declaration

  • [_: string]: string

Static onResponseError

onResponseError: ((error) => Promise<void>)

Type declaration

    • (error): Promise<void>

    • Parameters

      • error: ResponseError

      Returns Promise<void>

Static retries

retries: number

Static waitForConnectivity

waitForConnectivity: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Methods

addSignals

  • addSignals(token, sessionId, request): Promise<void>

  • Parameters

    • token: string
    • sessionId: string
    • request: IRtcAddSignalsRequest

    Returns Promise<void>

createPeer

  • createPeer(token, request): Promise<IRtcPeer>

  • Parameters

    • token: string
    • request: IRtcCreatePeerRequest

    Returns Promise<IRtcPeer>

createSession

  • createSession(token, request): Promise<IRtcSession>

  • Parameters

    • token: string
    • request: IRtcCreateSessionRequest

    Returns Promise<IRtcSession>

deleteSession

  • deleteSession(token, id): Promise<void>

  • Parameters

    • token: string
    • id: string

    Returns Promise<void>

Protected fetch

  • fetch<T>(path, extendedInit?): Promise<T>

  • Type Parameters

    • T

    Parameters

    • path: string
    • Optional extendedInit: IRequestInit

    Returns Promise<T>

Protected fetchVerbose

  • fetchVerbose<T>(path, extendedInit?): Promise<IResponse<T>>

  • Type Parameters

    • T

    Parameters

    • path: string
    • Optional extendedInit: IRequestInit

    Returns Promise<IResponse<T>>

Protected getHeaders

  • getHeaders(): {
        [_: string]: string;
    }

  • Returns {
        [_: string]: string;
    }

    • [_: string]: string

getIceServers

  • getIceServers(token): Promise<RTCIceServer[]>

  • Parameters

    • token: string

    Returns Promise<RTCIceServer[]>

getPeers

  • getPeers(token): Promise<IRtcPeer[]>

  • Parameters

    • token: string

    Returns Promise<IRtcPeer[]>

Protected getRetries

  • getRetries(): number

  • Returns number

getSessions

  • getSessions(token): Promise<IRtcSession[]>

  • Parameters

    • token: string

    Returns Promise<IRtcSession[]>

refreshPeer

  • refreshPeer(token, id): Promise<void>

  • Parameters

    • token: string
    • id: string

    Returns Promise<void>

refreshSession

  • refreshSession(token, id): Promise<void>

  • Parameters

    • token: string
    • id: string

    Returns Promise<void>

takeSignals

  • takeSignals(token, sessionId): Promise<IRtcSignal[]>

  • Parameters

    • token: string
    • sessionId: string

    Returns Promise<IRtcSignal[]>

Settings

Member Visibility

Theme

On This Page

constructorendpointheadersonResponseErrorretrieswaitForConnectivityaddSignalscreatePeercreateSessiondeleteSessionfetchfetchVerbosegetHeadersgetIceServersgetPeersgetRetriesgetSessionsrefreshPeerrefreshSessiontakeSignals

Generated using TypeDoc