API | 説明 |
シングルトンオブジェクトを取得します。 | |
シングルトンオブジェクトを廃棄します。 | |
イベントコールバックを設定します。 | |
イベントのコールバックが配置されているスレッドを設定します。 | |
ログイン。 | |
ログアウト。 | |
個人情報を修正します。 |
API | 説明 |
ルームの作成(管理者が呼び出し)。ルームが存在しない場合は、システムが新しいルームを自動的に作成します。 | |
ルームの破棄(管理者が呼び出し)。 | |
入室(リスナーが呼び出し)。 | |
退室(リスナーが呼び出し)。 | |
ルームリストの詳細情報を取得します。 | |
指定されたuserIdのユーザー情報を取得します。nilの場合は、ルーム内全員の情報を取得します。 |
API | 説明 |
マイクの集音開始。 | |
マイクの集音停止。 | |
音質の設定。 | |
ローカルオーディオミュートの開始/停止。 | |
スピーカーの起動設定。 | |
マイクの集音音量設定。 | |
再生音量の設定。 | |
インイヤーモニタリングのオン/オフ。 |
API | 説明 |
指定メンバーをミュート/ミュート解除。 | |
全メンバーをミュート/ミュート解除。 |
API | 説明 |
API | 説明 |
ルーム内でのテキストメッセージのブロードキャスト。通常、弾幕によるチャットに使用します。 | |
カスタマイズしたテキストメッセージを送信します。 |
API | 説明 |
ユーザーに招待を送信。 | |
招待の同意。 | |
招待の辞退。 | |
招待の取り消し。 |
API | 説明 |
エラーのコールバック。 | |
警告のコールバック。 | |
Logコールバック。 |
API | 説明 |
ルームが廃棄された時のコールバック。 | |
ボイスチャットルーム情報変更のコールバック。 | |
ユーザー通話音量のコールバック。 |
API | 説明 |
全量のマイクリストの変更。 | |
発言者のメンバーがいます(ユーザーが発言者になります/管理者が視聴者を発言できるように招待)。 | |
視聴者のメンバーがいます(ユーザーが視聴者になる/管理者がキックアウトしてマイク・オフ)。 | |
管理者のマイクミュート。 | |
ユーザーのマイクがミュートされているかどうか。 | |
管理者のマイククローズ。 |
API | 説明 |
リスナー入室通知の受信。 | |
リスナー退室通知の受信。 |
API | 説明 |
テキストメッセージを受信します。 | |
カスタムメッセージを受信します。 |
API | 説明 |
新規招待リクエストを受信。 | |
被招待者が招待に同意。 | |
被招待者が招待を拒否。 | |
招待者が招待を取り消し。 |
/*** TRTCVoiceRoom シングルトンオブジェクトの取得** - returns: TRTCVoiceRoom インスタンス* - note: {@link TRTCVoiceRoom#destroySharedInstance()}を呼び出してシングルトンオブジェクトを破棄することができます*/+ (instancetype)sharedInstance NS_SWIFT_NAME(shared());
/*** TRTCVoiceRoom のシングルトンオブジェクトの破棄** - note: インスタンスの破棄後は、外部にキャッシュされたTRTCVoiceRoomインスタンスの再使用ができません。改めて {@link TRTCVoiceRoom#sharedInstance()} を呼び出し、インスタンスを新規取得する必要があります*/+ (void)destroySharedInstance NS_SWIFT_NAME(destroyShared());
/*** コンポーネントコールバックインターフェースの設定** TRTCVoiceRoomDelegate によって TRTCVoiceRoom の各種ステータス通知を取得することができます** - parameter delegateコールバックインターフェース* - note: TRTCVoiceRoomのコールバックイベントは、デフォルトではMain Queueでコールバックされます。イベントのコールバックが配置されているキューを指定する必要がある場合は、 {@link TRTCVoiceRoom#setDelegateQueue(queue)}を使用することができます*/- (void)setDelegate:(id<TRTCVoiceRoomDelegate>)delegate NS_SWIFT_NAME(setDelegate(delegate:));
/*** イベントコールバックが配置されているキューの設定** - parameter queueキュー,TRTCVoiceRoomの各種ステータス通知コールバックは、指定したqueueに発信されます。*/- (void)setDelegateQueue:(dispatch_queue_t)queue NS_SWIFT_NAME(setDelegateQueue(queue:));
パラメータ | タイプ | 意味 |
queue | dispatch_queue_t | TRTCVoiceRoomの各種ステータス通知は、指定したスレッドキューに発信されます。 |
- (void)login:(int)sdkAppIDuserId:(NSString *)userIduserSig:(NSString *)userSigcallback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(login(sdkAppID:userId:userSig:callback:));
パラメータ | タイプ | 意味 |
sdkAppId | int | |
userId | NSString | 現在のユーザーID。文字列タイプでは、英語のアルファベット(a-zとA-Z)、数字(0-9)、ハイフン(-)とアンダーライン(_)のみ使用できます。 |
userSig | NSString | |
callback | ActionCallback | ログインのコールバック。成功時にcodeは0になります。 |
- (void)logout:(ActionCallback _Nullable)callback NS_SWIFT_NAME(logout(callback:));
パラメータ | タイプ | 意味 |
callback | ActionCallback | ログアウトのコールバック。成功時にcodeは0になります。 |
- (void)setSelfProfile:(NSString *)userName avatarURL:(NSString *)avatarURL callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(setSelfProfile(userName:avatarURL:callback:));
パラメータ | タイプ | 意味 |
userName | NSString | ニックネーム。 |
avatarURL | NSString | プロフィール画像のアドレス。 |
callback | ActionCallback | 個人情報設定のコールバック。成功時にcodeは0になります。 |
- (void)createRoom:(int)roomID roomParam:(VoiceRoomParam *)roomParam callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(createRoom(roomID:roomParam:callback:));
パラメータ | タイプ | 意味 |
roomId | int | ルームIDです。ご自身でアサインし、一元管理してください。複数のroomIDを、1つのボイスチャットルームリストにまとめることができます。Tencent Cloudでは現在、ボイスチャットルームリストの管理サービスを行っていませんので、ご自身でボイスチャットルームリストを管理してください。 |
roomParam | VoiceRoomParam | ルーム情報は、ルーム名、マイク情報、カバー情報など、ルームを説明するために用いる情報に使用します。マイク管理が必要な場合は、ルームのマイク数を入力してください。 |
callback | ActionCallback | ルームの新規作成結果のコールバック。成功時にcodeは0になります。 |
createRoom
を呼び出して新しいボイスチャットルームを作成します。この時にルームID、マイク・オンに管理者の確認の要否、マイク数などルームのプロパティ情報を渡します。enterSeat
を呼び出して参加します。onSeatListChange
マイクリスト変更イベント通知を受信します。この時、マイクリスト変更をUI上に更新することができます。onAnchorEnterSeat
というイベント通知も受信します。この時、マイク集音は自動的に開始されます。- (void)destroyRoom:(ActionCallback _Nullable)callback NS_SWIFT_NAME(destroyRoom(callback:));
パラメータ | タイプ | 意味 |
callback | ActionCallback | ルームの廃棄結果のコールバック。成功時にcodeは0になります。 |
- (void)enterRoom:(NSInteger)roomID callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(enterRoom(roomID:callback:));
パラメータ | タイプ | 意味 |
roomId | NSInteger | ルームID。 |
callback | ActionCallback | 入室結果のコールバック。成功時にcodeは0になります。 |
enterRoom
を呼び出してルームナンバーを渡すと、そのルームに参加できます。onRoomInfoChange
ルーム属性変更イベント通知を受信します。この時、ルーム属性を記録し、それに応じた修正を行うことができます。例:UIに表示するルーム名、発言者にする際の管理者への同意リクエストの要否の記録など。onSeatListChange
マイクリスト変更イベント通知を受信します。この時にマイクリストの変更をUI上に更新することができます。onAnchorEnterSeat
のイベント通知も受信します。- (void)exitRoom:(ActionCallback _Nullable)callback NS_SWIFT_NAME(exitRoom(callback:));
パラメータ | タイプ | 意味 |
callback | ActionCallback | 退室結果のコールバック。成功時にcodeは0になります。 |
createRoom()
作成時にroomInfoによって設定したものになります。- (void)getRoomInfoList:(NSArray<NSNumber *> *)roomIdList callback:(VoiceRoomInfoCallback _Nullable)callback NS_SWIFT_NAME(getRoomInfoList(roomIdList:callback:));
パラメータ | タイプ | 意味 |
roomIdList | NSArray<NSNumber> | ルームナンバーリスト。 |
callback | RoomInfoCallback | ルーム詳細情報のコールバック。 |
- (void)getUserInfoList:(NSArray<NSString *> * _Nullable)userIDList callback:(VoiceRoomUserListCallback _Nullable)callback NS_SWIFT_NAME(getUserInfoList(userIDList:callback:));
パラメータ | タイプ | 意味 |
userIdList | NSArray<NSString> | 取得すべきユーザーIDリスト。nullの場合は、ルーム内全員の情報を取得します。 |
userlistcallback | UserListCallback | ユーザーの詳細情報のコールバック。 |
onSeatListChange
および onAnchorEnterSeat
というイベント通知を受信します。- (void)enterSeat:(NSInteger)seatIndex callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(enterSeat(seatIndex:callback:));
パラメータ | タイプ | 意味 |
seatIndex | NSInteger | マイク・オンの必要があるマイク番号。 |
callback | ActionCallback | 操作コールバック。 |
sendInvitation
を呼び出してから管理者に申請し、onInvitationAccept
を受信するとこの関数を呼び出せるようになります。onSeatListChange
、onAnchorLeaveSeat
、onAnchorEnterSeat
のイベント通知を受け取ります。(キャスターが呼び出した後に変更できるのは、マイクのシート番号情報のみで、ユーザーのキャスターロールを切り替えることはできません。)- (NSInteger)moveSeat:(NSInteger)seatIndex callback:(ActionCallback _Nullable)callbackNS_SWIFT_NAME(moveSeat(seatIndex:callback:))
パラメータ | タイプ | 意味 |
seatIndex | NSInteger | 移動の必要があるマイク番号。 |
callback | ActionCallback | 操作コールバック。 |
戻り値 | タイプ | 意味 |
code | NSInteger | マイク移動操作の結果(0は成功、その他は失敗、10001はインターフェース呼び出し頻度制限)。 |
sendInvitation
を呼び出してから管理者に申請し、onInvitationAccept
を受信するとこの関数を呼び出せるようになります。onSeatListChange
およびonAnchorLeaveSeat
というイベント通知を受信します。- (void)leaveSeat:(ActionCallback _Nullable)callback NS_SWIFT_NAME(leaveSeat(callback:));
パラメータ | タイプ | 意味 |
callback | ActionCallback | 操作コールバック。 |
onSeatListChange
とonAnchorEnterSeat
というイベント通知を受信します。- (void)pickSeat:(NSInteger)seatIndex userId:(NSString *)userId callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(pickSeat(seatIndex:userId:callback:));
パラメータ | タイプ | 意味 |
seatIndex | NSInteger | マイク・オンの必要があるマイク番号。 |
userId | NSString | ユーザーID。 |
callback | ActionCallback | 操作コールバック。 |
sendInvitation
を呼び出してからリスナーに申請し、onInvitationAccept
を受信すると、この関数を呼び出せるようになります。onSeatListChange
およびonAnchorLeaveSeat
というイベント通知を受信します。- (void)kickSeat:(NSInteger)seatIndex callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(kickSeat(seatIndex:callback:));
パラメータ | タイプ | 意味 |
seatIndex | NSInteger | キックアウトしてマイク・オフの必要があるマイク番号。 |
callback | ActionCallback | 操作コールバック。 |
onSeatListChange
およびonSeatMute
というイベント通知を受信します。- (void)muteSeat:(NSInteger)seatIndex isMute:(BOOL)isMute callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(muteSeat(seatIndex:isMute:callback:));
パラメータ | タイプ | 意味 |
seatIndex | NSInteger | 操作が必要なマイク番号。 |
isMute | BOOL | YES:該当するマイクのミュート;NO:該当するマイクのミュート解除。 |
callback | ActionCallback | 操作コールバック。 |
onSeatListChange
およびonSeatClose
というイベント通知を受信します。- (void)closeSeat:(NSInteger)seatIndex isClose:(BOOL)isClose callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(closeSeat(seatIndex:isClose:callback:));
パラメータ | タイプ | 意味 |
seatIndex | NSInteger | 操作が必要なマイク番号。 |
isClose | BOOL | YES:該当するマイクのクローズ; NO:該当するマイクのクローズ解除。 |
callback | ActionCallback | 操作コールバック。 |
- (void)startMicrophone;
- (void)stopMicrophone;
- (void)setAuidoQuality:(NSInteger)quality NS_SWIFT_NAME(setAuidoQuality(quality:));
パラメータ | タイプ | 意味 |
quality | NSInteger |
- (void)muteLocalAudio:(BOOL)mute NS_SWIFT_NAME(muteLocalAudio(mute:));
パラメータ | タイプ | 意味 |
mute | BOOL |
- (void)setSpeaker:(BOOL)userSpeaker NS_SWIFT_NAME(setSpeaker(userSpeaker:));
パラメータ | タイプ | 意味 |
useSpeaker | BOOL | YES:スピーカー;NO:ヘッドホン。 |
- (void)setAudioCaptureVolume:(NSInteger)voluem NS_SWIFT_NAME(setAudioCaptureVolume(volume:));
パラメータ | タイプ | 意味 |
volume | NSInteger | 集音音量、0 - 100、デフォルト100。 |
- (void)setAudioPlayoutVolume:(NSInteger)volume NS_SWIFT_NAME(setAudioPlayoutVolume(volume:));
パラメータ | タイプ | 意味 |
volume | NSInteger | 再生音量、0 - 100、デフォルト100。 |
- (void)muteRemoteAudio:(NSString *)userId mute:(BOOL)mute NS_SWIFT_NAME(muteRemoteAudio(userId:mute:));
パラメータ | タイプ | 意味 |
userId | NSString | 指定のユーザーID。 |
mute | BOOL | YES:ミュート起動;NO:ミュート停止。 |
- (void)muteAllRemoteAudio:(BOOL)isMute NS_SWIFT_NAME(muteAllRemoteAudio(isMute:));
パラメータ | タイプ | 意味 |
mute | BOOL | YES:ミュート起動;NO:ミュート停止。 |
- (void)setVoiceEarMonitorEnable:(BOOL)enable NS_SWIFT_NAME(setVoiceEarMonitor(enable:));
パラメータ | タイプ | 意味 |
enable | BOOL | YES:インイヤーモニタリング起動;NO:インイヤーモニタリング停止。 |
- (TXAudioEffectManager * _Nullable)getAudioEffectManager;
- (void)sendRoomTextMsg:(NSString *)message callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(sendRoomTextMsg(message:callback:));
パラメータ | タイプ | 意味 |
message | NSString | テキストメッセージ。 |
callback | ActionCallback | 送信結果のコールバック。 |
- (void)sendRoomCustomMsg:(NSString *)cmd message:(NSString *)message callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(sendRoomCustomMsg(cmd:message:callback:));
パラメータ | タイプ | 意味 |
cmd | NSString | コマンドワードです。開発者がカスタマイズするものであり、主にさまざまなメッセージタイプを区別するために使用されます。 |
message | NSString | テキストメッセージ。 |
callback | ActionCallback | 送信結果のコールバック。 |
- (NSString *)sendInvitation:(NSString *)cmduserId:(NSString *)userIdcontent:(NSString *)contentcallback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(sendInvitation(cmd:userId:content:callback:));
パラメータ | タイプ | 意味 |
cmd | NSString | 業務カスタマイズコマンド。 |
userId | NSString | 招待するユーザーID。 |
content | NSString | 招待するコンテンツ。 |
callback | ActionCallback | 送信結果のコールバック。 |
戻り値 | タイプ | 意味 |
inviteId | NSString | 今回の招待IDの識別に使用。 |
- (void)acceptInvitation:(NSString *)identifier callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(acceptInvitation(id:callback:));
パラメータ | タイプ | 意味 |
id | NSString | 招待ID。 |
callback | ActionCallback | 送信結果のコールバック。 |
- (void)rejectInvitation:(NSString *)identifier callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(rejectInvitation(id:callback:));
パラメータ | タイプ | 意味 |
id | NSString | 招待ID。 |
callback | ActionCallback | 送信結果のコールバック。 |
- (void)cancelInvitation:(NSString *)identifier callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(cancelInvitation(id:callback:));
パラメータ | タイプ | 意味 |
id | NSString | 招待ID。 |
callback | ActionCallback | 送信結果のコールバック。 |
- (void)onError:(int)codemessage:(NSString*)messageNS_SWIFT_NAME(onError(code:message:));
パラメータ | タイプ | 意味 |
code | int | エラーコード。 |
message | NSString | エラー情報。 |
- (void)onWarning:(int)codemessage:(NSString *)messageNS_SWIFT_NAME(onWarning(code:message:));
パラメータ | タイプ | 意味 |
code | int | エラーコード。 |
message | NSString | 警告メッセージ。 |
- (void)onDebugLog:(NSString *)messageNS_SWIFT_NAME(onDebugLog(message:));
パラメータ | タイプ | 意味 |
message | NSString | ログ情報。 |
- (void)onRoomDestroy:(NSString *)roomIdNS_SWIFT_NAME(onRoomDestroy(roomId:));
パラメータ | タイプ | 意味 |
roomId | NSString | ルーム ID。 |
- (void)onRoomInfoChange:(VoiceRoomInfo *)roomInfoNS_SWIFT_NAME(onRoomInfoChange(roomInfo:));
パラメータ | タイプ | 意味 |
roomInfo | VoiceRoomInfo | ルーム情報。 |
- (void)onUserMicrophoneMute:(NSString *)userId mute:(BOOL)muteNS_SWIFT_NAME(onUserMicrophoneMute(userId:mute:));
パラメータ | タイプ | 意味 |
userId | NSString | ユーザーID。 |
mute | BOOL | YES:マイクミュート; NO:ミュート解除。 |
- (void)onUserVolumeUpdate:(NSArray<TRTCVolumeInfo *> *)userVolumes totalVolume:(NSInteger)totalVolumeNS_SWIFT_NAME(onUserVolumeUpdate(userVolumes:totalVolume:));
パラメータ | タイプ | 意味 |
userVolumes | NSArray | ユーザーリスト。 |
totalVolume | NSInteger | 音量の大きさ。値:0 - 100。 |
- (void)onSeatInfoChange:(NSArray<VoiceRoomSeatInfo *> *)seatInfolistNS_SWIFT_NAME(onSeatListChange(seatInfoList:));
パラメータ | タイプ | 意味 |
seatInfoList | NSArray<VoiceRoomSeatInfo> | 全量のマイクリスト。 |
- (void)onAnchorEnterSeat:(NSInteger)indexuser:(VoiceRoomUserInfo *)userNS_SWIFT_NAME(onAnchorEnterSeat(index:user:));
パラメータ | タイプ | 意味 |
index | NSInteger | メンバーがマイク・オンするマイク。 |
user | VoiceRoomUserInfo | マイク・オンユーザーの詳細情報。 |
- (void)onAnchorLeaveSeat:(NSInteger)indexuser:(VoiceRoomUserInfo *)userNS_SWIFT_NAME(onAnchorLeaveSeat(index:user:));
パラメータ | タイプ | 意味 |
index | NSInteger | マイク・オフのマイク。 |
user | VoiceRoomUserInfo | マイク・オンユーザーの詳細情報。 |
- (void)onSeatMute:(NSInteger)indexisMute:(BOOL)isMuteNS_SWIFT_NAME(onSeatMute(index:isMute:));
パラメータ | タイプ | 意味 |
index | NSInteger | 操作するマイク。 |
isMute | BOOL | YES:マイクミュート; NO:ミュート解除。 |
- (void)onSeatClose:(NSInteger)indexisClose:(BOOL)isCloseNS_SWIFT_NAME(onSeatClose(index:isClose:));
パラメータ | タイプ | 意味 |
index | NSInteger | 操作するマイク。 |
isClose | BOOL | YES:マイクのクローズ; NO: マイクのクローズ解除。 |
- (void)onAudienceEnter:(VoiceRoomUserInfo *)userInfoNS_SWIFT_NAME(onAudienceEnter(userInfo:));
パラメータ | タイプ | 意味 |
userInfo | VoiceRoomUserInfo | 入室したリスナーの情報。 |
- (void)onAudienceExit:(VoiceRoomUserInfo *)userInfoNS_SWIFT_NAME(onAudienceExit(userInfo:));
パラメータ | タイプ | 意味 |
userInfo | VoiceRoomUserInfo | 退室したリスナーの情報。 |
- (void)onRecvRoomTextMsg:(NSString *)messageuserInfo:(VoiceRoomUserInfo *)userInfoNS_SWIFT_NAME(onRecvRoomTextMsg(message:userInfo:));
パラメータ | タイプ | 意味 |
message | NSString | テキストメッセージ。 |
userInfo | VoiceRoomUserInfo | 送信者のユーザー情報。 |
- (void)onRecvRoomCustomMsg:(NSString *)commandmessage:(NSString *)messageuserInfo:(VoiceRoomUserInfo *)userInfoNS_SWIFT_NAME(onRecvRoomCustomMsg(command:message:userInfo:));
パラメータ | タイプ | 意味 |
command | NSString | コマンドワードです。開発者がカスタマイズするものであり、主にさまざまなメッセージタイプを区別するために使用されます。 |
message | NSString | テキストメッセージ。 |
userInfo | VoiceRoomUserInfo | 送信者のユーザー情報。 |
- (void)onReceiveNewInvitation:(NSString *)identifierinviter:(NSString *)invitercmd:(NSString *)cmdcontent:(NSString *)contentNS_SWIFT_NAME(onReceiveNewInvitation(id:inviter:cmd:content:));
パラメータ | タイプ | 意味 |
id | NSString | 招待ID。 |
inviter | NSString | 招待者のユーザーID。 |
cmd | NSString | 開発者がカスタマイズする業務指定のコマンドワードです。 |
content | NSString | 業務指定のコンテンツ。 |
- (void)onInviteeAccepted:(NSString *)identifierinvitee:(NSString *)inviteeNS_SWIFT_NAME(onInviteeAccepted(id:invitee:));
パラメータ | タイプ | 意味 |
id | NSString | 招待ID。 |
invitee | NSString | 被招待者のユーザーID。 |
- (void)onInviteeRejected:(NSString *)identifierinvitee:(NSString *)inviteeNS_SWIFT_NAME(onInviteeRejected(id:invitee:));
パラメータ | タイプ | 意味 |
id | NSString | 招待ID。 |
invitee | NSString | 被招待者のユーザーID。 |
- (void)onInvitationCancelled:(NSString *)identifierinvitee:(NSString *)invitee NS_SWIFT_NAME(onInvitationCancelled(id:invitee:));
パラメータ | タイプ | 意味 |
id | NSString | 招待ID。 |
inviter | NSString | 招待者のユーザーID。 |
この記事はお役に立ちましたか?