Starter Deal! First 3 month from only  $9.9 /month!
Starter Deal! First 3 month from only  $9.9 /month!
Grab It Now 
Features & Server APIs
  • On-Cloud Recording
  • Relay to CDN
  • RTMP Streaming with TRTC
  • Event Callbacks
    • Event Callbacks
    • Relay to CDN Callback
    • Verify Signature Example
  • Sending and Receiving Messages
  • Access Management
    • Overview
    • Manageable Resources and Actions
    • Preset Policies
    • Custom Policies
  • Enabling Advanced Permission Control
  • How to push stream to TRTC room with OBS WHIP
  • Server APIs
    • API Category
    • History
    • Making API Request
      • Request Structure
      • Common Params
      • Signature v3
      • Signature
      • Responses
    • Room Management APIs
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • Call Quality Monitoring APIs
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • Pull Stream Relay Related Interface
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • On-cloud Recording APIs
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • Stream Mixing and Relay APIs
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • Usage Statistics APIs
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • Data Types
    • Error Codes
    • Appendix
      • Event ID Mapping Table
Features & Server APIs

Data Types

AbnormalEvent

The information of an error event (the possible cause of an abnormal user experience).

Used by actions: DescribeUnusualEvent.

NameTypeDescription
AbnormalEventIdIntegerThe error event ID. For details, see https://www.tencentcloud.com/document/product/647/37906?has_map=1
PeerIdStringThe remote user ID. If this parameter is empty, it indicates that the error event is not associated with a remote user.
Note: This field may return null, indicating that no valid values can be obtained.

AbnormalExperience

The information of an abnormal user experience and the possible causes.

Used by actions: DescribeUnusualEvent.

NameTypeDescription
UserIdStringThe user ID.
ExperienceIdIntegerThe abnormal experience ID.
RoomIdStringThe room ID (string).
AbnormalEventListArray of AbnormalEventThe possible error events.
EventTimeIntegerThe report time.

AgentParams

The information of the relaying robot in the room.

Used by actions: StartPublishCdnStream.

NameTypeRequiredDescription
UserIdStringYesThe user ID of the relaying robot in the TRTC room, which cannot be the same as a user ID already in use. We recommend you include the room ID in this user ID.
UserSigStringNoThe signature (similar to a login password) required for the relaying robot to enter the room. For information on how to calculate the signature, see What is UserSig?. |
MaxIdleTimeIntegerNoThe timeout period (seconds) for relaying to stop automatically after all the users whose streams are mixed leave the room. The value cannot be smaller than 5 or larger than 86400 (24 hours). Default value: 30.

AudioEncode

The audio encoding parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
SampleRateIntegerYesThe audio sample rate (Hz). Valid values: 48000, 44100, 32000, 24000, 16000, 8000.
ChannelIntegerYesThe number of sound channels. Valid values: 1 (mono), 2 (dual).
BitRateIntegerYesThe audio bitrate (Kbps). Value range: 8-500.
CodecIntegerNoThe audio codec. Valid values: 0 (LC-AAC), 1 (HE-AAC), 2 (HE-AACv2). The default value is 0. If this parameter is set to 2, Channel must be 2. If it is set to 1 or 2, SampleRate can only be 48000, 44100, 32000, 24000, or 16000.

AudioEncodeParams

Audio transcoding parameters

Used by actions: StartStreamIngest.

NameTypeRequiredDescription
SampleRateIntegerYesAudio Sample rate, Value range [48000, 44100], unit is Hz.
ChannelIntegerYesAudio Channel number, Value range [1,2], 1 means Audio is Mono-channel, 2 means Audio is Dual-channel.
BitRateIntegerYesAudio Bitrate, Value range [8,500], unit is kbps.

AudioParams

The audio transcoding parameters for recording.

Used by actions: CreateCloudRecording.

NameTypeRequiredDescription
SampleRateIntegerYesThe audio sample rate.
1: 48000 Hz (default)
2: 44100 Hz
3: 16000 Hz
ChannelIntegerYesThe number of sound channels.
1: Mono-channel
2: Dual-channel (default)
BitRateIntegerYesThe audio bitrate (bps). Value range: [32000, 128000]. Default: 64000.

CloudStorage

The cloud storage information.

Used by actions: CreateCloudRecording.

NameTypeRequiredDescription
VendorIntegerYesThe cloud storage provider.
0: Tencent Cloud COS; 1: AWS storage. Other vendors are not supported currently.
RegionStringYesThe region of cloud storage.
BucketStringYesThe storage bucket.
AccessKeyStringYesThe access_key of the cloud storage account.
SecretKeyStringYesThe secret_key of the cloud storage account.
FileNamePrefixArray of StringNoThe bucket to save data, which is an array of strings that can contain letters (a-z and A-Z), numbers (0-9), underscores (_), and hyphens (-). For example, if the value of this parameter is ["prefix1", "prefix2"], the recording file xxx.m3u8 will be saved as prefix1/prefix2/TaskId/xxx.m3u8.

CloudVod

The VOD parameters.

Used by actions: CreateCloudRecording.

NameTypeRequiredDescription
TencentVodTencentVodNoThe Tencent Cloud VOD parameters.

EventList

A list of SDK or WebRTC events.

Used by actions: DescribeUserEvent.

NameTypeDescription
ContentArray of EventMessageThe event information.
PeerIdStringThe user ID of the sender.

EventMessage

The event information, including the timestamp and event ID.

Used by actions: DescribeUserEvent.

NameTypeDescription
TypeIntegerThe video stream type. Valid values:
0: A non-video event
2: The big video
3: The small video
7: A relayed video
TimeIntegerThe event reporting time in the format of UNIX timestamp (milliseconds), such as 1589891188801.
EventIdIntegerThe event ID. Events are classified into SDK events and WebRTC events. For more information, see https://www.tencentcloud.com/document/product/647/37906?has_map=1
ParamOneIntegerThe first event parameter, such as the video width.
ParamTwoIntegerThe second event parameter, such as the video height.

MaxVideoUser

The information of the large video in screen sharing or floating layout mode.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
UserMediaStreamUserMediaStreamYesThe stream information.

McuAudioParams

The audio parameters for relaying.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
AudioEncodeAudioEncodeNoThe audio encoding parameters.
SubscribeAudioListArray of McuUserInfoParamsNoThe audio mix allowlist. For the StartPublishCdnStream API, if you do not pass this parameter or leave it empty, the audios of all anchors will be mixed. For the UpdatePublishCdnStream API, if you do not pass this parameter, no changes will be made to the current allowlist; if you pass in an empty string, the audios of all anchors will be mixed.
In cases where SubscribeAudioList and UnSubscribeAudioList are used at the same time, you need to specify both parameters. If you pass neither SubscribeAudioList nor UnSubscribeAudioList, no changes will be made. If a user is included in both parameters, the user’s audio will not be mixed.
UnSubscribeAudioListArray of McuUserInfoParamsNoThe audio mix blocklist. If you do not pass this parameter or leave it empty, there won’t be a blocklist. For the UpdatePublishCdnStream API, if you do not pass this parameter, no changes will be made to the current blocklist; if you pass in an empty string, the blocklist will be reset.
In cases where SubscribeAudioList and UnSubscribeAudioList are used at the same time, you need to specify both parameters. If you pass neither SubscribeAudioList nor UnSubscribeAudioList, no changes will be made. If a user is included in both parameters, the user’s audio will not be mixed.

McuCustomCrop

The cropping parameters for mixed videos.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
LocationXIntegerYesThe horizontal offset (pixels) of the starting point for cropping. This parameter must be greater than 0.
LocationYIntegerYesThe vertical offset (pixels) of the starting point for cropping. This parameter must be greater than 0.
WidthIntegerYesThe video width (pixels) after cropping. The sum of this parameter and LocationX cannot be greater than 10000.
HeightIntegerYesThe video height (pixels) after cropping. The sum of this parameter and LocationY cannot be greater than 10000.

McuFeedBackRoomParams

Parameters for relaying to a TRTC room.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
RoomIdStringYesThe room ID.
RoomIdTypeIntegerYesThe ID type of the room to which streams are relayed. 0 indicates integer, and 1 indicates string.
UserIdStringYesThe user ID of the relaying robot in the TRTC room, which cannot be the same as a user ID already in use. We recommend you include the room ID in this user ID.
UserSigStringYesThe signature (similar to login password) required for the relaying robot to enter the room. For information on how to calculate the signature, see What is UserSig?.

McuLayout

