Class SoraConnection

constructor

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

  Parameters

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

  Returns SoraConnection

debug

signalingUrlCandidates

signalingUrl

• get signalingUrl(): string | string[]

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

  Returns string | string[]

  Deprecated

messaging

• messaging(
      channelId: string,
      metadata?: JSONType,
      options?: ConnectionOptions,
  ): ConnectionMessaging

  Parameters

  • channelId: string
  • metadata: JSONType = null
  • options: ConnectionOptions = ...

  Returns ConnectionMessaging

recvonly

• recvonly(
      channelId: string,
      metadata?: JSONType,
      options?: ConnectionOptions,
  ): ConnectionSubscriber

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

  Parameters

  • channelId: string

    チャネルID
  • metadata: JSONType = null

    メタデータ
  • options: ConnectionOptions = ...

    コネクションオプション

  Returns ConnectionSubscriber

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

  Example

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

sendonly

• sendonly(
      channelId: string,
      metadata?: JSONType,
      options?: ConnectionOptions,
  ): ConnectionPublisher

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

  Parameters

  • channelId: string

    チャネルID
  • metadata: JSONType = null

    メタデータ
  • options: ConnectionOptions = ...

    コネクションオプション

  Returns ConnectionPublisher

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

  Example

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

sendrecv

• sendrecv(
      channelId: string,
      metadata?: JSONType,
      options?: ConnectionOptions,
  ): ConnectionPublisher

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

  Parameters

  • channelId: string

    チャネルID
  • metadata: JSONType = null

    メタデータ
  • options: ConnectionOptions = ...

    コネクションオプション

  Returns ConnectionPublisher

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

  Example

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