Variable default

Type declaration

• connection: ((signalingUrlCandidates: string | string[], debug?: boolean) => SoraConnection)

  • • (signalingUrlCandidates: string | string[], debug?: boolean): SoraConnection

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

      Example

      const connection = Sora.connection('ws://192.0.2.100:5000/signaling', true);
      

      Parameters

      • signalingUrlCandidates: string | string[]

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

      • debug: boolean = false

        デバッグフラグ

      Returns SoraConnection

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

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

  • applyMediaStreamConstraints: ((mediastream: MediaStream, constraints: MediaStreamConstraints) => Promise<void>)

    • • (mediastream: MediaStream, constraints: MediaStreamConstraints): Promise<void>

      • MediaStream の constraints を動的に変更するメソッド.

        Parameters

        • mediastream: MediaStream

          メディアストリーム

        • constraints: MediaStreamConstraints

          メディアストリーム制約

        Returns Promise<void>

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

  • • (wasmUrl: string): Promise<void>

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

      Example

      Sora.initE2EE("http://192.0.2.100/wasm.wasm");
      

      Parameters

      • wasmUrl: string

        E2EE WASM の URL

      Returns Promise<void>

• initLyra: ((config: LyraConfig) => boolean)

  • • (config: LyraConfig): boolean

    • Lyra の初期化を行うメソッド

      このメソッドの呼び出し時には設定情報の保存のみを行い、 Lyra での音声エンコード・デコードに必要な WebAssembly ファイルおよびモデルファイルは、 実際に必要になったタイミングで初めてロードされます

      Lyra を使うためには以下の機能がブラウザで利用可能である必要があります:

      • クロスオリジン分離（内部で SharedArrayBuffer クラスを使用しているため）
      • WebRTC Encoded Transform

      これらの機能が利用不可の場合には、このメソッドは警告メッセージを出力した上で、 返り値として false を返します

      Returns

      Lyra の初期化に成功したかどうか

      Parameters

      • config: LyraConfig

        Lyra の設定情報

      Returns boolean

• version: (() => string)

  • • (): string

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

      Returns string