tencent cloud

フィードバック

Data Types

最終更新日:2022-09-28 19:45:22

AgentParams

The information of the relaying robot in the room.

Used by actions: StartPublishCdnStream.

Name Type Required Description
UserId String Yes The 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.
UserSig String No The 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?. |
MaxIdleTime Integer No The 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.

Name Type Required Description
SampleRate Integer Yes The audio sample rate (Hz). Valid values: 48000, 44100, 32000, 24000, 16000, 8000.
Channel Integer Yes The number of sound channels. Valid values: 1 (mono), 2 (dual).
BitRate Integer Yes The audio bitrate (Kbps). Value range: 8-500.
Codec Integer No The 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.

AudioParams

The audio transcoding parameters for recording.

Used by actions: CreateCloudRecording.

Name Type Required Description
SampleRate Integer Yes The audio sample rate.
1: 48000 Hz (default)
2: 44100 Hz
3: 16000 Hz
Channel Integer Yes The number of sound channels.
1: Mono-channel
2: Dual-channel (default)
BitRate Integer Yes The audio bitrate (bps). Value range: [32000, 128000]. Default: 64000.

CloudStorage

The cloud storage information.

Used by actions: CreateCloudRecording.

Name Type Required Description
Vendor Integer Yes The cloud storage provider.
0: Tencent Cloud COS. The storage services of other providers are not supported currently.
Region String Yes The region of cloud storage.
Bucket String Yes The storage bucket.
AccessKey String Yes The access_key of the cloud storage account.
SecretKey String Yes The secret_key of the cloud storage account.
FileNamePrefix Array of String No The 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.

Name Type Required Description
TencentVod TencentVod No The Tencent Cloud VOD parameters.

MaxVideoUser

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

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
UserMediaStream UserMediaStream Yes The stream information.

McuAudioParams

The audio parameters for relaying.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
AudioEncode AudioEncode No The audio encoding parameters.
SubscribeAudioList Array of McuUserInfoParams No The users whose audios are mixed. 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, TRTC will not change the users whose audios are mixed; if you pass in an empty string, the audios of all anchors will be mixed.

McuCustomCrop

The cropping parameters for mixed videos.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
LocationX Integer Yes The horizontal offset (pixels) of the starting point for cropping. This parameter must be greater than 0.
LocationY Integer Yes The vertical offset (pixels) of the starting point for cropping. This parameter must be greater than 0.
Width Integer Yes The video width (pixels) after cropping. The sum of this parameter and LocationX cannot be greater than 10000.
Height Integer Yes The video height (pixels) after cropping. The sum of this parameter and LocationY cannot be greater than 10000.

McuLayout

The layout parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
UserMediaStream UserMediaStream No The 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.
ImageWidth Integer No The video width (pixels). If you do not pass this parameter, 0 will be used.
ImageHeight Integer No The video height (pixels). If you do not pass this parameter, 0 will be used.
LocationX Integer No The 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.
LocationY Integer No The 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.
ZOrder Integer No The image layer of the video. If you do not pass this parameter, 0 will be used.
RenderMode Integer No The 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.
BackGroundColor String No The background color of the video. Below are the values for some common colors:
Red: 0xcc0033
Yellow: 0xcc9900
Green: 0xcccc33
Blue: 0x99CCFF
Black: 0x000000
White: 0xFFFFFF
Grey: 0x999999
BackgroundImageUrl String No The 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.
CustomCrop McuCustomCrop No Custom cropping.

McuLayoutParams

The layout parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
MixLayoutMode Integer No The 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.
PureAudioHoldPlaceMode Integer No Whether to display users who publish only audio. 0: Yes; 1: No. This parameter is valid only if dynamic layouts are used. If you do not pass this parameter, 0 will be used.
MixLayoutList Array of McuLayout No The details of a custom layout.
MaxVideoUser MaxVideoUser No The information of the large video in screen sharing or floating layout mode.

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.

Name Type Required Description
AppData String No The application data, which will be embedded in the app_data field of the custom SEI. It must be shorter than 4,096 characters.
PayloadType Integer No The payload type of the SEI message. The default is 100. Value range: 100-254 (244 is used internally by Tencent Cloud for timestamps).

McuPassThrough

The custom pass-through SEI.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
PayloadContent String Yes The payload of the pass-through SEI.
PayloadType Integer Yes The payload type of the SEI message. Value range: 5 and 100-254 (244 is used internally by Tencent Cloud for timestamps).
PayloadUuid String No This 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.

