Docs Overview/
TUIRoom(Android)/

TUIRoom(Android)

TUIRoomは、Tencent CloudのTencent Real-Time Communication（TRTC）およびIMサービスを基に組み合わせたコンポーネントで、以下の機能をサポートしています。
キャスターがルームを作成し、入室者はルームナンバーを入力した後に入室できます。
入室者の間で画面共有を行います。
各種のテキストメッセージとカスタムメッセージの送信をサポートします。
説明：
TUIKitシリーズコンポーネントはTencent CloudのTRTCとIMという2つの基本的なPaaSサービスを同時に使用し、TRTCをアクティブにした後、IMサービスを同期してアクティブ化することができます。 IMサービスの課金ルールの詳細については、Instant Messagingの料金説明をご参照ください。TRTCをアクティブ化すると、関連するIM SDKの体験版がデフォルトでアクティブ化されます。これは100 DAUのみをサポートします。
TUIRoomはオープンソースのClassであり、Tencent Cloudの2つのクローズドソースのSDKに依存しています。具体的な実装プロセスについては、 多人数オーディオビデオルーム(Android)をご参照ください。
TRTC SDK：TRTC SDKを低遅延のオーディオビデオルームコンポーネントとして使用します。
IM SDK：IM SDK を利用してチャットルームの機能（IM SDKはAndroidバージョンを使用）を実装します。

TUIRoom API概要

TUIRoomCore基本関数

API
説明
シングルトンオブジェクトを取得します。
シングルトンオブジェクトを破棄します。
イベントコールバックを設定します。

ルーム関連インターフェース関数

API
説明
ルームの作成（キャスターが呼び出し）。
ルームの破棄（キャスターが呼び出し）。
入室（参加者が呼び出し）。
退室（参加者が呼び出し）。
ルーム情報の取得。
ルーム内全メンバー情報の取得。
特定ユーザーの情報の取得。
キャスター権限の移転（キャスターが呼び出し）。

ローカルのオーディオビデオ操作インターフェース

API
説明
ローカルビデオのプレビュー画面を立ち上げます。
ローカルのビデオキャプチャおよびプレビューを停止します。
マイクキャプチャを起動します。
マイクキャプチャを停止します。
ローカル画面のイメージプレビューモードを設定します。
スピーカーの起動を設定します。

リモートユーザーに関するインターフェース

API
説明
指定メンバーのリモートビデオ画面をサブスクリプションし再生します。
リモートビデオ画面のサブスクリプションをキャンセルし再生を停止します。

チャットメッセージ送信インターフェース

API
説明
チャットメッセージを送信します。
カスタムメッセージを送信します。

フィールドコントロール関連インターフェース

API
説明
特定ユーザーのマイクを無効化/再有効化します。
全ユーザーのマイクを無効化/再有効化し、ステータスをルーム情報に同期させます。
特定ユーザーのカメラを無効化/再有効化します。
全ユーザーのカメラを無効化/再有効化し、ステータスをルーム情報に同期させます。
チャットルームのミュートを開始/停止します（キャスターが呼び出し）。
ルーム内の特定ユーザーをリムーブします（キャスターが呼び出し）。
キャスターが点呼を開始します。
キャスターが点呼を終了します。
参加者がキャスターの点呼に応答します。
キャスターがメンバーに発言するようインビテーションを送信します。
キャスターがメンバーの発言のためのインビテーションをキャンセルします。
参加者がキャスターの発言申請に同意/拒否します。
参加者が発言を申請します。
キャスターが参加者の発言申請に同意/拒否します。
キャスターが発言申請を禁止します。
キャスターが参加者に発言を停止するよう命令します。
キャスターが全員に発言を停止するよう命令します。
参加者は発言を停止し、視聴者になります。

画面共有インターフェース

API
説明
画面共有を開始。
画面キャプチャの停止。

美顔フィルターに関するインターフェース関数

API
説明
美顔管理オブジェクトTXBeautyManager。を取得します。

関連設定インターフェース

API
説明
ネットワークトラフィックコントロール関連パラメータを設定します。

SDKバージョンインターフェース関数の取得

API
説明
SDKバージョンを取得します。

TUIRoomCoreListener API概要

エラーイベントコールバック

API
説明
エラーのコールバック。

