TRTCLiveRoom API (Android)

Recent Pages

TRTCLiveRoom API (Android)

最終更新日:2022-07-19 16:21:32

TRTCLiveRoomは、Tencent CloudのTencent Real-Time Communication (TRTC)およびIMサービスを基に組み合わせたコンポーネントで、以下の機能をサポートしています。
キャスターが新しいライブストリーミングルームを作成して配信を開始し、視聴者がライブストリーミングルームに参加して視聴します。
キャスターと視聴者がビデオでマイク接続によるコラボライブを行います。
2つの異なるルームの間でキャスター同士のPK（クロスルーム対戦）を行います。
各種のテキストメッセージやカスタムメッセージの送信をサポートします。カスタムメッセージは弾幕、「いいね」、ギフトを実装するために使用することができます。
explain
TUIKitシリーズコンポーネントはTencent CloudのTRTCとIMという2つの基本的なPaaSサービスを同時に使用し、TRTCをアクティブにした後、IMサービスを同期的にアクティブにすることができます。IMサービスの課金ルールの詳細については、Instant Messagingの料金説明をご参照ください。TRTCをアクティブにすると、デフォルトでは、100DAUまでサポートするIM SDK体験版もアクティブになります。
TRTCLiveRoom はオープンソースのClassであり、Tencent Cloudの2つのクローズドソースのSDKに依存しています。具体的な実現プロセスは、ビデオマイク接続ライブストリーミング（Android）をご参照ください。
TRTC SDK： TRTC SDK を低遅延のライブストリーミングコンポーネントとして使用します。
IM SDK： IM SDKのAVChatroomを使用して、ライブストリーミングチャットルーム機能を実装します。同時に、IMのメッセージでキャスター間のマイク接続のフローをつなげます。
﻿
TRTCLiveRoom API 概要
SDK基本関数
API
説明
sharedInstance
シングルトンオブジェクトを取得します。
destroySharedInstance
シングルトンオブジェクトを破棄します。
setDelegate
イベントコールバックを設定します。
setDelegateHandler
イベントのコールバックが配置されているスレッドを設定します。
login
ログイン。
logout
ログアウト。
setSelfProfile
個人情報を修正します。
ルーム関連インターフェース関数
API
説明
createRoom
ルームの作成（キャスターが呼び出し）。ルームが存在しない場合は、システムが新しいルームを自動作成します。
destroyRoom
ルームの破棄（キャスターが呼び出し）。
enterRoom
入室（視聴者が呼び出し）。
exitRoom
退室（視聴者が呼び出し）。
getRoomInfos
ルームリストの詳細情報を取得します。
getAnchorList
ルーム内の全キャスターのリストを取得します。enterRoom()成功後に呼び出しが有効になります。
getAudienceList
ルーム内の全視聴者の情報を取得します。enterRoom()成功後に呼び出しが有効になります。
プッシュプルストリームに関連するインターフェース関数
API
説明
startCameraPreview
ローカルビデオのプレビュー画面を立ち上げます。
stopCameraPreview
ローカルのビデオキャプチャおよびプレビューを停止します。
startPublish
ライブストリーミング（プッシュ）を開始します。
stopPublish
ライブストリーミング（プッシュ）を停止します。
startPlay
リモートのビデオ画面を再生します。普通の視聴とマイク接続のシーンで呼び出すことができます。
stopPlay
リモートのビデオ画面のレンダリングを停止します。
キャスターと視聴者のマイク接続
API
説明
requestJoinAnchor
視聴者がマイク接続をリクエストします。
responseJoinAnchor
キャスターがマイク接続のリクエストを処理します。
kickoutJoinAnchor
キャスターがマイク接続の視聴者をキックアウトします。
キャスターのルーム間PK
API
説明
requestRoomPK
キャスターがルーム間のPKをリクエストします。
responseRoomPK
キャスターがルーム間PKのリクエストに応答します。
quitRoomPK
ルーム間PKから退出します。
音声ビデオ制御に関連するインターフェース関数
API
説明
switchCamera
フロント/リアカメラを切り替えます。
setMirror
ミラー表示のオン/オフを設定します。
muteLocalAudio
ローカルオーディオをミュートにします。
muteRemoteAudio
リモートオーディオをミュートにします。
muteAllRemoteAudio
全てのリモート側のオーディオをミュートにします。
BGMサウンドエフェクト関連インターフェース関数
API
説明
getAudioEffectManager
BGMサウンドエフェクト管理オブジェクトTXAudioEffectManagerを取得します。
美顔フィルタに関するインターフェース関数
API
説明
getBeautyManager
美顔管理オブジェクトTXBeautyManagerを取得します。
メッセージ送信関連インターフェース関数
API
説明
sendRoomTextMsg
ルーム内でのテキストメッセージのブロードキャスト。通常、弾幕によるチャットに使用します。
sendRoomCustomMsg
カスタマイズしたテキストメッセージを送信します。
デバックに関するインターフェース関数
API
説明
showVideoDebugLog
インターフェースにdebug情報を表示するか。
﻿
TRTCLiveRoomDelegate API概要
﻿
一般的なイベントコールバック
API
説明
onError
エラーのコールバック。
onWarning
警告のコールバック。
onDebugLog
Logコールバック。
ルームイベントのコールバック
API
説明
onRoomDestroy
ルームが破棄された時のコールバック。
onRoomInfoChange
ライブストリーミングルーム情報変更のコールバック。
キャスターと視聴者の参加/退出のイベントコールバック
API
説明
onAnchorEnter
新しいキャスターの入室通知を受信します。
onAnchorExit
キャスターの退室通知を受信します。
onAudienceEnter
視聴者入室通知の受信。
onAudienceExit
視聴者退室通知の受信。
キャスターと視聴者のマイク接続のイベントコールバック
API
説明
onRequestJoinAnchor
キャスターが視聴者のマイク接続リクエストを受信した時のコールバック。
onKickoutJoinAnchor
マイク接続の視聴者がマイク接続からキックアウトされた通知を受信します。
キャスター間PKのイベントコールバック
API
説明
onRequestRoomPK
ルーム間PKのリクエストの通知を受信。
onQuitRoomPK
ルーム間PK中止の通知を受信します。
メッセージイベントのコールバック
API
説明
onRecvRoomTextMsg
テキストメッセージの受信。
onRecvRoomCustomMsg
カスタムメッセージの受信。
SDK基本関数
﻿
sharedInstance
﻿TRTCLiveRoom シングルトンオブジェクトを取得します。
 public static synchronized TRTCLiveRoom sharedInstance(Context context);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
