tencent cloud

フィードバック

TUICallKit

最終更新日: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();
    お問い合わせ

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

    テクニカルサポート

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

    電話サポート(24 時間365日対応)