tencent cloud

Tencent Real-Time Communication

お知らせ・リリースノート
製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
製品の説明
製品概要
基礎概念
製品の機能
製品の強み
ユースケース
性能データ
購入ガイド
Billing Overview
無料時間の説明
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
課金に関するよくあるご質問
Refund Instructions
初心者ガイド
Demo体験
Call
コンポーネントの説明(TUICallKit)
Activate the Service
Run Demo
クイック導入
オフライン通知
Conversational Chat
クラウドレコーディング(TUICallKit)
AI Noise Reduction
インターフェースのカスタマイズ
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
公開ログ
よくある質問
ライブ配信
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Demo のクイックスタート
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDKのダウンロード
APIコードサンプル
Usage Guidelines
クライアント側 API
高度な機能
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
コンソールガイド
アプリケーション管理
使用統計
監視ダッシュボード
開発支援
Solution
Real-Time Chorus
よくあるご質問
課金関連問題
機能関連
UserSig関連
ファイアウォールの制限の対応関連
インストールパッケージの圧縮に関するご質問
AndriodおよびiOS関連
Web端末関連
Flutter関連
Electron関連
TRTCCalling Web関連
オーディオビデオ品質関連
その他のご質問
旧バージョンのドキュメント
TUIRoom(Web)の統合
TUIRoom (Android)の統合
TUIRoom (iOS)の統合
TUIRoom (Flutter)の統合
TUIRoom (Electron)の統合
TUIRoom APIのクエリー
クラウドレコーディングと再生の実現(旧)
Protocols and Policies
セキュリティコンプライアンス認証
セキュリティホワイトペーパー
情報セキュリティの説明
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
用語集

TUICallKit

PDF
フォーカスモード
フォントサイズ
最終更新日: 2024-07-19 14:53:21

APIの概要

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

APIの概要

<TUICallKit/>:UI通話コンポーネントを主体としています
<TUICallKitMini/>:UI通話フローティングウィンドウで、<TUICallKit/>allowedMinimizedtrueに設定されている場合、<TUICallKitMini/> はページ内に配置する必要があります
TUICallKitServer: 通話インスタンス、メンバーの関数です。
init TUICallKitの初期化
call 1v1通話の開始
groupCall グループ通話の開始
destroyed TUICallKitの破棄

<TUICallKit/> APIの詳細

属性

パラメータ
説明
タイプ
入力必須かどうか
デフォルト値
allowedMinimized
最小化を許可するかどうか。最小化ボタンは非表示
boolean
いいえ
false
allowedFullScreen
フルスクリーンを許可するかどうか。フルスクリーンボタンは非表示
boolean
いいえ
true

方法

パラメータ
説明
タイプ
入力必須かどうか
デフォルト値
beforeCalling
電話をかける前と通話の招待を受信する前にこの関数を実行
function(type、error)
いいえ
-
afterCalling
通話終了後にこの関数を実行
function()
いいえ
-
onMinimized
コンポーネントを最小化状態に切り替えた時にこの関数を実行
function(oldStatus、newStatus)
いいえ
-

<TUICallKitMini/> APIの詳細

なし

サンプルコード

/**
* beforeCalling
* @param { string } type値は"invited"です | "call" | "groupCall"は、 着信と発信の区別に使用できます
* @param { number } error.code エラーコード
* @param { string } error.type エラータイプ
* @param { string } error.code エラー情報
*/
function beforeCalling(type, error) {
console.log("通話前にこの関数を実行、タイプ: "、type、error);
}
function afterCalling() {
console.log("通話後にこの関数を実行");
}
/**
* onMinimized
* @param { boolean } oldStatus
* @param { boolean } newStatus
*/
function onMinimized(oldStatus, newStatus) {
if (newStatus === true) {
console.log("TUICallKit 最小化状態に進む");
}else{
console.log("TUICallKit 最小化状態を終了");
}
}
<TUICallKit
:allowedMinimized="true"
:allowedFullScreen="true"
:beforeCalling="beforeCalling"
:afterCalling="afterCalling"
:onMinimized="onMinimized"
/>
<TUICallKitMini />

TUICallKitServer APIの詳細

init

TUICallKitの初期化はcall、groupCallの前に行う必要があります。
import { TUICallKitServer } from "./components/TUICallKit/Web";
TUICallKitServer.init({
SDKAppID,
userID,
userSig,
tim,
});
パラメータは下表に示すとおりです。
パラメータ
タイプ
入力必須かどうか
意味
SDKAppID
Number
はい
IMアプリケーションのSDKAppID
userID
String
はい
現在のユーザーID、文字列タイプでは、アルファベット(a-z および A-Z)、数字(0-9)、ハイフン(-)、アンダーバー(_)のみ使用できます
userSig
String
はい
Tencent Cloudによって設計されたセキュリティ保護署名です。取得方法については、UserSigをご参照ください
TIMインスタンス
Any
いいえ
timパラメータはサービス内にすでに存在するTIMインスタンスに適用され、TIMインスタンスの一意性を保証します

call

電話をかけます(1v1通話)。
import { TUICallKitServer } from "./components/TUICallKit/Web";
TUICallKitServer.call({
userID: 'jack',
type: 1,
});
パラメータは下表に示すとおりです。
パラメータ
タイプ
入力必須かどうか
意味
userID
String
はい
ターゲットユーザーのuserId
type
Number
はい
通話のメディアタイプ。音声通話(type = 1)、ビデオ通話(type = 2)
timeout
Number
いいえ
通話のタイムアウト時間。0はタイムアウトしていないことを意味し、単位はs(秒)(オプション) - デフォルト 30s
offlinePushInfo
Object
いいえ
メッセージのオフラインプッシュをカスタマイズします(オプション)-- tsignaling バージョンは >= 0.8.0が必要です
そのうちofflinePushInfoについて
パラメータ
タイプ
入力必須かどうか
意味
offlinePushInfo.title
String
いいえ
タイトルのオフラインプッシュ(オプション)
offlinePushInfo.description
String
いいえ
コンテンツのオフラインプッシュ(オプション)
offlinePushInfo.androidOPPOChannelID
String
いいえ
オフラインプッシュでは、OPPO携帯(8.0およびそれ以降のシステム)のチャンネルIDを設定します(オプション)
offlinePushInfo.extension
String
いいえ
オフラインプッシュによるコンテンツのパススルー(オプション)(tsignalingバージョン >= 0.9.0)

groupCall

グループ通話を開始します。
import { TUICallKitServer } from "./components/TUICallKit/Web";
TUICallKitServer.groupCall({
userIDList: ['jack', 'tom'],
groupID: 'xxx',
type: 1,
});
パラメータは下表に示すとおりです。
パラメータ
タイプ
入力必須かどうか
意味
userIDList
Array
はい
招待リストメンバーリスト
type
Number
はい
通話のメディアタイプ。音声通話(type = 1)、ビデオ通話(type = 2)
groupID
String
はい
グループIDの呼び出し
timeout
Number
いいえ
通話のタイムアウト時間。0はタイムアウトしていないことを意味し、単位はs(秒)(オプション) - デフォルト 30s
offlinePushInfo
Object
いいえ
メッセージのオフラインプッシュをカスタマイズします(オプション)-- tsignaling バージョンは >= 0.8.0が必要です
そのうちofflinePushInfoは、callインターフェースと一致します。

destroyed

TUICallKitを破棄します。
import { TUICallKitServer } from "./components/TUICallKit/Web";
TUICallKitServer.destroyed();

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック