PrevNext
search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    Data Types

    Last updated: 2021-06-15 17:55:07
    Download PDF

    AbnormalEvent

    Types of exception events that can cause an exceptional experience

    Used by actions: DescribeAbnormalEvent.

    Name Type Description
    AbnormalEventId Integer Exception event ID. For specific values, please see Appendix. Exceptional Experience ID Mapping Table.
    PeerId String Remote user ID. If this parameter is left empty, it indicates that the exception event is not caused by the remote user.
    Note: this field may return null, indicating that no valid values can be obtained.

    AbnormalExperience

    Exceptional user experience and possible causes

    Used by actions: DescribeAbnormalEvent.

    Name Type Description
    UserId String User ID
    ExperienceId Integer Exceptional experience ID
    RoomId String Room ID in string type
    AbnormalEventList Array of AbnormalEvent Exception event array
    EventTime Integer Report time of the exception event

    EncodeParams

    Output stream encoding parameters for MCU On-Cloud MixTranscoding

    Used by actions: StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId.

    Name Type Required Description
    AudioSampleRate Integer Yes Output audio sample rate (Hz) for On-Cloud MixTranscoding. Valid values: 48000, 44100, 32000, 24000, 16000, 8000
    AudioBitrate Integer Yes Output audio bitrate (Kbps) for On-Cloud MixTranscoding. Value range: 8-500
    AudioChannels Integer Yes Number of sound channels of output stream for On-Cloud MixTranscoding. Valid values: 1, 2. 1 represents mono-channel, and 2 represents dual-channel.
    VideoWidth Integer No Output stream width in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1920].
    VideoHeight Integer No Output stream height in pixels for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [0, 1080].
    VideoBitrate Integer No Output bitrate (Kbps) for On-Cloud MixTranscoding, which is required for audio-video output. Value range: 1-10000
    VideoFramerate Integer No Output stream frame rate for On-Cloud MixTranscoding in FPS. This parameter is required for audio/video outputs. Value range: [1, 60].
    VideoGop Integer No Output stream GOP in seconds for On-Cloud MixTranscoding, which is required for audio/video output. Value range: [1, 5].
    BackgroundColor Integer No Output background color for On-Cloud MixTranscoding. Valid values: decimal integers. Commonly used colors include:
    Red: 0xff0000, whose decimal number is 16724736
    Yellow: 0xffff00, whose decimal number is 16776960
    Green: 0x33cc00, whose decimal number is 3394560
    Blue: 0x0066ff, whose decimal number is 26367
    Black: 0x000000, whose decimal number is 0
    White: 0xFFFFFF, whose decimal number is 16777215
    Grey: 0x999999, whose decimal number is 10066329
    BackgroundImageId Integer No Output stream background image for stream mix. Its value is the ID of image uploaded through the TRTC Console.
    AudioCodec Integer No Output audio codec for On-Cloud MixTranscoding. Valid values: 0, 1, 2. 0 (default): LC-AAC; 1: HE-AAC; 2: HE-AACv2. If this parameter is set to 2 (HE-AACv2), On-Cloud MixTranscoding can produce only dual-channel streams. If it is set to 1 (HE-AAC) or 2 (HE-AACv2), the valid values for the audio sample rate of output streams are 48000, 44100, 32000, 24000, and 16000.

    EventList

    List of SDK or WebRTC events.

    Used by actions: DescribeDetailEvent.

    Name Type Description
    Content Array of EventMessage Data content
    PeerId String Sender userId

    EventMessage

    Event information, including event timestamp and event ID.

    Used by actions: DescribeDetailEvent.

    Name Type Description
    Type Integer Video stream type:
    0: non-video event;
    2: big image;
    3: small image;
    7: relayed stream image.
    Time Integer Event reporting time in the format of UNIX timestamp, such as 1589891188801ms
    EventId Integer Event ID. Events divide into SDK events and WebRTC events. For more information, please see Appendix - Event ID Mapping Table at https://intl.cloud.tencent.com/document/product/647/44916?from_cn_redirect=1
    ParamOne Integer First event parameter, such as video resolution width
    ParamTwo Integer Second event parameter, such as video resolution height

    LayoutParams

    MCU On-Cloud MixTranscoding layout parameters

    Used by actions: StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId.

    Name Type Required Description
    Template Integer No On-cloud stream mix layout template ID. 0: floating template (default value); 1: grid template; 2: screen sharing template; 3: picture-in-picture template; 4: custom template.
    MainVideoUserId String No ID of the user in the big image, which takes effect in a screen sharing, floating, or picture-in-picture template.
    MainVideoStreamType Integer No Stream type of the big image, which takes effect in a screen sharing, floating, or picture-in-picture template. 0: camera; 1: screen sharing. If a web user's stream is displayed in the big image on the left, enter 0 for this parameter.
    SmallVideoLayoutParams SmallVideoLayoutParams No Layout parameter of the small image, which takes effect in a picture-in-picture template.
    MainVideoRightAlign Integer No You can set the layout parameter as 1 or 0 in the screen sharing template. 1: big image on the right and small images on the left, 0: big image on the left and small images on the right. The default value is 0.
    MixVideoUids Array of String No A user list, which takes effect for floating, grid, or screen sharing templates. When the user list has been set, the stream mix output for users in this user list will include both audio and video; the stream mix output for users not in the list will only include audio. Up to 16 users can be set.
    PresetLayoutConfig Array of PresetLayoutConfig No Valid in custom template, used to specify the video image position of a user in mixed streams.
    PlaceHolderMode Integer No Valid in custom templates. 1: the placeholding feature is enabled; 0 (default): the feature is disabled. When the feature is enabled, but a user for whom a position is reserved is not sending video data, the position will show the corresponding placeholder image.
    PureAudioHoldPlaceMode Integer No Whether an audio-only stream occupies an image spot, which takes effect in a floating, grid, or screen sharing template. Valid values: 0 (default): when a floating or grid template is used, users sending audio only occupy image spots; when a screen sharing template is used, users (except the user whose screen is shared) sending audio only do not occupy image spots; 1: users sending audio only occupy image spots; 2: users sending audio only do not occupy image spots.
    WaterMarkParams WaterMarkParams No Watermark parameters

    OutputParams

    MCU On-Cloud MixTranscoding output parameters

    Used by actions: StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId.

    Name Type Required Description
    StreamId String Yes Custom live stream ID, which must be different from the ID of relayed stream.
    PureAudioStream Integer No Value range: [0, 1]. If it is 0, live streams are audio and video; if it is 1, live streams are only audio. Default value: 0.
    RecordId String No Prefix of custom recording file names. Please enable the recording feature in the TRTC console first. https://intl.cloud.tencent.com/document/product/647/50768?from_cn_redirect=1
    RecordAudioOnly Integer No Whether to record audio only. Valid values: 0, 1. 0: no meaning; 1: records into MP3 files. This parameter is not recommended. Instead, you are advised to create an audio-only recording template in the TRTC console.

    PictureInfo

    Image information list

    Used by actions: DescribePicture.

    Name Type Description
    Height Integer Image height
    Width Integer Image width
    XPosition Integer X-axis value of the image’s position
    YPosition Integer Y-axis value of the image’s position
    SdkAppId Integer Application ID
    PictureId Integer Image ID

    PresetLayoutConfig

    Valid in custom template, used to specify the video image position of a user in mixed streams.

    Used by actions: StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId.

    Name Type Required Description
    UserId String No Used to assign users to preset positions; if not assigned, users will occupy the positions set in PresetLayoutConfig in room entry sequence.
    StreamType Integer No Stream type of the user when a specified user is assigned to the image. 0: camera; 1: screen sharing. Set this parameter to 0 when the small image is occupied by a web user.
    ImageWidth Integer No Width of the output image in pixels. If this parameter is not set, 0 is used by default.
    ImageHeight Integer No Height of the output image in pixels. If this parameter is not set, 0 is used by default.
    LocationX Integer No X offset of the output image in pixels. The sum of LocationX and ImageWidth cannot exceed the total width of the mixed stream. If this parameter is not set, 0 is used by default.
    LocationY Integer No Y offset of the output image in pixels. The sum of LocationY and ImageHeight cannot exceed the total height of the mixed stream. If this parameter is not set, 0 is used by default.
    ZOrder Integer No Output order of the image. 0 is used if it is left empty.
    RenderMode Integer No Render mode of the output image. 0: cropping; 1: scaling; 2: scaling on a black background. If this parameter is not set, 0 is used by default.
    MixInputType Integer No Media type of the mixed stream of the user occupying the current position. 0 (default): audio and video; 1: audio; 2: video. You are advised to specify a user ID when using this parameter.
    PlaceImageId Integer No ID of the placeholder image. If the placeholding feature is enabled, and a user for whom an image position is reserved is not sending video data, the position will show the placeholder image. The ID is generated after the placeholder image is uploaded in the TRTC console. https://intl.cloud.tencent.com/document/product/647/50769?from_cn_redirect=1

    PublishCdnParams

    Relayed push parameters of a non-Tencent Cloud CDN

    Used by actions: StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId.

    Name Type Required Description
    BizId Integer Yes Tencent Cloud LVB BizId
    PublishCdnUrls Array of String Yes Destination of non-Tencent Cloud CDN relayed push. It is possible to push to only one non-Tencent Cloud CDN address at a time.

    QualityData

    Quality data returned by ES

    Used by actions: DescribeCallDetail.

    Name Type Description
    Content Array of TimeValue Data content
    UserId String User ID
    PeerId String Peer ID. An empty value indicates that the returned data is upstream.
    DataType String Data type

    RealtimeData

    Returned data of seconds-level monitoring

    Used by actions: DescribeRealtimeNetwork, DescribeRealtimeQuality, DescribeRealtimeScale.

    Name Type Description
    Content Array of TimeValue Returned data
    DataType String Data type field

    RoomState

    Room information list

    Used by actions: DescribeRoomInformation.

    Name Type Description
    CommId String Call ID (unique call ID)
    RoomString String Room ID of string type
    CreateTime Integer Room creation time
    DestroyTime Integer Room termination time
    IsFinished Boolean Whether the room is terminated
    UserId String Room creator ID

    ScaleInfomation

    Historical scale information

    Used by actions: DescribeHistoryScale.

    Name Type Description
    Time Integer Start time for each day
    UserNumber Integer Number of users in room. If a user enters the room for multiple times, the user will be counted as one user.
    Note: this field may return null, indicating that no valid values can be obtained.
    UserCount Integer Number of room entries. Every time when a user enters the room, it will be counted as one room entry.
    Note: this field may return null, indicating that no valid values can be obtained.
    RoomNumbers Integer Number of rooms under sdkappid on a day
    Note: this field may return null, indicating that no valid values can be obtained.

    SmallVideoLayoutParams

    Layout parameter of the small image, which takes effect in a picture-in-picture template

    Used by actions: StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId.

    Name Type Required Description
    UserId String Yes ID of the user in the small image.
    StreamType Integer Yes Stream type of the small image. 0: camera; 1: screen sharing. If a web user's stream is displayed in the small image, enter 0 for this parameter.
    ImageWidth Integer No Output width of the small image in pixels. If this parameter is left empty, 0 will be used by default.
    ImageHeight Integer No Output height of the small image in pixels. If this parameter is left empty, 0 will be used by default.
    LocationX Integer No Output X-axis offset of the small image in pixels. The sum of LocationX and ImageWidth cannot exceed the total width of the output mixed stream. If this parameter is left empty, 0 will be used by default.
    LocationY Integer No Output Y-axis offset of the small image in pixels. The sum of LocationY and ImageHeight cannot exceed the total height of the output mixed stream. If this parameter is left empty, 0 will be used by default.

    TimeValue

    Returned quality data in the format of time:value

    Used by actions: DescribeCallDetail, DescribeRealtimeNetwork, DescribeRealtimeQuality, DescribeRealtimeScale.

    Name Type Description
    Time Integer Time in the format of UNIX timestamp, such as 1590065877s.
    Value Float Parameter value returned in the current time. For example, if bigvCapFps is set to 0 when the current time is 1590065877s (UNIX timestamp), the value of this parameter is 0.

    UserInformation

    User information, including when the user enters/exits a room

    Used by actions: DescribeCallDetail, DescribeUserInformation.

    Name Type Description
    RoomStr String Room ID
    UserId String User ID
    JoinTs Integer The time when the user enters the room
    LeaveTs Integer The time when the user exits the room. If the user is still in the room, the current time will be returned
    DeviceType String Device type
    SdkVersion String SDK version number
    ClientIp String Client IP
    Finished Boolean Determine whether a user has left the room

    WaterMarkParams

    Watermark parameters for On-Cloud MixTranscoding

    Used by actions: StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId.

    Name Type Required Description
    WaterMarkId Integer Yes Image ID of the watermark, which is generated after the image is uploaded to the TRTC console
    WaterMarkWidth Integer Yes Width (px) of the watermark for On-Cloud MixTranscoding
    WaterMarkHeight Integer Yes Height (px) of the watermark for On-Cloud MixTranscoding
    LocationX Integer Yes Horizontal offset (px) of the watermark
    LocationY Integer Yes Vertical offset (px) of the watermark
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy