Module trtc_cloud_def

• Description: end time (ms) for music playback. 0 or -1 means to play the music to the end.

• Description: music ID
• Note: The SDK allows you to play multiple music tracks. You use music ID to identify a music track and control its playback, volume, etc.

• Description: whether to play a short music file
• Value: YES: short music track that needs to be looped; NO (default): normal-length music track

• Description: music loop times
• Value: 0 (default value) or any positive integer. 0 indicates that the music is played once, 1 twice, and so on.

• Description: absolute path of a music file

• Description: whether to send music to remote users
• Value: YES: publish the music played locally to the cloud so that remote users can hear it; NO (default): play the music locally only and do not publish it

• Description: start time (ms) for music playback

• Height (absolute pixel value) of an image layer

• Room ID (roomId) of the users (userId) whose streams are to be mixed. null means the current room.

• Whether the primary stream (TRTC_VIDEO_STREAM_TYPE_BIG, default) or screen sharing stream (TRTC_VIDEO_STREAM_TYPE_SUB) is mixed

• Users (userId) whose streams are to be mixed

• Width (absolute pixel value) of an image layer

• X coordinate (absolute pixel value) of an image layer

• Y coordinate (absolute pixel value) of an image layer

• Layer number (1-15), which must be unique

-Notes:

• • SERVER (default value): cloud control, which is the recommended mode
• • CLIENT: local control, which is for internal debugging of the SDK and is not recommended

-Notes:

• • Prioritize smoothness: The video may be blurry and pixelated under poor network conditions, but playback is smooth without stutter.
• • Prioritize clarity: The video is clear under poor network conditions, but playback may stutter.

• Tencent Cloud appId. In the TRTC console, find the application you created, and click Application Info to view its ID in the Relayed Live Streaming Info section.

• CSS bizid. In the TRTC console, find the application you created, and click Application Info to view its bizid in the Relayed Live Streaming Info section.

• Relayed push URL

-Notes:

• The rendering mode may be aspect fill (the image may be stretched and cropped) or aspect fit (there may be black bars). The default value is TRTCCloudDef.TRTC_VIDEO_RENDER_MODE_FILL.
• • TRTCCloudDef.TRTC_VIDEO_RENDER_MODE_FILL: The image fills the entire screen, and the excess parts are cropped. The image may not be displayed in whole.
• • TRTCCloudDef.TRTC_VIDEO_RENDER_MODE_FIT: The long side of the image is stretched to fit the screen, and the blank area is filled with black bars. The image is displayed in whole.

-Notes:

• • TRTCCloudDef.TRTC_VIDEO_MIRROR_TYPE_AUTO (default value): mirror the front camera but not the rear camera
• • TRTCCloudDef.TRTC_VIDEO_MIRROR_TYPE_ENABLE: mirror both the front and rear cameras
• • TRTCCloudDef.TRTC_VIDEO_MIRROR_TYPE_DISABLE: mirror neither the front nor rear camera

-Notes: -* - TRTCCloudDef.TRTC_VIDEO_ROTATION_0 (default value): do not rotate -* - TRTCCloudDef.TRTC_VIDEO_ROTATION_90: rotate 90 degrees clockwise -* - TRTCCloudDef.TRTC_VIDEO_ROTATION_180: rotate 180 degrees clockwise -* - TRTCCloudDef.TRTC_VIDEO_ROTATION_270: rotate 270 degrees clockwise

• Description: room signature (optional). You can use this parameter to allow only specified users (userId) to enter a room.
• Value: Use this parameter only if you have high security requirements. For more information, please see Enabling Advanced Permission Control.

• Description: numeric room ID (required). Users (userId) in the same room can see one another and make a video call.
• Value: value range: 1-4294967294

• Description: string-type room ID (optional). Users in the same room can see one another and make a video call.
• Note: You must specify either roomId or strRoomId. If both are specified, roomId will be used.

• Description: user signature (required) of the current userId, which functions as the login password for Tencent Cloud services
• Value: For how to calculate user signatures, please see UserSig.

• Description: Tencent Cloud AppID

-Value: In the TRTC console, find the application created, and click Application Info to view the bizId in the Relayed Live Streaming Info section.

-Description: audio bitrate (Kbps) of the transcoded stream -Value: value range: [32,192]. Default value: 64

-Description: number of sound channels of the transcoded stream -Values: valid values: 1 (default value); 2

-Description: audio sample rate (Hz) of the transcoded stream -Value: valid values: 12000, 16000, 22050, 24000, 32000, 44100, 48000 (default value)

-Description: background color of the mixed stream. The default color is black, and the value is a hex number. For example: "0x61B9F1" represents the RGB color (97,158,241). -Value: default value: 0x000000 (black)

• Description: background image of the mixed stream
• Value: default value: null, which means that no background image is set

