シグナリング設定¶

シグナリング URL を一つだけ設定する例¶

final config = SoraConnectionConfig(
  signalingUrls: <String>[
    'wss://example.com/signaling',
  ],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
);

シグナリング URL を複数設定する例¶

final config = SoraConnectionConfig(
  // wss://1.example.com/signaling から順番に接続を試みます
  signalingUrls: <String>[
    'wss://1.example.com/signaling',
    'wss://2.example.com/signaling',
    'wss://3.example.com/signaling',
  ],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
);

SoraRole.sendrecv¶

双方向での通信を行いたい場合は SoraRole.sendrecv を指定します。

SoraRole.sendonly¶

音声や映像のみを配信するだけで、視聴はしない場合は SoraRole.sendonly を指定します。

SoraRole.recvonly¶

配信はせず、音声や映像を視聴するだけの場合は SoraRole.recvonly を指定します。

音声コーデック指定¶

項目:

audioCodecType

型:

AudioCodecType?

デフォルト:

null

未指定の場合は Sora 側のデフォルトコーデックが利用されます。 Sora は音声コーデックに AudioCodecType.opus のみを利用するため、この項目を明示的に指定する必要はありません。

final config = SoraConnectionConfig(
  signalingUrls: <String>[
    'wss://example.com/signaling',
  ],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
  audio: true,
  audioCodecType: AudioCodecType.opus,
);

音声ビットレート指定¶

項目:

audioBitRate

型:

int?

デフォルト:

null

音声ビットレートは kbps 単位の整数で指定する最大ビットレートです。指定可能な範囲は 6 〜 510 kbps です。 null の場合は bit_rate を connect メッセージに含めず、 Sora 側の設定に委ねます。

値は SoraConnectionConfig.toMap() の実行時に検証され、範囲外の値を指定すると RangeError が送出されます。

final config = SoraConnectionConfig(
  signalingUrls: <String>['wss://sora.example.com/signaling'],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
  audio: true,
  audioBitRate: 32,
);

// 511 を指定すると、toMap() の実行時に RangeError が送出されます。
// config.toMap();

詳細は Sora の オーディオビットレート指定 をご確認ください。

音声ストリーミングの言語コード¶

項目:

audioStreamingLanguageCode

型:

String?

デフォルト:

null

音声ストリーミングの言語コードを文字列で指定します。指定すると connect メッセージの audio_streaming_language_code に設定します。 null の場合はキーを送信しません。 audio が false の場合は音声を扱わないため送信しません。 Sora は指定された文字列をそのまま言語コードとして扱うため、 SDK は形式や長さを検証しません。

final config = SoraConnectionConfig(
  signalingUrls: <String>['wss://sora.example.com/signaling'],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
  audio: true,
  audioStreamingLanguageCode: 'ja-JP',
);

詳細は Sora の 音声ストリーミング機能 をご確認ください。

Opus の詳細パラメータ¶

項目:

audioOpusParamsChannels / audioOpusParamsMaxplaybackrate / audioOpusParamsMinptime / audioOpusParamsPtime / audioOpusParamsStereo / audioOpusParamsSpropStereo / audioOpusParamsUseinbandfec / audioOpusParamsUsedtx

指定した値は connect メッセージの audio.opus_params に含まれます。 null の項目はキーを含めません。 audioOpusParams を 1 つでも指定した場合は、 codec_type に OPUS が併記されます。 channels / maxplaybackrate / minptime は、 SoraConnectionConfig.toMap() の実行時に検証され、値が範囲外の場合に RangeError が送出されます。

final config = SoraConnectionConfig(
  signalingUrls: <String>['wss://sora.example.com/signaling'],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
  audio: true,
  audioOpusParamsChannels: 2,
  audioOpusParamsStereo: true,
);

詳細は Sora の オーディオの Opus 設定指定 をご確認ください。

映像コーデック指定¶

項目:

videoCodecType

型:

VideoCodecType?

デフォルト:

null

映像コーデックには VideoCodecType.{vp8, vp9, av1, h264, h265} が指定できます。未指定の場合は Sora 側で指定しているデフォルト映像コーデックが利用されます。

final config = SoraConnectionConfig(
  signalingUrls: <String>['wss://sora.example.com/signaling'],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
  video: true,
  videoCodecType: VideoCodecType.vp9,
);

