tencent cloud

피드백

TUICallKit

마지막 업데이트 시간:2023-02-10 18:26:20

    API 소개

    TUICallKit API는 UI 요소를 포함하는 음성/영상 통화 컴포넌트입니다. API를 사용하여 WeChat과 유사한 음성/영상 통화 애플리케이션을 빠르게 구현할 수 있습니다. 통합에 대한 지침은 TUICallKit 통합을 참고하십시오.

    API 개요

    
    <TUICallKit/>: 통화 컴포넌트
    <TUICallKitMini/>: 플로팅 통화 창, <TUICallKit/>allowedMinimizedtrue인 경우 <TUICallKitMini/> 필요
    TUICallKitServer: 다음 API가 있는 통화 인스턴스:
    init TUICallKit 초기화
    call 1v1 통화 걸기
    groupCall 그룹 통화 걸기
    destroyed TUICallKit 종료

    <TUICallKit/> API 세부 사항

    속성

    매개변수
    설명
    유형
    필수
    기본값
    allowedMinimized
    창 최소화 허용 여부. true이면 <TUICallKitMini/>가 필요합니다. false이면 최소화 버튼이 숨겨집니다.
    boolean
    아니오
    false
    allowedFullScreen
    전체 화면 허용 여부입니다. false이면 전체 화면 버튼이 숨겨집니다.
    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

    이 API는 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

    이 API는 (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은 호출이 시간 초과되지 않음을 나타냄, 기본값은 30s
    offlinePushInfo
    Object
    아니오
    사용자 지정 오프라인 푸시 메시지(옵션), tsignaling 버전이 0.8.0 이상인 경우에만 유효
    offlinePushInfo
    매개변수
    유형
    필수
    설명
    offlinePushInfo.title
    String
    아니오
    메시지 제목(옵션)
    offlinePushInfo.description
    String
    아니오
    메시지 내용(옵션)
    offlinePushInfo.androidOPPOChannelID
    String
    아니오
    v8.0 이상에서 OPPO 휴대폰의 오프라인 푸시 메시지에 대한 채널 ID(옵션)
    offlinePushInfo.extension
    String
    아니오
    통과 콘텐츠(옵션), tsignaling 버전이 0.9.0 이상인 경우에만 유효

    groupCall

    이 API는 그룹 통화를 하는 데 사용됩니다.
    import { TUICallKitServer } from "./components/TUICallKit/Web";
    TUICallKitServer.groupCall({
    userIDList: ['jack', 'tom'],
    groupID: 'xxx',
    type: 1,
    });
    매개변수는 다음과 같습니다.
    매개변수
    유형
    필수
    설명
    userIDList
    Array
    호출할 사용자의 ID
    type
    Number
    통화 유형, 음성 통화(type = 1), 영상 통화(type = 2)
    groupID
    String
    그룹 ID
    timeout
    Number
    아니오
    제한 시간(초)(옵션), 0은 호출이 시간 초과되지 않음을 나타냄, 기본값은 30s
    offlinePushInfo
    Object
    아니오
    사용자 지정 오프라인 푸시 메시지(옵션), tsignaling 버전이 0.8.0 이상인 경우에만 유효
    offlinePushInfo의 매개변수는 위를 참고하십시오.

    destroyed

    이 API는 TUICallKit을 종료하는 데 사용됩니다.
    import { TUICallKitServer } from "./components/TUICallKit/Web";
    TUICallKitServer.destroyed();
    
    문의하기

    고객의 업무에 전용 서비스를 제공해드립니다.

    기술 지원

    더 많은 도움이 필요하시면, 티켓을 통해 연락 바랍니다. 티켓 서비스는 연중무휴 24시간 제공됩니다.

    연중무휴 24시간 전화 지원