The layout parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
UserMediaStreamUserMediaStreamNoThe information of the stream that is displayed. If you do not pass this parameter, TRTC will display the videos of anchors in the room according to their room entry sequence.
ImageWidthIntegerNoThe video width (pixels). If you do not pass this parameter, 0 will be used.
ImageHeightIntegerNoThe video height (pixels). If you do not pass this parameter, 0 will be used.
LocationXIntegerNoThe horizontal offset (pixels) of the video. The sum of LocationX and ImageWidth cannot exceed the width of the canvas. If you do not pass this parameter, 0 will be used.
LocationYIntegerNoThe vertical offset of the video. The sum of LocationY and ImageHeight cannot exceed the height of the canvas. If you do not pass this parameter, 0 will be used.
ZOrderIntegerNoThe image layer of the video. If you do not pass this parameter, 0 will be used.
RenderModeIntegerNoThe rendering mode of the video. 0 (the video is scaled and the excess parts are cropped), 1 (the video is scaled), 2 (the video is scaled and the blank spaces are filled with black bars). If you do not pass this parameter, 0 will be used.
BackGroundColorStringNo(Not supported yet) The background color of a video. Below are the values for some commonly used colors:
Red: 0xcc0033
Yellow: 0xcc9900
Green: 0xcccc33
Blue: 0x99CCFF
Black: 0x000000
White: 0xFFFFFF
Grey: 0x999999
BackgroundImageUrlStringNoThe URL of the background image for the video. This parameter allows you to specify an image to display when the user’s camera is turned off or before the user enters the room. If the dimensions of the image specified are different from those of the video window, the image will be stretched to fit the space. This parameter has a higher priority than BackGroundColor.
CustomCropMcuCustomCropNoCustom cropping.
BackgroundRenderModeIntegerNoThe display mode of the sub-background image during output: 0 for cropping, 1 for scaling and displaying the background, 2 for scaling and displaying the black background, 3 for proportional scaling. If not filled in, the default is 3.

McuLayoutParams

The layout parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
MixLayoutModeIntegerNoThe layout mode. Valid values: 1 (floating), 2 (screen sharing), 3 (grid), 4 (custom). Floating, screen sharing, and grid are dynamic layouts. Custom layouts are static layouts.
PureAudioHoldPlaceModeIntegerNoWhether to display users who publish only audio. 0: No; 1: Yes. This parameter is valid only if a dynamic layout is used. If you do not pass this parameter, 0 will be used.
MixLayoutListArray of McuLayoutNoThe details of a custom layout.
MaxVideoUserMaxVideoUserNoThe information of the large video in screen sharing or floating layout mode.
RenderModeIntegerNoThe image fill mode. This parameter is valid if the layout mode is screen sharing, floating, or grid. 0: The image will be cropped. 1: The image will be scaled. 2: The image will be scaled and there may be black bars.

McuLayoutVolume

The SEI parameters for audio volume layout. You can specify the AppData and PayloadType.
This parameter may be empty, in which case the default SEI parameters for audio volume layout will be used.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
AppDataStringNoThe application data, which will be embedded in the app_data field of the custom SEI. It must be shorter than 4,096 characters.
PayloadTypeIntegerNoThe payload type of the SEI message. The default is 100. Value range: 100-254 (244 is used internally by Tencent Cloud for timestamps).
IntervalIntegerNoThe SEI sending interval (milliseconds). The default value is 1000.
FollowIdrIntegerNoValid values: 1: SEI is guaranteed when keyframes are sent; 0 (default): SEI is not guaranteed when keyframes are sent.

McuPassThrough

The custom pass-through SEI.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
PayloadContentStringYesThe payload of the pass-through SEI.
PayloadTypeIntegerYesThe payload type of the SEI message. Value range: 5 and 100-254 (244 is used internally by Tencent Cloud for timestamps).
PayloadUuidStringNoThis parameter is required only if PayloadType is 5. It must be a 32-character hexadecimal string. If PayloadType is not 5, this parameter will be ignored.
IntervalIntegerNoThe SEI sending interval (milliseconds). The default value is 1000.
FollowIdrIntegerNoValid values: 1: SEI is guaranteed when keyframes are sent; 0 (default): SEI is not guaranteed when keyframes are sent.

McuPublishCdnParam

The relaying parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
PublishCdnUrlStringYesThe URLs of the CDNs to relay to.
IsTencentCdnIntegerNoWhether to relay to Tencent Cloud’s CDN. 0: Third-party CDN; 1 (default): Tencent Cloud’s CDN. Relaying to a third-party CDN will incur fees. To avoid unexpected charges, we recommend you pass in a specific value. For details, see the API document.

McuSeiParams

The stream mixing SEI parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
LayoutVolumeMcuLayoutVolumeNoThe audio volume layout SEI.
PassThroughMcuPassThroughNoThe pass-through SEI.

McuUserInfoParams

The users whose streams are mixed.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
UserInfoMixUserInfoYesThe user information.

McuVideoParams

