RTC Engine
  • Overview
  • Web
    • Demo のクイックスタート
    • SDK クイックスタート
    • 基本機能
      • 画面共有
      • ライブブロードキャスト
      • メディアデバイス
      • 音量
      • エンコーディング構成ファイルの設定
      • ネットワーク品質の検出
      • 検出能力
    • 高度な機能
      • AI ノイズ低減の有効化
      • ミキシングを有効にします
      • ウォーターマークを有効にします
      • Enable Virtual Background
      • 美顔とエフェクトの有効化
      • データメッセージ
      • キャプチャーとレンタリングのカスタマイズ
    • インターフェースリスト
    • リリース説明
    • 対応するプラットホーム
    • Web に関するよくあるご質問
      • 複数人でのビデオ通話を最適化
      • 制限付き自動再生の処理
      • ファイアウォール制限への対応
      • その他
  • Android
    • Run Sample Code
    • Integration
    • インテグレーション
      • 7. ネットワーク品質の検出
      • 8. 画面共有の有効化
      • 9. ビデオ品質の設定
      • 10. ビデオの回転
    • Advanced Features
      • ネットワーク品質のテスト
      • キャプチャーとレンタリングのカスタマイズ
      • オーディオキャプチャーと再生のカスタマイズ
    • 顧客インターフェース
      • Overview
      • TRTCCloud
      • TRTCStatistics
      • TRTCCloudListener
      • TXAudioEffectManager
      • TXBeautyManager
      • TXDeviceManager
      • タイプ定義
      • 廃棄インタフェース
      • エラーコード
    • ソリューション
      • リアルタイムコーラス (TUIKaraoke)
        • クイックインテグレーション
        • 実施ステップ
        • 曲の同期
        • 歌詞の同期
        • 音声同期
        • ミクスストリーミングソリューション
        • TRTCKaraoke 関連インターフェース
        • よくあるご質問
    • リリース説明
  • iOS
    • Run Sample Code
    • Integration
    • インテグレーション
      • 7. ネットワーク品質の検出
      • 8. 画面共有の有効化
      • 9. ビデオ品質の設定
      • 10. ビデオの回転
    • Advanced Features
      • ネットワーク品質のテスト
      • キャプチャーとレンタリングのカスタマイズ
      • オーディオキャプチャーと再生のカスタマイズ
    • 顧客インターフェース
      • Overview
      • TRTCCloud
      • TRTCCloudDelegate
      • TRTCStatistics
      • TXAudioEffectManager
      • TXBeautyManager
      • TXDeviceManager
      • タイプ定義
      • 廃棄インタフェース
      • ErrorCode
    • ソリューション
      • クイックインテグレーション
      • 実施ステップ
      • 曲の同期
      • 歌詞の同期
      • 音声同期
      • ミクスストリーミングソリューション
      • TRTCKaraoke 関連インターフェース
      • よくあるご質問
    • リリース説明
  • macOS
    • Run Sample Code
    • Integration
    • インテグレーション
      • 7. ネットワーク品質の検出
      • 8. 画面共有の有効化
      • 9. パソコンサウンドの共有
      • 10. ビデオ品質の設定
      • 11. ビデオの回転
    • Advanced Features
      • ハードウェアデバイスのテスト
      • ネットワーク品質のテスト
      • キャプチャーとレンタリングのカスタマイズ
      • オーディオキャプチャーと再生のカスタマイズ
    • 顧客インターフェース
      • Overview
      • TRTCCloud
      • TRTCCloudDelegate
      • TRTCStatistics
      • TXAudioEffectManager
      • TXBeautyManager
      • TXDeviceManager
      • タイプ定義
      • 廃棄インタフェース
      • ErrorCode
      • リリース説明
    • リリース説明
  • Windows
    • Run Sample Code
    • Integration
    • インテグレーション
      • 7. ネットワーク品質の検出
      • 8. 画面共有の有効化
      • 9. ビデオ品質の設定
      • 10. ビデオの回転
    • Advanced Features
      • ハードウェアデバイスのテスト
      • ネットワーク品質のテスト
      • キャプチャーとレンタリングのカスタマイズ
      • オーディオキャプチャーと再生のカスタマイズ
    • 顧客インターフェース
      • Overview
      • ITRTCCloud
      • ITRTCStatistics
      • TRTCCloudCallback
      • ITXAudioEffectManager
      • ITXDeviceManager
      • タイプ定義
      • 廃棄インタフェース
      • エラーコード
    • リリース説明
  • Electron
    • インテグレーション
      • 1. インターフェースの例
      • 2. SDK のインポート
      • 3. ルームに入る
      • 4. オーディオ・ビデオストリームのサブスクリプション
      • 5. オーディオ・ビデオストリームのリリース
      • 6. ルームからの退出
      • 7. ネットワーク品質の検出
      • 8. 画面共有の有効化
      • 9. パソコンサウンドの共有
      • 10. ビデオ品質の設定
      • 11. ビデオの回転
    • 顧客インターフェース
      • Overview
      • エラーコード
  • Flutter
    • インテグレーション
      • 1. インターフェースの例
      • 2. SDK のインポート
      • 3. ルームに入る
      • 4. オーディオ・ビデオストリームのサブスクリプション
      • 5. オーディオ・ビデオストリームのリリース
      • 6. ルームからの退出
      • 7. ネットワーク品質の検出
      • 8. 画面共有の有効化
      • 9. パソコンサウンドの共有
      • 10. ビデオ品質の設定
      • 11. ビデオの回転
    • 顧客インターフェース
      • Overview
      • エラーコード
  • Unity
    • インテグレーション
      • 1. インターフェースの例
      • 2. SDK のインポート
    • 顧客インターフェース
      • Overview
      • エラーコード
  • QT
    • インテグレーション
      • 1. SDK のインポート
  • Overview
    • Overview
  • 概念
  • Features
  • 性能統計
  • 価格
    • 無料時間
    • RTC-Engine パッケージ
    • サブスクリプションパッケージ期間の課金説明
    • 従量課金
      • 音声・ビデオ時間の課金説明
      • クラウド録画の課金説明
      • ミックストランスコーディングとCDNへのリレーの課金説明
  • よくあるご質問
    • 初心者のよくあるご質問
    • マイグレーションガイド
      • Twilio Video から TRTC への移行
      • 課金
      • Features
      • UserSig
      • ファイアウォール制限
      • インストールパッケージを削減する方法
      • TRTCCalling Web 関連
      • オーディオ・ビデオの品質
      • その他
