- お知らせ・リリースノート
- 製品の説明
- 購入ガイド
- 初心者ガイド
- Demo体験
- Video Calling (Including UI)
- Voice Chat Room (with UI)
- UIを含まない統合ソリューション
- 高度な機能
- サーバー側 API
- コンソールガイド
- Solution
- よくあるご質問
- 旧バージョンのドキュメント
- Protocols and Policies
- TRTC ポリシー
- 用語集
- お知らせ・リリースノート
- 製品の説明
- 購入ガイド
- 初心者ガイド
- Demo体験
- Video Calling (Including UI)
- Voice Chat Room (with UI)
- UIを含まない統合ソリューション
- 高度な機能
- サーバー側 API
- コンソールガイド
- Solution
- よくあるご質問
- 旧バージョンのドキュメント
- Protocols and Policies
- TRTC ポリシー
- 用語集
API概要
最終更新日:2022-11-21 16:34:36
TUICallKit (UIインターフェースあり)
TUICallKit APIはオーディオビデオ通話コンポーネントのUIインターフェース付きのものです。TUICallKit APIを使用することで、WeChatのようなオーディオビデオ通話シーンをシンプルなインターフェースでスピーディーに実現できます。
| API | 説明 |
|---|---|
| createInstance | TUICallKitインスタンスの作成（シングルトンモード） |
| setSelfInfo | ユーザーのプロフィール画像、ニックネームの設定 |
| call | 1v1通話の開始 |
| groupCall | グループ通話の開始 |
| joinInGroupCall | 現在のグループ通話に自主的に参加 |
| setCallingBell | カスタム着信音の設定 |
| enableMuteMode | ミュートモードのオン/オフ |
| enableFloatWindow | フローティングウィンドウ機能のオン/オフ |
TUICallEngine (UIインターフェースなし)
TUICallEngine APIはオーディオビデオ通話コンポーネントのUIインターフェースがないものです。TUICallKitのインタラクションではニーズを満たせない場合はこのAPIを使用し、業務ニーズに応じてパッケージをカスタマイズすることができます。
| API | 説明 |
|---|---|
| createInstance | TUICallEngineインスタンスの作成（シングルトンモード） |
| destroyInstance | TUICallEngineインスタンスの破棄（シングルトンモード） |
| init | オーディオビデオ通話基本機能の認証完了 |
| addObserver | イベントコールバックの追加 |
| removeObserver | コールバックインターフェースの削除 |
| call | 1v1通話の開始 |
| groupCall | グループ通話の開始 |
| accept | 通話応答 |
| reject | 通話拒否 |
| hangup | 通話終了 |
| ignore | 通話を無視 |
| inviteUser | グループ通話中に他の人を招待 |
| joinInGroupCall | 現在のグループ通話に自主的に参加 |
| switchCallMediaType | 通話メディアタイプの切り替え。ビデオ通話からオーディオ通話への切り替えなど |
| setRenderView | ビデオ画面に表示するViewオブジェクトの設定 |
| startRemoteView | ビデオ画面に表示するViewオブジェクトの設定 |
| stopRemoteView | ビデオ画面に表示するViewオブジェクトの設定 |
| openCamera | カメラの起動 |
| closeCamera | カメラの終了 |
| switchCamera | フロント/リアカメラの切り替え |
| openMicrophone | マイクをオンにする |
| closeMicrophone | マイクをオフにする |
| selectAudioPlaybackDevice | オーディオ再生デバイスの選択（ヘッドホン/ハンズフリー） |
| setSelfInfo | ユーザーのプロフィール画像、ニックネームの設定 |
| enableMultiDeviceAbility | TUICallEngineのマルチデバイスログインモードのオン/オフ （プレミアム版パッケージのみサポート） |
TUICallObserver
TUICallObserverはTUICallEngineに対応するコールバックイベントクラスです。このコールバックによって、関心のあるコールバックイベントを監視することができます。
| API | 説明 |
|---|---|
| onError | 通話中のエラーコールバック |
| onCallReceived | 通話リクエストのコールバック |
| onCallCancelled | 通話キャンセルのコールバック |
| onCallBegin | 通話接続のコールバック |
| onCallEnd | 通話終了のコールバック |
| onCallMediaTypeChanged | 通話メディアタイプ変更発生のコールバック |
| onUserReject | xxxxユーザーによる通話拒否のコールバック |
| onUserNoResponse | xxxxユーザーの応答なしのコールバック |
| onUserLineBusy | xxxxユーザーが通話中である場合のコールバック |
| onUserJoin | xxxxユーザーの通話参加のコールバック |
| onUserLeave | xxxxユーザーの通話からの退出のコールバック |
| onUserVideoAvailable | xxxユーザーのビデオストリームの有無のコールバック |
| onUserAudioAvailable | xxxユーザーのオーディオストリームの有無のコールバック |
| onUserVoiceVolumeChanged | 全ユーザーの音量レベルフィードバックのコールバック |
| onUserNetworkQualityChanged | 全ユーザーのネットワーク品質フィードバックのコールバック |
主要なタイプの定義
| API | 説明 |
|---|---|
| TUICallMediaType | 通話のメディアタイプ。列挙タイプ：ビデオ通話、音声通話 |
| TUICallRole | 通話のロール。列挙タイプ：発呼側、着呼側 |
| TUICallStatus | 通話の状態。列挙タイプ：アイドル状態、応答待ち、応答中 |
| TUIRoomId | オーディオビデオルームId。数字、文字列の2種類をサポートしています |
| TUICallCamera | カメラIdパラメータ。列挙タイプ：フロントカメラ、リアカメラ |
| TUIAudioPlaybackDevice | 音声再生デバイス。列挙タイプ：スピーカー、ヘッドホン |
| TUINetworkQualityInfo | 現在のネットワーク品質情報 |
はい
いいえ
この記事はお役に立ちましたか？