The video parameters for relaying.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
VideoEncodeVideoEncodeNoThe video encoding parameters.
LayoutParamsMcuLayoutParamsNoThe layout parameters.
BackGroundColorStringNoThe canvas color. Below are the values for some common colors:
Red: 0xcc0033
Yellow: 0xcc9900
Green: 0xcccc33
Blue: 0x99CCFF
Black: 0x000000
White: 0xFFFFFF
Grey: 0x999999
BackgroundImageUrlStringNoThe URL of the background image for the canvas. This parameter has a higher priority than BackGroundColor.
WaterMarkListArray of McuWaterMarkParamsNoThe watermark information for the mixed stream.
BackgroundRenderModeIntegerNoBackground image display mode during output: 0 for crop, 1 for scale and display with black background, 2 for proportional scaling. The backend default is proportional scaling.

McuWaterMarkImage

The information of the watermark image.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
WaterMarkUrlStringYesThe URL of the watermark image, which must be in PNG, JPG, or JPEG format and cannot exceed 5 MB.
WaterMarkWidthIntegerYesThe watermark width (pixels).
WaterMarkHeightIntegerYesThe watermark height (pixels).
LocationXIntegerYesThe horizontal offset (pixels) of the watermark.
LocationYIntegerYesThe vertical offset (pixels) of the watermark.
ZOrderIntegerNoThe image layer of the watermark. If you do not pass this parameter, 0 will be used.

McuWaterMarkParams

The Watermark information.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
WaterMarkTypeIntegerNoThe watermark type. Valid values: 0 (default): Image; 1: Text.
WaterMarkImageMcuWaterMarkImageNoThe watermark image information. This parameter is required if WaterMarkType is 0.
WaterMarkTextMcuWaterMarkTextNoThe text watermark configuration. This parameter is required if WaterMarkType is 1.

McuWaterMarkText

The text watermark configuration.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
TextStringYesThe text.
WaterMarkWidthIntegerYesThe watermark width (pixels).
WaterMarkHeightIntegerYesThe watermark height (pixels).
LocationXIntegerYesThe horizontal offset (pixels) of the watermark.
LocationYIntegerYesThe vertical offset (pixels) of the watermark.
FontSizeIntegerYesThe font size.
FontColorStringNoThe text color. The default color is white. Values for some commonly used colors: Red: 0xcc0033; yellow: 0xcc9900; green: 0xcccc33; blue: 0x99CCFF; black: 0x000000; white: 0xFFFFFF; gray: 0x999999.
BackGroundColorStringNoThe text fill color. If you do not specify this parameter, the fill color will be transparent. Values for some commonly used colors: Red: 0xcc0033; yellow: 0xcc9900; green: 0xcccc33; blue: 0x99CCFF; black: 0x000000; white: 0xFFFFFF; gray: 0x999999.

MixLayout

The custom layout parameters.

Used by actions: CreateCloudRecording, ModifyCloudRecording.

NameTypeRequiredDescription
TopIntegerYesThe Y axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas height.
LeftIntegerYesThe X axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas width.
WidthIntegerYesThe relative width of the window. Value range: [0, 1920]. The sum of the values of this parameter and Left cannot exceed the canvas width.
HeightIntegerYesThe relative height of the window. Value range: [0, 1920]. The sum of the values of this parameter and Top cannot exceed the canvas height.
UserIdStringNoThe user ID (string) of the anchor whose video is shown in the window. If you do not set this parameter, anchors’ videos will be shown in their room entry sequence.
AlphaIntegerNoThe degree of transparency of the canvas. Value range: [0, 255]. 0 means fully opaque, and 255 means fully transparent.
RenderModeIntegerNo0: Stretch. In this mode, the image is stretched to fill the space available. The whole image is visible after scaling. However, if the original aspect ratio is different from the target, the image may be distorted.

1: Crop (default). In this mode, if the original aspect ratio is different from the target, the image will be cropped according to the target before being stretched to fill the space available. The image will not be distorted.

2: Blank. This mode stretches the image while keeping its original aspect ratio. If the original aspect ratio is different from the target, there may be blank spaces to the top and bottom or to the left and right of the window.

3: Smart stretch. This mode is similar to the crop mode, except that it restricts cropping to 20% of the image’s width or height at most.
MediaIdIntegerNoThe type of the stream subscribed to.
0: Primary stream (default)
1: Substream
ImageLayerIntegerNoThe image layer. 0 is the default value and means the bottommost layer.
SubBackgroundImageStringNoThe URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of RenderMode.

MixLayoutParams

The layout parameters for mixed-stream recording.

Used by actions: CreateCloudRecording, ModifyCloudRecording.

NameTypeRequiredDescription
MixLayoutModeIntegerYesLayout mode:
1: Floating
2: Screen sharing
3: Grid (default)
4: Custom

Floating: By default, the video of the first anchor (you can also specify an anchor) who enters the room is scaled to fill the screen. When other anchors enter the room, their videos appear smaller and are superimposed over the large video from left to right starting from the bottom of the canvas according to their room entry sequence. If the total number of videos is 17 or less, there will be four windows in each row (4 x 4); if it is greater than 17, there will be five windows in each row (5 x 5). Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window.