RTC Engine

TRTCKaraoke 関連インターフェース

TRTCKaraokeRoomは、Tencent CloudのTRTCおよびIMサービスを基に組み合わせたコンポーネントで、以下の機能をサポートしています。
管理者が作成した新しいKaraokeルームが配信を開始すると、リスナーはKaraokeルームに入室して聴取/インタラクションを行います。
管理者は、楽曲の順序を管理し、マイク・オンのキャスターをキックアウトすることもできます。
管理者はまた、座席をクローズすることができ、その他のリスナーはマイク・オンを申請することができなくなります。
リスナーはマイク・オンを申請して、マイク・オンのキャスターになり、マイク・オン後は楽曲の選択や歌唱ができるようになります。また、いつでもマイク・オフにして、通常のリスナーになることも可能です。
ギフトや各種のテキストメッセージ、カスタムメッセージの送信をサポートします。カスタムメッセージを弾幕、「いいね」などを実装するために使用することができます。
説明:
TUIKitシリーズコンポーネントはTencent CloudのTRTCIMという2つの基本的なPaaSサービスを同時に使用し、TRTCをアクティブにした後、IMサービスを同期的にアクティブにすることができます。IMサービスの課金ルールの詳細については、Instant Messagingの料金説明をご参照ください。TRTCをアクティブにすると、デフォルトでは、100DAUまでサポートするIM SDK体験版もアクティブになります。
TRTCKaraokeRoomはオープンソースのClassであり、Tencent Cloudの2つのクローズドソースのSDKに依存しています。具体的な実装プロセスについては、Karaoke (Android)をご参照ください。
TRTC SDK:TRTC SDKを低遅延のボイスチャットコンポーネントとして使用しています。
IM SDK:IM SDKのAVChatroomを使用してチャットルーム機能を実装します。同時にIMの属性インターフェースによって、マイクリストなどのルーム情報を保存し、招待シグナリングはマイク・オン/ピックのリクエストに用いることができます。

