tencent cloud

Feedback

TUICallEngine

Last updated: 2024-03-07 10:46:00

    TUICallEngine API

    TUICallEngine is an audio/video call component that does not include UI elements. If TUICallKit does not meet your requirements, you can use the APIs of TUICallEngine to customize your project.
    Note
    It needs to be used with TencentCloud-TUICallKit plugin and cannot be used alone.

    API Overview

    API
    Description
    hangup
    Ends a call.
    accept
    Accepts a call.
    Set the rendering mode of video image.
    Set the encoding parameters of video encoder.

    API Details

    hangup

    This API is used to end a call.
    const TUICallEngine = uni.requireNativePlugin('TencentCloud-TUICallKit-TUICallEngine');
    TUICallEngine.hangup();

    accept

    This API is used to accept a call. After receiving the onCallReceived() callback, you can call this API to accept the call.
    const TUICallEngine = uni.requireNativePlugin('TencentCloud-TUICallKit-TUICallEngine');
    TUICallEngine.accept();

    setVideoRenderParams

    Set the rendering mode of video image.
    const TUICallEngine = uni.requireNativePlugin('TencentCloud-TUICallKit-TUICallEngine');
    const params = {
    userID: '234',
    fillMode: 0, // 0-fill mode,1-adapter mode
    rotation: 1, // 0:Rotation_0; 1: Rotation_90; 2: Rotation_180; 3: Rotation_270
    };
    TUICallEngine.setVideoRenderParams(params, (res) => {
    console.warn('res = ', JSON.stringify(res));
    });
    The parameters are described below:
    Parameter
    Type
    Description
    userID
    String
    target userId
    params
    Object
    Video frame rendering parameters, e.g. frame rotation angle, fill mode

    setVideoEncoderParams

    Set the encoding parameters of video encoder.
    This setting can determine the quality of image viewed by remote users, which is also the image quality of on-cloud recording files.
    const TUICallEngine = uni.requireNativePlugin('TencentCloud-TUICallKit-TUICallEngine');
    const params = {
    resolution: 108,
    resolutionMode: 0, // 0--landscape,1--portrait
    };
    TUICallEngine.setVideoEncoderParams(params, (res) => {
    console.warn('res = ', JSON.stringify(res));
    });
    The parameters are described below:
    Parameter
    Type
    Description
    resolution
    Number
    video resolution
    62: aspect ratio 16:9;resolution 640x360;
    64: aspect ratio 4:3;resolution 960x720;
    108: aspect ratio 16:9;resolution 640x360;
    110: aspect ratio 16:9;resolution 960x540;
    112: aspect ratio 16:9;resolution 1280x720;
    114: aspect ratio 16:9;resolution 1920x1080;
    resolutionMode
    Number
    resolution mode
    0: Landscape
    1: Portrait
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support