tencent cloud

TUICallKit APIの概要

TUICallKit APIはオーディオビデオ通話コンポーネントのUIインターフェース付きのものです。TUICallKit APIを使用することで、WeChatのようなオーディオビデオ通話シーンをシンプルなインターフェースでスピーディーに実現できます。より詳細なアクセス手順については、TUICallKitクイックアクセスをご参照ください。

APIの概要

API	説明
createInstance	TUICallKitインスタンスの作成（シングルトンモード）
setSelfInfo	ユーザーのニックネーム、プロフィール画像の設定
call	1v1通話の開始
groupCall	グループ通話の開始
joinInGroupCall	現在のグループ通話に自主的に参加
setCallingBell	カスタム着信音の設定
enableMuteMode	ミュートモードのオン/オフ
enableFloatWindow	フローティングウィンドウ機能のオン/オフ

APIの詳細

createInstance

TUICallKitのシングルトンを作成します。

TUICallKit createInstance(Context context)

setSelfInfo

ユーザーニックネーム、プロフィール画像を設定します。ユーザーニックネームは500バイト以内、ユーザープロフィール画像はURL形式でなければなりません。

void setSelfInfo(String nickname, String avatar, TUICommonDefine.Callback callback)

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

パラメータ	タイプ	意味
nickname	String	ターゲットユーザーのニックネーム
avatar	String	ターゲットユーザーのプロフィール画像

call

電話をかけます（1v1通話）。

void call(String userId, TUICallDefine.MediaType callMediaType)

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

パラメータ	タイプ	意味
userId	String	ターゲットユーザーのuserId
callMediaType	TUICallDefine.MediaType	通話のメディアタイプ。ビデオ通話、音声通話など

groupCall

グループ通話を開始します。

注意：

グループ通話を使用する前にIMグループを作成する必要があります。作成済みの場合は無視してください。

void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType callMediaType) {

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

パラメータ	タイプ	意味
groupId	String	今回のグループ通話のグループID
userIdList	List	ターゲットユーザーのuserIdリスト
callMediaType	TUICallDefine.MediaType	通話のメディアタイプ。ビデオ通話、音声通話など

joinInGroupCall

グループ通話を開始します。

注意：

グループ通話を使用する前にIMグループを作成する必要があります。作成済みの場合は無視してください。

void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, TUICallDefine.MediaType callMediaType, TUICommonDefine.Callback callback);

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

パラメータ	タイプ	意味
roomId	TUICommonDefine.RoomId	今回の通話のオーディオビデオルームID。現在は数字のルームナンバーのみサポートしています。文字列のルームナンバーは今後のバージョンでサポート予定です
groupId	String	今回のグループ通話のグループID
callMediaType	TUICallDefine.MediaType	通話のメディアタイプ。ビデオ通話、音声通話など

setCallingBell

カスタム着信音を設定します。 ここではローカルファイルアドレスのみ渡すことができます。このファイルディレクトリにアプリケーションがアクセスできることを確認する必要があります。

着信音を設定後、デバイスにバインドします。ユーザーを変更しても着信音はそのまま有効です。

デフォルトの着信音に戻したい場合は、filePathにnullを渡します。

void setCallingBell(String filePath);

enableMuteMode

ミュートモードをオン/オフします。

void enableMuteMode(boolean enable);

enableFloatWindow

フローティングウィンドウ機能をオン/オフします。

デフォルトではfalseで、通話画面の左上隅のフローティングウィンドウボタンは非表示になっており、trueに設定すると表示されます。

void enableFloatWindow(boolean enable);