-Note: You need to upload the image in Application Management > Function Configuration > Material Management in the console.

•        You will get an image ID for the image uploaded, which you need to convert to a string before using it as the value of `backgroundImage`.<br>
  

•        For example, if the image ID is `63`, you should set `backgroundImage` to `63`.<br>
  

-Description: Tencent Cloud bizid -Value: In the TRTC console, find the application created, and click Application Info to view the bizId in the Relayed Live Streaming Info section.

-Description: position of each channel of image

-Description: transcoding configuration mode

-Description: ID of the live stream pushed to CDN

•      If you do not set this parameter, the SDK will execute the default logic, that is, it will mix multiple streams in the room into the video stream of the API caller, i.e., A + B => A.
  

•      If you set this parameter, the SDK will mix multiple streams in the room into a new stream with the specified ID, i.e., A + B => C.
  

-Value: default value: null, which indicates that multiple streams in the room are mixed into the video stream of the API caller

-Description: video bitrate (Kbps) of the transcoded stream -Value: If you set this parameter to 0, the backend will work out a bitrate based on videoWidth and videoHeight. You can also refer to the comment for the enumerated value TRTC_VIDEO_RESOLUTION_640_480.

-Description: frame rate (fps) of the transcoded stream -Value: value range: (0,30]. default value: 15

-Description: keyframe interval (GOP) of the transcoded stream -Value: value range: [1,8]. default value: 2 (sec)

-Description: video height (px) of the transcoded stream -Value: 640 is recommended. If audio-only streams are mixed, the mixing result will carry a video stream that shows a canvas background. To avoid this, set both the width and height to 0.

-Description: video width (px) of the transcoded stream -Value: 360 is recommended. If audio-only streams are mixed, the mixing result will carry a video stream that shows a canvas background. To avoid this, set both the width and height to 0.

-Value:

• - For mobile live streaming, `false` is recommended.
  

• - For video calls, if you prioritize smoothness, set it to `true`, and the SDK will reduce the resolution (for `TRTCVideoStreamTypeBig` only) if the bandwidth is limited.
  

• - Default value: `false`
  

-Note: If you need to record a call, before setting this parameter to true, make sure that resolution adjustment won’t affect the recording quality.

-Value:

• -If you are tolerant of stutter but have high requirements on clarity, you can set `minVideoBitrate` to 60% of `videoBitrate`.
  

• -If you prioritize smoothness over clarity, you can set `minVideoBitrate` to 200 Kbps.
  

• -Setting `videoBitrate` and `minVideoBitrate` to the same value will disable the SDK’s automatic bitrate control feature.
  

• - If this parameter is `0` (default value), the SDK will determine the lowest bitrate according to the resolution.
  

-Notes:

• - To avoid blurry or pixelated video, you are not advised to set `minVideoBitrate` too low if the target resolution is high.
  

•  For example, if the resolution is set to 720p and the bitrate to 200 Kbps, the encoded video will be heavily pixelated.
  

-Value: Please refer to the recommended bitrates for different TRTCVideoResolution values. You may increase the value moderately.

•        For example, the recommended bitrate for `TRTC_VIDEO_RESOLUTION_1280_720` is 1200 Kbps, but you can set the target bitrate to 1500 Kbps for higher video quality.
  

-Note: Normally, the SDK encodes streams at the bitrate specified by videoBitrate, but under poor network conditions, it will reduce the bitrate, whose minimum allowed value is determined by minVideoBitrate.

•        If you are tolerant of stutter but have high requirements on clarity, you can set `minVideoBitrate` to 60% of `videoBitrate`.
  

•       If you prioritize smoothness over clarity, you can set `minVideoBitrate` to 200 Kbps.
  

•        Setting `videoBitrate` and `minVideoBitrate` to the same value will disable the SDK’s automatic bitrate control feature.
  

-Note: On many Android phones, the front camera does not support a capturing frame rate higher than 15 fps. For some that emphasize beauty filters, the frame rate may be lower than 10 fps.

-Value:

• • For video calls, we recommend a resolution of 360 × 640 or lower and Portrait for resMode.
• • For mobile live streaming, we recommend a resolution of 540 × 960 and Portrait for resMode.
• • For Windows and macOS, we recommend a resolution of 640 × 360 or above and Landscape for resMode.

-Notes:

• By default, TRTCVideoResolution supports only landscape resolutions, such as 640 × 360.
• To use portrait resolutions, set resMode to Portrait. For example, if videoResolution is 640 × 360 and resMode is set to Portrait, the resolution 360 × 640 will be used.

• Description: resolution mode (landscape/portrait)

-Note: If videoResolution is set to 640 × 360 and resMode to Portrait, the resolution 360 × 640 will be used for encoding.