McuPublishCdnParam

The relaying parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
PublishCdnUrl String Yes The URLs of the CDNs to relay to.
IsTencentCdn Integer No Whether to relay to Tencent Cloud’s CDN. 0 (default): No; 1: Yes. An optimized route will be assigned if you relay to Tencent Cloud’s CDN.

McuSeiParams

The stream mixing SEI parameters.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
LayoutVolume McuLayoutVolume No The audio volume layout SEI.
PassThrough McuPassThrough No The pass-through SEI.

McuUserInfoParams

The users whose streams are mixed.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
UserInfo MixUserInfo Yes The user information.

McuVideoParams

The video parameters for relaying.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
VideoEncode VideoEncode No The video encoding parameters.
LayoutParams McuLayoutParams No The layout parameters.
BackGroundColor String No The canvas color. Below are the values for some common colors:
Red: 0xcc0033
Yellow: 0xcc9900
Green: 0xcccc33
Blue: 0x99CCFF
Black: 0x000000
White: 0xFFFFFF
Grey: 0x999999
BackgroundImageUrl String No The URL of the background image for the canvas. This parameter has a higher priority than BackGroundColor.
WaterMarkList Array of McuWaterMarkParams No The watermark information for the mixed stream.

McuWaterMarkImage

The information of the watermark image.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
WaterMarkUrl String Yes The URL of the watermark image, which must be in PNG, JPG, or JPEG format and cannot exceed 5 MB.
WaterMarkWidth Integer Yes The watermark width (pixels).
WaterMarkHeight Integer Yes The watermark height (pixels).
LocationX Integer Yes The horizontal offset (pixels) of the watermark.
LocationY Integer Yes The vertical offset (pixels) of the watermark.
ZOrder Integer No The 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.

Name Type Required Description
WaterMarkType Integer No The watermark type. The default is 0, which indicates an image watermark.
WaterMarkImage McuWaterMarkImage No The watermark image information. This parameter is required if WaterMarkType is 0.

MixLayout

The custom layout parameters.

Used by actions: CreateCloudRecording, ModifyCloudRecording.

Name Type Required Description
Top Integer Yes The Y axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas height.
Left Integer Yes The X axis of the window’s top-left corner. Value range: [0, 1920]. The value cannot be larger than the canvas width.
Width Integer Yes The relative width of the window. Value range: [0, 1920]. The sum of the values of this parameter and Left cannot exceed the canvas width.
Height Integer Yes The relative height of the window. Value range: [0, 1920]. The sum of the values of this parameter and Top cannot exceed the canvas height.
UserId String No The 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.
Alpha Integer No The degree of transparency of the canvas. Value range: [0, 255]. 0 means fully opaque, and 255 means fully transparent.
RenderMode Integer No 0: 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.
MediaId Integer No The type of the stream subscribed to.
0: Primary stream (default)
1: Substream
ImageLayer Integer No The image layer. 0 is the default value and means the bottommost layer.
SubBackgroundImage String No The download 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.

Name Type Required Description
MixLayoutMode Integer Yes Layout 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.
MixLayoutList Array of MixLayout No The custom layout details. This parameter is valid if MixLayoutMode is set to 4. Up to 25 videos can be displayed.
BackGroundColor String No The 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.
MaxResolutionUserId String No The 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.
MediaId Integer No The 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.
BackgroundImageUrl String No The download URL of the background image for the canvas, which must be in JPG or PNG format and cannot be larger than 5 MB.
PlaceHolderMode Integer No 1 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.
BackgroundImageRenderMode Integer No The 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.
DefaultSubBackgroundImage String No The download URL of the default 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.
WaterMarkList Array of WaterMark No The watermark layout. Up to 25 watermarks are supported.

MixTranscodeParams

The audio and video parameters for recording.

Used by actions: CreateCloudRecording.

Name Type Required Description
VideoParams VideoParams No The 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.
AudioParams AudioParams No The 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.

Name Type Required Description
UserId String Yes User ID.
RoomId String No If 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.
RoomIdType Integer No The type of the RoomId parameter. 0: integer; 1: string.

RecordParams

The on-cloud recording parameters.

Used by actions: CreateCloudRecording.

