TRTCChatSalon(iOS)

最終更新日:2021-10-12 09:40:10

    TRTCChatSalonは、Tencent CloudのTRTCおよびIMサービスを基に組み合わせたコンポーネントで、以下の機能をサポートしています。

    • 管理者は新しいボイスサロンを作成して配信を開始し、リスナーはボイスサロンに参加して視聴/インタラクションを行います。
    • 管理者は、リスナーをマイク・オンに招待したり、マイク・オンのキャスターをキックアウトしたりすることもできます。
    • リスナーはマイク・オンを申請して、マイク・オンのキャスターになり、他者と音声インタラクションを行うことができます。また、いつでもマイク・オフにして、通常のリスナーになることも可能です。
    • 各種のテキストメッセージやカスタムメッセージの送信をサポートします。カスタムメッセージは弾幕、「いいね」、ギフトなどを実装するために使用することができます。

    TRTCChatSalonは、オープンソースのClassであり、Tencent Cloudの2つのクローズドソースであるSDKに依存しています。具体的な実装プロセスについては、ボイスサロン(iOS)をご参照ください。

    • TRTC SDK:TRTC SDKを低遅延のボイスチャットコンポーネントとして使用します。
    • IM SDK:IM SDKのAVChatroomを使用してチャットルーム機能を実装します。同時にIMの属性インターフェースによって、マイクリストなどのルーム情報を保存し、招待シグナリングはマイク・オン/ピックのリクエストに用いることができます。

    TRTCChatSalon API概要

    SDK基本関数

    API 説明
    sharedInstance シングルトンオブジェクトを取得します。
    destroySharedInstance シングルトンオブジェクトを廃棄します。
    setDelegate イベントコールバックを設定します。
    delegateQueue イベントコールバックが配置されているスレッドを設定します。
    login ログイン。
    logout ログアウト。
    setSelfProfile 個人情報を修正します。

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

    API 説明
    createRoom ルームの作成(管理者が呼び出し)。ルームが存在しない場合は、システムが新しいルームを自動的に作成します。
    destroyRoom ルームの破棄(管理者が呼び出し)。
    enterRoom 入室(リスナーが呼び出し)。
    exitRoom 退室(リスナーが呼び出し)。
    getRoomInfoList ルームリストの詳細情報を取得します。
    getUserInfoList 指定されたuserIdのユーザー情報を取得します。nilの場合は、ルーム内全員の情報を取得します。

    マイクのオン・オフインターフェース

    API 説明
    enterSeat ユーザーが発言者になる(リスナー側/管理者ともに呼び出し可)。
    leaveSeat ユーザーが視聴者になる(キャスターが呼び出し)。
    pickSeat 視聴者が発言できるように招待(管理者が呼び出し)。
    kickSeat キックアウトしてマイク・オフ(管理者が呼び出し)。

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

    API 説明
    startMicrophone マイクの集音開始。
    stopMicrophone マイクの集音停止。
    setAudioQuality 音質の設定。
    muteLocalAudio ローカルオーディオミュートの開始/停止。
    setSpeaker スピーカーの起動設定。
    setAudioCaptureVolume マイクの集音音量設定。
    setAudioPlayoutVolume 再生音量の設定。

    リモートユーザー音声操作インターフェース

    API 説明
    muteRemoteAudio 指定メンバーをミュート/ミュート解除。
    muteAllRemoteAudio 全メンバーをミュート/ミュート解除。

    BGMサウンドエフェクト関連インターフェース

    API 説明
    getAudioEffectManager バックグラウンド・サウンドエフェクト管理オブジェクトTXAudioEffectManagerの取得。

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

    API 説明
    sendRoomTextMsg ルーム内でのテキストメッセージのブロードキャスト。通常、弾幕によるチャットに使用します。
    sendRoomCustomMsg カスタマイズしたテキストメッセージを送信します。

    招待シグナリング関連インターフェース

    API 説明
    sendInvitation ユーザーに招待を送信。
    acceptInvitation 招待の同意。
    rejectInvitation 招待の辞退。
    cancelInvitation 招待の取り消し。

    TRTCChatSalonDelegate API概要

    一般的なイベントコールバック

    API 説明
    onError エラーのコールバック。
    onWarning 警告のコールバック。
    onDebugLog Logコールバック。

    ルームイベントのコールバック

    API 説明
    onRoomDestroy ルームが破棄された時のコールバック。
    onRoomInfoChange ボイスサロン情報変更のコールバック。
    onUserVolumeUpdate ユーザー通話音量のコールバック。

    マイク変更コールバック

    API 説明
    onAnchorEnterSeat 発言者のメンバーがいます(ユーザーが発言者になる/管理者が視聴者を発言できるように招待)。
    onAnchorLeaveSeat 視聴者のメンバーがいます(ユーザーが視聴者になる/管理者がキックアウトしてマイク・オフ)。
    onSeatMute 管理者のマイクミュート。

    リスナーの入退室イベントのコールバック

    API 説明
    onAudienceEnter リスナー入室通知の受信。
    onAudienceExit リスナー退室通知の受信。

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

    API 説明
    onRecvRoomTextMsg テキストメッセージの受信。
    onRecvRoomCustomMsg カスタムメッセージの受信。

    シグナリングイベントのコールバック

    API 説明
    onReceiveNewInvitation 新規招待リクエストの受信。
    onInviteeAccepted 被招待者が招待に同意。
    onInviteeRejected 被招待者による招待の辞退。
    onInvitationCancelled 招待者が招待を取り消し。

    SDK基本関数

    sharedInstance

    TRTCChatSalonシングルトンオブジェクトを取得します。

    /**
    * TRTCChatSalonシングルトンオブジェクトを取得します
    *
    * - returns: TRTCChatSalonインスタンス
    * - note: {@link TRTCChatSalon#destroySharedInstance()}を呼び出してシングルトンオブジェクトを廃棄することができます
    */
    + (instancetype)sharedInstance NS_SWIFT_NAME(shared());
    

    destroySharedInstance

    TRTCChatSalonシングルトンオブジェクトを廃棄します。

    説明:

    インスタンスを破棄すると、外部キャッシュのTRTCChatSalonインスタンスは再利用できなくなります。あらためてsharedInstanceを呼び出し、新しいインスタンスを取得する必要があります。

    /**
    * TRTCChatSalonシングルトンオブジェクトを廃棄します
    *
    * - note: インスタンスの廃棄後、外部にキャッシュされた TRTCChatSalonインスタンスは再利用できなくなります。あらためて{@link TRTCChatSalon#sharedInstance()}を呼び出し、新しいインスタンスを取得する必要があります
    */
    + (void)destroySharedInstance NS_SWIFT_NAME(destroyShared());
    

    setDelegate

    TRTCChatSalonイベントコールバック。TRTCChatSalonDelegateを介してTRTCChatSalonの各種ステータス通知を受け取ることができます。

    /**
    * コンポーネントコールバックインターフェースの設定
    * 
    * TRTCChatSalonDelegateを介してTRTCChatSalonの各種ステータス通知を受け取ることができます
    *
    * - parameter delegateコールバックインターフェース
    * - note: TRTCChatSalonのコールバックイベントは、デフォルトではMain Queueでコールバックされます。イベントのコールバックが配置されているキューを指定する必要がある場合は、 {@link TRTCChatSalon#setDelegateQueue(queue)}を使用することができます
    */
    - (void)setDelegate:(id<TRTCChatSalonDelegate>)delegate NS_SWIFT_NAME(setDelegate(delegate:));
    
    説明:

    setDelegateはTRTCChatSalonのプロキシコールバックです。

    setDelegateQueue

    イベントコールバックが配置されているスレッドキューを設定します。デフォルトでは、メインスレッドMainQueueに送信されます。

    /**
    * イベントコールバックが配置されているキューの設定
    *
    * - parameter queueキュー、TRTCChatSalonの各種ステータス通知コールバックは、指定したqueueに発信されます。
    */
    - (void)setDelegateQueue:(dispatch_queue_t)queue NS_SWIFT_NAME(setDelegateQueue(queue:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    queue dispatch_queue_t TRTCChatSalonの各種ステータス通知は、指定したスレッドキューに発信されます。

    login

    ログイン。

    - (void)login:(int)sdkAppID
         userID:(NSString *)userID
        userSig:(NSString *)userSig
       callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(login(sdkAppID:userID:userSig:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    sdkAppId int TRTCコンソール> 【[アプリケーション管理](https://console.cloud.tencent.com/trtc/app)】>アプリケーション情報の中でSDKAppIDを確認できます。
    userId String 現在のユーザーID。文字列タイプでは、英語のアルファベット(a-zとA-Z)、数字(0-9)、ハイフン(-)とアンダーライン(_)のみ使用できます。
    userSig String Tencent Cloudによって設計されたセキュリティ保護署名。取得方法についてはUserSigの計算方法をご参照ください。
    callback ActionCallback ログインのコールバック。成功時にcodeは0になります。

    logout

    ログアウト。

    - (void)logout:(ActionCallback _Nullable)callback NS_SWIFT_NAME(logout(callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    callback ActionCallback ログアウトのコールバック。成功時にcodeは0になります。

    setSelfProfile

    個人情報の修正。

    - (void)setSelfProfile:(NSString *)userName avatarURL:(NSString *)avatarURL callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(setSelfProfile(userName:avatarURL:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userName String ニックネーム。
    avatarURL String プロフィール画像のアドレス。
    callback ActionCallback 個人情報設定のコールバック。成功時にcodeは0になります。

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

    createRoom

    ルームの作成(管理者が呼び出し)。

    - (void)createRoom:(int)roomID roomParam:(ChatSalonParam *)roomParam callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(createRoom(roomID:roomParam:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    roomId int ルームIDは、ご自身でアサインし、一元管理する必要があります。複数のroomIDを、一つのボイスサロンのルームリストにまとめることができます。Tencent Cloudでは現在、ボイスサロンのルームリストの管理サービスを行っていませんので、ご自身でボイスサロンのルームリストを管理してください。
    roomParam ChatSalonParam ルーム情報は、ルームについて説明するための情報です。例えば、ルーム名、マイク情報、カバー情報などです。
    callback ActionCallback ルームの作成結果のコールバック。成功時にcodeは0になります。

    管理者が配信を開始する際の通常の呼び出しプロセスは次のとおりです。

    1. 管理者は、createRoomを呼び出して新しいボイスサロンを作成します。この時、ルームID、マイク・オンにすることの管理者の確認の要否などルームの属性情報を渡します。
    2. 管理者は、ルーム作成に成功した後、enterSeatを呼び出して参加します。
    3. 管理者は、マイクリストのメンバーが参加したonAnchorEnterSeatというイベント通知も受信します。この時、マイク集音は自動的に開始されます。

    destroyRoom

    ルームの破棄(管理者が呼び出し)。管理者は、ルーム作成後、この関数を呼び出してルームを破棄します。

    - (void)destroyRoom:(ActionCallback _Nullable)callback NS_SWIFT_NAME(destroyRoom(callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    callback ActionCallback ルームの廃棄結果のコールバック。成功時にcodeは0になります。

    enterRoom

    入室(リスナーが呼び出し)

    - (void)enterRoom:(NSInteger)roomID callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(enterRoom(roomID:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    roomId int ルームID。
    callback ActionCallback 入室結果のコールバック。成功時にcodeは0になります。

    リスナーが入室し視聴する際の通常の呼び出しプロセスは次のとおりです。

    1. リスナーがサーバーから取得する最新のボイスサロンリストには、多くのボイスサロンのroomIdおよびルーム情報が含まれる場合があります。
    2. リスナーはボイスサロンの1つを選択し、enterRoomを呼び出してルームナンバーを渡すと、そのルームに参加できます。
    3. 入室後、コンポーネントのonRoomInfoChange ルーム属性変更イベント通知を受信します。この時、ルーム属性を記録し、それに応じた修正を行うことができます。例:UIに表示するルーム名、発言者にする際の管理者への同意リクエストの要否の記録など。
    4. 入室後に、マイクリストにキャスターが参加した onAnchorEnterSeatというイベント通知も受信します。

    exitRoom

    ルームから退出します。

    - (void)exitRoom:(ActionCallback _Nullable)callback NS_SWIFT_NAME(exitRoom(callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    callback ActionCallback 退室結果のコールバック。成功時にcodeは0になります。

    getRoomInfoList

    ルームリストの詳細情報を取得します。このうち、ルーム名、ルームカバーは、管理者がcreateRoom()作成時にroomInfoによって設定したものになります。

    説明:

    ルームリストおよびルーム情報をご自身で管理する場合は、この関数は無視してもかまいません。

    - (void)getRoomInfoList:(NSArray<NSNumber *> *)roomIdList callback:(ChatSalonInfoCallback _Nullable)callback NS_SWIFT_NAME(getRoomInfoList(roomIdList:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    roomIdList List&dxlt;Integer&dxgt; ルームナンバーリスト。
    callback ChatSalonInfoCallback ルーム詳細情報のコールバック。

    getUserInfoList

    指定されたuserIdのユーザー情報を取得します。

    - (void)getUserInfoList:(NSArray<NSString *> * _Nullable)userIDList callback:(ChatSalonUserListCallback _Nullable)callback NS_SWIFT_NAME(getUserInfoList(userIDList:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userIdList List&dxlt;String&dxgt; 取得すべきユーザーIDリスト。nullの場合は、ルーム内全員の情報を取得します。
    callback ChatSalonUserListCallback ユーザーの詳細情報のコールバック。

    マイクのオン・オフインターフェース

    enterSeat

    ユーザーが発言者になる(リスナー側/管理者ともに呼び出し可)します。

    説明:

    マイク・オンが成功した後、ルーム内の全メンバーはonAnchorEnterSeatというイベント通知を受信します。

    - (void)enterSeat:(ActionCallback _Nullable)callback
    NS_SWIFT_NAME(enterSeat(callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    callback ActionCallback 操作コールバック。

    そのインターフェースを呼び出すと、直ちにマイクリストが変更されます。リスナーが管理者に同意を申請しなければマイク・オンできないユースケースの場合は、まずsendInvitationを呼び出してから管理者に申請し、onInvitationAcceptを受信するとその関数を呼び出せるようになります。

    leaveSeat

    ユーザーが視聴者になる(キャスターが呼び出し)。

    説明:

    マイク・オフが成功した後、ルーム内の全メンバーはonAnchorLeaveSeatというイベント通知を受信します。

    - (void)leaveSeat:(ActionCallback _Nullable)callback NS_SWIFT_NAME(leaveSeat(callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    callback ActionCallback 操作コールバック。

    pickSeat

    視聴者が発言できるように招待(管理者が呼び出し)。

    説明:

    管理者が視聴者を発言できるように招待すると、ルーム内の全メンバーはonAnchorEnterSeatというイベント通知を受信します。

    - (void)pickSeat:(NSString *)userID callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(pickSeat(userID:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userID String ユーザーID 。
    callback ActionCallback 操作コールバック。

    そのインターフェースを呼び出すと、すぐにマイクリストが修正されます。管理者がリスナーの同意がなければマイク・オンできないユースケースの場合は、まずsendInvitationを呼び出してからリスナーに申請し、onInvitationAcceptを受信すると、その関数をコールできるようになります。

    kickSeat

    キックアウトしてマイク・オフ(管理者が呼び出し)。

    説明:

    管理者がキックアウトしてマイク・オフにすると、ルーム内の全メンバーは、onSeatListChangeおよびonAnchorLeaveSeatというイベント通知を受信します。

    - (void)kickSeat:(NSString *)userID callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(kickSeat(userID:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userID String キックアウトしてマイク・オフにする必要のあるユーザーID。
    callback ActionCallback 操作コールバック。

    このインターフェースを呼び出すと、すぐにマイクリストが修正されます。

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

    startMicrophone

    マイクの集音開始。

    - (void)startMicrophone;
    

    stopMicrophone

    マイクの集音停止。

    - (void)stopMicrophone;
    

    setAudioQuality

    音質の設定。

    - (void)setAuidoQuality:(NSInteger)quality NS_SWIFT_NAME(setAuidoQuality(quality:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    quality int オーディオ品質。詳細については、TRTC SDKをご参照ください。

    muteLocalAudio

    ローカルの音声のミュート/ミュート取り消し。

    - (void)muteLocalAudio:(BOOL)mute NS_SWIFT_NAME(muteLocalAudio(mute:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    mute boolean ミュート/ミュート取り消し。詳細は TRTC SDKをご参照ください。

    setSpeaker

    スピーカーの起動設定。

    - (void)setSpeaker:(BOOL)userSpeaker NS_SWIFT_NAME(setSpeaker(userSpeaker:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userSpeaker boolean true:スピーカー、false:ヘッドホン。

    setAudioCaptureVolume

    マイクの集音音量設定。

    - (void)setAudioCaptureVolume:(NSInteger)voluem NS_SWIFT_NAME(setAudioCaptureVolume(volume:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    volume int 集音音量、0 - 100、 デフォルト100。

    setAudioPlayoutVolume

    再生音量の設定。

    - (void)setAudioPlayoutVolume:(NSInteger)volume NS_SWIFT_NAME(setAudioPlayoutVolume(volume:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    volume int 再生音量、0 - 100、 デフォルト100。

    muteRemoteAudio

    指定メンバーのミュート/ミュート解除。

    - (void)muteRemoteAudio:(NSString *)userID mute:(BOOL)mute NS_SWIFT_NAME(muteRemoteAudio(userId:mute:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userID String 指定ユーザーID。
    mute boolean true:ミュート起動;false:ミュート停止。

    muteAllRemoteAudio

    全メンバーのミュート/ミュート解除。

    - (void)muteAllRemoteAudio:(BOOL)isMute NS_SWIFT_NAME(muteAllRemoteAudio(isMute:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    isMute boolean true:ミュートを起動、false:ミュートを停止。

    BGMサウンドエフェクト関連インターフェース関数

    getAudioEffectManager

    BGMサウンドエフェクト管理オブジェクト TXAudioEffectManagerの取得。

    - (TXAudioEffectManager * _Nullable)getAudioEffectManager;
    

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

    sendRoomTextMsg

    ルーム内でテキストメッセージをブロードキャストします。通常、弾幕によるチャットに使用します。

    - (void)sendRoomTextMsg:(NSString *)message callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(sendRoomTextMsg(message:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    message String テキストメッセージ。
    callback ActionCallback 送信結果のコールバック。

    sendRoomCustomMsg

    カスタマイズしたテキストメッセージを送信します。

    - (void)sendRoomCustomMsg:(NSString *)cmd message:(NSString *)message callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(sendRoomCustomMsg(cmd:message:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    cmd String コマンドワードは、開発者がカスタマイズします。主にさまざまなメッセージタイプを区別するために使用されます。
    message String テキストメッセージ。
    callback ActionCallback 送信結果のコールバック。

    招待シグナリング関連インターフェース

    sendInvitation

    ユーザーに招待を送信。

    - (NSString *)sendInvitation:(NSString *)cmd
                        userID:(NSString *)userID
                       content:(NSString *)content
                      callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(sendInvitation(cmd:userId:content:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    cmd String 業務カスタマイズコマンド。
    userID String 招待ユーザーID。
    content String 招待コンテンツ。
    callback ActionCallback 送信結果のコールバック。

    戻り値:

    戻り値 タイプ 意味
    inviteId String 今回の招待IDの識別に使用。

    acceptInvitation

    招待の同意。

    - (void)acceptInvitation:(NSString *)identifier callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(acceptInvitation(identifier:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    identifier String 招待ID。
    callback ActionCallback 送信結果のコールバック。

    rejectInvitation

    招待の拒否。

    - (void)rejectInvitation:(NSString *)identifier callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(rejectInvitation(identifier:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    identifier String 招待ID。
    callback ActionCallback 送信結果のコールバック。

    cancelInvitation

    招待の取り消し。

    - (void)cancelInvitation:(NSString *)identifier callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(cancelInvitation(identifier:callback:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    identifier String 招待ID。
    callback ActionCallback 送信結果のコールバック。

    TRTCChatSalonDelegateイベントコールバック

    一般的なイベントコールバック

    onError

    エラーのコールバック。

    説明:

    SDKリカバリー不能なエラーは必ず監視し、状況に応じてユーザーに適切なインターフェースプロンプトを表示します。

    - (void)onError:(int)code
                  message:(NSString*)message
    NS_SWIFT_NAME(onError(code:message:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    code int エラーコード。
    message String エラー情報。

    onWarning

    警告のコールバック。

    - (void)onWarning:(int)code
                    message:(NSString *)message
    NS_SWIFT_NAME(onWarning(code:message:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    code int エラーコード。
    message String 警告メッセージ。

    onDebugLog

    Logコールバック。

    - (void)onDebugLog:(NSString *)message
    NS_SWIFT_NAME(onDebugLog(message:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    message String ログ情報。

    ルームイベントのコールバック

    onRoomDestroy

    ルーム破棄のコールバック。管理者がルームを解散するとき、ルーム内の全ユーザーはこの通知を受信します。

    - (void)onRoomDestroy:(NSString *)message
    NS_SWIFT_NAME(onRoomDestroy(message:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    roomId String ルームID。

    onRoomInfoChange

    入室に成功後、このインターフェースをコールバックします。roomInfoの情報は、管理者がルームを作成するときに渡されます。

    - (void)onRoomInfoChange:(ChatSalonInfo *)roomInfo
    NS_SWIFT_NAME(onRoomInfoChange(roomInfo:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    roomInfo ChatSalonInfo ルーム情報。

    onUserVolumeUpdate

    音量レベルリマインダを有効にして、各メンバーの音量を通知します。

    - (void)onUserVolumeUpdate:(NSArray<TRTCVolumeInfo *> *)userVolumes totalVolume:(NSInteger)totalVolume
    NS_SWIFT_NAME(onUserVolumeUpdate(userVolumes:totalVolume:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userVolumes NSArray&dxlt;TRTCVolumeInfo *&dxgt; 各ユーザーの音量情報。
    totalVolume int 全体の音量情報。

    マイクコールバック

    onAnchorEnterSeat

    発言者のメンバーがいます(ユーザーが発言者になる/管理者が視聴者を発言できるように招待)。

    - (void)onAnchorEnterSeat:(ChatSalonUserInfo *)user
    NS_SWIFT_NAME(onAnchorEnterSeat(user:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    user ChatSalonUserInfo マイク・オンのユーザーの詳細情報。

    onAnchorLeaveSeat

    視聴者のメンバーがいます(ユーザーが視聴者になる/管理者がキックアウトしてマイク・オフ)。

    - (void)onAnchorLeaveSeat:(ChatSalonUserInfo *)user
    NS_SWIFT_NAME(onAnchorLeaveSeat(user:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    user ChatSalonUserInfo マイク・オンのユーザーの詳細情報。

    onSeatMute

    管理者のマイクミュート。

    - (void)onSeatMute:(NSString *)userID
              isMute:(BOOL)isMute
    NS_SWIFT_NAME(onSeatMute(userID:isMute:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userID String マイクのユーザーid。
    isMute boolean true:マイクミュート、false:ミュート解除。

    リスナーの入退室イベントのコールバック

    onAudienceEnter

    リスナー入室通知の受信。

    - (void)onAudienceEnter:(ChatSalonUserInfo *)userInfo
    NS_SWIFT_NAME(onAudienceEnter(userInfo:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userInfo ChatSalonUserInfo 入室したリスナーの情報。

    onAudienceExit

    リスナー退室通知の受信。

    - (void)onAudienceExit:(ChatSalonUserInfo *)userInfo
    NS_SWIFT_NAME(onAudienceExit(userInfo:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    userInfo ChatSalonUserInfo 退室したリスナーの情報。

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

    onRecvRoomTextMsg

    テキストメッセージの受信。

    - (void)onRecvRoomTextMsg:(NSString *)message
                   userInfo:(ChatSalonUserInfo *)userInfo
    NS_SWIFT_NAME(onRecvRoomTextMsg(message:userInfo:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    message String テキストメッセージ。
    userInfo ChatSalonUserInfo 送信者のユーザー情報。

    onRecvRoomCustomMsg

    カスタムメッセージの受信。

    - (void)onRecvRoomCustomMsg:(NSString *)cmd
                      message:(NSString *)message
                     userInfo:(ChatSalonUserInfo *)userInfo
    NS_SWIFT_NAME(onRecvRoomCustomMsg(cmd:message:userInfo:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    cmd String コマンドワードは、開発者がカスタマイズします。主にさまざまなメッセージタイプを区別するために使用されます。
    message String テキストメッセージ。
    userInfo ChatSalonUserInfo 送信者のユーザー情報。

    招待シグナリングイベントのコールバック

    onReceiveNewInvitation

    新規招待リクエストの受信。

    - (void)onReceiveNewInvitation:(NSString *)identifier
                         inviter:(NSString *)inviter
                             cmd:(NSString *)cmd
                         content:(NSString *)content
    NS_SWIFT_NAME(onReceiveNewInvitation(identifier:inviter:cmd:content:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    identifier String 招待ID。
    inviter String 招待者のユーザーID。
    cmd String 業務指定のコマンドワードは、開発者がカスタマイズします。
    content String 業務指定のコンテンツ。

    onInviteeAccepted

    被招待者が招待に同意。

    - (void)onInviteeAccepted:(NSString *)identifier
                    invitee:(NSString *)invitee
    NS_SWIFT_NAME(onInviteeAccepted(identifier:invitee:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    identifier String 招待ID。
    invitee String 被招待者のユーザーID。

    onInviteeRejected

    被招待者による招待の拒否。

    - (void)onInviteeRejected:(NSString *)identifier
                    invitee:(NSString *)invitee
    NS_SWIFT_NAME(onInviteeRejected(identifier:invitee:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    identifier String 招待ID。
    invitee String 被招待者のユーザーID。

    onInvitationCancelled

    招待者が招待を取り消し。

    - (void)onInvitationCancelled:(NSString *)identifier
                        invitee:(NSString *)invitee NS_SWIFT_NAME(onInvitationCancelled(identifier:invitee:));
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    identifier String 招待ID。
    invitee String 招待者のユーザーID。

    onInvitationTimeout

    招待のタイムアウト。

    - (void)onInvitationTimeout:(NSString *)identifier;
    

    パラメータは下表に示すとおりです。

    パラメータ タイプ 意味
    identifier String 招待ID。