基本イベントコールバック

API
説明
ルーム解散のコールバック。
音量の大きさのコールバック。
キャスター変更のコールバック。

リモートユーザーイベントコールバック

API
説明
リモートユーザー入室コールバック。
リモートユーザー退室コールバック。
リモートユーザーがカメラビデオを起動するかどうかのコールバック。
リモートユーザーが画面共有を開始するかどうかのコールバック。
リモートユーザーがオーディオのアップストリームを開始するかどうかのコールバック。
リモートユーザーの発言開始のコールバック。
リモートユーザーの発言終了のコールバック。

メッセージイベントのコールバック

API
説明
テキストメッセージ受信のコールバック。
カスタムメッセージ受信のコールバック。

フィールドコントロールイベントコールバック

API
説明
ユーザーがキャスターの発言要請を受信した場合のコールバック。
ユーザーがキャスターの発言要請キャンセルを受信する場合のコールバック。
キャスターがユーザーの発言申請を受信する場合のコールバック。
ユーザーが発言申請をキャンセルする場合のコールバック。
キャスターが発言申請を禁止する場合のコールバック。
参加者が発言の停止をリクエストされる場合のコールバック。
キャスターが点呼を開始し、参加者が受信する場合のコールバック。
キャスターが点呼を終了し、参加者が受信する場合のコールバック。
参加者が点呼に応答し、キャスターが受信する場合のコールバック。
キャスターがチャットルームのミュートを変更する場合のコールバック。
キャスターがマイクの無効化を設定する場合のコールバック。
キャスターがカメラの無効化を設定する場合のコールバック。
参加者がキャスターからキックアウトされた場合のコールバック。

統計および品質コールバック

API
説明
技術指標統計のコールバック。
ネットワーク品質のコールバック。

画面共有関連コールバック

API
説明
画面共有開始のコールバック。
画面共有停止のコールバック。

TUIRoomCore基本関数

getInstance

TUIRoomCore シングルトンオブジェクトを取得します。
public static TUIRoomCore getInstance(Context context);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
context
Context
Androidコンテキスト。内部ではApplicationContextに変換してシステムAPIの呼び出しに使用します。

destroyInstance

void destroyInstance();

setListener

TUIRoomCore イベントコールバック。TUIRoomCoreListener を介してTUIRoomCoreの各種ステータス通知を取得できます。
void setListener(TUIRoomCoreListener listener);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
listener
TUIRoomCoreListener
イベントコールバッククラスを受信します。

createRoom

ルームの作成（キャスターが呼び出し）。
void createRoom(String roomId, TUIRoomCoreDef.SpeechMode speechMode, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
roomId
String
ルームID。ご自身でアサインし、一元管理する必要があります。
speechMode
TUIRoomCoreDef.SpeechMode
発言モード。
callback
TUIRoomCoreCallback.ActionCallback
ルームの作成結果のコールバック。
キャスターの通常の呼び出しフローは以下のとおりです。
1. キャスターがcreateRoom()を呼び出し、ルームを作成します。ルーム作成の成否はTUIRoomCoreCallback.ActionCallbackでキャスターに通知されます。
2. キャスターがstartCameraPreview()を呼び出し 、カメラキャプチャとプレビューを起動します。
3. キャスターがstartLocalAudio()を呼び出し、ローカルマイクを起動します。

destroyRoom

ルームの破棄（キャスターが呼び出し）。キャスターは、ルームの作成後、この関数を呼び出して、ルームを破棄できます。
void destroyRoom(TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
UIRoomCoreCallback.ActionCallback
ルームの破棄結果のコールバック。

enterRoom

入室（参加者が呼び出し）。
void enterRoom(String roomId, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
roomId
String
ルームID。
callback
UIRoomCoreCallback.ActionCallback
結果のコールバック。
参加者が入室する場合の通常の呼び出し手順は次のとおりです。
1. 参加者がenterRoomを呼び出し、roomIdを渡せば入室できます。
2. 参加者がstartCameraPreview()を呼び出して、カメラプレビューを起動し、startLocalAudio()を呼び出して、マイクキャプチャを起動します。
3. 参加者がonRemoteUserCameraAvailableのイベントを受信し、startRemoteView()を呼び出して、ビデオ再生を開始します。

leaveRoom

退室（参加者が呼び出し）。
 void leaveRoom(TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
UIRoomCoreCallback.ActionCallback
結果のコールバック。

getRoomInfo

ルーム情報を取得します。
TUIRoomCoreDef.RoomInfo getRoomInfo();

getRoomUsers

ルームの全メンバー情報を取得します。
 List<TUIRoomCoreDef.UserInfo> getRoomUsers();

getUserInfo

メンバー情報を取得します。
void getUserInfo(String userId, TUIRoomCoreCallback.UserInfoCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
callback
UIRoomCoreCallback.UserInfoCallback
ルームメンバーの詳細情報のコールバック。

setSelfProfile

ユーザー情報を設定します。
void setSelfProfile(String userName, String avatarURL, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userName
String
ユーザーの氏名。
avatarURL
String
ユーザーのプロフィール画像URL。
callback
TUIRoomCoreCallback.ActionCallback
設定が成功したかどうかの結果のコールバック。

transferRoomMaster

グループを他のユーザーに引き渡します。
 void transferRoomMaster(String userId, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

ローカルプッシュインターフェース

startCameraPreview

ローカルカメラプレビューを起動します。
void startCameraPreview(boolean isFront, TXCloudVideoView view);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
isFront
boolean
true：フロントカメラ、false：リアカメラ。
view
TXCloudVideoView
ビデオ画像をロードするウィジェット。

stopCameraPreview

ローカルカメラプレビューを停止します。
 void stopCameraPreview();

startLocalAudio

マイクの集音開始。
 void startLocalAudio(int quality);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
quality
int
キャプチャの音質：
TRTC_AUDIO_QUALITY_MUSIC
TRTC_AUDIO_QUALITY_DEFAULT
TRTC_AUDIO_QUALITY_SPEECH

stopLocalAudio

マイクの集音停止
void stopLocalAudio();

setVideoMirror

ローカル画面のイメージプレビューモードを設定します。
 void setVideoMirror(int type);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
type
int
イメージタイプ。

setSpeaker

スピーカーの起動設定。
 void setSpeaker(boolean isUseSpeaker);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
isUseSpeaker
boolean
true：スピーカー、false：ヘッドホン。

リモートユーザーに関するインターフェース

startRemoteView

リモートユーザーのビデオストリームのサブスクリプション。
void startRemoteView(String userId, TXCloudVideoView view, TUIRoomCoreDef.SteamType streamType, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
再生が必要なユーザーのID。
view
TXCloudVideoView
ビデオ画像をロードするviewウィジェット。
streamType
TUIRoomCoreDef.SteamType
ストリームのタイプ。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

stopRemoteView

サブスクリプションをキャンセルし、リモートビデオ画面の再生を停止します。
void stopRemoteView(String userId, TUIRoomCoreCallback.ActionCallback callback);

パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
再生停止が必要なユーザーのID。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

switchCamera

フロント/リアカメラを切り替えます。
void switchCamera(boolean isFront);

パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
isFront
boolean
true：フロントカメラ、false：リアカメラ。

メッセージ送信インターフェース

sendChatMessage

ルーム内でテキストメッセージをブロードキャストします。通常、テキストによるチャットに使用します。
void sendChatMessage(String message, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
message
String
メッセージの内容。
callback
TUIRoomCoreCallback.ActionCallback
送信結果のコールバック。

sendCustomMessage

カスタムメッセージを送信します。
void sendCustomMessage(String data, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
data
String
メッセージの内容。
callback
TUIRoomCoreCallback.ActionCallback
送信結果のコールバック。

フィールドコントロール関連インターフェース

muteUserMicrophone

特定ユーザーのマイクを無効化/再有効化します。
void muteUserMicrophone(String userId, boolean mute, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
mute
boolean
無効にするかどうか。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

muteAllUsersMicrophone

全ユーザーのマイクを無効化/再有効化します。
void muteAllUsersMicrophone(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
mute
boolean
無効にするかどうか。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

muteUserCamera

特定ユーザーのカメラを無効化/再有効化します。
void muteUserCamera(String userId, boolean mute, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
mute
boolean
無効にするかどうか。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

muteAllUsersCamera

全ユーザーのカメラを無効化/再有効化します。
void muteAllUsersCamera(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
mute
boolean
無効にするかどうか。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

muteChatRoom

テキストチャットのミュート/再有効化。
void muteChatRoom(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
mute
boolean
無効にするかどうか。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

kickOffUser

キャスターがキックアウトします。
void kickOffUser(String userId, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

startCallingRoll

キャスターが点呼を開始します。
 void startCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

stopCallingRoll

キャスターが点呼を終了します。
 void stopCallingRoll(TUIRoomCoreCallback.ActionCallback callback);

パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

replyCallingRoll

参加者がキャスターの点呼に応答します。
void replyCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

sendSpeechInvitation

キャスターが参加者の発言を要請します。
void sendSpeechInvitation(String userId, TUIRoomCoreCallback.InvitationCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
callback
TUIRoomCoreCallback.InvitationCallback
結果のコールバック。

cancelSpeechInvitation

キャスターが参加者の発言要請をキャンセルします。
 void cancelSpeechInvitation(String userId, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

replySpeechInvitation

参加者がキャスターの発言要請に同意/拒否します。
void replySpeechInvitation(boolean agree, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
agree
boolean
同意するかどうか。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

sendSpeechApplication

参加者が発言を申請します。
void sendSpeechApplication(TUIRoomCoreCallback.InvitationCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomCoreCallback.InvitationCallback
結果のコールバック。

cancelSpeechApplication

参加者が発言申請をキャンセルします。
void cancelSpeechApplication(TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

replySpeechApplication

キャスターが参加者の発言申請に同意/拒否します。
void replySpeechApplication(boolean agree, String userId, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
agree
boolean
同意するかどうか。
userId
String
ユーザーID。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

forbidSpeechApplication

キャスターが発言申請を禁止します。
 void forbidSpeechApplication(boolean forbid, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
forbid
boolean
禁止するかどうか。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

sendOffSpeaker

キャスターが参加者に発言の停止を命令します。
void sendOffSpeaker(String userId, TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

sendOffAllSpeakers

キャスターが全メンバーに発言の停止を命令します。
void sendOffAllSpeakers(TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

exitSpeechState

参加者が発言を停止し、視聴者になります。
void exitSpeechState(TUIRoomCoreCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomCoreCallback.ActionCallback
結果のコールバック。

画面共有インターフェース

startScreenCapture

画面共有を開始。
void startScreenCapture(TRTCCloudDef.TRTCVideoEncParam encParams, TRTCCloudDef.TRTCScreenShareParams screenShareParams);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
encParams
TRTCCloudDef.TRTCVideoEncParam
画面共有時のエンコードパラメータを設定します。上記の推奨設定を採用することをお勧めします。encParamsにnullを指定した場合、startScreenCaptureを呼び出す前のエンコードパラメータ設定が使用されます。
screenShareParams
TRTCCloudDef.TRTCScreenShareParams
画面共有の特殊なレイアウト設定については、その中のfloatingViewの設定を推奨します。一方で、Appがシステムから強制排除されるのを回避でき、もう一方で、ユーザーのプライバシー保護にも役立ちます。
説明：
詳細については、TRTC SDKをご参照ください。 |

stopScreenCapture

画面キャプチャの停止。
void stopScreenCapture();

美顔フィルターに関するインターフェース関数

getBeautyManager

美顔管理オブジェクト TXBeautyManagerを取得します。
TXBeautyManager getBeautyManager();
美顔管理では、次の機能を使用できます。
「美顔のスタイル」、「美白」、「肌色補正（血色・つや感）」、「デカ眼」、「顔痩せ」、「V顔」、「下あご」、「面長補正」、「小鼻」、「キラキラ目」、「白い歯」、「目の弛み除去」、「シワ除去」、「ほうれい線除去」などの美容効果を設定します。
「髪の生え際」、「眼と眼の距離」、「眼の角度」、「唇の形」、「鼻翼」、「鼻の位置」、「唇の厚さ」、「顔の形」を調整します。
人の顔のスタンプ（素材）等のダイナミック効果を設定します。
メイクアップを追加します。
ジェスチャー認識を行います。

関連設定インターフェース

setVideoQosPreference

ネットワークトラフィックコントロール関連パラメータを設定します。
 void setVideoQosPreference(TRTCCloudDef.TRTCNetworkQosParam preference);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
preference
TRTCCloudDef.TRTCNetworkQosParam
ネットワークトラフィックコントロールポリシー。

setAudioQuality

音質の設定。
void setAudioQuality(int quality);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
quality
int
オーディオ品質。詳細については、TRTC SDKをご参照ください。

setVideoResolution

解像度の設定。
void setVideoResolution(int resolution);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
resolution
int
ビデオの解像度。詳細については、TRTC SDKをご参照ください。

setVideoFps

フレームレートの設定。
void setVideoFps(int fps);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
fps
int
ビデオキャプチャのフレームレート。
説明：
推奨する値：15fpsまたは20fps。5fps以下ではラグ感が目立ち、10fps以下では軽微なラグ感があります。20fps以上は高すぎて浪費になります（映画のフレームレートは24fps）。

setVideoBitrate

ビットレートの設定。
void setVideoBitrate(int bitrate);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
bitrate
int
ビットレート。SDKは、目標ビットレートに応じてエンコードを行い、ネットワークの状態が良くない場合のみ、ビデオビットレートを動的に引き下げます。詳細については、TRTC SDKをご参照ください。
説明：
推奨する値：TRTCVideoResolutionの各クラスに注記する最適ビットレートをご参照ください。これをもとにより高いレートに適宜調整することも可能です。例えば、TRTC_VIDEO_RESOLUTION_1280_720に対応する目標ビットレートが1200kbpsであるならば、設定を1500kbpsにし、より鮮明な画像を得ることができます。

enableAudioEvaluation

音量レベルリマインダを有効にします。
void enableAudioEvaluation(boolean enable);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
enable
boolean
true：オン、false：オフ。
説明：
有効化すると、onUserVolumeUpdateの中でSDKの音量のボリュームに対する評価を取得できます。

setAudioPlayVolume

再生音量の設定。
void setAudioPlayVolume(int volume);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
volume
int
再生音量、0～100、 デフォルト100。

setAudioCaptureVolume

マイクの集音音量設定
void setAudioCaptureVolume(int volume);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
volume
int
集音音量、0～100、 デフォルト100。

startFileDumping

録音の開始。
void startFileDumping(TRTCCloudDef.TRTCAudioRecordingParams trtcAudioRecordingParams);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
trtcAudioRecordingParams
TRTCCloudDef.TRTCAudioRecordingParams
録音パラメータ。詳細については、TRTC SDKをご参照ください。
説明：
この方法で呼び出した後、 SDKは通話プロセスの中のすべての音声（ローカル音声、リモート音声、BGMなど）を1つのファイルにレコーディングします。ルームに参加しているか否かにかかわらず、このインターフェースを呼び出せば有効となります。leaveRoomを呼び出した時に録音中であれば、録音は自動的に停止します。

stopFileDumping

録音の停止。
void stopFileDumping();

SDKバージョンインターフェースの取得

getSdkVersion

SDKバージョン情報を取得します。
int getSdkVersion();

エラーイベントコールバック

onError

void onError(int code, String message);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
code
int
エラーコード。
message
String
エラー情報。

基本イベントコールバック

onDestroyRoom

ルーム解散のコールバックです。
void onDestroyRoom();

onUserVoiceVolume

ユーザー音量の大きさのコールバック。
void onUserVoiceVolume(String userId, int volume);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
volume
int
ユーザーの音量の大きさ、値の範囲0～100。

onRoomMasterChanged

キャスター変更のコールバック。
void onRoomMasterChanged(String previousUserId, String currentUserId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
previousUserId
String
変更前のキャスターユーザーID。
currentUserId
String
変更後のキャスターユーザーID。

リモートユーザーコールバックイベント

onRemoteUserEnter

リモートユーザー入室コールバック。
void onRemoteUserEnter(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。

onRemoteUserLeave

リモートユーザー退室コールバック。
void onRemoteUserLeave(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。

onRemoteUserCameraAvailable

リモートユーザーが、カメラ、ビデオを起動しているかどうか。
void onRemoteUserCameraAvailable(String userId, boolean available);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
available
boolean
true：ビデオストリームデータあり、false：ビデオストリームデータなし。

onRemoteUserScreenVideoAvailable

メンバーのビデオ共有オン/オフの通知。
void onRemoteUserScreenVideoAvailable(String userId, boolean available);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
available
boolean
画面共有ストリームデータの有無。

onRemoteUserAudioAvailable

リモートユーザーがオーディオアップストリームを開始したかどうかのコールバック。
void onRemoteUserAudioAvailable(String userId, boolean available);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
available
boolean
オーディオデータの有無。

onRemoteUserEnterSpeechState

リモートユーザーが発言を開始します。
void onRemoteUserEnterSpeechState(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。

onRemoteUserExitSpeechState

リモートユーザーが発言を終了します。
void onRemoteUserExitSpeechState(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。

チャットルームメッセージイベントコールバック

onReceiveChatMessage

テキストメッセージの受信。
void onReceiveChatMessage(String userId, String message);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
message
String
テキストメッセージ。

onReceiveRoomCustomMsg

カスタムメッセージの受信。
void onReceiveRoomCustomMsg(String userId, String data);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。
message
String
カスタムメッセージ。

フィールドコントロールメッセージコールバック

onReceiveSpeechInvitation

ユーザーがキャスターの発言要請を受信する場合のコールバック。
void onReceiveSpeechInvitation(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
キャスターユーザーID。

onReceiveInvitationCancelled

ユーザーがキャスターの発言要請キャンセルを受信する場合のコールバック。
void onReceiveInvitationCancelled(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
キャスターユーザーID。

onReceiveSpeechApplication

キャスターがユーザーの発言申請を受信する場合のコールバック。
void onReceiveSpeechApplication(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。

onSpeechApplicationCancelled

ユーザーが発言申請をキャンセルする場合のコールバック。
void onSpeechApplicationCancelled(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。

onSpeechApplicationForbidden

キャスターが発言申請を禁止する場合のコールバック。
void onSpeechApplicationForbidden(boolean isForbidden);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
isForbidden
boolean
禁止するかどうか。

onOrderedToExitSpeechState

参加者が発言を停止するようリクエストされる場合のコールバック。
void onOrderedToExitSpeechState(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
キャスターユーザーID。

onCallingRollStarted

キャスターが点呼を開始し、参加者が受信する場合のコールバック。
void onCallingRollStarted(String userId);

onCallingRollStopped

キャスターが点呼を終了し、参加者が受信する場合のコールバック。
void onCallingRollStopped(String userId);

onMemberReplyCallingRoll

参加者が点呼に応答し、キャスターが受信する場合のコールバック。
void onMemberReplyCallingRoll(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
ユーザーID。

onChatRoomMuted

キャスターがチャットルームのミュートを変更する場合のコールバック。
void onChatRoomMuted(boolean muted);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
muted
boolean
無効にするかどうか。

onMicrophoneMuted

キャスターがマイクの無効化を設定する場合のコールバック。
void onMicrophoneMuted(boolean muted);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
muted
boolean
無効にするかどうか。

onCameraMuted

キャスターがカメラの無効化を設定する場合のコールバック。
void onCameraMuted(boolean muted);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
muted
boolean
無効にするかどうか。

onReceiveKickedOff

キャスターによるキックアウトのコールバック。
void onReceiveKickedOff(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
String
キャスター/管理者ユーザーID。

統計および品質コールバック

onStatistics

技術指標統計のコールバック。
void onStatistics(TRTCStatistics statistics);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
statis
TRTCStatistics
統計データ。

onNetworkQuality

ネットワーク状況のコールバック。
void onNetworkQuality(TRTCCloudDef.TRTCQuality localQuality, List<TRTCCloudDef.TRTCQuality> remoteQuality);

パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
localQuality
TRTCCloudDef.TRTCQuality
アップストリームネットワークの品質。
remoteQuality
List&amp;lt;TRTCCloudDef.TRTCQuality&amp;gt;
ダウンストリームのネットワーク品質。
説明：
詳細については、 TRTC SDKをご参照ください。

画面共有イベントコールバック

onScreenCaptureStarted

画面共有開始のコールバック。
 void onScreenCaptureStarted();

onScreenCaptureStopped

画面共有停止のコールバック。
void onScreenCaptureStopped(int reason);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
reason
int
停止の理由。
0：ユーザーの自発的な停止。
1：その他アプリケーションに占有されたことによる停止。