Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SoraConnection

Role 毎の Connection インスタンスを生成するためのクラス

param signalingUrlCandidates

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

param debug

デバッグフラグ

Hierarchy

  • SoraConnection

Index

Constructors

constructor

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

    • signalingUrlCandidates: string | string[]
    • debug: boolean = false

    Returns SoraConnection

Properties

debug

debug: boolean

デバッグフラグ

signalingUrlCandidates

signalingUrlCandidates: string | string[]

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

Accessors

signalingUrl

  • get signalingUrl(): string | string[]
  • シグナリングに使用する URL の候補

    deprecated

    Returns string | string[]

Methods

recvonly

  • role recvonly で接続するための Connecion インスタンスを生成するメソッド

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

    Parameters

    • channelId: string

      チャネルID

    • metadata: JSONType = null

      メタデータ

    • options: ConnectionOptions = ...

      コネクションオプション

    Returns ConnectionSubscriber

    role recvonly な Connection オブジェクトを返します

sendonly

  • role sendonly で接続するための Connecion インスタンスを生成するメソッド

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

    Parameters

    • channelId: string

      チャネルID

    • metadata: JSONType = null

      メタデータ

    • options: ConnectionOptions = ...

      コネクションオプション

    Returns ConnectionPublisher

    role sendonly な Connection オブジェクトを返します

sendrecv

  • role sendrecv で接続するための Connecion インスタンスを生成するメソッド

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

    Parameters

    • channelId: string

      チャネルID

    • metadata: JSONType = null

      メタデータ

    • options: ConnectionOptions = ...

      コネクションオプション

    Returns ConnectionPublisher

    role sendrecv な Connection オブジェクトを返します

Generated using TypeDoc