TRTCKaraokeRoom API概要

SDK基本関数

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

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

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

音楽再生インターフェース

API
説明
音楽の再生を開始します。
音楽の再生を停止します。
音楽の再生を一時停止します。
音楽の再生を再開します。

マイク管理インターフェース

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

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

API
説明
マイクの集音開始。
マイクの集音停止。
音質の設定。
ローカルオーディオミュートの開始/停止。
スピーカーの起動設定。
マイクの集音音量設定。
再生音量の設定。
インイヤーモニタリングのオン/オフ。

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

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

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

API
説明
BGMサウンドエフェクト管理オブジェクトTXAudioEffectManagerを取得します。

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

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

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

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

TRTCKaraokeRoomDelegate API概要

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

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

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

API
説明
ルームが廃棄された時のコールバック。
Karaoke情報変更のコールバック。
ユーザー通話音量のコールバック。

マイク変更コールバック

API
説明
全量のマイクリストの変更。
発言者のメンバーがいます(ユーザーが発言者になります/管理者が視聴者を発言できるように招待)。
視聴者のメンバーがいます(ユーザーが視聴者になる/管理者がキックアウトしてマイク・オフ)。
管理者のマイクミュート。
ユーザーのマイクがミュートされているかどうか。
管理者のマイククローズ。

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

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

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

API
説明
テキストメッセージを受信します。
カスタムメッセージを受信します。

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

API
説明
新規招待リクエストの受信。
被招待者が招待に同意。
被招待者が招待を拒否。
招待者が招待を取り消し。

楽曲イベントコールバック

API
説明
楽曲再生進捗度のコールバック。
音楽再生準備のコールバック。
音楽再生完了のコールバック。

SDK基本関数

sharedInstance

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

destroySharedInstance

TRTCKaraokeRoomシングルトンオブジェクトを破棄します。
説明:
インスタンスの破棄後は、外部にキャッシュされたTRTCKaraokeRoomインスタンスの再使用ができません。改めてsharedInstanceを呼び出し、インスタンスを新規取得してください。
public static void destroySharedInstance();

setDelegate

TRTCKaraokeRoomイベントコールバック。 TRTCKaraokeRoomDelegate を介してTRTCKaraokeLiveRoomの各種ステータス通知を受け取ることができます。
public abstract void setDelegate(TRTCKaraokeRoomDelegate delegate);
説明:
setDelegateはTRTCKaraokeRoomのプロキシコールバックです。

setDelegateHandler

イベントコールバックが配置されているスレッドを設定します。
public abstract void setDelegateHandler(Handler handler);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
handler
Handler
TRTCKaraokeRoomの各種ステータス通知は、指定したhandlerスレッドに発信されます。

login

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

logout

