Variable default

default: {
    connection: ((signalingUrlCandidates, debug?) => SoraConnection);
    helpers: {
        applyMediaStreamConstraints: ((mediaStream, constraints) => Promise<void>);
    };
    initE2EE: ((wasmUrl) => Promise<void>);
    version: (() => string);
}

Sora JS SDK package

Type declaration

  • connection: ((signalingUrlCandidates, debug?) => SoraConnection)

    SoraConnection インスタンスを生成するメソッド

    Example

    const connection = Sora.connection('ws://192.0.2.100:5000/signaling', true);
    
      • (signalingUrlCandidates, debug?): SoraConnection
      • Parameters

        • signalingUrlCandidates: string | string[]

          シグナリングに使用する URL 候補

        • debug: boolean = false

          デバッグフラグ

        Returns SoraConnection

  • helpers: {
        applyMediaStreamConstraints: ((mediaStream, constraints) => Promise<void>);
    }

    WebRTC のユーティリティ関数群

    • applyMediaStreamConstraints: ((mediaStream, constraints) => Promise<void>)
        • (mediaStream, constraints): Promise<void>
        • MediaStream の constraints を動的に変更するメソッド.

          Parameters

          • mediaStream: MediaStream

            メディアストリーム

          • constraints: MediaStreamConstraints

            メディアストリーム制約

          Returns Promise<void>

  • initE2EE: ((wasmUrl) => Promise<void>)

    E2EE で使用する WASM の読み込みを行うメソッド

    Example

    Sora.initE2EE("http://192.0.2.100/wasm.wasm");
    
      • (wasmUrl): Promise<void>
      • Parameters

        • wasmUrl: string

          E2EE WASM の URL

        Returns Promise<void>

  • version: (() => string)

    SDK のバージョンを返すメソッド

      • (): string
      • Returns string