イベント¶

接続状態の変更¶

SoraConnectionStateChangedEvent は接続状態が変わったときに通知されます。

conn.events.listen((event) {
  if (event case SoraConnectionStateChangedEvent(:final state)) {
    switch (state) {
      case SoraConnectingState():
        print('connecting');
      case SoraConnectedState():
        print('connected');
      case SoraDisconnectedState(:final closeInfo):
        print('disconnected');
        if (closeInfo != null) {
          print('close code: ${closeInfo.code}');
          print('close reason: ${closeInfo.reason}');
        }
    }
  }
});

通知される状態は次の 3 種類です。

• SoraConnectingState
• SoraConnectedState
• SoraDisconnectedState

conn.events.listen((event) {
  if (event case SoraConnectionStateChangedEvent(state: SoraConnectingState())) {
    print('connecting');
  }
});

conn.events.listen((event) {
  if (event case SoraConnectionStateChangedEvent(state: SoraConnectedState())) {
    print('connected');
  }
});

conn.events.listen((event) {
  if (event case SoraConnectionStateChangedEvent(
    state: SoraDisconnectedState(:final closeInfo),
  )) {
    print('disconnected');
    if (closeInfo != null) {
      print('close code: ${closeInfo.code}');
      print('close reason: ${closeInfo.reason}');
    }
  }
});

接続エラー¶

接続エラーは SoraConnectionErrorEvent で通知されます。

conn.events.listen((event) {
  if (event case SoraConnectionErrorEvent(:final code, :final message)) {
    print('connection error: ${code ?? 'unknown'} ${message ?? ''}');
  }
});

code にはエラー種別が、 message にはエラーの詳細が含まれます。 どちらも null になる可能性があるため、利用の際は null チェックを行ってください。

code には、たとえば次のような値が入ります。

• event_channel_error
• websocket_error
• connection_timeout
• disconnect_timeout
• signaling_candidate_timeout
• offer_invalid

track¶

リモートトラックが追加されたときは SoraTrackEvent が通知されます。

トラックは RemoteMediaStreamTrack として渡され、 kind で音声か映像かを判別できます。

• kind == 'audio': 音声トラック (textureId は null)
• kind == 'video': 映像トラック (textureId は non-null)

conn.events.listen((event) {
  if (event case SoraTrackEvent(:final track)) {
    if (track.kind == 'audio') {
      print('audio track added: ${track.trackId}');
    } else {
      print('video track added: ${track.trackId}');
      print('textureId: ${track.textureId}');
    }
  }
});

RemoteMediaStreamTrack のフィールドは以下の通りです。

• trackId: トラック ID
• kind: audio または video
• connectionId: Sora の connection_id
• textureId: kind == 'video' の場合のみ値を取得できます

映像トラックの追加イベントでは、 textureId をそのまま Texture に渡せます。

if (event case SoraTrackEvent(:final track) when track.kind == 'video') {
  return Texture(textureId: track.textureId!);
}

removetrack¶

リモートトラックが削除されたときは SoraRemoveTrackEvent が通知されます。

conn.events.listen((event) {
  if (event case SoraRemoveTrackEvent(:final track)) {
    print('track removed: ${track.trackId}');
  }
});

削除イベントでも追加イベント時と同様に RemoteMediaStreamTrack 型となります。UI 側は通常 trackId で対象を特定して除去します。

接続単位でトラックを扱いたい場合は、 SoraConnection.remoteMediaStreams も利用できます。 connectionId をキーに RemoteMediaStream が入り、 audioTrack / videoTrack にそれぞれのトラックが格納されます。

notify¶

Sora からシグナリング通知を受け取ったときは SoraNotifyEvent が通知されます。

Sora のシグナリング通知の詳細は https://sora-doc.shiguredo.jp/SIGNALING_NOTIFY をご確認ください。

conn.events.listen((event) {
  if (event case SoraNotifyEvent(:final message)) {
    print('notify: $message');
  }
});

connection.created などの通知をここで受け取ることができます。

push¶

Sora からのプッシュ通知を受け取ったときは SoraPushEvent が通知されます。

conn.events.listen((event) {
  if (event case SoraPushEvent(:final message)) {
    print('push: $message');
  }
});

switched¶

シグナリングが WebSocket から DataChannel に切り替わったときは SoraSwitchedEvent が通知されます。

conn.events.listen((event) {
  if (event case SoraSwitchedEvent(:final message)) {
    print('switched: $message');
  }
});

timeout¶

WebSocket の close reason が TIMEOUT のときは SoraTimeoutEvent が通知されます。

conn.events.listen((event) {
  if (event case SoraTimeoutEvent()) {
    print('timeout');
  }
});

message¶

DataChannel を利用したリアルタイムメッセージング機能でメッセージを受信したときは SoraDataChannelMessageEvent が通知されます。

conn.events.listen((event) {
  if (event case SoraDataChannelMessageEvent(:final message)) {
    print('label: ${message.label}');
    print('data: ${message.data}');
  }
});

datachannel¶

DataChannel が利用可能になったときは SoraDataChannelOpenEvent が通知されます。

conn.events.listen((event) {
  if (event case SoraDataChannelOpenEvent(:final dataChannel)) {
    print('label: ${dataChannel.label}');
    print('direction: ${dataChannel.direction}');
  }
});

メッセージング機能を使う場合は、このイベントを送信可能の目安として扱えます。

signaling¶

シグナリングメッセージの送受信を確認したいときは SoraSignalingMessageEvent を利用します。

conn.events.listen((event) {
  if (event case SoraSignalingMessageEvent(:final signaling)) {
    print('${signaling.transportType} ${signaling.direction}');
    print(signaling.data);
  }
});

transportType は websocket または datachannel です。 direction は sent または received です。

data には、シグナリングメッセージの内容がそのまま入ります。 offer / answer / candidate などの内容を確認することができます。

log¶

SDK の構造化ログは SoraLogDebugEvent で受け取ることができます。

conn.debugEvents.listen((event) {
  if (event case SoraLogDebugEvent(:final log)) {
    print('${log.title}: ${log.message}');
  }
});

timeline¶

タイムラインの構造化ログは SoraTimelineDebugEvent で受け取ることができます。

conn.debugEvents.listen((event) {
  if (event case SoraTimelineDebugEvent(:final timeline)) {
    print('${timeline.logType.value} ${timeline.type}');
    print(timeline.data);
  }
});

SoraTimelineEvent では、主に次の情報を参照します。

• type: イベント種別
• logType: websocket / datachannel / peerconnection / sora
• data: イベントの詳細データ
• dataChannelId: DataChannel に紐づく場合の ID
• dataChannelLabel: DataChannel に紐づく場合の label