メッセージング機能¶

概要¶

ここでは DataChannel を利用したメッセージング機能について説明します。

DataChannel は、WebRTC の機能の一つでデータの送受信を行える機能です。

注意¶

• メッセージング機能を利用するためには、 data_channel_siganling が有効になっている必要があります
• メッセージング機能は DataChannel プロトコル互換性を維持しつつ Sora 独自の仕組みを追加しています

制限¶

SDK 対応状況¶

• 最新版の JavaScript SDK
  • 対応済みです
• 最新版の iOS SDK
  • 対応済みです
• 最新版の Android SDK
  • 対応済みです
• 最新版の Unity SDK
  • 対応済みです
• 最新版の C++ SDK
  • 対応済みです

DataChannel を利用したメッセージング機能を有効にする¶

DataChannel を利用したメッセージングを利用する場合、 DataChannel シグナリングが有効になっている必要があります。

その上で sora.conf にて data_channel_messaging を true に指定してください。

利用する場合は {"type": "connect"} 時に data_channels を指定してください。

メッセージング用 DataChannel の作成¶

Sora では、Sora がシグナリングで使用する DataChannel 以外にも、メッセージング用の DataChannel を作成できます。

利用する場合は {"type": "connect"} 時に定義するか、認証成功時の払い出しで定義する必要があります。

Sora のメッセージング用 DataChannel は、DataChannel の属性である label を定義する際に必ず # から始める必要があります。

data_channels 仕様¶

"type": "connect" 時の "data_channels"¶

{
    "type": "connect",
    "data_channels": [
        {
            "label": "#spam",
            "max_packet_life_time": 5000,
            "ordered": true,
            "protocol": "efg",
            "compress": false,
            "direction": "sendonly"
        },
        {
            "label": "#egg",
            "max_retransmits": 0,
            "ordered": false,
            "protocol": "abc",
            "compress": false,
            "direction": "recvonly"
        }
    ]
}

認証成功時の戻り値¶

認証ウェブフックの認証成功時に data_channels を指定することができます。

{
    "allowed": true,
    "data_channels": [
        {
            "label": "#spam",
            "max_packet_life_time": 5000,
            "ordered": true,
            "protocol": "efg",
            "compress": false,
            "direction": "sendonly"
        },
        {
            "label": "#egg",
            "max_retransmits": 0,
            "ordered": false,
            "protocol": "abc",
            "compress": false,
            "direction": "recvonly"
        }
    ]
}

"type": "offer" 時の "data_channels"¶

接続時か認証成功時に指定された data_channels は {"type": "offer"} に含まれます。

{
    "type": "offer",
    "data_channels": [
        {
            "label": "signaling",
            "ordered": true,
            "protocol": "signaling",
            "compress": true,
            "direction": "sendrecv"
        },
        {
            "label": "notify",
            "ordered": true,
            "protocol": "notify",
            "compress": true,
            "direction": "recvonly"
        },
        {
            "label": "push",
            "ordered": true,
            "protocol": "push",
            "compress": true,
            "direction": "recvonly"
        },
        {
            "label": "stats",
            "ordered": true,
            "max_retransmits": 1,
            "protocol": "stats",
            "compress": true,
            "direction": "sendrecv"
        },
        {
            "label": "#spam",
            "max_packet_life_time": 5000,
            "ordered": true,
            "protocol": "efg",
            "compress": false,
            "direction": "sendrecv"
        },
        {
            "label": "#egg",
            "max_retransmits": 0,
            "ordered": false,
            "protocol": "abc",
            "compress": false
            "direction": "recvonly"
        }
    ]
}

DataChannel を利用したメッセージングのみで接続する¶

DataChannel を利用したメッセージングのみを有効にするには以下を満たす必要があります。

• sora.conf の default_data_channel_signaling を true にする
• sora.conf の data_channel_messaging_only を true にする
• sora.conf の data_channel_messaging を true にする
• {"type": "connect"} 時に role を sendrecv にする
• {"type": "connect"} 時に multistream を true にする
• {"type": "connect"} 時に audio を false にする
  • 認証成功時の払い出しでも可
• {"type": "connect"} 時に video を false にする
  • 認証成功時の払い出しでも可
• {"type": "connect"} 時に data_channels を指定する
  • 認証成功時の払い出しでも可
• {"type": "connect"} 時に data_channel_signaling を true にする
  • 認証成功時の払い出しでも可

これで音声や映像を送らず、 DataChannel を利用したメッセージングのみを利用することが可能になります。

シーケンス図¶