Tencent Cloud

Recent Pages

TUIRoom API（iOS）

最終更新日:2024-07-19 15:35:35

﻿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に依存しています。具体的な実装プロセスについては、 多人数オーディオビデオルーム(iOS)をご参照ください。
TRTC SDK：TRTC SDKを低遅延のオーディオビデオルームコンポーネントとして使用します。
IM SDK：IM SDK を利用してチャットルームの機能（IM SDKはiOSバージョンを使用）を実装します。
TUIRoom API概要
TUIRoomCore基本関数
API
説明
shareInstance
シングルトンオブジェクトを取得します。
destroyInstance
シングルトンオブジェクトを破棄します。
setDelegate
イベントコールバックを設定します。
ルーム関連インターフェース関数
API
説明
createRoom
ルームの作成（キャスターが呼び出し）。
destroyRoom
ルームの破棄（キャスターが呼び出し）。
enterRoom
入室（参加者が呼び出し）。
leaveRoom
退室（参加者が呼び出し）。
getRoomInfo
ルーム情報の取得。
getRoomUsers
ルーム内全メンバー情報の取得。
getUserInfo
特定ユーザーの情報の取得。
transferRoomMaster
キャスター権限の移転（キャスターが呼び出し）。
ローカルのオーディオビデオ操作インターフェース
API
説明
startCameraPreview
ローカルビデオのプレビュー画面を立ち上げます。
stopCameraPreview
ローカルのビデオキャプチャおよびプレビューを停止します。
startLocalAudio
マイクキャプチャを起動します。
stopLocalAudio
マイクキャプチャを停止します。
setVideoMirror
ローカル画面のイメージプレビューモードを設定します。
setSpeaker
スピーカーの起動を設定します。
リモートユーザーに関するインターフェース
API
説明
startRemoteView
指定メンバーのリモートビデオ画面をサブスクリプションし再生します。
stopRemoteView
リモートビデオ画面のサブスクリプションをキャンセルし再生を停止します。
チャットメッセージ送信インターフェース
API
説明
sendChatMessage
チャットメッセージを送信します。
sendCustomMessage
カスタムメッセージを送信します。
フィールドコントロール関連インターフェース
API
説明
muteUserMicrophone
特定ユーザーのマイクを無効化/再有効化します。
muteAllUsersMicrophone
全ユーザーのマイクを無効化/再有効化し、ステータスをルーム情報に同期させます。
muteUserCamera
特定ユーザーのカメラを無効化/再有効化します。
muteAllUsersCamera
全ユーザーのカメラを無効化/再有効化し、ステータスをルーム情報に同期させます。
muteChatRoom
チャットルームのミュートを開始/停止します（キャスターが呼び出し）。
kickOffUser
ルーム内の特定ユーザーをリムーブします（キャスターが呼び出し）。
startCallingRoll
キャスターが点呼を開始します。
stopCallingRoll
キャスターが点呼を終了します。
replyCallingRoll
参加者がキャスターの点呼に応答します。
sendSpeechInvitation
キャスターが参加者の発言を要請します。
cancelSpeechInvitation
キャスターが参加者の発言要請をキャンセルします。
replySpeechInvitation
参加者がキャスターの発言申請に同意/拒否します。
sendSpeechApplication
参加者が発言を申請します。
replySpeechApplication
キャスターが参加者の発言申請に同意/拒否します。
forbidSpeechApplication
キャスターが発言申請を禁止します。
sendOffSpeaker
キャスターが参加者に発言を停止するよう命令します。
sendOffAllSpeakers
キャスターが全員に発言を停止するよう命令します。
exitSpeechState
参加者は発言を停止し、視聴者になります。
画面共有インターフェース
API
説明
startScreenCapture
画面共有を開始。
stopScreenCapture
画面キャプチャの停止。
美顔フィルターに関するインターフェース関数
API
説明
getBeautyManager
美顔管理オブジェクトTXBeautyManagerを取得します。
関連設定インターフェース
API
説明
setVideoQosPreference
ネットワークトラフィックコントロール関連パラメータを設定します。
SDKバージョンインターフェース関数の取得
API
説明
getSDKVersion
SDKバージョンを取得します。
TUIRoomCoreDelegate API概要
エラーイベントコールバック
API
説明
onError
エラーのコールバック。
基本イベントコールバック
API
説明
onDestroyRoom
ルーム解散のコールバック。
onUserVoiceVolume
音量の大きさのコールバック。
onRoomMasterChanged
キャスター変更のコールバック。
リモートユーザーイベントコールバック
API
説明
onRemoteUserEnter
リモートユーザー入室コールバック。
onRemoteUserLeave
リモートユーザー退室コールバック。
onRemoteUserCameraAvailable
リモートユーザーがカメラビデオを起動するかどうかのコールバック。
onRemoteUserScreenVideoAvailable
リモートユーザーが画面共有を開始するかどうかのコールバック。
onRemoteUserAudioAvailable
リモートユーザーがオーディオのアップストリームを開始するかどうかのコールバック。
onRemoteUserEnterSpeechState
リモートユーザーの発言開始のコールバック。
onRemoteUserExitSpeechState
リモートユーザーの発言終了のコールバック。
メッセージイベントのコールバック
API
説明
onReceiveChatMessage
テキストメッセージ受信のコールバック。
フィールドコントロールイベントコールバック
API
説明
onReceiveSpeechInvitation
ユーザーがキャスターの発言要請を受信した場合のコールバック。
onReceiveInvitationCancelled
ユーザーがキャスターの発言要請キャンセルを受信する場合のコールバック。
onReceiveSpeechApplication
キャスターがユーザーの発言申請を受信する場合のコールバック。
onSpeechApplicationCancelled
ユーザーが発言申請をキャンセルする場合のコールバック。
onSpeechApplicationForbidden
キャスターが発言申請を禁止する場合のコールバック。
onOrderedToExitSpeechState
参加者が発言の停止をリクエストされる場合のコールバック。
onCallingRollStarted
キャスターが点呼を開始し、参加者が受信する場合のコールバック。
onCallingRollStopped
キャスターが点呼を終了し、参加者が受信する場合のコールバック。
onMemberReplyCallingRoll
参加者が点呼に応答し、キャスターが受信する場合のコールバック。
onChatRoomMuted
キャスターがチャットルームのミュートを変更する場合のコールバック。
onMicrophoneMuted
キャスターがマイクの無効化を設定する場合のコールバック。
onCameraMuted
キャスターがカメラの無効化を設定する場合のコールバック。
onReceiveKickedOff
参加者がキャスターからキックアウトされた場合のコールバック。
統計および品質コールバック
API
説明
onStatistics
技術指標統計のコールバック。
onNetworkQuality
ネットワーク品質のコールバック。
画面共有関連コールバック
API
説明
onScreenCaptureStarted
画面共有開始のコールバック。
onScreenCaptureStopped
画面共有停止のコールバック。
TUIRoomCore基本関数
getInstance
TUIRoomCore シングルトンオブジェクトを取得します。
+ (instancetype)shareInstance;
destroyInstance
+ (void)destroyInstance;
setDelegate
TUIRoomCore イベントコールバック。TUIRoomCoreDelegateを介してTUIRoomCoreの各種ステータス通知を取得できます。
- (void)setDelegate:(id<TUIRoomCoreDelegate>)delegate;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
delegate
TUIRoomCoreDelegate
イベントコールバッククラスを受信します。
createRoom
ルームの作成（キャスターが呼び出し）。
- (void)createRoom:(NSString *)roomId
        speechMode:(TUIRoomSpeechMode)speechMode
        callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