Screen sharing: The video of a specified anchor occupies a larger part of the canvas on the left side (if you do not specify an anchor, the left window will display the canvas background). The videos of other anchors are smaller and are positioned on the right side. If the total number of videos is 17 or less, the small videos are positioned from top to bottom in up to two columns on the right side, with eight videos per column at most. If there are more than 17 videos, the additional videos are positioned at the bottom of the canvas from left to right. Up to 25 videos can be displayed. A user who publishes only audio will still be displayed in one window.

Grid: The videos of anchors are scaled and positioned automatically according to the total number of anchors in a room. Each video has the same size. Up to 25 videos can be displayed.

Custom: Specify the layout of videos by using the MixLayoutList parameter.
MixLayoutListArray of MixLayoutNoThe custom layout details. This parameter is valid if MixLayoutMode is set to 4. Up to 25 videos can be displayed.
BackGroundColorStringNoThe background color, which is a hexadecimal value (starting with "#", followed by the color value) converted from an 8-bit RGB value. For example, the RGB value of orange is R:255 G:165 B:0, and its hexadecimal value is #FFA500. The default color is black.
MaxResolutionUserIdStringNoThe user whose video is displayed in the big window. This parameter is valid if MixLayoutMode is set to 1 (floating) or 2 (screen sharing). If it is left empty, the first anchor entering the room is displayed in the big window in the floating mode and the canvas background is displayed in the screen sharing mode.
MediaIdIntegerNoThe stream type.
0: Primary stream (default)
1: Substream (screen sharing stream)
This parameter specifies the type of the stream displayed in the big window. If it appears in MixLayoutList, it indicates the type of the stream of a specified user.
BackgroundImageUrlStringNoThe URL of the background image, which cannot contain Chinese characters. The image must be in JPG or PNG format and cannot be larger than 5 MB.
PlaceHolderModeIntegerNo1 means to use placeholders, and 0 (default) means to not use placeholders. If this parameter is set to 1, when a user is not publishing video, a placeholder image will be displayed in the window reserved for the user.
BackgroundImageRenderModeIntegerNoThe render mode to use when the aspect ratio of a video is different from that of the window. This parameter is defined the same as RenderMode in MixLayoufList.
DefaultSubBackgroundImageStringNoThe URL of the background image for a window. The image must be in JPG or PNG format and cannot be larger than 5 MB. If the image’s aspect ratio is different from that of the window, the image will be rendered according to the value of RenderMode.
WaterMarkListArray of WaterMarkNoThe watermark layout. Up to 25 watermarks are supported.
RenderModeIntegerNoThe render mode to use when the aspect ratio of a video is different from that of the window. This parameter is invalid if a custom layout is used. It is defined the same as RenderMode in MixLayoufList.
MaxResolutionUserAlignIntegerNoThis parameter is valid only if the screen sharing layout is used. If you set it to 1, the large video window will appear on the right and the small window on the left. The default value is 0.

MixTranscodeParams

The audio and video parameters for recording.

Used by actions: CreateCloudRecording.

NameTypeRequiredDescription
VideoParamsVideoParamsNoThe video transcoding parameters for recording. If you set this parameter, you must specify all its fields. If you do not set it, the default will be used.
AudioParamsAudioParamsNoThe audio transcoding parameters for recording. If you set this parameter, you must specify all its fields. If you do not set it, the default will be used.

MixUserInfo

The user information.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
UserIdStringYesUser ID.
RoomIdStringNoIf a dynamic layout is used, the value of this parameter should be the ID of the main room. If a custom layout is used, the value of this parameter should be the same as the room ID in MixLayoutList.
RoomIdTypeIntegerNoThe type of the RoomId parameter. 0: integer; 1: string.

QualityData

The quality data returned by ES.

Used by actions: DescribeCallDetailInfo.

NameTypeDescription
ContentArray of TimeValueThe quality data.
UserIdStringThe user ID.
PeerIdStringThe remote user ID. An empty string indicates that the data is upstream data.
Note: This field may return null, indicating that no valid values can be obtained.
DataTypeStringThe data type.

RecordParams

The on-cloud recording parameters.

Used by actions: CreateCloudRecording.

