TUIRoom(Windows&Mac)
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に依存しています。具体的な実装プロセスについては、 多人数オーディオビデオルーム(Windows&Mac)をご参照ください。
TRTC SDK： TRTC SDK を低遅延のビデオミーティングのコンポーネントとして使用します。
IM SDK：IM SDK を利用してチャットルームの機能（IM SDKはC++バージョンを使用）を実装します。
TUIRoom API概要
TUIRoomCore基本関数
API | 説明 |
シングルトンオブジェクトを取得します。 | |
シングルトンオブジェクトを破棄します。 | |
イベントコールバックを設定します。 |
ルーム関連インターフェース関数
API | 説明 |
ログイン。 | |
ログアウト。 | |
ルームの作成（キャスターが呼び出し）。 | |
ルームの破棄（キャスターが呼び出し）。 | |
入室（参加者が呼び出し）。 | |
退室（参加者が呼び出し）。 | |
ルーム情報の取得。 | |
ルーム内全メンバー情報の取得。 | |
特定ユーザーの情報の取得。 | |
キャスター権限の移転（キャスターが呼び出し）。 |
ローカルのオーディオビデオ操作インターフェース
API | 説明 |
ローカルビデオのプレビュー画面を立ち上げます。 | |
ローカルビデオキャプチャおよびプレビューを停止します。 | |
ローカルビデオレンダリングウィンドウを変更します。 | |
マイクキャプチャを起動します。 | |
マイクキャプチャを停止します。 | |
システム音声のキャプチャを起動/停止します。 | |
システム音声のキャプチャを起動/停止します。 | |
ローカル画面のイメージプレビューモードを設定します。 |
リモートユーザーに関するインターフェース
API | 説明 |
指定メンバーのリモートビデオ画面をサブスクリプションし再生します。 | |
リモートビデオ画面のサブスクリプションをキャンセルし再生を停止します。 | |
リモートユーザーのビデオレンダリングウィンドウを変更します。 |
チャットメッセージ送信インターフェース
API | 説明 |
チャットメッセージを送信します。 | |
カスタムメッセージを送信します。 |
フィールドコントロール関連インターフェース
API | 説明 |
特定ユーザーのマイクを無効化/再有効化します。 | |
全ユーザーのマイクを無効化/再有効化し、ステータスをルーム情報に同期させます。 | |
特定ユーザーのカメラを無効化/再有効化します。 | |
全ユーザーのカメラを無効化/再有効化し、ステータスをルーム情報に同期させます。 | |
チャットルームのミュートを開始/停止します（キャスターが呼び出し）。 | |
ルーム内の特定ユーザーをリムーブします（キャスターが呼び出し）。 | |
キャスターが点呼を開始します。 | |
キャスターが点呼を終了します。 | |
メンバーがキャスターの点呼に応答します。 | |
キャスターが参加者の発言を要請します。 | |
キャスターが参加者の発言要請をキャンセルします。 | |
参加者がキャスターの発言申請に同意/拒否します。 | |
参加者が発言を申請します。 | |
参加者が発言申請をキャンセルします。 | |
キャスターが参加者の発言申請に同意/拒否します。 | |
キャスターが発言申請を禁止します。 | |
キャスターが参加者に発言を停止するよう命令します。 | |
キャスターが全員に発言を停止するよう命令します。 | |
参加者は発言を停止し、視聴者になります。 |
基本コンポーネントインターフェース関数
API | 説明 |
ローカル設定管理オブジェクトITXDeviceManagerを取得します。 | |
画面共有管理オブジェクトIScreenShareManagerを取得します。 |
クラウドレコーディングインターフェース関数
API | 説明 |
クラウドレコーディングを開始します 。 | |
クラウドレコーディングを停止します 。 |
美顔関連インターフェース関数
API | 説明 |
美顔を設定します。 |
関連設定インターフェース
API | 説明 |
ネットワークトラフィックコントロール関連パラメータを設定します。 |
SDKバージョンインターフェース関数の取得
API | 説明 |
SDKバージョンを取得します。 |
TUIRoomCoreCallback API概要
エラーイベントコールバック
API | 説明 |
エラーのコールバック。 |
基本イベントコールバック
API | 説明 |
ログインコールバック。 | |
ログアウトコールバック。 | |
ルーム作成のコールバック。 | |
ルーム解散のコールバック。 | |
入室のコールバック。 | |
退室のコールバック。 | |
最初のフレーム画面のコールバック。 | |
音量の大きさのコールバック。 | |
キャスター変更のコールバック。 |
リモートユーザーイベントコールバック
API | 説明 |
リモートユーザー入室コールバック。 | |
リモートユーザー退室コールバック。 | |
リモートユーザーがカメラビデオを起動するかどうかのコールバック。 | |
リモートユーザーが画面共有を開始するかどうかのコールバック。 | |
リモートユーザーがマイクをオンにしているかどうかのコールバック。 | |
リモートユーザーの発言開始のコールバック。 | |
リモートユーザーの発言終了のコールバック。 |
メッセージイベントのコールバック
API | 説明 |
テキストメッセージ受信のコールバック。 | |
テキストメッセージ受信のコールバック。 |
フィールドコントロールイベントコールバック
API | 説明 |
ユーザーがキャスターの発言要請を受信した場合のコールバック。 | |
ユーザーがキャスターの発言要請キャンセルを受信する場合のコールバック。 | |
キャスターがユーザーの発言要請への同意を受信する場合のコールバック。 | |
キャスターがユーザーの発言申請を受信する場合のコールバック。 | |
ユーザーが発言申請をキャンセルする場合のコールバック。 | |
キャスターが発言申請に同意する場合のコールバック。 | |
キャスターが発言申請を禁止する場合のコールバック。 | |
参加者が発言の停止をリクエストされる場合のコールバック。 | |
キャスターが点呼を開始し、参加者が受信する場合のコールバック。 | |
キャスターが点呼を終了し、参加者が受信する場合のコールバック。 | |
参加者が点呼に応答し、キャスターが受信する場合のコールバック。 | |
キャスターがチャットルームのミュートを変更する場合のコールバック。 | |
キャスターがマイクの無効化を設定する場合のコールバック。 | |
キャスターがカメラの無効化を設定する場合のコールバック。 |
統計および品質コールバック
API | 説明 |
技術指標統計のコールバック。 | |
ネットワーク品質のコールバック。 |
画面共有関連コールバック
API | 説明 |
画面共有開始のコールバック。 | |
画面共有停止のコールバック。 |
ビデオレコーディングコールバック
API | 説明 |
レコーディングエラーのコールバック。 | |
レコーディング完了のコールバック。 | |
レコーディング進捗のコールバック。 |
ローカルデバイステストコールバック
API | 説明 |
スピーカー音量のコールバック。 | |
マイク音量のコールバック。 | |
システムキャプチャ音量調節のコールバック。 | |
システム再生音量調節のコールバック。 |
TUIRoomCore基本関数
GetInstance
TUIRoomCore シングルトンオブジェクトを取得します。
static TUIRoomCore* GetInstance();
DestroyInstance
static void DestroyInstance();
SetCallback
virtual void SetCallback(const TUIRoomCoreCallback* callback) = 0;
Login
ログイン。
virtual int Login(int sdk_appid, const std::string& user_id, const std::string& user_sig) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
sdk_appid | int | |
user_id | string | 現在のユーザーID。文字列タイプでは、英語のアルファベット（a-z、A-Z）、数字（0-9）、ハイフン（-）とアンダーライン（_）のみ使用できます。業務の実際のアカウントシステムと組み合わせてご自身で設定することをお勧めします。 |
user_sig | string |
Logout
ログアウト。
virtual int Logout() = 0;
CreateRoom
ルームの作成（キャスターが呼び出し）。
virtual int CreateRoom(const std::string& room_id, TUISpeechMode speech_mode) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
room_id | string | ルームIDは、ご自身でアサインし、一元管理する必要があります。 |
speech_mode | TUISpeechMode | 発言モード。 |
キャスターの通常の呼び出しフローは以下のとおりです。
1. キャスターが
CreateRoom() を呼び出し、ルームを作成します。ルームの作成の成否はOnCreateRoomを介してキャスターに通知されます。2. キャスターが
EnterRoom()を呼び出し、入室します。3. キャスターが
StartCameraPreview()を呼び出し 、カメラキャプチャとプレビューを起動します。4. キャスターが
StartLocalAudio()を呼び出し、ローカルマイクを起動します。DestroyRoom
ルームの破棄（キャスターが呼び出し）。キャスターは、ルームの作成後、この関数を呼び出して、ルームを破棄できます。
virtual int DestroyRoom() = 0;
EnterRoom
入室（参加者が呼び出し）。
virtual int EnterRoom(const std::string& room_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
room_id | string | ルームID。 |
参加者が入室する場合の通常の呼び出し手順は次のとおりです。
1. 参加者が
EnterRoomを呼び出し、room_idを渡せば、入室できます。2. 参加者が
startCameraPreview()を呼び出して、カメラプレビューを起動し、StartLocalAudio()を呼び出して、マイクキャプチャを起動します。3. 参加者が
OnRemoteUserCameraAvailableのイベントを受信し、StartRemoteView()を呼び出して、ビデオ再生を開始します。LeaveRoom
退室（参加者が呼び出し）。
virtual int LeaveRoom() = 0;
GetRoomInfo
ルーム情報を取得します。
virtual TUIRoomInfo GetRoomInfo() = 0;
GetRoomUsers
ルームの全メンバー情報を取得します。
virtual std::vector<TUIUserInfo> GetRoomUsers() = 0;
GetUserInfo
メンバー情報を取得します。
virtual const TUIUserInfo* GetUserInfo(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザーID。 |
SetSelfProfile
ユーザーの属性を設定します。
virtual int SetSelfProfile(const std::string& user_name, const std::string& avatar_url) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_name | string | ユーザー氏名。 |
avatar_url | string | ユーザーのプロフィール画像URL。 |
TransferRoomMaster
グループを他のユーザーに引き渡します。
virtual int TransferRoomMaster(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザーID。 |
ローカルプッシュインターフェース
StartCameraPreview
ローカルカメラプレビューを起動します。
virtual int StartCameraPreview(const liteav::TXView& view) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
view | liteav::TXView | ウィンドウハンドル。 |
StopCameraPreview
ローカルカメラプレビューを停止します。
virtual int StopCameraPreview() = 0;
UpdateCameraPreview
ローカルビデオプレビュー画面のウィンドウを更新します。
virtual int UpdateCameraPreview(const liteav::TXView& view) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
view | liteav::TXView | ウィンドウハンドル。 |
StartLocalAudio
ローカルオーディオデバイスを起動します。
virtual int StartLocalAudio(const liteav::TRTCAudioQuality& quality) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
view | liteav::TXView | ウィンドウハンドル。 |
StopLocalAudio
ローカルオーディオデバイスを停止します。
virtual int StopLocalAudio() = 0;
StartSystemAudioLoopback
システム音声のキャプチャを開始します。
virtual int StartSystemAudioLoopback() = 0;
StopSystemAudioLoopback
システム音声のキャプチャを停止します。
virtual int StopSystemAudioLoopback() = 0;
SetVideoMirror
イメージを設定します。
virtual int SetVideoMirror(bool mirror) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
mirror | bool | ミラーオン/オフ。 |
リモートユーザーに関するインターフェース
StartRemoteView
リモートユーザーのビデオストリームのサブスクリプション。
virtual int StartRemoteView(const std::string& user_id, const liteav::TXView& view,TUIStreamType type = TUIStreamType::kStreamTypeCamera) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | 再生が必要なユーザー ID。 |
liteav::TXView | TXView | ビデオ画像をロードするviewウィジェット。 |
type | TUIStreamType | ストリームのタイプ。 |
StopRemoteView
サブスクリプションをキャンセルし、リモートビデオ画面の再生を停止します。
virtual int StopRemoteView(const std::string& user_id,TUIStreamType type = TUIStreamType::kStreamTypeCamera) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | 再生の停止が必要なユーザー ID。 |
type | TUIStreamType | ストリームのタイプ。 |
UpdateRemoteView
リモートビデオレンダリングウィンドウを更新します。
virtual int UpdateRemoteView(const std::string& user_id, TUIStreamType type, liteav::TXView& view) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
type | TUIStreamType | ストリームのタイプ。 |
view | liteav::TXView | レンダリングウィンドウハンドル。 |
メッセージ送信インターフェース
SendChatMessage
テキストメッセージを送信します。
virtual int SendChatMessage(const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
message | string | メッセージの内容。 |
SendCustomMessage
カスタムメッセージを送信します。
virtual int SendCustomMessage(const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
message | string | メッセージの内容。 |
フィールドコントロール関連インターフェース
MuteUserMicrophone
特定ユーザーのマイクを無効化/再有効化します。
virtual int MuteUserMicrophone(const std::string& user_id, bool mute, Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
mute | bool | 無効にするかどうか。 |
callback | Callback | インターフェースコールバック。 |
MuteAllUsersMicrophone
全ユーザーのマイクを無効化/再有効化します。
virtual int MuteAllUsersMicrophone(bool mute) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
mute | bool | 無効にするかどうか。 |
MuteUserCamera
特定ユーザーのカメラを無効化/再有効化します。
virtual int MuteUserCamera(const std::string& user_id, bool mute, Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
mute | bool | 無効にするかどうか。 |
callback | Callback | インターフェースコールバック。 |
MuteAllUsersCamera
全ユーザーのカメラを無効化/再有効化します。
virtual int MuteAllUsersCamera(bool mute) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
mute | bool | 無効にするかどうか。 |
MuteChatRoom
チャットルームのミュートを開始/停止します。
virtual int MuteChatRoom(bool mute) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
mute | bool | 無効にするかどうか。 |
KickOffUser
キャスターがキックアウトします。
virtual int KickOffUser(const std::string& user_id, Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
callback | Callback | インターフェースコールバック。 |
StartCallingRoll
キャスターが点呼を開始します。
virtual int StartCallingRoll() = 0;
StopCallingRoll
キャスターが点呼を終了します。
virtual int StopCallingRoll() = 0;
ReplyCallingRoll
参加者がキャスターの点呼に応答します。
virtual int ReplyCallingRoll(Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
callback | Callback | インターフェースコールバック。 |
SendSpeechInvitation
キャスターが参加者の発言を要請します。
virtual int SendSpeechInvitation(const std::string& user_id, Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
callback | Callback | インターフェースコールバック。 |
CancelSpeechInvitation
キャスターが参加者の発言要請をキャンセルします。
virtual int CancelSpeechInvitation(const std::string& user_id, Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
callback | Callback | インターフェースコールバック。 |
ReplySpeechInvitation
参加者がキャスターの発言要請に同意/拒否します。
virtual int ReplySpeechInvitation(bool agree, Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
agree | bool | 同意するかどうか。 |
callback | Callback | インターフェースコールバック。 |
SendSpeechApplication
参加者が発言を申請します。
virtual int SendSpeechApplication(Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
callback | Callback | インターフェースコールバック。 |
CancelSpeechApplication
参加者が発言申請をキャンセルします。
virtual int CancelSpeechApplication(Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
callback | Callback | インターフェースコールバック。 |
ReplySpeechApplication
キャスターが参加者の発言申請に同意/拒否します。
virtual int ReplySpeechApplication(const std::string& user_id, bool agree, Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
callback | Callback | インターフェースコールバック。 |
ForbidSpeechApplication
キャスターが発言申請を禁止します。
virtual int ForbidSpeechApplication(bool forbid) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
forbid | bool | 禁止するかどうか。 |
SendOffSpeaker
キャスターが参加者に発言の停止を命令します。
virtual int SendOffSpeaker(const std::string& user_id, Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
callback | Callback | インターフェースコールバック。 |
SendOffAllSpeakers
キャスターが全メンバーに発言の停止を命令します。
virtual int SendOffAllSpeakers(Callback callback) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
callback | Callback | インターフェースコールバック。 |
ExitSpeechState
参加者が発言を停止し、視聴者になります。
virtual int ExitSpeechState() = 0;
基本コンポーネントインターフェース
GetDeviceManager
デバイス管理のオブジェクトポインタを取得します。
virtual liteav::ITXDeviceManager* GetDeviceManager() = 0;
GetScreenShareManager
画面共有管理のオブジェクトポインタを取得します。
virtual IScreenShareManager* GetScreenShareManager() = 0;
クラウドレコーディングインターフェース
StartCloudRecord
クラウドレコーディングを開始します。
virtual int StartCloudRecord() = 0;
StopCloudRecord
クラウドレコーディングを停止します。
virtual int StopCloudRecord() = 0;
美顔関連インターフェース関数
SetBeautyStyle
美顔、美白、肌の色調補正効果のランクを設定します。
virtual int SetBeautyStyle(liteav::TRTCBeautyStyle style, uint32_t beauty_level,uint32_t whiteness_level, uint32_t ruddiness_level) = 0;
美顔管理では、次の機能を使用できます。
「美顔スタイル」を「スムース」または「ナチュラル」に設定します。「スムース」では、より強力な美肌補正効果が得られます。
「美顔レベル」を設定します。数値の範囲は0～9で、0はオフ、1～9までは数値が大きくなるほど効果が高くなります。
「美白レベル」を設定します。数値の範囲は0～9で、0はオフ、1～9までは数値が大きくなるほど効果が高くなります。
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
style | liteav::TRTCBeautyStyle | 美顔スタイル。 |
beauty_level | uint32_t | 美顔レベル。 |
whiteness_level | uint32_t | 美白レベル。 |
ruddiness_level | uint32_t | 肌色補正レベル。 |
関連設定インターフェース
SetVideoQosPreference
ネットワークトラフィックコントロール関連パラメータを設定します。
virtual int SetVideoQosPreference(TUIVideoQosPreference preference) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
preference | TUIVideoQosPreference | ネットワークトラフィックコントロールポリシー。 |
SDKバージョンインターフェースの取得
GetSDKVersion
SDKバージョン情報を取得します。
virtual const char* GetSDKVersion() = 0;
エラーイベントコールバック
OnError
void OnError(int code, const std::string& message);
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
code | int | エラーコード。 |
message | string | エラー情報。 |
基本イベントコールバック
OnLogin
virtual void OnLogin(int code, const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
code | int | エラーコード。 |
message | string | ログイン情報またはログイン失敗のエラー情報。 |
OnLogout
virtual void OnLogout(int code, const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
code | int | エラーコード。 |
message | string | エラー情報。 |
OnCreateRoom
ルーム作成のコールバックです。
virtual void OnCreateRoom(int code, const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
code | int | エラーコード。 |
message | string | エラー情報。 |
OnDestroyRoom
ルーム解散のコールバックです。
virtual void OnDestroyRoom(int code, const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
code | int | エラーコード。 |
message | string | エラー情報。 |
OnEnterRoom
入室コールバックです。
virtual void OnEnterRoom(int code, const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
code | int | エラーコード。 |
message | string | エラー情報。 |
OnExitRoom
退室コールバックです。
virtual void OnExitRoom(TUIExitRoomType type, const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
type | TUIExitRoomType | 退室のタイプ。 |
message | string | エラー情報。 |
OnFirstVideoFrame
自身のローカルまたはリモートユーザーの最初のフレーム画面のレンダリングを開始します。
virtual void OnFirstVideoFrame(const std::string& user_id, const TUIStreamType stream_type) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
stream_type | TUIStreamType | ストリームのタイプ。 |
OnUserVoiceVolume
ユーザー音量の大きさのコールバック。
virtual void OnUserVoiceVolume(const std::string& user_id, int volume)
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
volume | int | ユーザーの音量の大きさ、値の範囲0～100。 |
OnRoomMasterChanged
キャスター変更のコールバック。
virtual void OnRoomMasterChanged(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
リモートユーザーコールバックイベント
OnRemoteUserEnter
リモートユーザー入室コールバック。
virtual void OnRemoteUserEnter(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
OnRemoteUserLeave
リモートユーザー退室コールバック。
virtual void OnRemoteUserLeave(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
OnRemoteUserCameraAvailable
リモートユーザーが、カメラ、ビデオを起動しているかどうか。
virtual void OnRemoteUserCameraAvailable(const std::string& user_id, bool available) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
available | bool | true：ビデオストリームデータあり；false：ビデオストリームデータなし。 |
OnRemoteUserScreenAvailable
リモートユーザーが画面共有を開始しているかどうか。
virtual void OnRemoteUserScreenAvailable(const std::string& user_id, bool available) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
available | bool | true：ビデオストリームデータあり；false：ビデオストリームデータなし。 |
OnRemoteUserAudioAvailable
リモートユーザーがマイクをオンにしているかどうか。
virtual void OnRemoteUserAudioAvailable(const std::string& user_id, bool available) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
available | bool | true：オーディオストリームデータあり、false：オーディオストリームデータなし。 |
OnRemoteUserEnterSpeechState
リモートユーザーが発言を開始します。
virtual void OnRemoteUserEnterSpeechState(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
OnRemoteUserExitSpeechState
リモートユーザーが発言を終了します。
virtual void OnRemoteUserExitSpeechState(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
チャットルームメッセージイベントコールバック
OnReceiveChatMessage
テキストメッセージの受信。
virtual void OnReceiveChatMessage(const std::string& user_id, const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
message | string | テキストメッセージ。 |
OnReceiveCustomMessage
カスタムメッセージの受信。
virtual void OnReceiveCustomMessage(const std::string& user_id, const std::string& message) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
message | string | カスタムメッセージ。 |
フィールドコントロールメッセージコールバック
OnReceiveSpeechInvitation
ユーザーがキャスターの発言要請を受信する場合のコールバック。
virtual void OnReceiveSpeechInvitation() = 0;
OnReceiveInvitationCancelled
ユーザーがキャスターの発言要請キャンセルを受信する場合のコールバック。
virtual void OnReceiveInvitationCancelled() = 0;
OnReceiveReplyToSpeechInvitation
キャスターがユーザーの発言要請への同意を受信する場合のコールバック。
virtual void OnReceiveReplyToSpeechInvitation(const std::string& user_id, bool agree) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
agree | bool | 同意するかどうか。 |
OnReceiveSpeechApplication
キャスターがユーザーの発言申請を受信する場合のコールバック。
virtual void OnReceiveSpeechApplication(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
OnSpeechApplicationCancelled
ユーザーが発言申請をキャンセルする場合のコールバック。
virtual void OnSpeechApplicationCancelled(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
OnReceiveReplyToSpeechApplication
キャスターが発言申請に同意する場合のコールバック。
virtual void OnReceiveReplyToSpeechApplication(bool agree) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
agree | bool | 同意するかどうか。 |
OnSpeechApplicationForbidden
キャスターが発言申請を禁止する場合のコールバック。
virtual void OnSpeechApplicationForbidden(bool forbidden) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
forbidden | bool | 禁止するかどうか。 |
OnOrderedToExitSpeechState
参加者が発言を停止するようリクエストされる場合のコールバック。
virtual void OnOrderedToExitSpeechState() = 0;
OnCallingRollStarted
キャスターが点呼を開始し、メンバーが受信する場合のコールバック。
virtual void OnCallingRollStarted() = 0;
OnCallingRollStopped
キャスターが点呼を終了し、参加者が受信する場合のコールバック。
virtual void OnCallingRollStopped() = 0;
OnMemberReplyCallingRoll
参加者が点呼に応答し、キャスターが受信する場合のコールバック。
virtual void OnMemberReplyCallingRoll(const std::string& user_id) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
user_id | string | ユーザー ID。 |
OnChatRoomMuted
キャスターがチャットルームのミュートを変更する場合のコールバック。
virtual void OnChatRoomMuted(bool muted) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
muted | bool | 無効にするかどうか。 |
OnMicrophoneMuted
キャスターがマイクの無効化を設定する場合のコールバック。
virtual void OnMicrophoneMuted(bool muted) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
muted | bool | 無効にするかどうか。 |
OnCameraMuted
キャスターがカメラの無効化を設定する場合のコールバック。
virtual void OnCameraMuted(bool muted) = 0;
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
muted | bool | 無効にするかどうか。 |
統計および品質コールバック
OnStatistics
技術指標統計のコールバック。
virtual void OnStatistics(const liteav::TRTCStatistics& statis) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
statis | liteav::TRTCStatistics | 統計データ。 |
OnNetworkQuality
ネットワーク状況のコールバック。
virtual void OnNetworkQuality(const liteav::TRTCQualityInfo& local_quality, liteav::TRTCQualityInfo* remote_quality,uint32_t remote_quality_count) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
local_quality | liteav::TRTCQualityInfo | ローカルユーザー品質情報。 |
remote_quality | liteav::TRTCQualityInfo* | リモートユーザー品質情報ポインタ。 |
remote_quality_count | uint32_t | リモートユーザー数。 |
スクリーンキャプチャのイベントコールバック
OnScreenCaptureStarted
画面共有開始のコールバック。
virtual void OnScreenCaptureStarted() {}
OnScreenCaptureStopped
画面共有停止のコールバック。
void OnScreenCaptureStopped(int reason) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
reason | int | 停止の理由。0：ユーザーの自発的な停止。1：その他アプリケーションに占有されたことによる停止。 |
ビデオレコーディングコールバック
OnRecordError
レコーディングエラーのコールバック。
virtual void OnRecordError(TXLiteAVLocalRecordError error, const std::string& messgae) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
error | TXLiteAVLocalRecordError | エラー情報。 |
messgae | string | エラー説明。 |
OnRecordComplete
レコーディング完了のコールバック。
virtual void OnRecordComplete(const std::string& path) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
path | string | エラーの説明。 |
OnRecordProgress
レコーディング進捗のコールバック。
virtual void OnRecordProgress(int duration, int file_size) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
duration | int | ファイルの長さ。 |
file_size | int | ファイルのサイズ。 |
ローカルデバイステストコールバック
OnTestSpeakerVolume
スピーカー音量の大きさのコールバック。
virtual void OnTestSpeakerVolume(uint32_t volume) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
volume | uint32_t | 音量の大きさ。 |
OnTestMicrophoneVolume
マイク音量の大きさのコールバック。
virtual void OnTestMicrophoneVolume(uint32_t volume) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
volume | uint32_t | 音量の大きさ。 |
OnAudioDeviceCaptureVolumeChanged
システムキャプチャ音量調節のコールバック。
virtual void OnAudioDeviceCaptureVolumeChanged(uint32_t volume, bool muted) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
volume | uint32_t | 音量の大きさ。 |
muted | bool | 無効にされるかどうか |
OnAudioDevicePlayoutVolumeChanged
システム再生音量調節のコールバック。
virtual void OnAudioDevicePlayoutVolumeChanged(uint32_t volume, bool muted) {}
パラメータは下表に示すとおりです。
パラメータ | タイプ | 意味 |
volume | uint32_t | 音量の大きさ。 |
muted | bool | 無効にされるかどうか |