roomId
NSString
ルームID。ご自身でアサインし、一元管理する必要があります。
speechMode
TUIRoomSpeechMode
発言モード。
callback
TUIRoomActionCallback
ルームの作成結果のコールバック。
キャスターの通常の呼び出しフローは以下のとおりです。
1. キャスターがcreateRoom()を呼び出し、ルームを作成します。ルーム作成の成否はTUIRoomActionCallbackでキャスターに通知されます。
2. キャスターがstartCameraPreview()を呼び出し 、カメラキャプチャとプレビューを起動します。
3. キャスターがstartLocalAudio()を呼び出し、ローカルマイクを起動します。
destroyRoom
ルームの破棄（キャスターが呼び出し）。キャスターは、ルームの作成後、この関数を呼び出して、ルームを破棄できます。
- (void)destroyRoom:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomActionCallback
ルームの破棄結果のコールバック。
enterRoom
入室（参加者が呼び出し）。
- (void)enterRoom:(NSString *)roomId
        callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
roomId
NSString
ルームID。
callback
TUIRoomActionCallback
結果のコールバック。
参加者が入室する場合の通常の呼び出し手順は次のとおりです。
1. 参加者がenterRoomを呼び出し、roomIdを渡せば入室できます。
2. 参加者がstartCameraPreview()を呼び出して、カメラプレビューを起動し、startLocalAudio()を呼び出して、マイクキャプチャを起動します。
3. 参加者がonRemoteUserCameraAvailableのイベントを受信し、startRemoteView()を呼び出して、ビデオ再生を開始します。
leaveRoom
退室（参加者が呼び出し）。
 - (void)leaveRoom:(TUIRoomActionCallback)callback;
  パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomActionCallback
結果のコールバック。
getRoomInfo
ルーム情報を取得します。
- (nullable TUIRoomInfo *)getRoomInfo;
getRoomUsers
ルームの全メンバー情報を取得します。
 - (nullable NSArray<TUIRoomUserInfo *> *)getRoomUsers;
getUserInfo
メンバー情報を取得します。
- (void)getUserInfo:(NSString *)userId
           callback:(TUIRoomUserInfoCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
callback
TUIRoomUserInfoCallback
ルームメンバーの詳細情報のコールバック。
setSelfProfile
ユーザー情報を設定します。
- (void)setSelfProfile:(NSString *)userName
        avatarURL:(NSString *)avatarURL
        callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userName
NSString
ユーザーの氏名。
avatarURL
NSString
ユーザーのプロフィール画像URL。
callback
TUIRoomActionCallback
設定が成功したかどうかの結果のコールバック。
transferRoomMaster
グループを他のユーザーに引き渡します。
 - (void)transferRoomMaster:(NSString *)userId
                  callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
callback
TUIRoomActionCallback
結果のコールバック。
ローカルプッシュインターフェース
startCameraPreview
ローカルカメラプレビューを起動します。
- (void)startCameraPreview:(BOOL)isFront
                      view:(UIView *)view;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
isFront
BOOL
YES：フロントカメラ、NO：リアカメラ。
view
UIView
ビデオ画像をロードするウィジェット。
stopCameraPreview
ローカルカメラプレビューを停止します。
- (void)stopCameraPreview;
startLocalAudio
マイクの集音開始。
- (void)startLocalAudio:(TRTCAudioQuality)quality;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
quality
TRTCAudioQuality
キャプチャの音質。
stopLocalAudio
マイクの集音停止
- (void)stopLocalAudio;
setVideoMirror
ローカル画面のイメージプレビューモードを設定します。
 - (void)setVideoMirror:(TRTCVideoMirrorType)type;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
type
TRTCVideoMirrorType
イメージタイプ。
setSpeaker
スピーカーの起動設定。
 - (void)setSpeaker:(BOOL)isUseSpeaker;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
isUseSpeaker
BOOL
YES：スピーカー、NO：ヘッドホン。
リモートユーザーに関するインターフェース
startRemoteView
リモートユーザーのビデオストリームのサブスクリプション。
- (void)startRemoteView:(NSString *)userId
                   view:(UIView *)view
             streamType:(TUIRoomStreamType)streamType
               callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
再生が必要なユーザー ID。
view
UIView
ビデオ画像をロードするviewウィジェット。
streamType
TUIRoomStreamType
ストリームのタイプ。
callback
TUIRoomActionCallback
結果のコールバック。
stopRemoteView
サブスクリプションをキャンセルし、リモートビデオ画面の再生を停止します。
- (void)stopRemoteView:(NSString *)userId
            streamType:(TUIRoomStreamType)streamType
              callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
再生停止が必要なユーザーのID。
streamType
TUIRoomStreamType
ストリームのタイプ。
callback
TUIRoomActionCallback
結果のコールバック。
switchCamera
フロント/リアカメラを切り替えます。
- (void)switchCamera:(BOOL)isFront;
﻿
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
isFront
BOOL
YES：フロントカメラ、NO：リアカメラ。
メッセージ送信インターフェース
sendChatMessage
ルーム内でテキストメッセージをブロードキャストします。通常、テキストによるチャットに使用します。
- (void)sendChatMessage:(NSString *)message
               callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
message
NSString
メッセージの内容。
callback
TUIRoomActionCallback
送信結果のコールバック。
フィールドコントロール関連インターフェース
muteUserMicrophone
特定ユーザーのマイクを無効化/再有効化します。
- (void)muteUserMicrophone:(NSString *)userId
                      mute:(BOOL)mute
                  callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
mute
BOOL
無効にするかどうか。
callback
TUIRoomActionCallback
結果のコールバック。
muteAllUsersMicrophone
全ユーザーのマイクを無効化/再有効化します。
- (void)muteAllUsersMicrophone:(BOOL)mute
                      callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
mute
BOOL
無効にするかどうか。
callback
TUIRoomActionCallback
結果のコールバック。
muteUserCamera
特定ユーザーのカメラを無効化/再有効化します。
- (void)muteUserCamera:(NSString *)userId
                  mute:(BOOL)mute
              callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
mute
BOOL
無効にするかどうか。
callback
TUIRoomActionCallback
結果のコールバック。
muteAllUsersCamera
全ユーザーのカメラを無効化/再有効化します。
- (void)muteAllUsersCamera:(BOOL)mute
                  callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
mute
BOOL
無効にするかどうか。
callback
TUIRoomActionCallback
結果のコールバック。
muteChatRoom
テキストチャットのミュート/再有効化。
- (void)muteChatRoom:(BOOL)mute
            callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
mute
BOOL
無効にするかどうか。
callback
TUIRoomActionCallback
結果のコールバック。
kickOffUser
キャスターがキックアウトします。
- (void)kickOffUser:(NSString *)userId
           callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
callback
TUIRoomActionCallback
結果のコールバック。
startCallingRoll
キャスターが点呼を開始します。
 - (void)startCallingRoll:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomActionCallback
結果のコールバック。
stopCallingRoll
キャスターが点呼を終了します。
- (void)stopCallingRoll:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomActionCallback
結果のコールバック。
replyCallingRoll
参加者がキャスターの点呼に応答します。
- (void)replyCallingRoll:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomActionCallback
結果のコールバック。
sendSpeechInvitation
キャスターが参加者の発言を要請します。
- (void)sendSpeechInvitation:(NSString *)userId
                    callback:(TUIRoomInviteeCallback)callback
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
callback
TUIRoomInviteeCallback
結果のコールバック。
cancelSpeechInvitation
キャスターが参加者の発言要請をキャンセルします。
- (void)cancelSpeechInvitation:(NSString *)userId
                      callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
callback
TUIRoomActionCallback
結果のコールバック。
replySpeechInvitation
参加者がキャスターの発言要請に同意/拒否します。
- (void)replySpeechInvitation:(BOOL)agree
                     callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
agree
BOOL
同意するかどうか。
callback
TUIRoomActionCallback
結果のコールバック。
sendSpeechApplication
参加者が発言を申請します。
- (void)sendSpeechApplication:(TUIRoomInviteeCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomInviteeCallback
結果のコールバック。
cancelSpeechApplication
参加者が発言申請をキャンセルします。
- (void)cancelSpeechApplication:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomActionCallback
結果のコールバック。
replySpeechApplication
キャスターが参加者の発言申請に同意/拒否します。
- (void)replySpeechApplication:(BOOL)agree
                        userId:(NSString *)userId
                      callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
agree
BOOL
同意するかどうか
userId
NSString
ユーザーID。
callback
TUIRoomActionCallback
結果のコールバック。
forbidSpeechApplication
キャスターが発言申請を禁止します。
- (void)forbidSpeechApplication:(BOOL)forbid
                       callback:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
forbid
BOOL
禁止するかどうか。
callback
TUIRoomActionCallback
結果のコールバック。
sendOffSpeaker
キャスターが参加者に発言の停止を命令します。
- (void)sendOffSpeaker:(NSString *)userId
              callback:(TUIRoomInviteeCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
callback
TUIRoomInviteeCallback
結果のコールバック。
sendOffAllSpeakers
キャスターが全メンバーに発言の停止を命令します。
- (void)sendOffAllSpeakers:(TUIRoomInviteeCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomInviteeCallback
結果のコールバック。
exitSpeechState
参加者が発言を停止し、視聴者になります。
- (void)exitSpeechState:(TUIRoomActionCallback)callback;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
callback
TUIRoomActionCallback
結果のコールバック。
画面共有インターフェース
startScreenCapture
画面共有を開始。
- (void)startScreenCapture:(TRTCVideoEncParam *)encParam API_AVAILABLE(ios(11.0));
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
encParams
TRTCVideoEncParam
画面共有時のエンコードパラメータを設定します。
説明：
詳細については、TRTC SDKをご参照ください。
stopScreenCapture
画面キャプチャの停止。
- (void)stopScreenCapture API_AVAILABLE(ios(11.0));
美顔フィルターに関するインターフェース関数
getBeautyManager
美顔管理オブジェクトTXBeautyManagerを取得します。
- (TXBeautyManager *)getBeautyManager;
美顔管理では、次の機能を使用できます。
「美顔のスタイル」、「美白」、「肌色補正（血色・つや感）」、「デカ眼」、「顔痩せ」、「V顔」、「下あご」、「面長補正」、「小鼻」、「キラキラ目」、「白い歯」、「目の弛み除去」、「シワ除去」、「ほうれい線除去」などの美容効果を設定します。
「髪の生え際」、「眼と眼の距離」、「眼の角度」、「唇の形」、「鼻翼」、「鼻の位置」、「唇の厚さ」、「顔の形」を調整します。
人の顔のスタンプ（素材）等のダイナミック効果を設定します。
メイクアップを追加します。
ジェスチャー認識を行います。
関連設定インターフェース
setVideoQosPreference
ネットワークトラフィックコントロール関連パラメータを設定します。
- (void)setVideoQosPreference:(TRTCNetworkQosParam *)preference;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
preference
TRTCNetworkQosParam
ネットワークトラフィックコントロールポリシー。
setAudioQuality
音質の設定
- (void)setAudioQuality:(TRTCAudioQuality)quality;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
quality
TRTCAudioQuality
音質。詳細については、TRTC SDKをご参照ください。
setVideoResolution
解像度の設定。
- (void)setVideoResolution:(TRTCVideoResolution)resolution;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
resolution
TRTCVideoResolution
ビデオの解像度。詳細については、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:(BOOL)enable;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
enable
BOOL
YES：オン、NO：オフ。
説明：
有効化すると、onUserVolumeUpdateの中でSDKの音量のボリュームに対する評価を取得できます。
setAudioPlayVolume
再生音量の設定。
- (void)setAudioPlayVolume:(NSInteger)volume;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
volume
int
再生音量、0～100、 デフォルト100。
setAudioCaptureVolume
マイクの集音音量設定。
- (void)setAudioCaptureVolume:(NSInteger)volume;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
volume
int
集音音量、0～100、 デフォルト100。
startFileDumping
録音の開始。
- (void)startFileDumping:(TRTCAudioRecordingParams *)params;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
params
TRTCAudioRecordingParams
録音パラメータ。詳細については、TRTC SDKをご参照ください。
説明：
この方法で呼び出した後、 SDKは通話プロセスの中のすべての音声（ローカル音声、リモート音声、BGMなど）を1つのファイルにレコーディングします。ルームに参加しているか否かにかかわらず、このインターフェースを呼び出せば有効となります。leaveRoomを呼び出した時に録音中であれば、録音は自動的に停止します。
stopFileDumping
録音の停止。
- (void)stopFileDumping;
SDKバージョンインターフェースの取得
getSdkVersion
SDKバージョン情報を取得します。
- (NSInteger)getSdkVersion;
エラーイベントコールバック
onError
- (void)onError:(NSInteger)code message:(NSString *)message;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
code
NSInteger
エラーコード。
message
NSString
エラー情報。
基本イベントコールバック
onDestroyRoom
ルーム解散のコールバックです。
- (void)onDestroyRoom;
onUserVoiceVolume
ユーザー音量の大きさのコールバック。
- (void)onUserVoiceVolume:(NSString *)userId volume:(NSInteger)volume;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
volume
NSInteger
ユーザーの音量の大きさ。値の範囲は0～100。
onRoomMasterChanged
キャスター変更のコールバック。
- (void)onRoomMasterChanged:(NSString *)previousUserId
              currentUserId:(NSString *)currentUserId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
previousUserId
NSString
変更前のキャスターユーザーID。
currentUserId
NSString
変更後のキャスターユーザーID。
リモートユーザーコールバックイベント
onRemoteUserEnter
リモートユーザー入室コールバック。
- (void)onRemoteUserEnter:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
onRemoteUserLeave
リモートユーザー退室コールバック。
- (void)onRemoteUserLeave:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
onRemoteUserCameraAvailable
リモートユーザーが、カメラ、ビデオを起動しているかどうか。
- (void)onRemoteUserCameraAvailable:(NSString *)userId
                          available:(BOOL)available;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
available
BOOL
YES：ビデオストリームデータあり、NO：ビデオストリームデータなし。
onRemoteUserScreenVideoAvailable
メンバーのビデオ共有オン/オフの通知。
- (void)onRemoteUserScreenVideoAvailable:(NSString *)userId
                               available:(BOOL)available;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
available
BOOL
画面共有ストリームデータの有無。
onRemoteUserAudioAvailable
リモートユーザーがオーディオアップストリームを開始したかどうかのコールバック。
- (void)onRemoteUserAudioAvailable:(NSString *)userId
                         available:(BOOL)available;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
available
BOOL
オーディオデータの有無。
onRemoteUserEnterSpeechState
リモートユーザーが発言を開始します。
- (void)onRemoteUserEnterSpeechState:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
onRemoteUserExitSpeechState
リモートユーザーが発言を終了します。
- (void)onRemoteUserExitSpeechState:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
チャットルームメッセージイベントコールバック
onReceiveChatMessage
テキストメッセージの受信。
- (void)onReceiveChatMessage:(NSString *)userId message:(NSString *)message;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
message
NSString
テキストメッセージ。
フィールドコントロールメッセージコールバック
onReceiveSpeechInvitation
ユーザーがキャスターの発言要請を受信する場合のコールバック。
- (void)onReceiveSpeechInvitation:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
キャスターユーザーID。
onReceiveInvitationCancelled
ユーザーがキャスターの発言要請キャンセルを受信する場合のコールバック。
- (void)onReceiveInvitationCancelled:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
キャスターユーザーID。
OnReceiveSpeechApplication
キャスターがユーザーの発言申請を受信する場合のコールバック。
void onReceiveSpeechApplication(String userId);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
onSpeechApplicationCancelled
ユーザーが発言申請をキャンセルする場合のコールバック。
- (void)onSpeechApplicationCancelled:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
onSpeechApplicationForbidden
キャスターが発言申請を禁止する場合のコールバック。
- (void)onSpeechApplicationForbidden:(BOOL)isForbidden userId:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
isForbidden
BOOL
禁止するかどうか。
userId
NSString
ユーザーID。
onOrderedToExitSpeechState
参加者が発言を停止するようリクエストされる場合のコールバック。
- (void)onOrderedToExitSpeechState:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
キャスターユーザーID。
onCallingRollStarted
キャスターが点呼を開始し、参加者が受信する場合のコールバック。
- (void)onCallingRollStarted:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
キャスターユーザーID。
onCallingRollStopped
キャスターが点呼を終了し、参加者が受信する場合のコールバック。
- (void)onCallingRollStopped:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
キャスターユーザーID。
onMemberReplyCallingRoll
参加者が点呼に応答し、キャスターが受信する場合のコールバック。
- (void)onMemberReplyCallingRoll:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
ユーザーID。
onChatRoomMuted
キャスターがチャットルームのミュートを変更する場合のコールバック。
- (void)onChatRoomMuted:(BOOL)muted userId:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
muted
BOOL
無効にするかどうか。
userId
NSString
キャスターユーザーID。
onMicrophoneMuted
キャスターがマイクの無効化を設定する場合のコールバック。
- (void)onMicrophoneMuted:(BOOL)muted userId:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
muted
BOOL
無効にするかどうか。
userId
NSString
キャスターユーザーID。
onCameraMuted
キャスターがカメラの無効化を設定する場合のコールバック。
- (void)onCameraMuted:(BOOL)muted userId:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
muted
BOOL
無効にするかどうか。
userId
NSString
キャスターユーザーID。
onReceiveKickedOff
キャスターによるキックアウトのコールバック。
- (void)onReceiveKickedOff:(NSString *)userId;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
userId
NSString
キャスター/管理者ユーザーID。
統計および品質コールバック
onStatistics
技術指標統計のコールバック。
- (void)onStatistics:(TRTCStatistics *)statistics;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
statis
TRTCStatistics
統計データ。
onNetworkQuality
ネットワーク状況のコールバック。
- (void)onNetworkQuality:(TRTCQualityInfo *)localQuality remoteQuality:(NSArray<TRTCQualityInfo *> *)remoteQuality;
﻿
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
localQuality
TRTCQualityInfo
アップストリームネットワークの品質。
remoteQuality
NSArray<TRTCQualityInfo *>
ダウンストリームネットワークの品質。
説明：
詳細については、TRTC SDKをご参照ください。
画面共有イベントコールバック
onScreenCaptureStarted
画面共有開始のコールバック。
 - (void)onScreenCaptureStarted;
onScreenCaptureStopped
画面共有停止のコールバック。
- (void)onScreenCaptureStopped:(NSInteger)reason;
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
reason
NSInteger
停止の理由。0：ユーザーの自発的な停止。1：その他のアプリケーションに占有されたことによる停止。

お問い合わせ

カスタマーサービスをご提供できるため、ぜひお気軽にお問い合わせくださいませ。

テクニカルサポート

さらにサポートが必要な場合は、サポートチケットを送信して弊社サポートチームにお問い合わせください。24時間365日のサポートをご提供します。

電話サポート（24 時間365日対応）

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

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

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

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

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

API	説明
muteUserMicrophone	特定ユーザーのマイクを無効化/再有効化します。
muteAllUsersMicrophone	全ユーザーのマイクを無効化/再有効化し、ステータスをルーム情報に同期させます。
muteUserCamera	特定ユーザーのカメラを無効化/再有効化します。
muteAllUsersCamera	全ユーザーのカメラを無効化/再有効化し、ステータスをルーム情報に同期させます。
muteChatRoom	チャットルームのミュートを開始/停止します（キャスターが呼び出し）。
kickOffUser	ルーム内の特定ユーザーをリムーブします（キャスターが呼び出し）。
startCallingRoll	キャスターが点呼を開始します。
stopCallingRoll	キャスターが点呼を終了します。
replyCallingRoll	参加者がキャスターの点呼に応答します。
sendSpeechInvitation	キャスターが参加者の発言を要請します。
cancelSpeechInvitation	キャスターが参加者の発言要請をキャンセルします。
replySpeechInvitation	参加者がキャスターの発言申請に同意/拒否します。
sendSpeechApplication	参加者が発言を申請します。
replySpeechApplication	キャスターが参加者の発言申請に同意/拒否します。
forbidSpeechApplication	キャスターが発言申請を禁止します。
sendOffSpeaker	キャスターが参加者に発言を停止するよう命令します。
sendOffAllSpeakers	キャスターが全員に発言を停止するよう命令します。
exitSpeechState	参加者は発言を停止し、視聴者になります。

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

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

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

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

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

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

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

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

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

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

パラメータ	タイプ	意味
delegate	TUIRoomCoreDelegate	イベントコールバッククラスを受信します。

tencent cloud

サインアップ

ログイン

Recent Pages

TUIRoom API（iOS）

TUIRoom API概要

TUIRoomCore基本関数

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

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

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

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

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

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

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

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

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

TUIRoomCoreDelegate API概要

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

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

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

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

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

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

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

TUIRoomCore基本関数

getInstance

destroyInstance

setDelegate

createRoom

destroyRoom

enterRoom

leaveRoom

getRoomInfo

getRoomUsers

getUserInfo

setSelfProfile

transferRoomMaster

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

startCameraPreview

stopCameraPreview

startLocalAudio

stopLocalAudio

setVideoMirror

setSpeaker

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

startRemoteView

stopRemoteView

switchCamera

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

sendChatMessage

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

muteUserMicrophone

muteAllUsersMicrophone

muteUserCamera

muteAllUsersCamera

muteChatRoom

kickOffUser

startCallingRoll

stopCallingRoll

replyCallingRoll

sendSpeechInvitation

cancelSpeechInvitation

replySpeechInvitation

sendSpeechApplication

cancelSpeechApplication

replySpeechApplication

forbidSpeechApplication

sendOffSpeaker

sendOffAllSpeakers

exitSpeechState

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

startScreenCapture

stopScreenCapture

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

getBeautyManager

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

setVideoQosPreference

setAudioQuality

setVideoResolution

setVideoFps