NameTypeRequiredDescription
RecordModeIntegerYesThe recording mode.
1: Single-stream recording. Records the audio and video of each subscribed user (UserId) in a room and saves the recording files to the cloud.
2: Mixed-stream recording. Mixes the audios and videos of subscribed users (UserId) in a room, records the mixed stream, and saves the recording files to the cloud.
MaxIdleTimeIntegerNoThe time period (seconds) to wait to automatically stop recording after there are no anchors (users who publish streams) in a room. Value range: 5-86400 (max 24 hours). Default value: 30.
StreamTypeIntegerNoThe media type of the streams to record.
0: Audio and video streams (default)
1: Audio streams only
2: Video streams only
SubscribeStreamUserIdsSubscribeStreamUserIdsNoThe allowlist/blocklist for stream subscription.
OutputFormatIntegerNoThe output format. 0 (default): HLS; 1: HLS + MP4; 2: HLS + AAC; 3 : MP4, 4 : AAC. This parameter is invalid if you save recording files to VOD. To specify the format of files saved to VOD, use MediaType of TencentVod.
AvMergeIntegerNoWhether to merge the audio and video of a user in the single-stream recording mode. 0 (default): Do not mix the audio and video; 1: Mix the audio and video into one TS file. You don’t need to specify this parameter for mixed-stream recording, which merges audios and videos by default.
MaxMediaFileDurationIntegerNoThe maximum file duration allowed (minutes). If the output format is AAC or MP4, and the maximum file duration is exceeded, the file will be segmented. Value range: 1-1440. Default value: 1440 (24 hours). The maximum file size allowed is 2 GB. If the file size exceeds 2 GB, or the file duration exceeds 24 hours, the file will also be segmented.
This parameter is invalid if the output format is HLS.
MediaIdIntegerNoThe type of stream to record. 0 (default): The primary stream and substream; 1: The primary stream; 2: The substream.

RoomState

The room information.

Used by actions: DescribeRoomInfo.

NameTypeDescription
CommIdStringThe call ID, which uniquely identifies a call.
RoomStringStringThe room ID.
CreateTimeIntegerThe room creation time.
DestroyTimeIntegerThe room termination time.
IsFinishedBooleanWhether the room is terminated.
UserIdStringThe user ID of the room creator.

RowValues

Two-dimensional array of SeriesInfo type

Used by actions: DescribeTRTCMarketQualityData, DescribeTRTCMarketScaleData, DescribeTRTCRealTimeQualityData, DescribeTRTCRealTimeScaleData.

NameTypeRequiredDescription
RowValueArray of IntegerNoData value

ScaleInfomation

The room and user number.

Used by actions: DescribeScaleInfo.

NameTypeDescription
TimeIntegerStart time for each day
UserNumberIntegerThe number of users. If a user enters a room multiple times, it will be counted as one user.
Note: This field may return null, indicating that no valid values can be obtained.
UserCountIntegerThe number of room entries. Every time a user enters a room, it will be counted as one room entry.
Note: This field may return null, indicating that no valid values can be obtained.
RoomNumbersIntegerThe total number of rooms of the application on a day.
Note: This field may return null, indicating that no valid values can be obtained.

SeriesInfos

SeriesInfos type

Used by actions: DescribeTRTCMarketQualityData, DescribeTRTCMarketScaleData, DescribeTRTCRealTimeQualityData, DescribeTRTCRealTimeScaleData.

NameTypeDescription
ColumnsArray of StringData columns
ValuesArray of RowValuesData values

SingleSubscribeParams

The information of a single stream relayed.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
UserMediaStreamUserMediaStreamYesThe stream information.

StorageFile

The information of the recording files, which is returned by the DescribeCloudRecording API.

Used by actions: DescribeCloudRecording.

NameTypeDescription
UserIdStringThe user whose stream is recorded into the file. In the mixed-stream recording mode, this parameter will be empty.
Note: This field may return null, indicating that no valid values can be obtained.
FileNameStringThe filename.
TrackTypeStringThe type of the media recorded.
video
audio
audio_video
Note: This field may return null, indicating that no valid values can be obtained.
BeginTimeStampIntegerThe start time (Unix timestamp) of the recording file.

StorageParams

The storage parameters.

Used by actions: CreateCloudRecording.

NameTypeRequiredDescription
CloudStorageCloudStorageNoThe account information for third-party storage. Please note that if you save files to COS, a recording-to-COS fee will be incurred. For details, see the document "Billing of On-Cloud Recording". If you save files to VOD, there won't be such a fee.
CloudVodCloudVodNoThe account information for VOD storage.

SubscribeStreamUserIds

The subscription allowlist/blocklist. You cannot specify an allowlist and a blocklist for audio/video subscription at the same time. The maximum number of streams one can receive at the same time is 25. When streams are mixed, up to 24 videos are supported. You can use .*$ to specify user IDs with the same prefix, but make sure there aren’t users whose IDs contain ".*$" and are exactly the same as the prefix you pass in. If there are, TRTC will only allow or block those users.