映像ビットレート指定¶

項目:

videoBitRate

型:

int?

デフォルト:

null

映像ビットレートは kbps 単位の整数で指定する最大ビットレートです。指定可能な範囲は 1 〜 50000 kbps です。 null の場合は bit_rate を connect メッセージに含めず、 Sora 側の設定が使われます。

値は SoraConnectionConfig.toMap() の実行時に検証され、範囲外の値を指定すると RangeError が送出されます。最適なビットレートは映像の内容、解像度、フレームレート、コーデックによって異なります。

final config = SoraConnectionConfig(
  signalingUrls: <String>['wss://sora.example.com/signaling'],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
  video: true,
  videoBitRate: 1500, // kbps
);

コーデック固有パラメータ¶

コーデック毎に固有のパラメータを指定できます。

final config = SoraConnectionConfig(
  signalingUrls: <String>['wss://sora.example.com/signaling'],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
  video: true,
  videoCodecType: VideoCodecType.vp9,
  videoVp9Params: <String, Object?>{
   'profileId': 1,
  },
);

送信側¶

サイマルキャストで同時に送れる映像の本数は、コーデック、解像度、ビットレートに依存しています。また仕様は WebRTC ライブラリによって異なります。

Sora の SDK で採用している WebRTC ライブラリである libwebrtc の仕様は Sora ドキュメントの サイマルキャストの仕様 をご確認ください。

視聴側¶

項目:

simulcastRequestRid

型:

SimulcastRequestRid?

デフォルト:

null

none / r0 / r1 / r2 のいずれかを指定します。 null の場合は simulcast_request_rid を connect メッセージに含めません。

サイマルキャストを視聴する側は接続時にどの画質の映像を受信するかを指定できます。これは接続後に Sora の HTTP API や RPC 機能 を使って変更することができます。

final config = SoraConnectionConfig(
  signalingUrls: <String>['wss://sora.example.com/signaling'],
  channelId: 'example-channel',
  role: SoraRole.recvonly,
  simulcast: true,
  simulcastRequestRid: SimulcastRequestRid.r1,
);

スポットライトがフォーカスした際に利用する映像の ID¶

項目:

spotlightFocusRid

型:

SpotlightRid?

デフォルト:

Sora の設定に依存

音声が一定時間以上続いた場合、その話者にスポットライトがフォーカスします。 その際に利用する映像の rid を指定します。rid は Sora 側で設定している spotlight_encodings の rid と一致させる必要があります。

rid は none / r0 / r1 / r2 のいずれかを指定します。

スポットライトがアンフォーカスした際に利用する映像の ID¶

項目:

spotlightUnfocusRid

型:

SpotlightRid?

デフォルト:

Sora の設定に依存

音声が一定時間以上続かなかったり、他の話者が話し始めた場合、スポットライトがアンフォーカスします。 その際に利用する映像の ID を指定します。ID は Sora 側で設定している spotlight_encodings の rid と一致させる必要があります。

rid は none / r0 / r1 / r2 のいずれかを指定します。

timeoutOptions¶

• 型: SoraTimeoutOptions
• 省略可能。省略時は SoraTimeoutOptions のデフォルト値を使用します
• WebRTC 接続ライフサイクルのタイムアウト設定です

SoraTimeoutOptions では次の項目を設定できます。

• connectionTimeout (Duration 、デフォルト: 30 秒): WebSocket 接続から PeerConnection 接続完了までの待機時間
• disconnectWaitTimeout (Duration 、デフォルト: 10 秒): disconnect() のリソース解放待機時間
• signalingCandidateTimeout (Duration 、デフォルト: 5 秒): シグナリング URL への WebSocket 接続確立時間

final config = SoraConnectionConfig(
  signalingUrls: <String>['wss://sora.example.com/signaling'],
  channelId: 'example-channel',
  role: SoraRole.sendrecv,
  timeoutOptions: SoraTimeoutOptions(
    connectionTimeout: Duration(seconds: 60),
    disconnectWaitTimeout: Duration(seconds: 15),
    signalingCandidateTimeout: Duration(seconds: 10),
  ),
);

詳しくは タイムアウト機能 をご確認ください。