ログアウト。
public abstract void logout(TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
callback
ActionCallback
ログアウトのコールバック。成功時にcodeは0になります。

setSelfProfile

個人情報の修正。
public abstract void setSelfProfile(String userName, String avatarURL, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
userName
String
ニックネーム。
avatarURL
String
プロフィール画像のアドレス。
callback
ActionCallback
個人情報設定のコールバック。成功時にcodeは0になります。

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

createRoom

ルームの作成(管理者が呼び出し):
public abstract void createRoom(int roomId, TRTCKaraokeRoomDef.RoomParam roomParam, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです。
パラメータ
タイプ
意味
roomI
int
ルームIDは、ご自身でアサインし、一元管理してください。複数のroomIDを、一つのKaraokeルームリストにまとめることができます。Tencent Cloudでは現在、Karaokeルームリストの管理サービスを行っていませんので、ご自身でKaraokeルームリストを管理してください。
roomParam
TRTCCreateRoomParam
ルーム情報です。ルーム名、マイク情報、カバー情報など、ルームを説明するために用いる情報に使用します。マイク管理が必要な場合は、ルームのマイク数を記入してください。
callback
ActionCallback
ルームの新規作成結果のコールバック。成功時にcodeは0になります。
管理者が配信を開始する際の通常の呼び出しプロセスは次のとおりです:
1. 管理者は、createRoomを呼び出して新しいKaraokeルームを作成します。この時、ルームID、マイク・オンにすることの管理者の確認の要否、ルームタイプなどルームの属性情報を渡します。
2. 管理者は、ルーム作成に成功した後、enterSeatを呼び出して参加します。
3. 管理者は、コンポーネントのonSeatListChangeマイクリスト変更イベント通知を受信します。この時、マイクリストの変更をUI上で更新することができます。
4. 管理者は、マイクリストのメンバーが参加したonAnchorEnterSeatというイベント通知も受信します。この時、マイク集音は自動的に開始されます。

destroyRoom

ルームの破棄(管理者が呼び出し)。管理者は、ルーム作成後、この関数を呼び出してルームを破棄します。
public abstract void destroyRoom(TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
callback
ActionCallback
ルームの廃棄結果のコールバック。成功時にcodeは0になります。

enterRoom

入室(リスナーが呼び出し)。
public abstract void enterRoom(int roomId, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
roomId
int
ルームID。
callback
ActionCallback
入室結果のコールバック。成功時にcodeは0になります。
リスナーが入室し聴取する際の通常の呼び出しプロセスは次のとおりです:
1. リスナーがサーバーから取得する最新のKaraokeルームリストには、多くのKaraokeルームのroomIdおよびルーム情報が含まれる場合があります。
2. リスナーは1つのKaraokeルームを選択し、enterRoomを呼び出してルームナンバーを渡すと、そのルームに参加できます。
3. 入室後、コンポーネントのonRoomInfoChangeルーム属性変更イベント通知を受信します。この時、ルーム属性を記録し、それに応じた修正を行うことができます。例:UIに表示するルーム名、マイク・オンの際の管理者への同意リクエストの要否の記録など。
4. 入室後は、コンポーネントのonSeatListChangeマイクリスト変更イベント通知を受信します。この時、マイクリストの変更をUI上に更新することができます。
5. 入室後に、マイクリストにキャスターが参加したonAnchorEnterSeatのイベント通知も受信します。

exitRoom

ルームから退出します。
public abstract void exitRoom(TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
callback
ActionCallback
退室結果のコールバック。成功時にcodeは0になります。

getRoomInfoList

ルームリストの詳細情報を取得します。このうち、ルーム名、ルームカバーは、管理者がcreateRoom()作成時にroomInfoによって設定したものになります。
説明:
ルームリストおよびルーム情報をご自身で管理する場合は、この関数は無視できます。
public abstract void getRoomInfoList(List<Integer> roomIdList, TRTCKaraokeRoomCallback.RoomInfoCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
roomIdList
List<Integer>
ルームナンバーリスト。
callback
RoomInfoCallback
ルーム詳細情報のコールバック。

getUserInfoList

指定されたuserIdのユーザー情報を取得します。
public abstract void getUserInfoList(List<String> userIdList, TRTCKaraokeRoomCallback.UserListCallback userlistcallback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
userIdList
List<String>
取得すべきユーザーIDリスト。nullの場合は、ルーム内全員の情報を取得します。
userlistcallback
UserListCallback
ユーザーの詳細情報のコールバック。

音楽再生インターフェース

startPlayMusic

音楽を再生します(マイク・オン後に呼び出し)。
説明:
音楽を再生すると、onMusicPrepareToPlayというイベント通知を受信します。
音楽の再生中、ルーム内の全メンバーは、onMusicProgressUpdateというイベント通知を継続して受け取ります。
音楽の再生が完了すると、onMusicCompletePlayingというイベント通知を受信します。
public abstract void startPlayMusic(int musicID, String originalUrl, String accompanyUrl);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
musicID
int
音楽のID。
originalUrl
String
原曲の絶対パス。
accompanyUrl
String
伴奏の絶対パス。
このインターフェースを呼び出すと、最後に再生されていた楽曲が停止します。

stopPlayMusic

音楽の再生を停止します(音楽を再生するときに呼び出します)。
説明:
再生が停止すると、onMusicCompletePlayingというイベント通知を受信します。
public abstract void stopPlayMusic();

pausePlayMusic

音楽の再生を一時停止します(音楽を再生するときに呼び出します)。
説明:
onMusicProgressUpdateというイベント通知が一時停止されます
onMusicCompletePlayingというイベント通知を受信しません。
public abstract void pausePlayMusic();

resumePlayMusic

一時停止した音楽を再開します(一時停止後に呼び出します)。
説明:
onMusicPrepareToPlayというイベント通知を受信しません。
public abstract void resumePlayMusic();

マイク管理インターフェース

enterSeat

ユーザーが発言者になります(リスナー側/管理者ともに呼び出し可)。
説明:
マイク・オンの成功後、ルーム内の全メンバーは、onSeatListChangeおよびonAnchorEnterSeatというイベント通知を受信します。
public abstract void enterSeat(int seatIndex, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
seatIndex
int
マイク・オンの必要があるマイク番号。
callback
ActionCallback
操作コールバック。
このインターフェースを呼び出すと、直ちにマイクリストが変更されます。リスナーによるマイク・オンの申請に管理者の同意が必要となるケースの場合は、まずsendInvitationを呼び出してから管理者に申請し、onInvitationAcceptを受信するとこの関数を呼び出せるようになります。

leaveSeat

ユーザーが視聴者になります(キャスターが呼び出し)。
説明:
マイク・オフの成功後、ルーム内の全メンバーは、onSeatListChangeおよびonAnchorLeaveSeatというイベント通知を受信します。
public abstract void leaveSeat(TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
callback
ActionCallback
操作コールバック。

pickSeat

視聴者が発言できるように招待(管理者が呼び出し)。
説明:
管理者が視聴者を発言できるように招待すると、ルーム内の全メンバーは、onSeatListChangeonAnchorEnterSeatというイベント通知を受信します。
public abstract void pickSeat(int seatIndex, String userId, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
seatIndex
int
視聴者が発言できるように招待する必要があるマイク番号。
userId
String
ユーザーID。
callback
ActionCallback
操作コールバック。
このインターフェースを呼び出すと、すぐにマイクリストが修正されます。管理者がリスナーの同意がなければマイク・オンできないケースの場合は、まずsendInvitationを呼び出してからリスナーに申請し、onInvitationAcceptを受信すると、この関数をコールできるようになります。

kickSeat

キックアウトしてマイク・オフ(管理者が呼び出し)。
説明:
管理者がキックアウトしてマイク・オフにすると、ルーム内の全メンバーは、onSeatListChangeおよびonAnchorLeaveSeatというイベント通知を受信します。
public abstract void kickSeat(int seatIndex, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
seatIndex
int
キックアウトしてマイク・オフの必要があるマイク番号。
callback
ActionCallback
操作コールバック。
このインターフェースを呼び出すと、すぐにマイクリストが修正されます。

muteSeat

任意のマイクのミュート/ミュート解除(管理者が呼び出し)。
説明:
任意のマイクをミュート/ミュート解除します。ルーム内の全メンバーがonSeatListChangeおよびonSeatMuteというイベント通知を受信します。
public abstract void muteSeat(int seatIndex, boolean isMute, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
seatIndex
int
操作の必要があるマイク番号。
isMute
boolean
true:該当するマイクをミュートします;false:該当するマイクをミュート解除します。
callback
ActionCallback
操作コールバック。
このインターフェースを呼び出すと、直ちにマイクリストが変更されます。seatIndexの座席に該当するキャスターは、muteAudioを自動的に呼び出してミュート/ミュート解除にします。

closeSeat

任意のマイクのクローズ/解除(管理者が呼び出し)。
説明:
管理者は、該当するマイクをクローズ/解除し、ルーム内の全メンバーはonSeatListChangeおよびonSeatCloseというイベント通知を受信します。
public abstract void closeSeat(int seatIndex, boolean isClose, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
seatIndex
int
操作の必要があるマイク番号。
isClose
boolean
true:該当するマイクをクローズします; false:該当するマイクをクローズ解除します。
callback
ActionCallback
操作コールバック。
このインターフェースを呼び出すと、すぐにマイクリストが修正されます。該当するseatIndexの座席上のキャスターはクローズされ、自動的にマイク・オフになります。

ローカル音声操作のインターフェース

startMicrophone

マイクの集音開始。
public abstract void startMicrophone();

stopMicrophone

マイクの集音停止。
public abstract void stopMicrophone();

setAudioQuality

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

muteLocalAudio

ローカルの音声のミュート/ミュート取り消し。
public abstract void muteLocalAudio(boolean mute);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
mute
boolean
ミュート/ミュート取り消し。詳細は TRTC SDKをご参照ください。

setSpeaker

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

setAudioCaptureVolume

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

setAudioPlayoutVolume

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

muteRemoteAudio

指定メンバーのミュート/ミュート解除。
public abstract void muteRemoteAudio(String userId, boolean mute);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
userId
String
指定ユーザーID。
mute
boolean
true:ミュート起動;false:ミュート停止。

muteAllRemoteAudio

全メンバーのミュート/ミュート解除。
public abstract void muteAllRemoteAudio(boolean mute);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
mute
boolean
true:ミュート起動;false:ミュート停止。

setVoiceEarMonitorEnable

インイヤーモニタリングのオン/オフ。
public abstract void setVoiceEarMonitorEnable(boolean enable);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
enable
boolean
true:インイヤーモニタリングをオン。false:インイヤーモニタリングをオフ。

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

getAudioEffectManager

BGMサウンドエフェクト管理オブジェクト TXAudioEffectManagerを取得します。
public abstract TXAudioEffectManager getAudioEffectManager();

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

sendRoomTextMsg

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

sendRoomCustomMsg

カスタマイズしたテキストメッセージを送信します。
public abstract void sendRoomCustomMsg(String cmd, String message, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
cmd
String
コマンドワードです。開発者がカスタマイズするものであり、主にさまざまなメッセージタイプを区別するために使用されます。
message
String
テキストメッセージ。
callback
ActionCallback
送信結果のコールバック。

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

sendInvitation

ユーザーに招待を送信。
public abstract String sendInvitation(String cmd, String userId, String content, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
cmd
String
業務カスタマイズコマンド。
userId
String
招待ユーザーID。
content
String
招待コンテンツ。
callback
ActionCallback
送信結果のコールバック。
戻り値:
戻り値
タイプ
意味
inviteId
String
今回の招待IDの識別に使用。

acceptInvitation

招待の同意。
public abstract void acceptInvitation(String id, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
id
String
招待ID。
callback
ActionCallback
送信結果のコールバック。

rejectInvitation

招待の拒否。
public abstract void rejectInvitation(String id, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
id
String
招待ID。
callback
ActionCallback
送信結果のコールバック。

cancelInvitation

招待の取り消し。
public abstract void cancelInvitation(String id, TRTCKaraokeRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
id
String
招待ID。
callback
ActionCallback
送信結果のコールバック。

TRTCKaraokeRoomDelegateイベントコールバック

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

onError

エラーのコールバック。
説明:
SDKリカバリー不能なエラーは必ず監視し、状況に応じてユーザーに適切なインターフェースプロンプトを表示します。
void onError(int code, String message);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
code
int
エラーコード。
message
String
エラーメッセージ。

onWarning

警告のコールバック。
void onWarning(int code, String message);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
code
int
エラーコード。
message
String
警告メッセージ。

onDebugLog

Logコールバック。
void onDebugLog(String message);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
message
String
ログ情報。

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

onRoomDestroy

ルーム破棄のコールバック。管理者がルームを解散するとき、ルーム内の全ユーザーはこの通知を受信します。
void onRoomDestroy(String roomId);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
roomId
String
ルームID。

onRoomInfoChange

入室に成功後、このインターフェースをコールバックします。roomInfoの情報は、管理者がルームを作成するときに渡されます。
void onRoomInfoChange(TRTCKaraokeRoomDef.RoomInfo roomInfo);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
roomInfo
RoomInfo
ルーム情報。

onUserMicrophoneMute

ユーザーのマイクがミュートになっているかどうかについて、ユーザーがmuteLocalAudioを呼び出すと、ルームの他のユーザーがこの通知を受信します。
void onUserMicrophoneMute(String userId, boolean mute);

パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
userId
String
ユーザーID。
mute
boolean
音量の大きさ。値:0~100。

onUserVolumeUpdate

音量レベルリマインダを有効にすると、各メンバーの音量を通知します。
void onUserVolumeUpdate(List<TRTCCloudDef.TRTCVolumeInfo> userVolumes, int totalVolume);

パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
userVolumes
List
ユーザーリスト。
totalVolume
int
音量の大きさ。値:0~100。

マイクコールバック

onSeatListChange

全量のマイクリストの変更です。全てのマイクリストを含みます。
void onSeatListChange(List<SeatInfo> seatInfoList);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
seatInfoList
List<SeatInfo>
全量のマイクリスト。

onAnchorEnterSeat

発言者のメンバーがいます(ユーザーが発言者になる/管理者が視聴者を発言できるように招待)。
void onAnchorEnterSeat(int index, TRTCKaraokeRoomDef.UserInfo user);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
index
int
メンバーがマイク・オンのマイク。
user
UserInfo
マイク・オンのユーザーの詳細情報。

onAnchorLeaveSeat

視聴者のメンバーがいます(ユーザーが視聴者になる/管理者がキックアウトしてマイク・オフ)。
void onAnchorLeaveSeat(int index, TRTCKaraokeRoomDef.UserInfo user);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
index
int
マイク・オフのマイク。
user
UserInfo
マイク・オフのユーザーの詳細情報。

onSeatMute

管理者のマイクミュート。
void onSeatMute(int index, boolean isMute);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
index
int
操作するマイク。
isMute
boolean
true:マイクミュート; false:ミュート解除。

onSeatClose

管理者のマイククローズ。
void onSeatClose(int index, boolean isClose);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
index
int
操作するマイク。
isClose
boolean
true:マイクのクローズ; false:マイクのクローズ解除。

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

onAudienceEnter

リスナー入室通知の受信。
void onAudienceEnter(TRTCKaraokeRoomDef.UserInfo userInfo);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
userInfo
UserInfo
入室したリスナーの情報。

onAudienceExit

リスナー退室通知の受信。
void onAudienceExit(TRTCKaraokeRoomDef.UserInfo userInfo);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
userInfo
UserInfo
退室したリスナーの情報。

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

onRecvRoomTextMsg

テキストメッセージを受信します。
void onRecvRoomTextMsg(String message, TRTCKaraokeRoomDef.UserInfo userInfo);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
message
String
テキストメッセージ。
userInfo
UserInfo
送信者のユーザー情報。

onRecvRoomCustomMsg

カスタムメッセージを受信します。
void onRecvRoomCustomMsg(String cmd, String message, TRTCKaraokeRoomDef.UserInfo userInfo);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
command
String
コマンドワードです。開発者がカスタマイズするもので、主にさまざまなメッセージタイプを区別するために使用されます。
message
String
テキストメッセージ。
userInfo
UserInfo
送信者のユーザー情報。

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

onReceiveNewInvitation

新規招待リクエストの受信。
void onReceiveNewInvitation(String id, String inviter, String cmd, String content);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
id
String
招待ID。
inviter
String
招待者のユーザーID。
cmd
String
開発者がカスタマイズする業務指定のコマンドワードです。
content
String
業務指定のコンテンツ。

onInviteeAccepted

被招待者が招待に同意。
void onInviteeAccepted(String id, String invitee);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
id
String
招待ID。
invitee
String
被招待者のユーザーID。

onInviteeRejected

被招待者による招待の拒否。
void onInviteeRejected(String id, String invitee);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
id
String
招待ID。
invitee
String
被招待者のユーザーID。

onInvitationCancelled

招待者が招待を取り消し。
void onInvitationCancelled(String id, String inviter);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
id
String
招待ID。
inviter
String
招待者のユーザーID。

音楽再生ステータスコールバック

onMusicPrepareToPlay

音楽再生準備のコールバック
void onMusicPrepareToPlay(int musicID);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
musicID
int
再生時に渡されたmusicID。

onMusicProgressUpdate

楽曲再生進捗度のコールバック
void onMusicProgressUpdate(int musicID, long progress, long total);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
musicID
int
再生時に渡されたmusicID。
progress
long
現在の再生時間。単位: ms。
total
long
合計時間。単位: ms。

onMusicCompletePlaying

音楽再生完了のコールバック
void onMusicCompletePlaying(int musicID);
パラメータは下表に示すとおりです:
パラメータ
タイプ
意味
musicID
int
再生時に渡されたmusicID。