Used by actions: CreateCloudRecording, ModifyCloudRecording.

NameTypeRequiredDescription
SubscribeAudioUserIdsArray of StringNoThe allowlist for audio subscription. For example, ["1", "2", "3"] means to only subscribe to the audios of users 1, 2, and 3, and ["1.*$"] means to only subscribe to the audios of users whose ID prefix is 1. If this parameter is left empty, the audios of all anchors in the room will be received. The array can contain at most 32 elements.
UnSubscribeAudioUserIdsArray of StringNoThe blocklist for audio subscription. For example, ["1", "2", "3"] means to not subscribe to the audios of users 1, 2, and 3, and ["1.*$"] means to not subscribe to users whose ID prefix is 1. If this parameter is left empty, the audios of all anchors in the room will be received. The array can contain at most 32 elements.
SubscribeVideoUserIdsArray of StringNoThe allowlist for video subscription. For example, ["1", "2", "3"] means to only subscribe to the videos of users 1, 2, and 3, and ["1.*$"] means to only subscribe to the videos of users whose ID prefix is 1. If this parameter is left empty, the videos of all anchors in the room will be received. The array can contain at most 32 elements.
UnSubscribeVideoUserIdsArray of StringNoThe blocklist for video subscription. For example, ["1", "2", "3"] means to not subscribe to the videos of users 1, 2, and 3, and ["1.*$"] means to not subscribe to the videos of users whose ID prefix is 1. If this parameter is left empty, the videos of all anchors in the room will be received. The array can contain at most 32 elements.

TRTCDataResult

TRTC Data Dashboard/Real-Time Monitoring API output parameters

Used by actions: DescribeTRTCMarketQualityData, DescribeTRTCMarketScaleData, DescribeTRTCRealTimeQualityData, DescribeTRTCRealTimeScaleData.

NameTypeDescription
StatementIDIntegerStatementID value, fixed at 0 for Monitoring Dashboard.
SeriesArray of SeriesInfosQuery result data, returned in Columns-Values format.
TotalIntegerTotal value, fixed at 1 for Monitoring Dashboard.

TencentVod

The Tencent Cloud VOD parameters.

Used by actions: CreateCloudRecording.

NameTypeRequiredDescription
ProcedureStringNoThe operation to perform on the media uploaded. The value of this parameter is the name of a task flow template. You can create a custom task flow template in Tencent Cloud VOD.
ExpireTimeIntegerNoThe expiration time of the media file, which is a time period (seconds) from the current time. For example, 86400 means to save the media file for one day. To save the file permanently, set this parameter to 0.
StorageRegionStringNoThe storage region. Set this parameter if you have special requirements on the storage region.
ClassIdIntegerNoThe category ID, which is returned after you create a category by calling an API. You can use categories to manage media files.
The default value is 0, which means others.
SubAppIdIntegerNoThe VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
SessionContextStringNoThe task flow context, which is passed through after the task is completed.
SourceContextStringNoThe upload context, which is passed through after upload is completed.
MediaTypeIntegerNoThe format of recording files uploaded to VOD. 0 (default): MP4; 1: HLS; 2: AAC (valid only if StreamType is 1); 3: HLS+MP4; 4: HLS+AAC.
UserDefineRecordIdStringNoThe custom prefix of recording files. This parameter is valid only if recording files are uploaded to VOD. It can contain letters, numbers, underscores, and hyphens and cannot exceed 64 bytes. This prefix and the automatically generated filename are connected with __UserId_u_.

TimeValue

The quality data, which consists of the time and value parameters.

Used by actions: DescribeCallDetailInfo.

NameTypeDescription
TimeIntegerThe UNIX timestamp (seconds), such as 1590065877.
ValueFloatThe metric value. For example, if the video capturing frame rate (bigvCapFps) at the time 1590065877 is 0, the value of this parameter will be 0.

TrtcUsage

The TRTC audio/video duration generated in a certain time period.

Used by actions: DescribeMixTranscodingUsage, DescribeRecordingUsage, DescribeRelayUsage, DescribeTrtcUsage.

NameTypeDescription
TimeKeyStringThe time point in the format of YYYY-MM-DD HH:mm:ss. If more than one day is queried, HH:mm:ss is 00:00:00.
UsageValueArray of FloatThe usage (minutes). Each element of this parameter corresponds to an element of UsageKey in the order they are listed.

UserInformation

The user information, including when the user entered/left the room.

Used by actions: DescribeCallDetailInfo, DescribeUserInfo.