Name Type Required Description
RecordMode Integer Yes The 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.
MaxIdleTime Integer No The time period (seconds) to wait after there are no anchors in a room to stop recording automatically. The value cannot be smaller than 5 or larger than 86400 (24 hours). Default value: 30.
StreamType Integer No The media type of the streams to record.
0: Audio and video streams (default)
1: Audio streams only
2: Video streams only
SubscribeStreamUserIds SubscribeStreamUserIds No The allowlist/blocklist for stream subscription.
OutputFormat Integer No The output format. 0 (default): HLS; 1: HLS + MP4 (recorded in HLS and converted to MP4). This parameter is invalid if you save recording files to VOD. To specify the format of files saved to VOD, use MediaType of TencentVod.
AvMerge Integer No Whether 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.

SingleSubscribeParams

The information of a single stream relayed.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
UserMediaStream UserMediaStream Yes The stream information.

StorageFile

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

Used by actions: DescribeCloudRecording.

Name Type Description
UserId String The 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.
FileName String The filename.
TrackType String The type of the media recorded.
video
audio
audio_video
Note: This field may return null, indicating that no valid values can be obtained.
BeginTimeStamp Integer The start time (Unix timestamp) of the recording file.

StorageParams

The storage parameters.

Used by actions: CreateCloudRecording.

Name Type Required Description
CloudStorage CloudStorage No The third-party cloud storage information (not supported currently).
CloudVod CloudVod No The VOD information.

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.

Name Type Required Description
SubscribeAudioUserIds Array of String No The 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.
UnSubscribeAudioUserIds Array of String No The 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.
SubscribeVideoUserIds Array of String No The 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.
UnSubscribeVideoUserIds Array of String No The 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.

TencentVod

The Tencent Cloud VOD parameters.

Used by actions: CreateCloudRecording.

Name Type Required Description
Procedure String No The 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.
ExpireTime Integer No The 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.
StorageRegion String No The storage region. Set this parameter if you have special requirements on the storage region.
ClassId Integer No The 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.
SubAppId Integer No The VOD subapplication ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.
SessionContext String No The task flow context, which is passed through after the task is completed.
SourceContext String No The upload context, which is passed through after upload is completed.
MediaType Integer No The format of recording files saved to VOD. 0 (default): MP4; 1: HLS.

UserMediaStream

The stream information.

Used by actions: StartPublishCdnStream, UpdatePublishCdnStream.

Name Type Required Description
UserInfo MixUserInfo No The user information.
StreamType Integer No The 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.

Name Type Required Description
Width Integer Yes The width of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1920].
Height Integer Yes The height of the output stream (pixels). This parameter is required if audio and video are relayed. Value range: [0, 1080].
Fps Integer Yes The frame rate (fps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 60].
BitRate Integer Yes The bitrate (Kbps) of the output stream. This parameter is required if audio and video are relayed. Value range: [0, 10000].
Gop Integer Yes The GOP (seconds) of the output stream. This parameter is required if audio and video are relayed. Value range: [1, 5].

VideoParams

The video transcoding parameters for recording.

Used by actions: CreateCloudRecording.

Name Type Required Description
Width Integer Yes The 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.
Height Integer Yes The 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.
Fps Integer Yes The video frame rate. Value range: [1, 60]. Default: 15.
BitRate Integer Yes The video bitrate (bps). Value range: [64000, 8192000]. Default: 550000.
Gop Integer Yes The keyframe interval (seconds). Default value: 10.

WaterMark

The watermark layout.

Used by actions: CreateCloudRecording, ModifyCloudRecording.

Name Type Required Description
WaterMarkType Integer No The watermark type. 0 (default): image; 1: text (not supported yet).
WaterMarkImage WaterMarkImage No The information of watermark images. This parameter is required if the watermark type is image.

WaterMarkImage

The information of watermark images.

Used by actions: CreateCloudRecording, ModifyCloudRecording.

Name Type Required Description
WaterMarkUrl String Yes The download URLs of the watermark images, which must be in JPG or PNG format and cannot be larger than 5 MB.
Top Integer Yes The Y axis of the image's top-left corner. Value range: [0, 2560]. The value cannot be larger than the canvas height.
Left Integer Yes The X axis of the image’s top-left corner. Value range: [0, 2560]. The value cannot be larger than the canvas width.
Width Integer Yes The relative width of the image. Value range: [0, 2560]. The sum of the values of this parameter and Left cannot exceed the canvas width.
Height Integer Yes The relative height of the image. Value range: [0, 2560]. The sum of the values of this parameter and Top cannot exceed the canvas height.
お問い合わせ

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

テクニカルサポート

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

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