context
Context
Androidコンテキスト。内部ではApplicationContextに変換してシステムAPIの呼び出しに使用します
destroySharedInstance
TRTCLiveRoom シングルトンオブジェクトを破棄します。
explain
インスタンスの破棄後は、外部にキャッシュされたTRTCLiveRoomインスタンスの再使用ができません。改めて sharedInstance をコールして、インスタンスを新規取得する必要があります。
public static void destroySharedInstance();
setDelegate
TRTCLiveRoom イベントコールバック。 TRTCLiveRoomDelegate を介してTRTCLiveRoomの各種ステータス通知を受け取ることができます。
public abstract void setDelegate(TRTCLiveRoomDelegate delegate);
explain
setDelegateはTRTCLiveRoomのプロキシコールバックです。   
setDelegateHandler
イベントコールバックが配置されているスレッドを設定します。
public abstract void setDelegateHandler(Handler handler);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
handler
Handler
TRTCLiveRoomの中の各種状態の通知のコールバックは、このhandlerによって通知されます。setDelegateと混用しないでください。
login
ログイン。
public abstract void login(int sdkAppId,
 String userId, String userSig,
 TRTCLiveRoomDef.TRTCLiveRoomConfig config, 
 TRTCLiveRoomCallback.ActionCallback callback);
﻿
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
sdkAppId
int
TRTCコンソール >【アプリケーション管理】> アプリケーション情報の中でSDKAppIDを確認できます。
userId
String
現在のユーザーID。文字列タイプでは、英語のアルファベット（a-zとA-Z）、数字（0-9）、ハイフン（-）とアンダーライン（_）のみ使用できます。
userSig
String
Tencent Cloudによって設計されたセキュリティ保護署名。取得方法については、 UserSigの計算、使用方法をご参照ください。
config
TRTCLiveRoomConfig
グローバルコンフィギュレーション情報。ログイン時に初期化してください。ログイン後は変更できなくなります。
﻿
useCDNFirst 属性：視聴者の視聴方式の設定に使用します。trueは、普通の視聴者のCDN経由での視聴を表し、費用は安価ですがレイテンシーは高めです。falseは、普通の視聴者の低レイテンシーによる視聴を表し、費用は CDN とマイク接続の間ですが、レイテンシーを1s以内に抑えることができます。
CDNPlayDomain 属性： useCDNFirstの設定がtrueの時に有効となり、CDNでの視聴の再生ドメイン名の指定に使用します。CSSコンソール >【ドメイン名管理】の画面からログインし、設定を行います。
callback
ActionCallback
ログインのコールバック。成功時にcodeは0になります。
logout
ログアウト。
public abstract void logout(TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
callback
ActionCallback
ログアウトのコールバック。成功時にcodeは0になります。
setSelfProfile
個人情報の修正。
public abstract void setSelfProfile(String userName, String avatarURL, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userName
String
ニックネーム。
avatarURL
String
プロフィール画像のアドレス。
callback
ActionCallback
個人情報設定のコールバック。成功時にcodeは0になります。
ルーム関連インターフェース関数
createRoom
ルームの新規作成（キャスターが呼び出し）。
public abstract void createRoom(int roomId, TRTCLiveRoomDef.TRTCCreateRoomParam roomParam, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
roomId
int
ルームIDは、ご自身でアサインし、一元管理してください。複数の roomID を、1つのライブストリーミングルームリストにまとめることができます。Tencent Cloudでは現在、ライブストリーミングルームリストの管理サービスを行っていませんので、ご自身でライブストリーミングルームリストを管理してください。
roomParam
TRTCCreateRoomParam
ルーム情報は、ルーム名、マイク情報、カバー情報などのルーム説明の情報に使用します。ルームリストおよびルーム情報をご自身のサーバーで管理する場合は、このパラメータは無視できます。
callback
ActionCallback
ルームの作成結果のコールバック。成功時にcodeは0になります。
キャスターがブロードキャストを開始する際の通常の呼び出しプロセスは次のとおりです。 
1. 【キャスター】 startCameraPreview()を呼び出し、カメラのプレビューを起動します。この時美顔パラメータを調整できます。 
2. 【キャスター】createRoom()を呼び出し、ライブストリーミングルームを作成します。ルーム作成が成功したかどうかがActionCallbackでキャスターに通知されます。
3. 【キャスター】starPublish()を呼び出し、プッシュを開始します。
destroyRoom
ルームの破棄（キャスターが呼び出し）。キャスターは、ルーム作成後、この関数を呼び出してルームを破棄します。
public abstract void destroyRoom(TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
callback
ActionCallback
ルームの廃棄結果のコールバック。成功時にcodeは0になります。
enterRoom
入室（視聴者が呼び出し）
public abstract void enterRoom(int roomId, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
roomId
int
ルームID。
callback
ActionCallback
入室結果のコールバック。成功時にcodeは0になります。
視聴者のライブストリーミング視聴の通常の呼び出しフローは以下のとおりです。 
1.【視聴者】サーバーから最新のライブストリーミングルームリストを取得します。その中には、多くのライブストリーミングルームのroomIdおよびルーム情報が含まれる場合があります。
2. 【視聴者】視聴者は1つのライブストリーミングルームを選択し、enterRoom()を呼び出して、このルームに参加します。
3. 【視聴者】startPlay(userId)を呼び出し、キャスターのuserIdを渡して再生を開始します。
ライブストリーミングルームリストにキャスターのuserId情報がすでに含まれている場合、視聴者は、startPlay(userID)を直接呼び出せば、再生を開始できます。
ルーム参加前にキャスターのuserIDが一時的に取得できない場合、視聴者はルーム参加後に TRTCLiveRoomDelegateの中の onAnchorEnter(userID)のイベントコールバックを受信します。このコールバックの中にキャスターのuserID 情報が含まれていますので、startPlay(userID)再び呼び出しせば、再生できます。
exitRoom
ルームを退出します。
public abstract void exitRoom(TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
callback
ActionCallback
退室結果のコールバック。成功時にcodeは0になります。
getRoomInfos
ルームリストの詳細情報を取得します。ルーム情報は、キャスターが createRoom()作成時にroomInfoによって設定します。
explain
ルームリストおよびルーム情報をご自身で管理する場合は、この関数は無視できます。
public abstract void getRoomInfos(List<Integer> roomIdList, TRTCLiveRoomCallback.RoomInfoCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
roomIdList
List<Integer>
ルームナンバーリスト。
callback
RoomInfoCallback
ルーム詳細情報のコールバック。
getAnchorList
ルーム内の全キャスターのリストを取得します。enterRoom()成功後に呼び出しが有効となります。
public abstract void getAnchorList(TRTCLiveRoomCallback.UserListCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
callback
UserListCallback
ユーザーの詳細情報のコールバック。
getAudienceList
ルーム内の全視聴者の情報を取得します。enterRoom()成功後に呼び出しが有効となります。
public abstract void getAudienceList(TRTCLiveRoomCallback.UserListCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
callback
UserListCallback
ユーザーの詳細情報のコールバック。
プッシュプルストリームに関連するインターフェース関数
startCameraPreview
ローカルビデオのプレビュー画面を立ち上げます。
public abstract void startCameraPreview(boolean isFront, TXCloudVideoView view, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
isFront
boolean
true：フロントカメラ、false：リアカメラ。
view
TXCloudVideoView
ビデオ画像をロードするウィジェット。
callback
ActionCallback
操作コールバック。
stopCameraPreview
ローカルのビデオキャプチャおよびプレビューを停止します。
public abstract void stopCameraPreview();
startPublish
ライブストリーミング（プッシュ）を開始します。次のシーンに適用します：
キャスターの配信開始時の呼び出し
視聴者のマイク接続開始時の呼び出し
public abstract void startPublish(String streamId, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
streamId
String
ライブCDNのstreamIdをバインドするために利用します。視聴者にライブCDN経由で視聴させたい場合は、現在のキャスターのライブストリーミングstreamIdを指定する必要があります。
callback
ActionCallback
操作コールバック。
stopPublish
ライブストリーミング（プッシュ）を停止します。次のシーンに適用します：
キャスターがライブストリーミングを終了する時の呼び出し
視聴者がマイク接続を終了する時の呼び出し
public abstract void stopPublish(TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
callback
ActionCallback
操作コールバック。
startPlay
リモートのビデオ画面を再生します。普通の視聴とマイク接続のシーンで呼び出すことができます。
public abstract void startPlay(String userId, TXCloudVideoView view, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userId
String
視聴が必要なユーザーid。
view
TXCloudVideoView
ビデオ画像をロードするviewウィジェット。
callback
ActionCallback
操作コールバック。
普通の視聴シーン
ライブストリーミングルームリストにキャスターのuserId情報がすでに含まれている場合、視聴者は、enterRoom()成功後にstartPlay(userId)を直接呼び出せばキャスターの画面を再生できます。
ルーム参加前にキャスターのuserIDが一時的に取得できない場合、視聴者はルーム参加後に TRTCLiveRoomDelegateの中のonAnchorEnter(userId)のイベントコールバックを受信します。このコールバックの中にキャスターのuserID情報が含まれていますので、startPlay(userId)を再び呼び出せば、キャスターの画面を再生できます。
ライブストリーミングのマイク接続シーン
マイク接続の始動後、キャスターはTRTCLiveRoomDelegateからonAnchorEnter(userId)のコールバックを受信します。この時コールバックの中のuserIDを使用してstartPlay(userID)を呼び出せば、マイク接続の画面を再生できます。
stopPlay
リモートのビデオ画面のレンダリングを停止します。onAnchorExit()のコールバック時、このインターフェースを呼び出してください。
public abstract void stopPlay(String userId, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userId
String
相手側のユーザー情報。
callback
ActionCallback
操作コールバック。
キャスターと視聴者のマイク接続
requestJoinAnchor
視聴者がマイク接続をリクエストします。
public abstract void requestJoinAnchor(String reason, int timeout, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
reason
String
マイク接続の理由。
timeout
int
タイムアウトの時間。
callback
ActionCallback
キャスターの応答のコールバック。
キャスターと視聴者のマイク接続フローは次のとおりです：
1. 【視聴者】requestJoinAnchor()を呼び出し、キャスターにマイク接続リクエストを送信します。
2. 【キャスター】 TRTCLiveRoomDelegateのonRequestJoinAnchor()のコールバック通知を受信します。
3. 【キャスター】responseJoinAnchor()を呼び出して、視聴者からのマイク接続リクエストを受け入れるか決定します。
4. 【視聴者】responseCallbackのコールバック通知を受信します。この通知にキャスターの処理結果が含まれています。
5. 【視聴者】リクエストが同意されると、startCameraPreview()が呼び出され、ローカルカメラが起動します。
6. 【視聴者】その後 startPublish()を呼び出し、正式にプッシュストリームの状態に入ります。
7. 【キャスター】一度視聴者がマイク接続に入ると、キャスターは、TRTCLiveRoomDelegateの onAnchorEnter()の通知を受信します。
8. 【キャスター】キャスターが startPlay()を呼び出すと、マイク接続の視聴者のビデオ画面を見ることができるようになります。
9. 【視聴者】ライブストリーミングルームの中で他の視聴者がすでにキャスターとマイク接続を行っている場合、新しく参加したマイク接続の視聴者はonAnchorEnter()の通知を受け取ります。この時にstartPlay()を呼び出せば他のマイク接続者のビデオ画面を再生することができます。
responseJoinAnchor
キャスターがマイク接続のリクエストを処理します。キャスターは、TRTCLiveRoomDelegateの onRequestJoinAnchor()のコールバックを受け取った後、このインターフェースを呼び出して、視聴者のマイク接続リクエストを処理してください。
public abstract void responseJoinAnchor(String userId, boolean agree, String reason);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userId
String
視聴者ID。
agree
boolean
true：同意；false：拒否。
reason
String
マイク接続に同意/拒否した理由の説明。
kickoutJoinAnchor
キャスターがマイク接続の視聴者をキックアウトします。キャスターがこのインターフェースを呼び出し、マイク接続の視聴者をキックアウトすると、キックアウトされたマイク接続の視聴者は、TRTCLiveRoomDelegateのonKickoutJoinAnchor()のコールバック通知を受信します。
public abstract void kickoutJoinAnchor(String userId, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userId
String
マイク接続の視聴者 ID。
callback
ActionCallback
操作コールバック。
キャスターのルーム間PK
requestRoomPK
キャスターがルーム間PKをリクエストします。
public abstract void requestRoomPK(int roomId, String userId, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
roomId
int
招待された側のルーム ID。
userId
String
招待された側のキャスター ID。
callback
ActionCallback
ルーム間PKのリクエスト結果のコールバック。
キャスターとキャスターの間でルーム間PKを行うことができます。ライブストリーミング中の2名のキャスターAとBのルーム間PKのフローは次のとおりです：
1. 【キャスター A】 requestRoomPK()を呼び出してキャスターBに向けてマイク接続リクエストを送信します。
2. 【キャスター B】TRTCLiveRoomDelegateのonRequestRoomPK()のコールバック通知を受信します。
3. 【キャスター B】responseRoomPK()を呼び出して、キャスター AのPKのリクエストを受け入れるかどうか決定します。
4. 【キャスター B】キャスター Aのリクエストを受け入れる場合は、TRTCLiveRoomDelegateのonAnchorEnter()の通知を待ってから、startPlay()を呼び出してキャスターAのビデオ画面を表示させます 。
5. 【キャスター A】responseCallbackのコールバック通知を受信します。この通知にはキャスター B の処理結果が含まれます。
6. 【キャスターA】リクエストが同意された場合は、TRTCLiveRoomDelegateのonAnchorEnter()の通知を待ってから、startPlay()を呼び出し、キャスターBのビデオ画面を表示します。
responseRoomPK
キャスターがルーム間PKのリクエストに応答します。キャスターが応答した後、相手側キャスターは requestRoomPKで渡されたresponseCallbackのコールバックを受信します。
public abstract void responseRoomPK(String userId, boolean agree, String reason);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userId
String
PKをリクエストしたキャスターID。
agree
boolean
true：同意；false：拒否。
reason
String
PKを同意/拒否した理由の説明。
quitRoomPK
ルーム間PKから退出します。PK中のいずれかのキャスターがルーム間PKの状態から退出すると、もう一方のキャスターはTRTCLiveRoomDelegateのonQuitRoomPk()のコールバック通知を受信します。
public abstract void quitRoomPK(TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
callback
ActionCallback
操作コールバック。
音声ビデオ制御に関連するインターフェース関数
switchCamera
フロント/リアカメラを切り替えます。
public abstract void switchCamera();
setMirror
ミラー表示のオン/オフを設定します。
public abstract void setMirror(boolean isMirror);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
isMirror
boolean
ミラーオン/オフ。
muteLocalAudio
ローカルオーディオをミュートにします。
public abstract void muteLocalAudio(boolean mute);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
mute
boolean
true：ミュート起動、false：ミュート停止。
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：ミュート停止。
BGMサウンドエフェクト関連インターフェース関数
getAudioEffectManager
BGMサウンドエフェクト管理オブジェクト TXAudioEffectManagerを取得します。
public abstract TXAudioEffectManager getAudioEffectManager();
美顔フィルタに関するインターフェース関数
getBeautyManager
美顔管理オブジェクトTXBeautyManagerを取得します。 |
public abstract TXBeautyManager getBeautyManager();
美顔管理では、次の機能を使用できます。
「美顔のスタイル」、「美白」、「肌色補正（血色・つや感）」、「デカ眼」、「顔痩せ」、「V顔」、「下あご」、「面長補正」、「小鼻」、「キラキラ目」、「白い歯」、「目の弛み除去」、「シワ除去」、「ほうれい線除去」などの美容効果を設定します。
「髪の生え際」、「眼と眼の距離」、「眼角度」、「唇の形」、「鼻翼」、「鼻の位置」、「唇の厚さ」、「顔の形」を調整します。
人の顔のスタンプ（素材）等のダイナミック効果を設定します。
メイクアップを追加します。
ジェスチャー認識を行います。
メッセージ送信関連インターフェース関数
sendRoomTextMsg
ルーム内でテキストメッセージをブロードキャストします。通常、弾幕によるチャットに使用します。
public abstract void sendRoomTextMsg(String message, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
message
String
テキストメッセージ。
callback
ActionCallback
送信結果のコールバック。
sendRoomCustomMsg
カスタマイズしたテキストメッセージを送信します。
public abstract void sendRoomCustomMsg(String cmd, String message, TRTCLiveRoomCallback.ActionCallback callback);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
cmd
String
コマンドワードです。開発者がカスタマイズするものであり、主にさまざまなメッセージタイプを区別するために使用されます。
message
String
テキストメッセージ。
callback
ActionCallback
送信結果のコールバック。
デバックに関するインターフェース関数
showVideoDebugLog
インターフェースの中にdebug情報を表示するかどうか。
public abstract void showVideoDebugLog(boolean isShow);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
isShow
boolean
Debug情報表示のオン/オフ。
TRTCLiveRoomDelegateイベントのコールバック
一般的なイベントコールバック
onError
エラーのコールバック。
explain
 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
ライブストリーミングルーム情報変更のコールバック。ライブストリーミングのマイク接続やPKで、ルーム状態の変化を通知するシーンに多用されます。
void onRoomInfoChange(TRTCLiveRoomDef.TRTCLiveRoomInfo roomInfo);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
roomInfo
TRTCLiveRoomInfo
ルーム情報。
キャスターと視聴者の参加／退出のイベントコールバック
onAnchorEnter
新しいキャスターの入室の通知を受信します。マイク接続の視聴者とルーム間PKのキャスターが入室すると、視聴者は、新しいキャスターが入室したというイベントを受信します。TRTCLiveRoomの startPlay()を呼び出して、そのキャスターのビデオ画面を表示することができます。
void onAnchorEnter(String userId);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userId
String
新しく入室したキャスターの ID。
onAnchorExit
キャスターの退室の通知を受信します。ルーム内のキャスター（およびマイク接続中の視聴者）が、新しいキャスターの退室のイベントを受信します。TRTCLiveRoomのstopPlay()を呼び出して、そのキャスターのビデオ画面を閉じることができます。
void onAnchorExit(String userId);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userId
String
ルームを退出したユーザーID。
onAudienceEnter
視聴者入室通知を受信します。
void onAudienceEnter(TRTCLiveRoomDef.TRTCLiveUserInfo userInfo);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userInfo
TRTCLiveUserInfo
入室した視聴者の情報。
onAudienceExit
視聴者退室通知を受信します。
void onAudienceExit(TRTCLiveRoomDef.TRTCLiveUserInfo userInfo);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userInfo
TRTCLiveUserInfo
退室した視聴者の情報。
キャスターと視聴者のマイク接続のイベントコールバック
onRequestJoinAnchor
キャスターが視聴者のマイク接続リクエストを受信した時のコールバック。
void onRequestJoinAnchor(TRTCLiveRoomDef.TRTCLiveUserInfo userInfo, String reason, int timeOut);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userInfo
TRTCLiveUserInfo
マイク接続をリクエストした視聴者の情報。
reason
String
マイク接続の理由の説明。
timeout
int
リクエスト処理のタイムアウトの時間。上の階層がこの時間をオーバーしても処理しない場合、このリクエストは自動的に破棄されます。
onKickoutJoinAnchor
マイク接続の視聴者がマイク接続からキックアウトされた通知を受信します。マイク接続の視聴者は、キャスターからマイク接続キックアウトのメッセージを受信した場合、TRTCLiveRoomのstopPublish() を呼び出してマイク接続から退出する必要があります。
void onKickoutJoinAnchor();
キャスター間PKのイベントコールバック
onRequestRoomPK
ルーム間PKのリクエストの通知を受信します。キャスターは、他のルームのキャスターからPKのリクエストを受け取り、PKに同意する場合、TRTCLiveRoomDelegateのonAnchorEnter()の通知を待ってから、startPlay()を呼び出して招待側キャスターのストリームを再生する必要があります。
void onRequestRoomPK(TRTCLiveRoomDef.TRTCLiveUserInfo userInfo, int timeout);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
userInfo
TRTCLiveUserInfo
ルーム間マイク接続を始動したキャスターの情報。
timeout
int
リクエスト処理のタイムアウトの時間。
onQuitRoomPK
ルーム間PK中止の通知を受信します。
void onQuitRoomPK();
メッセージイベントのコールバック
onRecvRoomTextMsg
テキストメッセージを受信します。
void onRecvRoomTextMsg(String message, TRTCLiveRoomDef.TRTCLiveUserInfo userInfo);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
message
String
テキストメッセージ。
userInfo
TRTCLiveUserInfo
送信者のユーザー情報。
onRecvRoomCustomMsg
カスタムメッセージを受信します。
void onRecvRoomCustomMsg(String cmd, String message, TRTCLiveRoomDef.TRTCLiveUserInfo userInfo);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
command
String
コマンドワードです。開発者がカスタマイズするものであり、主にさまざまなメッセージタイプを区別するために使用されます。
message
String
テキストメッセージ。
userInfo
TRTCLiveUserInfo
送信者のユーザー情報。
﻿
TRTCAudioEffectManager
playBGM
BGMを再生します。
void playBGM(String url, int loopTimes, int bgmVol, int micVol, TRTCCloud.BGMNotify notify);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
url
String
BGMファイルパス。
loopTimes
int
ループ回数
bgmVol
int
BGM音量
micVol
int
キャプチャ音量
notify
TRTCCloud.BGMNotify
再生の通知
stopBGM
BGMの再生を停止します。
void stopBGM();
pauseBGM
BGMの再生を一時停止します。
void pauseBGM();
resumeBGM
BGMの再生を続けます
void resumeBGM();
setBGMVolume
BGMの音量の大きさを設定します。BGMをミキシングして再生する時に使用し、BGMの音量の大きさの制御に利用します。
void setBGMVolume(int volume);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
volume
int
音量の大きさ。100は通常の音量を表し、値の範囲は0 - 100です。デフォルト値は100です。
setBGMPosition
BGM再生の進度を設定します。
int setBGMPosition(int position);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
position
int
BGM再生の進度。単位はミリ秒（ms）。
戻る
0：成功。
setMicVolume
マイク音量の大きさを設定します。BGMをミキシングして再生する時に使用し、マイク音量の大きさの制御に利用します。
void setMicVolume(int volume);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
volume
Int
音量の大きさ。値の範囲は0 - 100、デフォルト値は100です。
setReverbType
リバーブ効果を設定します。
void setReverbType(int reverbType);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
reverbType
int
リバーブタイプ。詳細は、TRTCCloudDefの中のTRTC_REVERB_TYPEの定義をご参照ください。
setVoiceChangerType
ボイスチェンジのタイプを設定します。
void setVoiceChangerType(int type);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
type
int
リバーブタイプ。詳細は、TRTCCloudDefの中のTRTC_VOICE_CHANGER_TYPEの定義をご参照ください。
playAudioEffect
サウンドエフェクトを再生します。サウンドエフェクトごとに具体的なIDを指定する必要があります。このIDでサウンドエフェクトのスタート、ストップ、音量等を設定することができます。aac、mp3、m4a形式をサポートしています。
void playAudioEffect(int effectId, String path, int count, boolean publish, int volume);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
effectId
int
サウンドエフェクト ID。
path
String
サウンドエフェクトパス。
count
int
ループ回数。
publish
boolean
プッシュかどうか / trueは視聴者に対するプッシュ、 falseはローカルプレビューです。
volume
int
音量の大きさ。数値の範囲は0 - 100、デフォルト値は100です。
pauseAudioEffect
サウンドエフェクトの再生を一時停止します。
void pauseAudioEffect(int effectId);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
effectId
int
サウンドエフェクト ID。
resumeAudioEffect
サウンドエフェクトの再生を再開します。
void resumeAudioEffect(int effectId);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
effectId
int
サウンドエフェクト ID。
stopAudioEffect
サウンドエフェクトの再生を停止します。
void stopAudioEffect(int effectId);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
effectId
int
サウンドエフェクト ID。
stopAllAudioEffects
すべてのサウンドエフェクトの再生を停止します。
void stopAllAudioEffects();
setAudioEffectVolume
サウンドエフェクトの音量を設定します。
void setAudioEffectVolume(int effectId, int volume);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
effectId
int
サウンドエフェクト ID。
volume
int
音量の大きさ。数値の範囲は0 - 100、デフォルト値は100です。
setAllAudioEffectsVolume
全てのサウンドエフェクトの音量を設定します。
void setAllAudioEffectsVolume(int volume);
パラメータは下表に示すとおりです：
パラメータ
タイプ
意味
volume
int
音量の大きさ。数値の範囲は0 - 100、デフォルト値は100です。

お問い合わせ

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

テクニカルサポート

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

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

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

API	説明
createRoom	ルームの作成（キャスターが呼び出し）。ルームが存在しない場合は、システムが新しいルームを自動作成します。
destroyRoom	ルームの破棄（キャスターが呼び出し）。
enterRoom	入室（視聴者が呼び出し）。
exitRoom	退室（視聴者が呼び出し）。
getRoomInfos	ルームリストの詳細情報を取得します。
getAnchorList	ルーム内の全キャスターのリストを取得します。enterRoom()成功後に呼び出しが有効になります。
getAudienceList	ルーム内の全視聴者の情報を取得します。enterRoom()成功後に呼び出しが有効になります。

API	説明
startCameraPreview	ローカルビデオのプレビュー画面を立ち上げます。
stopCameraPreview	ローカルのビデオキャプチャおよびプレビューを停止します。
startPublish	ライブストリーミング（プッシュ）を開始します。
stopPublish	ライブストリーミング（プッシュ）を停止します。
startPlay	リモートのビデオ画面を再生します。普通の視聴とマイク接続のシーンで呼び出すことができます。
stopPlay	リモートのビデオ画面のレンダリングを停止します。

API	説明
requestJoinAnchor	視聴者がマイク接続をリクエストします。
responseJoinAnchor	キャスターがマイク接続のリクエストを処理します。
kickoutJoinAnchor	キャスターがマイク接続の視聴者をキックアウトします。

API	説明
requestRoomPK	キャスターがルーム間のPKをリクエストします。
responseRoomPK	キャスターがルーム間PKのリクエストに応答します。
quitRoomPK	ルーム間PKから退出します。

API	説明
switchCamera	フロント/リアカメラを切り替えます。
setMirror	ミラー表示のオン/オフを設定します。
muteLocalAudio	ローカルオーディオをミュートにします。
muteRemoteAudio	リモートオーディオをミュートにします。
muteAllRemoteAudio	全てのリモート側のオーディオをミュートにします。

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

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

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

API	説明
showVideoDebugLog	インターフェースにdebug情報を表示するか。

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

API	説明
onRoomDestroy	ルームが破棄された時のコールバック。
onRoomInfoChange	ライブストリーミングルーム情報変更のコールバック。

API	説明
onAnchorEnter	新しいキャスターの入室通知を受信します。
onAnchorExit	キャスターの退室通知を受信します。
onAudienceEnter	視聴者入室通知の受信。
onAudienceExit	視聴者退室通知の受信。

API	説明
onRequestJoinAnchor	キャスターが視聴者のマイク接続リクエストを受信した時のコールバック。
onKickoutJoinAnchor	マイク接続の視聴者がマイク接続からキックアウトされた通知を受信します。

API	説明
onRequestRoomPK	ルーム間PKのリクエストの通知を受信。
onQuitRoomPK	ルーム間PK中止の通知を受信します。

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

パラメータ	タイプ	意味
context	Context	Androidコンテキスト。内部ではApplicationContextに変換してシステムAPIの呼び出しに使用します

tencent cloud

サインアップ

ログイン

Recent Pages

TRTCLiveRoom API (Android)

TRTCLiveRoom API 概要

SDK基本関数

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

プッシュプルストリームに関連するインターフェース関数

キャスターと視聴者のマイク接続

キャスターのルーム間PK

音声ビデオ制御に関連するインターフェース関数

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

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

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

デバックに関するインターフェース関数

TRTCLiveRoomDelegate API概要

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

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

キャスターと視聴者の参加/退出のイベントコールバック

キャスターと視聴者のマイク接続のイベントコールバック

キャスター間PKのイベントコールバック

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

SDK基本関数

sharedInstance

destroySharedInstance

setDelegate

setDelegateHandler

login

logout

setSelfProfile

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

createRoom

destroyRoom

enterRoom

exitRoom

getRoomInfos

getAnchorList

getAudienceList

プッシュプルストリームに関連するインターフェース関数

startCameraPreview

stopCameraPreview

startPublish

stopPublish

startPlay

stopPlay

キャスターと視聴者のマイク接続

requestJoinAnchor

responseJoinAnchor

kickoutJoinAnchor

キャスターのルーム間PK

requestRoomPK

responseRoomPK

quitRoomPK

音声ビデオ制御に関連するインターフェース関数

switchCamera

setMirror

muteLocalAudio

muteRemoteAudio

muteAllRemoteAudio

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

getAudioEffectManager

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

getBeautyManager

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

sendRoomTextMsg

sendRoomCustomMsg

デバックに関するインターフェース関数

showVideoDebugLog

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

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

onError

onWarning

onDebugLog

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

onRoomDestroy

onRoomInfoChange

キャスターと視聴者の参加／退出のイベントコールバック

onAnchorEnter

onAnchorExit