NameTypeDescription
RoomStrStringThe room ID.
UserIdStringThe user ID.
JoinTsIntegerThe time when the user entered the room.
LeaveTsIntegerThe time when the user left the room. If the user is still in the room, the current time will be returned.
DeviceTypeStringThe device type.
SdkVersionStringThe SDK version number.
ClientIpStringThe client IP address.
FinishedBooleanWhether a user has left the room.

UserMediaStream

The stream information.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
UserInfoMixUserInfoNoThe user information.
StreamTypeIntegerNoThe stream type. 0: Camera; 1: Screen sharing. If you do not pass this parameter, 0 will be used.

VideoEncode

The video encoding parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

NameTypeRequiredDescription
WidthIntegerYesThe width of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1920].
HeightIntegerYesThe height of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1080].
FpsIntegerYesThe frame rate (fps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 60].
BitRateIntegerYesThe bitrate (Kbps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 10000].
GopIntegerYesThe GOP (seconds) of the output stream. This parameter is required if audio and video are relayed. Value range: [1, 5].

VideoEncodeParams

Video transcoding parameters

Used by actions: StartStreamIngest.

NameTypeRequiredDescription
WidthIntegerYesWidth. Value range [0,1920], unit is pixel value.
HeightIntegerYesHeight. Value range [0,1080], unit is pixel value.
FpsIntegerYesFrame Rate. Value range [1,60], indicating that the frame rate can be selected from 1 to 60fps.
BitRateIntegerYesBitrate. Value range [1,10000], unit is kbps.
GopIntegerYesGop. Value range [1,2], unit is second.

VideoParams

The video transcoding parameters for recording.

Used by actions: CreateCloudRecording.

NameTypeRequiredDescription
WidthIntegerYesThe video width in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying Width and Height cannot exceed 1920 x 1080. The default value is 360.
HeightIntegerYesThe video height in pixels. The value of this parameter cannot be larger than 1920, and the result of multiplying Width and Height cannot exceed 1920 x 1080. The default value is 640.
FpsIntegerYesThe video frame rate. Value range: [1, 60]. Default: 15.
BitRateIntegerYesThe video bitrate (bps). Value range: [64000, 8192000]. Default: 550000.
GopIntegerYesThe keyframe interval (seconds). Default value: 10.

WaterMark

The watermark layout.

Used by actions: CreateCloudRecording, ModifyCloudRecording.

NameTypeRequiredDescription
WaterMarkTypeIntegerNoThe watermark type. 0 (default): image; 1: text (not supported yet).
WaterMarkImageWaterMarkImageNoThe information of watermark images. This parameter is required if the watermark type is image.
WaterMarkCharWaterMarkCharNoThe information of the text watermark. This parameter is required if WaterMarkType is 1.
WaterMarkTimestampWaterMarkTimestampNoThe information of the timestamp watermark. This parameter is required if WaterMarkType is 2.

WaterMarkChar

Used by actions: CreateCloudRecording, ModifyCloudRecording.

NameTypeRequiredDescription
TopIntegerYesThe Y coordinate of the text watermark from the top left.
LeftIntegerYesThe X coordinate of the text watermark from the top left.
WidthIntegerYesThe watermark width (pixels).
HeightIntegerYesThe watermark height (pixels).
CharsStringYesThe text.
FontSizeIntegerNoThe font size (pixels). The default value is 14.
FontColorStringNoThe text color. The default color is white.
BackGroundColorStringNoThe background color. If this parameter is empty, the background will be transparent (default).

WaterMarkImage

The information of watermark images.

Used by actions: CreateCloudRecording, ModifyCloudRecording.

NameTypeRequiredDescription
WaterMarkUrlStringYesThe download URLs of the watermark images, which must be in JPG or PNG format and cannot be larger than 5 MB.
TopIntegerYesThe Y axis of the image's top-left corner. Value range: [0, 2560]. The value cannot be larger than the canvas height.
LeftIntegerYesThe X axis of the image’s top-left corner. Value range: [0, 2560]. The value cannot be larger than the canvas width.
WidthIntegerYesThe relative width of the image. Value range: [0, 2560]. The sum of the values of this parameter and Left cannot exceed the canvas width.
HeightIntegerYesThe relative height of the image. Value range: [0, 2560]. The sum of the values of this parameter and Top cannot exceed the canvas height.

WaterMarkTimestamp

Used by actions: CreateCloudRecording, ModifyCloudRecording.

NameTypeRequiredDescription
PosIntegerYesThe position of the timestamp watermark. Valid values: 0 (top left), 1 (top right), 2 (bottom left), 3 (bottom right), 4 (top center), 5 (bottom center), 6 (center).
TimeZoneIntegerNoThe time zone. The default is UTC+8.