内容紹介

TRTC SDK はカスタムメッセージを送信する機能を提供します。この機能を介して、キャスターのロールを持つユーザーは同じビデオルーム内の他のユーザーに自身のカスタムメッセージをブロードキャストすることができます。

サポートするプラットフォーム

送受信の原理

あるユーザーのカスタマイズメッセージは音声ビデオデータストリーム内にクリップされ、音声ビデオデータストリームと同時にルーム内の他のユーザーに送信されます。音声ビデオライン自体は100%信頼できるものではないため、信頼性を高めるため、TRTC SDK 内部に信頼性保護メカニズムを実装しています。

メッセージの送信

TRTCCloud の sendCustomCmdMsg インターフェースを呼び出して送信する場合は、送信時に4つのパラメータを指定する必要があります：

reliable とordered を同時にYES または NOに設定してください。現在のところ、クロス設定はサポートされていません。

• Objective-C

//カスタマイズメッセージを送信するためのサンプルコード
- (void)sendHello {
  // カスタマイズメッセージのコマンドワードであり、サービスに応じて一連のルールをカスタマイズする必要があります。ここではテキストブロードキャストメッセージの送信を意味する0x1を例示します。
  NSInteger cmdID = 0x1;
  NSData *data = [@"Hello" dataUsingEncoding:NSUTF8StringEncoding];
  // 現在のところ、reliable と ordered を一致させる必要があります。ここではメッセージの送信順の着信を保証する必要があることを例示します
  [trtcCloud sendCustomCmdMsg:cmdID data:data reliable:YES ordered:YES];
}

• Java

//カスタマイズメッセージを送信するためのサンプルコード
public void sendHello() {
  try {
      // カスタマイズメッセージのコマンドワードであり、サービスに応じて一連のルールをカスタマイズする必要があります。ここではテキストブロードキャストメッセージの送信を意味する0x1を例示します。
      int cmdID = 0x1;
      String hello = "Hello";
      byte[] data = hello.getBytes("UTF-8");
      // 現在のところ、reliable と ordered を一致させる必要があります。ここではメッセージの送信順の着信を保証する必要があることを例示します
      trtcCloud.sendCustomCmdMsg(cmdID, data, true, true);

  } catch (UnsupportedEncodingException e) {
      e.printStackTrace();
  }
}

• C++

// カスタマイズメッセージを送信するためのサンプルコード
void sendHello()
{
  // カスタマイズメッセージのコマンドワードであり、サービスに応じて一連のルールをカスタマイズする必要があります。ここではテキストブロードキャストメッセージの送信を意味する0x1を例示します。
   uint32_t cmdID = 0x1;
  uint8_t* data = { '1', '2', '3' };
  uint32_t dataSize = 3;  // dataの長さ
   // 現在のところ、reliable と ordered を一致させる必要があります。ここではメッセージの送信順の着信を保証する必要があることを例示します
  trtcCloud->sendCustomCmdMsg(cmdID, data, dataSize, true, true);
}

• C#

// カスタマイズメッセージを送信するためのサンプルコード
private void sendHello()
{
  // カスタマイズメッセージのコマンドワードであり、サービスに応じて一連のルールをカスタマイズする必要があります。ここではテキストブロードキャストメッセージの送信を意味する0x1を例示します。
   uint cmdID = 0x1;
  byte[] data = { '1', '2', '3' };
  uint dataSize = 3;  // dataの長さ
   // 現在のところ、reliable と ordered を一致させる必要があります。ここではメッセージの送信順の着信を保証する必要があることを例示します
  mTRTCCloud.sendCustomCmdMsg(cmdID, data, dataSize, true, true);
}

メッセージの受信

ルーム内の1人のユーザーが sendCustomCmdMsg を介してカスタムメッセージを送信した後、ルーム内の他のユーザーは SDK コールバックの onRecvCustomCmdMsg インターフェースを介してこれらのメッセージを受信することができます。

• Objective-C

//ルーム内の他のユーザーが送信したメッセージの受信および処理
- (void)onRecvCustomCmdMsgUserId:(NSString *)userId cmdID:(NSInteger)cmdId seq:(UInt32)seq message:(NSData *)message
{
// userId が送信したメッセージの受信
  switch (cmdId)  // 送信者と受信者が承諾済みのcmdId
  {
  case 0:
      // cmdId = 0メッセージを処理
      break;
  case 1:
      // cmdId = 1メッセージを処理
      break;
  case 2:
      // cmdId = 2メッセージを処理
      break;
  default:
      break;
  }
}

• Java

//TRTCCloudListenerの継承、onRecvCustomCmdMsg メソッドの実装でルーム内の他のユーザーが送信したメッセージの受信および処理
public void onRecvCustomCmdMsg(String userId, int cmdId, int seq, byte[] message) {
// userId が送信したメッセージを受信
  switch (cmdId)  // 送信者と受信者が承諾済みのcmdId
  {
  case 0:
      // cmdId = 0メッセージを処理
      break;
  case 1:
      // cmdId = 1メッセージを処理
      break;
  case 2:
      // cmdId = 2メッセージを処理
      break;
  default:
      break;

}

• C++

// ルーム内の他のユーザーが送信したメッセージの受信および処理
void TRTCCloudCallbackImpl::onRecvCustomCmdMsg(
                          const char* userId, int32_t cmdId, uint32_t seq, const uint8_t* msg, uint32_t msgSize)
{
  // userId が送信したメッセージを受信
  switch (cmdId)  // 送信者と受信者が承諾済みのcmdId
  {
  case 0:
      // cmdId = 0メッセージを処理
      break;
  case 1:
      // cmdId = 1メッセージを処理
      break;
  case 2:
      // cmdId = 2メッセージを処理
      break;
  default:
      break;
  }
}

• C#

// ルーム内の他のユーザーが送信したメッセージの受信および処理
public void onRecvCustomCmdMsg(string userId, int cmdId, uint seq, byte[] msg, uint msgSize)
{
  // userId が送信したメッセージを受信
  switch (cmdId)  // 送信者と受信者が承諾済みのcmdId
  {
  case 0:
      // cmdId = 0メッセージを処理
      break;
  case 1:
      // cmdId = 1メッセージを処理
      break;
  case 2:
      // cmdId = 2メッセージを処理
      break;
  default:
      break;
  }
}

使用制限

カスタマイズメッセージは音声ビデオデータよりも送信優先度が高いため、カスタマイズデータの送信が多すぎると、音声ビデオデータが干渉を受け、画像がフリーズしたりぼやけたりする可能性があります。以上のことから、カスタマイズメッセージの送信について次の頻度制限を実施しています。

• カスタマイズメッセージはクラウドによってルーム内のすべてのユーザーにブロードキャストされるため、送信可能なメッセージは30通/秒を上限とします。
• 各メッセージパケット（ dataのサイズ）は 1 KBを上限とし、これを超える場合は、中間ルーターまたはサーバーによって破棄される可能性が極めて高くなります。
• 各クライアントが送信可能なデータは最大8 KB /秒とします。つまり、各データパケットがいずれも1KBであれば、最大8個のデータパケット/秒しか送信できません。