@tencent-rtc/mcp 1.6.3 → 1.6.5

package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md

@@ -131,79 +131,77 @@ For more information, see [Error Codes](https://intl.cloud.tencent.com/document/
 
 **Whether room entry is successful.**
 
-After calling the enterRoom API in ` TRTCCloud ` to enter a room, you will receive the ` onEnterRoom(result) ` callback from ` TRTCCloudDelegate `.
--  If room entry succeeded, ` result ` will be a positive number (` result ` > 0), indicating the time in milliseconds (ms) the room entry takes.
+After calling the enterRoom API in  `TRTCCloud`  to enter a room, you will receive the  `onEnterRoom(result)`  callback from  `TRTCCloudDelegate` .
+-  If room entry succeeded,  `result`  will be a positive number ( `result`  > 0), indicating the time in milliseconds (ms) the room entry takes.
 
--  If room entry failed, ` result ` will be a negative number (result < 0), indicating the error code for the failure.
+-  If room entry failed,  `result`  will be a negative number (result < 0), indicating the error code for the failure.
 
 For more information on the error codes for room entry failure, see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).
 
 |Param|DESC|
 |---------|---------|
-|result|If ` result ` is greater than 0, it indicates the time (in ms) the room entry takes; if ` result ` is less than 0, it represents the error code for room entry.|
+|result|If  `result`  is greater than 0, it indicates the time (in ms) the room entry takes; if  `result`  is less than 0, it represents the error code for room entry.|
 
 > **Note**
 >
-
-> 1. In TRTC versions below 6.6, the ` onEnterRoom(result) ` callback is returned only if room entry succeeds, and the onError callback is returned if room entry fails.
+> 1. In TRTC versions below 6.6, the  `onEnterRoom(result)`  callback is returned only if room entry succeeds, and the onError callback is returned if room entry fails.
 >
-
-> 2. In TRTC 6.6 and above, the ` onEnterRoom(result) ` callback is returned regardless of whether room entry succeeds or fails, and the onError callback is also returned if room entry fails.
+> 2. In TRTC 6.6 and above, the  `onEnterRoom(result)`  callback is returned regardless of whether room entry succeeds or fails, and the onError callback is also returned if room entry fails.
 >
 
 ## onExitRoom:
 
 **Room exit.**
 
-Calling the exitRoom API in ` TRTCCloud ` will trigger the execution of room exit-related logic, such as releasing resources of audio/video devices and codecs.
+Calling the exitRoom API in  `TRTCCloud`  will trigger the execution of room exit-related logic, such as releasing resources of audio/video devices and codecs.
 
-After all resources occupied by the SDK are released, the SDK will return the ` onExitRoom() ` callback.
+After all resources occupied by the SDK are released, the SDK will return the  `onExitRoom()`  callback.
 
-If you need to call enterRoom again or switch to another audio/video SDK, please wait until you receive the ` onExitRoom() ` callback.
+If you need to call enterRoom again or switch to another audio/video SDK, please wait until you receive the  `onExitRoom()`  callback.
 
 Otherwise, you may encounter problems such as the camera or mic being occupied.
 
 |Param|DESC|
 |---------|---------|
-|reason|Reason for room exit. ` 0 `: the user called ` exitRoom ` to exit the room; ` 1 `: the user was removed from the room by the server; ` 2 `: the room was dismissed; ` 3 `: the server status was abnormal.|
+|reason|Reason for room exit.  `0` : the user called  `exitRoom`  to exit the room;  `1` : the user was removed from the room by the server;  `2` : the room was dismissed;  `3` : the server status was abnormal.|
 
 ## onSwitchRole:errMsg:
 
 **Role switching.**
 
-You can call the switchRole API in ` TRTCCloud ` to switch between the anchor and audience roles. This is accompanied by a line switching process.
+You can call the switchRole API in  `TRTCCloud`  to switch between the anchor and audience roles. This is accompanied by a line switching process.
 
-After the switching, the SDK will return the ` onSwitchRole() ` event callback.
+After the switching, the SDK will return the  `onSwitchRole()`  event callback.
 
 |Param|DESC|
 |---------|---------|
-|errCode|Error code. ` ERR_NULL ` indicates a successful switch. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|errCode|Error code.  `ERR_NULL`  indicates a successful switch. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 |errMsg|Error message|
 
 ## onSwitchRoom:errMsg:
 
 **Result of room switching.**
 
-You can call the switchRoom API in ` TRTCCloud ` to switch from one room to another.
+You can call the switchRoom API in  `TRTCCloud`  to switch from one room to another.
 
-After the switching, the SDK will return the ` onSwitchRoom() ` event callback.
+After the switching, the SDK will return the  `onSwitchRoom()`  event callback.
 
 |Param|DESC|
 |---------|---------|
-|errCode|Error code. ` ERR_NULL ` indicates a successful switch. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35124).|
+|errCode|Error code.  `ERR_NULL`  indicates a successful switch. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35124).|
 |errMsg|Error message|
 
 ## onConnectOtherRoom:errCode:errMsg:
 
 **Result of requesting cross-room call.**
 
-You can call the connectOtherRoom API in ` TRTCCloud ` to establish a video call with the anchor of another room. This is the “anchor competition” feature.
+You can call the connectOtherRoom API in  `TRTCCloud`  to establish a video call with the anchor of another room. This is the “anchor competition” feature.
 
-The caller will receive the ` onConnectOtherRoom() ` callback, which can be used to determine whether the cross-room call is successful.
+The caller will receive the  `onConnectOtherRoom()`  callback, which can be used to determine whether the cross-room call is successful.
 
 |Param|DESC|
 |---------|---------|
-|errCode|Error code. ` ERR_NULL ` indicates that cross-room connection is established successfully. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|errCode|Error code.  `ERR_NULL`  indicates that cross-room connection is established successfully. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 |errMsg|Error message|
 |userId|The user ID of the anchor (in another room) to be called|
 
@@ -211,33 +209,33 @@ The caller will receive the ` onConnectOtherRoom() ` callback, which can be used
 
 **Result of ending cross-room call.**
 
-You can call the disConnectOtherRoom API in ` TRTCCloud ` to end a video call with the anchor of another room. This is the “anchor competition” feature.
+You can call the disConnectOtherRoom API in  `TRTCCloud`  to end a video call with the anchor of another room. This is the “anchor competition” feature.
 
-The caller will receive the ` onDisconnectOtherRoom() ` callback to determine whether the cross-room call has been successfully disconnected.
+The caller will receive the  `onDisconnectOtherRoom()`  callback to determine whether the cross-room call has been successfully disconnected.
 
 |Param|DESC|
 |---------|---------|
-|errCode|Error code. ` ERR_NULL ` indicates that the cross-room call has been successfully disconnected. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|errCode|Error code.  `ERR_NULL`  indicates that the cross-room call has been successfully disconnected. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 |errMsg|Error message|
 
 ## onUpdateOtherRoomForwardMode:errMsg:
 
 **Result of changing the upstream capability of the cross-room anchor.**
 
-You can call the updateOtherRoomForwardMode API in ` TRTCCloud ` to limit the upstream capability of the cross-room anchor in the current room, and prohibit or allow the cross-room anchor to publish audio/video/sub-stream. This behavior will affect all users in the room.
+You can call the updateOtherRoomForwardMode API in  `TRTCCloud`  to limit the upstream capability of the cross-room anchor in the current room, and prohibit or allow the cross-room anchor to publish audio/video/sub-stream. This behavior will affect all users in the room.
 
-The caller will receive the ` onUpdateOtherRoomForwardMode() ` callback to determine whether the changing upstream capability of the cross-room anchor is successful.
+The caller will receive the  `onUpdateOtherRoomForwardMode()`  callback to determine whether the changing upstream capability of the cross-room anchor is successful.
 
 |Param|DESC|
 |---------|---------|
-|errCode|Error code. ` ERR_NULL ` indicates that upstream capability of the cross-room anchor is changed successfully. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|errCode|Error code.  `ERR_NULL`  indicates that upstream capability of the cross-room anchor is changed successfully. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 |errMsg|Error message|
 
 ## onRemoteUserEnterRoom:
 
 **A user entered the room.**
 
-Due to performance concerns, this callback works differently in different scenarios (i.e., ` AppScene `, which you can specify by setting the second parameter when calling enterRoom).
+Due to performance concerns, this callback works differently in different scenarios (i.e.,  `AppScene` , which you can specify by setting the second parameter when calling enterRoom).
 -  Live streaming scenarios (TRTCAppSceneLIVE or TRTCAppSceneVoiceChatRoom): in live streaming scenarios, a user is either in the role of an anchor or audience. The callback is returned only when an anchor enters the room.
 
 -  Call scenarios (TRTCAppSceneVideoCall or TRTCAppSceneAudioCall): in call scenarios, the concept of roles does not apply (all users can be considered as anchors), and the callback is returned when any user enters the room.
@@ -248,10 +246,8 @@ Due to performance concerns, this callback works differently in different scenar
 
 > **Note**
 >
-
-> 1. The ` onRemoteUserEnterRoom ` callback indicates that a user entered the room, but it does not necessarily mean that the user enabled audio or video.
+> 1. The  `onRemoteUserEnterRoom`  callback indicates that a user entered the room, but it does not necessarily mean that the user enabled audio or video.
 >
-
 > 2. If you want to know whether a user enabled video, we recommend you use the onUserVideoAvailable callback.
 >
 
@@ -259,47 +255,46 @@ Due to performance concerns, this callback works differently in different scenar
 
 **A user exited the room.**
 
-As with onRemoteUserEnterRoom, this callback works differently in different scenarios (i.e., ` AppScene `, which you can specify by setting the second parameter when calling enterRoom).
+As with onRemoteUserEnterRoom, this callback works differently in different scenarios (i.e.,  `AppScene` , which you can specify by setting the second parameter when calling enterRoom).
 -  Live streaming scenarios (TRTCAppSceneLIVE or TRTCAppSceneVoiceChatRoom): the callback is triggered only when an anchor exits the room.
 
 -  Call scenarios (TRTCAppSceneVideoCall or TRTCAppSceneAudioCall): in call scenarios, the concept of roles does not apply, and the callback is returned when any user exits the room.
 
 |Param|DESC|
 |---------|---------|
-|reason|Reason for room exit. ` 0 `: the user exited the room voluntarily; ` 1 `: the user exited the room due to timeout; ` 2 `: the user was removed from the room; ` 3 `: the anchor user exited the room due to switch to audience.|
+|reason|Reason for room exit.  `0` : the user exited the room voluntarily;  `1` : the user exited the room due to timeout;  `2` : the user was removed from the room;  `3` : the anchor user exited the room due to switch to audience.|
 |userId|User ID of the remote user|
 
 ## onUserVideoAvailable:available:
 
 **A remote user published/unpublished primary stream video.**
 
-The primary stream is usually used for camera images. If you receive the ` onUserVideoAvailable(userId, YES) ` callback, it indicates that the user has available primary stream video.
+The primary stream is usually used for camera images. If you receive the  `onUserVideoAvailable(userId, YES)`  callback, it indicates that the user has available primary stream video.
 
-You can then call startRemoteView to subscribe to the remote user’s video. If the subscription is successful, you will receive the ` onFirstVideoFrame(userid) ` callback, which indicates that the first video frame of the user is rendered.
+You can then call startRemoteView to subscribe to the remote user’s video. If the subscription is successful, you will receive the  `onFirstVideoFrame(userid)`  callback, which indicates that the first video frame of the user is rendered.
 
-If you receive the ` onUserVideoAvailable(userId, NO) ` callback, it indicates that the video of the remote user is disabled, which may be because the user called muteLocalVideo or stopLocalPreview.
+If you receive the  `onUserVideoAvailable(userId, NO)`  callback, it indicates that the video of the remote user is disabled, which may be because the user called muteLocalVideo or stopLocalPreview.
 
 |Param|DESC|
 |---------|---------|
-|available|Whether the user published (or unpublished) primary stream video. ` YES `: published; ` NO `: unpublished|
+|available|Whether the user published (or unpublished) primary stream video.  `YES` : published;  `NO` : unpublished|
 |userId|User ID of the remote user|
 
 ## onUserSubStreamAvailable:available:
 
 **A remote user published/unpublished substream video.**
 
-The substream is usually used for screen sharing images. If you receive the ` onUserSubStreamAvailable(userId, YES) ` callback, it indicates that the user has available substream video.
+The substream is usually used for screen sharing images. If you receive the  `onUserSubStreamAvailable(userId, YES)`  callback, it indicates that the user has available substream video.
 
-You can then call startRemoteView to subscribe to the remote user’s video. If the subscription is successful, you will receive the ` onFirstVideoFrame(userid) ` callback, which indicates that the first frame of the user is rendered.
+You can then call startRemoteView to subscribe to the remote user’s video. If the subscription is successful, you will receive the  `onFirstVideoFrame(userid)`  callback, which indicates that the first frame of the user is rendered.
 
 |Param|DESC|
 |---------|---------|
-|available|Whether the user published (or unpublished) substream video. ` YES `: published; ` NO `: unpublished|
+|available|Whether the user published (or unpublished) substream video.  `YES` : published;  `NO` : unpublished|
 |userId|User ID of the remote user|
 
 > **Note**
 >
-
 > The API used to display substream images is startRemoteView, not startRemoteSubStreamView, startRemoteSubStreamView is deprecated.
 >
 
@@ -307,19 +302,18 @@ You can then call startRemoteView to subscribe to the remote user’s video. If
 
 **A remote user published/unpublished audio.**
 
-If you receive the ` onUserAudioAvailable(userId, YES) ` callback, it indicates that the user published audio.
+If you receive the  `onUserAudioAvailable(userId, YES)`  callback, it indicates that the user published audio.
 -  In auto-subscription mode, the SDK will play the user’s audio automatically.
 
 -  In manual subscription mode, you can call muteRemoteAudio(userid, NO) to play the user’s audio.
 
 |Param|DESC|
 |---------|---------|
-|available|Whether the user published (or unpublished) audio. ` YES `: published; ` NO `: unpublished|
+|available|Whether the user published (or unpublished) audio.  `YES` : published;  `NO` : unpublished|
 |userId|User ID of the remote user|
 
 > **Note**
 >
-
 > The auto-subscription mode is used by default. You can switch to the manual subscription mode by calling setDefaultStreamRecvMode, but it must be called before room entry for the switch to take effect.
 >
 
@@ -327,24 +321,22 @@ If you receive the ` onUserAudioAvailable(userId, YES) ` callback, it indicates
 
 **The SDK started rendering the first video frame of the local or a remote user.**
 
-The SDK returns this event callback when it starts rendering your first video frame or that of a remote user. The ` userId ` in the callback can help you determine whether the frame is yours or a remote user’s.
--  If ` userId ` is empty, it indicates that the SDK has started rendering your first video frame. The precondition is that you have called startLocalPreview or startScreenCapture.
+The SDK returns this event callback when it starts rendering your first video frame or that of a remote user. The  `userId`  in the callback can help you determine whether the frame is yours or a remote user’s.
+-  If  `userId`  is empty, it indicates that the SDK has started rendering your first video frame. The precondition is that you have called startLocalPreview or startScreenCapture.
 
--  If ` userId ` is not empty, it indicates that the SDK has started rendering the first video frame of a remote user. The precondition is that you have called startRemoteView to subscribe to the user’s video.
+-  If  `userId`  is not empty, it indicates that the SDK has started rendering the first video frame of a remote user. The precondition is that you have called startRemoteView to subscribe to the user’s video.
 
 |Param|DESC|
 |---------|---------|
 |height|Video height|
-|streamType|Video stream type. The primary stream (` Main `) is usually used for camera images, and the substream (` Sub `) for screen sharing images.|
+|streamType|Video stream type. The primary stream ( `Main` ) is usually used for camera images, and the substream ( `Sub` ) for screen sharing images.|
 |userId|The user ID of the local or a remote user. If it is empty, it indicates that the first local video frame is available; if it is not empty, it indicates that the first video frame of a remote user is available.|
 |width|Video width|
 
 > **Note**
 >
-
 > 1. The callback of the first local video frame being rendered is triggered only after you call startLocalPreview or startScreenCapture.
 >
-
 > 2. The callback of the first video frame of a remote user being rendered is triggered only after you call startRemoteView or startRemoteSubStreamView.
 >
 
@@ -366,11 +358,11 @@ After you enter a room and call startLocalPreview or startScreenCapture to enabl
 
 the SDK will start video encoding and publish the local video data via its network module to the cloud.
 
-It returns the ` onSendFirstLocalVideoFrame ` callback after publishing the first local video frame.
+It returns the  `onSendFirstLocalVideoFrame`  callback after publishing the first local video frame.
 
 |Param|DESC|
 |---------|---------|
-|streamType|Video stream type. The primary stream (` Main `) is usually used for camera images, and the substream (` Sub `) for screen sharing images.|
+|streamType|Video stream type. The primary stream ( `Main` ) is usually used for camera images, and the substream ( `Sub` ) for screen sharing images.|
 
 ## onSendFirstLocalAudioFrame
 
@@ -380,79 +372,73 @@ After you enter a room and call startLocalAudio to enable audio capturing (which
 
 the SDK will start audio encoding and publish the local audio data via its network module to the cloud.
 
-The SDK returns the ` onSendFirstLocalAudioFrame ` callback after sending the first local audio frame.
+The SDK returns the  `onSendFirstLocalAudioFrame`  callback after sending the first local audio frame.
 
 ## onRemoteVideoStatusUpdated:streamType:streamStatus:reason:extrainfo:
 
 **Change of remote video status.**
 
-You can use this callback to get the status (` Playing `, ` Loading `, or ` Stopped `) of the video of each remote user and display it on the UI.
+You can use this callback to get the status ( `Playing` ,  `Loading` , or  `Stopped` ) of the video of each remote user and display it on the UI.
 
 |Param|DESC|
 |---------|---------|
 |extraInfo|Extra information|
 |reason|Reason for the change of status|
-|status|Video status, which may be ` Playing `, ` Loading `, or ` Stopped `|
-|streamType|Video stream type. The primary stream (` Main `) is usually used for camera images, and the substream (` Sub `) for screen sharing images.|
+|status|Video status, which may be  `Playing` ,  `Loading` , or  `Stopped` |
+|streamType|Video stream type. The primary stream ( `Main` ) is usually used for camera images, and the substream ( `Sub` ) for screen sharing images.|
 |userId|User ID|
 
 ## onRemoteAudioStatusUpdated:streamStatus:reason:extrainfo:
 
 **Change of remote audio status.**
 
-You can use this callback to get the status (` Playing `, ` Loading `, or ` Stopped `) of the audio of each remote user and display it on the UI.
+You can use this callback to get the status ( `Playing` ,  `Loading` , or  `Stopped` ) of the audio of each remote user and display it on the UI.
 
 |Param|DESC|
 |---------|---------|
 |extraInfo|Extra information|
 |reason|Reason for the change of status|
-|status|Audio status, which may be ` Playing `, ` Loading `, or ` Stopped `|
+|status|Audio status, which may be  `Playing` ,  `Loading` , or  `Stopped` |
 |userId|User ID|
 
 ## onUserVideoSizeChanged:streamType:newWidth:newHeight:
 
 **Change of remote video size.**
 
-If you receive the ` onUserVideoSizeChanged(userId, streamType, newWidth, newHeight) ` callback, it indicates that the user changed the video size. It may be triggered by setVideoEncoderParam or setSubStreamEncoderParam.
+If you receive the  `onUserVideoSizeChanged(userId, streamType, newWidth, newHeight)`  callback, it indicates that the user changed the video size. It may be triggered by setVideoEncoderParam or setSubStreamEncoderParam.
 
 |Param|DESC|
 |---------|---------|
 |newHeight|Video height|
 |newWidth|Video width|
-|streamType|Video stream type. The primary stream (` Main `) is usually used for camera images, and the substream (` Sub `) for screen sharing images.|
+|streamType|Video stream type. The primary stream ( `Main` ) is usually used for camera images, and the substream ( `Sub` ) for screen sharing images.|
 |userId|User ID|
 
 ## onNetworkQuality:remoteQuality:
 
 **Real-time network quality statistics.**
 
-This callback is returned every 2 seconds and notifies you of the upstream and downstream network quality detected by the SDK.
+This callback is returned every 2 seconds and notifies you of the upstream quality of the local user and remote users detected by the SDK.
 
 The SDK uses a built-in proprietary algorithm to assess the current latency, bandwidth, and stability of the network and returns a result.
 
-If the result is ` 1 ` (excellent), it means that the current network conditions are excellent; if it is ` 6 ` (down), it means that the current network conditions are too bad to support TRTC calls.
+If the result is  `1`  (excellent), it means that the current network conditions are excellent; if it is  `6`  (down), it means that the current network conditions are too bad to support TRTC calls.
 
 |Param|DESC|
 |---------|---------|
-|localQuality|Upstream network quality|
-|remoteQuality|Downstream network quality, it refers to the data quality finally measured on the local side after the data flow passes through a complete transmission link of "remote ->cloud ->local". Therefore, the downlink network quality here represents the joint impact of the remote uplink and the local downlink.|
-
-> **Note**
->
-
-> The uplink quality of remote users cannot be determined independently through this interface.
->
+|localQuality|Upstream network quality of the local user.|
+|remoteQuality|Upstream network quality of remote users.|
 
 ## onStatistics:
 
 **Real-time statistics on technical metrics.**
 
 This callback is returned every 2 seconds and notifies you of the statistics on technical metrics related to video, audio, and network. The metrics are listed in TRTCStatistics:
--  Video statistics: video resolution (` resolution `), frame rate (` FPS `), bitrate (` bitrate `), etc.
+-  Video statistics: video resolution ( `resolution` ), frame rate ( `FPS` ), bitrate ( `bitrate` ), etc.
 
--  Audio statistics: audio sample rate (` samplerate `), number of audio channels (` channel `), bitrate (` bitrate `), etc.
+-  Audio statistics: audio sample rate ( `samplerate` ), number of audio channels ( `channel` ), bitrate ( `bitrate` ), etc.
 
--  Network statistics: the round trip time (` rtt `) between the SDK and the cloud (SDK -> Cloud -> SDK), package loss rate (` loss `), upstream traffic (` sentBytes `), downstream traffic (` receivedBytes `), etc.
+-  Network statistics: the round trip time ( `rtt` ) between the SDK and the cloud (SDK -> Cloud -> SDK), package loss rate ( `loss` ), upstream traffic ( `sentBytes` ), downstream traffic ( `receivedBytes` ), etc.
 
 |Param|DESC|
 |---------|---------|
@@ -460,7 +446,6 @@ This callback is returned every 2 seconds and notifies you of the statistics on
 
 > **Note**
 >
-
 > If you want to learn about only the current network quality and do not want to spend much time analyzing the statistics returned by this callback, we recommend you use onNetworkQuality.
 >
 
@@ -553,8 +538,7 @@ Note that the SDK returns this callback at the specified interval regardless of
 
 > **Note**
 >
-
-> ` userVolumes ` is an array. If ` userId ` is empty, the elements in the array represent the volume of the local user’s audio. Otherwise, they represent the volume of a remote user’s audio.
+>  `userVolumes`  is an array. If  `userId`  is empty, the elements in the array represent the volume of the local user’s audio. Otherwise, they represent the volume of a remote user’s audio.
 >
 
 ## onDevice:type:stateChanged:
@@ -567,7 +551,7 @@ The SDK returns this callback when a local device (camera, mic, or speaker) is c
 |---------|---------|
 |deviceId|Device ID|
 |deviceType|Device type|
-|state|Device status. ` 0 `: disconnected; ` 1 `: connected|
+|state|Device status.  `0` : disconnected;  `1` : connected|
 
 ## onAudioDeviceCaptureVolumeChanged:muted:
 
@@ -583,13 +567,12 @@ When users set the mic capturing volume via the UI or a keyboard shortcut, the S
 
 |Param|DESC|
 |---------|---------|
-|muted|Whether the mic is muted. ` YES `: muted; ` NO `: unmuted|
+|muted|Whether the mic is muted.  `YES` : muted;  `NO` : unmuted|
 |volume|System audio capturing volume, which users can set in the audio control panel. Value range: [0, 100]|
 
 > **Note**
 >
-
-> You need to call enableAudioVolumeEvaluation and set the callback interval (` interval ` > 0) to enable the callback. To disable the callback, set ` interval ` to ` 0 `.
+> You need to call enableAudioVolumeEvaluation and set the callback interval ( `interval`  > 0) to enable the callback. To disable the callback, set  `interval`  to  `0` .
 >
 
 ## onAudioDevicePlayoutVolumeChanged:muted:
@@ -604,13 +587,12 @@ When users set the system’s playback volume via the UI or a keyboard shortcut,
 
 |Param|DESC|
 |---------|---------|
-|muted|Whether the speaker is muted. ` YES `: muted; ` NO `: unmuted|
+|muted|Whether the speaker is muted.  `YES` : muted;  `NO` : unmuted|
 |volume|The system playback volume, which users can set in the audio control panel. Value range: 0-100|
 
 > **Note**
 >
-
-> You need to call enableAudioVolumeEvaluation and set the callback interval (` interval ` > 0) to enable the callback. To disable the callback, set ` interval ` to ` 0 `.
+> You need to call enableAudioVolumeEvaluation and set the callback interval ( `interval`  > 0) to enable the callback. To disable the callback, set  `interval`  to  `0` .
 >
 
 ## onSystemAudioLoopbackError:
@@ -627,13 +609,13 @@ The SDK returns this callback after trying to enable system audio capturing. To
 
 |Param|DESC|
 |---------|---------|
-|err|If it is ` ERR_NULL `, system audio capturing is enabled successfully. Otherwise, it is not. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|err|If it is  `ERR_NULL` , system audio capturing is enabled successfully. Otherwise, it is not. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 
 ## onRecvCustomCmdMsgUserId:cmdID:seq:message:
 
 **Receipt of custom message.**
 
-When a user in a room uses sendCustomCmdMsg to send a custom message, other users in the room can receive the message through the ` onRecvCustomCmdMsg ` callback.
+When a user in a room uses sendCustomCmdMsg to send a custom message, other users in the room can receive the message through the  `onRecvCustomCmdMsg`  callback.
 
 |Param|DESC|
 |---------|---------|
@@ -646,9 +628,9 @@ When a user in a room uses sendCustomCmdMsg to send a custom message, other user
 
 **Loss of custom message.**
 
-When you use sendCustomCmdMsg to send a custom UDP message, even if you enable reliable transfer (by setting ` reliable ` to ` YES `), there is still a chance of message loss. Reliable transfer only helps maintain a low probability of message loss, which meets the reliability requirements in most cases.
+When you use sendCustomCmdMsg to send a custom UDP message, even if you enable reliable transfer (by setting  `reliable`  to  `YES` ), there is still a chance of message loss. Reliable transfer only helps maintain a low probability of message loss, which meets the reliability requirements in most cases.
 
-If the sender sets ` reliable ` to ` YES `, the SDK will use this callback to notify the recipient of the number of custom messages lost during a specified time period (usually 5s) in the past.
+If the sender sets  `reliable`  to  `YES` , the SDK will use this callback to notify the recipient of the number of custom messages lost during a specified time period (usually 5s) in the past.
 
 |Param|DESC|
 |---------|---------|
@@ -659,15 +641,14 @@ If the sender sets ` reliable ` to ` YES `, the SDK will use this callback to no
 
 > **Note**
 >
-
-> The recipient receives this callback only if the sender sets ` reliable ` to ` YES `.
+> The recipient receives this callback only if the sender sets  `reliable`  to  `YES` .
 >
 
 ## onRecvSEIMsg:message:
 
 **Receipt of SEI message.**
 
-If a user in the room uses sendSEIMsg to send an SEI message via video frames, other users in the room can receive the message through the ` onRecvSEIMsg ` callback.
+If a user in the room uses sendSEIMsg to send an SEI message via video frames, other users in the room can receive the message through the  `onRecvSEIMsg`  callback.
 
 |Param|DESC|
 |---------|---------|
@@ -684,7 +665,7 @@ The SDK will then receive the execution result from the CVM and return the resul
 
 |Param|DESC|
 |---------|---------|
-|err|` 0 `: successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|err| `0` : successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 |errMsg|Error message|
 
 ## onStopPublishing:errMsg:
@@ -697,7 +678,7 @@ The SDK will then receive the execution result from the CVM and return the resul
 
 |Param|DESC|
 |---------|---------|
-|err|` 0 `: successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|err| `0` : successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 |errMsg|Error message|
 
 ## onStartPublishCDNStream:errMsg:
@@ -710,12 +691,11 @@ The SDK will then receive the execution result from the CVM and return the resul
 
 |Param|DESC|
 |---------|---------|
-|err|` 0 `: successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|err| `0` : successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 |errMsg|Error message|
 
 > **Note**
 >
-
 > If you receive a callback that the command is executed successfully, it only means that your command was sent to Tencent Cloud’s backend server. If the CDN vendor does not accept your streams, the publishing will still fail.
 >
 
@@ -729,7 +709,7 @@ The SDK will then receive the execution result from the CVM and return the resul
 
 |Param|DESC|
 |---------|---------|
-|err|` 0 `: successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|err| `0` : successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 |errMsg|Error message|
 
 ## onSetMixTranscodingConfig:errMsg:
@@ -742,7 +722,7 @@ The SDK will then receive the execution result from the CVM and return the resul
 
 |Param|DESC|
 |---------|---------|
-|err|` 0 `: successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
+|err| `0` : successful; other values: failed. For more information, please see [Error Codes](https://intl.cloud.tencent.com/document/product/647/35135).|
 |errMsg|Error message|
 
 ## onStartPublishMediaStream:code:message:extraInfo:
@@ -754,7 +734,7 @@ When you call startPublishMediaStream to publish a stream to the TRTC backend, t
 The SDK will then receive the publishing result from the cloud server and will send the result to you via this callback.
 | Param | DESC |
 | --- | --- |
-| code | : <code> 0 </code>: Successful; other values: Failed. For more information, please see <a href="https://intl.cloud.tencent.com/document/product/647/35135">Error Codes</a>. |
+| code | :  <code>0</code> : Successful; other values: Failed. For more information, please see <a href="https://intl.cloud.tencent.com/document/product/647/35135">Error Codes</a>. |
 | extraInfo | : Additional information. For some error codes, there may be additional information to help you troubleshoot the issues.<br>If the code return value is ERR_SERVER_PROCESS_FAILED, it means the server failed to process your request. You can use "error_code" as the key to retrieve the error code returned by the server. The specific error codes and recommended actions are as follows:<br>-  2000: Parameter error. Check the request parameters.<br>-  2001: Live streaming service is not enabled. Enable it in the Live streaming console.<br>-  2021: Third-party retweet service is not enabled. Contact product support to enable it.<br>-  3000: Internal server error. Retry is recommended.<br>-  4006: Concurrency conflict with the same task. The server is still processing the previous startPublishMediaStream task. Retry after a delay is recommended.<br>-  4007: The same task has already been successfully started using startPublishMediaStream. Use the returned taskId to call the updatePublishMediaStream API to update the task.<br>-  5001: Resource constraints. Retry after a delay is recommended. |
 | message | : The callback information. |
 | taskId | : If a request is successful, a task ID will be returned via the callback. You need to provide this task ID when you call updatePublishMediaStream to modify publishing parameters or stopPublishMediaStream to stop publishing. |
@@ -768,7 +748,7 @@ When you call updatePublishMediaStream to modify publishing parameters, the SDK
 The SDK will then receive the modification result from the cloud server and will send the result to you via this callback.
 | Param | DESC |
 | --- | --- |
-| code | : <code> 0 </code>: Successful; other values: Failed. For more information, please see <a href="https://intl.cloud.tencent.com/document/product/647/35135">Error Codes</a>. |
+| code | :  <code>0</code> : Successful; other values: Failed. For more information, please see <a href="https://intl.cloud.tencent.com/document/product/647/35135">Error Codes</a>. |
 | extraInfo | : Additional information. For some error codes, there may be additional information to help you troubleshoot the issues.<br>If the code return value is ERR_SERVER_PROCESS_FAILED, it means the server failed to process your request. You can use "error_code" as the key to retrieve the error code returned by the server. The specific error codes and recommended solutions are as follows:<br>-  2000: Parameter error. Check the request parameters.<br>-  2001: Live streaming service is not enabled. Enable it in the Live Streaming Console.<br>-  2002: Task not found. Restart the task by calling the startPublishMediaStream API.<br>-  2018: Concurrent requests are out of order. Retry with the latest streaming parameters.<br>-  2021: Third-party retweet service is not enabled. Contact product support to enable it.<br>-  3000: Internal server error. Retry.<br>-  4003: Task is exiting. Stop the task by calling the stopPublishMediaStream API first, then restart it by calling the startPublishMediaStream API. |
 | message | : The callback information. |
 | taskId | : The task ID you pass in when calling updatePublishMediaStream, which is used to identify a request. |
@@ -782,7 +762,7 @@ When you call stopPublishMediaStream to stop publishing, the SDK will immediatel
 The SDK will then receive the modification result from the cloud server and will send the result to you via this callback.
 | Param | DESC |
 | --- | --- |
-| code | : <code> 0 </code>: Successful; other values: Failed. For more information, please see <a href="https://intl.cloud.tencent.com/document/product/647/35135">Error Codes</a>. |
+| code | :  <code>0</code> : Successful; other values: Failed. For more information, please see <a href="https://intl.cloud.tencent.com/document/product/647/35135">Error Codes</a>. |
 | extraInfo | : Additional information. For some error codes, there may be additional information to help you troubleshoot the issues.<br>If the code return value is ERR_SERVER_PROCESS_FAILED, it means the server was unable to process your request. You can use "error_code" as the key to retrieve the error code returned by the server. The specific error codes and recommended actions are as follows:<br>-  2000: Parameter error. Please check the request parameters.<br>-  2002: Task not found. No action required.<br>-  3000: Internal server error. Please retry.<br>-  4003: Task is exiting. No action required. |
 | message | : The callback information. |
 | taskId | : The task ID you pass in when calling stopPublishMediaStream, which is used to identify a request. |
@@ -797,10 +777,10 @@ If you set the publishing destination (TRTCPublishTarget) to the URL of Tencent
 | Param | DESC |
 | --- | --- |
 | cdnUrl | : The URL you specify in TRTCPublishTarget when you call startPublishMediaStream. |
-| code | : The publishing result. <code> 0 </code>: Successful; other values: Failed. For more information, please see <a href="https://intl.cloud.tencent.com/document/product/647/35135">Error Codes</a>. |
+| code | : The publishing result.  <code>0</code> : Successful; other values: Failed. For more information, please see <a href="https://intl.cloud.tencent.com/document/product/647/35135">Error Codes</a>. |
 | extraInfo | : Additional information. For some error codes, there may be additional information to help you troubleshoot the issues. |
 | message | : The publishing information. |
-| status | : The publishing status.<br>-  0: The publishing has not started yet or has ended. This value will be returned after you call stopPublishMediaStream.<br>-  1: The TRTC server is connecting to the CDN server. If the first attempt fails, the TRTC backend will retry multiple times and will return this value via the callback (every five seconds). After publishing succeeds, the value <code> 2 </code> will be returned. If a server error occurs or publishing is still unsuccessful after 60 seconds, the value <code> 4 </code> will be returned.<br>-  2: The TRTC server is publishing to the CDN. This value will be returned if the publishing succeeds.<br>-  3: The TRTC server is disconnected from the CDN server and is reconnecting. If a CDN error occurs or publishing is interrupted, the TRTC backend will try to reconnect and resume publishing and will return this value via the callback (every five seconds). After publishing resumes, the value <code> 2 </code> will be returned. If a server error occurs or the attempt to resume publishing is still unsuccessful after 60 seconds, the value <code> 4 </code> will be returned.<br>-  4: The TRTC server is disconnected from the CDN server and failed to reconnect within the timeout period. In this case, the publishing is deemed to have failed. You can call updatePublishMediaStream to try again.<br>-  5: The TRTC server is disconnecting from the CDN server. After you call stopPublishMediaStream, the SDK will return this value first and then the value <code> 0 </code>. |
+| status | : The publishing status.<br>-  0: The publishing has not started yet or has ended. This value will be returned after you call stopPublishMediaStream.<br>-  1: The TRTC server is connecting to the CDN server. If the first attempt fails, the TRTC backend will retry multiple times and will return this value via the callback (every five seconds). After publishing succeeds, the value  <code>2</code>  will be returned. If a server error occurs or publishing is still unsuccessful after 60 seconds, the value  <code>4</code>  will be returned.<br>-  2: The TRTC server is publishing to the CDN. This value will be returned if the publishing succeeds.<br>-  3: The TRTC server is disconnected from the CDN server and is reconnecting. If a CDN error occurs or publishing is interrupted, the TRTC backend will try to reconnect and resume publishing and will return this value via the callback (every five seconds). After publishing resumes, the value  <code>2</code>  will be returned. If a server error occurs or the attempt to resume publishing is still unsuccessful after 60 seconds, the value  <code>4</code>  will be returned.<br>-  4: The TRTC server is disconnected from the CDN server and failed to reconnect within the timeout period. In this case, the publishing is deemed to have failed. You can call updatePublishMediaStream to try again.<br>-  5: The TRTC server is disconnecting from the CDN server. After you call stopPublishMediaStream, the SDK will return this value first and then the value  <code>0</code> . |
 
 ## onScreenCaptureStarted
 
@@ -825,7 +805,7 @@ The SDK returns this callback when you call stopScreenCapture to stop screen sha
 
 |Param|DESC|
 |---------|---------|
-|reason|Reason. ` 0 `: the user stopped screen sharing; ` 1 `: screen sharing stopped because the shared window was closed.|
+|reason|Reason.  `0` : the user stopped screen sharing;  `1` : screen sharing stopped because the shared window was closed.|
 
 ## onLocalRecordBegin:storagePath:
 
@@ -905,8 +885,8 @@ If you have configured the callback of custom rendering for local or remote vide
 |Param|DESC|
 |---------|---------|
 |frame|Video frames to be rendered|
-|streamType|Stream type. The primary stream (` Main `) is usually used for camera images, and the substream (` Sub `) for screen sharing images.|
-|userId|` userId ` of the video source. This parameter can be ignored if the callback is for local video (setLocalVideoRenderDelegate).|
+|streamType|Stream type. The primary stream ( `Main` ) is usually used for camera images, and the substream ( `Sub` ) for screen sharing images.|
+|userId| `userId`  of the video source. This parameter can be ignored if the callback is for local video (setLocalVideoRenderDelegate).|
 
 ## onGLContextCreated
 
@@ -916,13 +896,13 @@ If you have configured the callback of custom rendering for local or remote vide
 
 **Video processing by third-party beauty filters.**
 
-If you use a third-party beauty filter component, you need to configure this callback in ` TRTCCloud ` to have the SDK return to you video frames that are otherwise pre-processed by TRTC.
+If you use a third-party beauty filter component, you need to configure this callback in  `TRTCCloud`  to have the SDK return to you video frames that are otherwise pre-processed by TRTC.
 
 You can then send the video frames to the third-party beauty filter component for processing. As the data returned can be read and modified, the result of processing can be synced to TRTC for subsequent encoding and publishing.
 
 Case 1: the beauty filter component generates new textures
 
-If the beauty filter component you use generates a frame of new texture (for the processed image) during image processing, please set ` dstFrame.textureId ` to the ID of the new texture in the callback function.
+If the beauty filter component you use generates a frame of new texture (for the processed image) during image processing, please set  `dstFrame.textureId`  to the ID of the new texture in the callback function.
 ``` objectivec
 uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVideoFrame * _Nonnull)dstFrame{
     self.frameID += 1;
@@ -951,7 +931,6 @@ uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVi
 
 > **Note**
 >
-
 > Currently, only the OpenGL texture scheme is supported(PC supports TRTCVideoBufferType_Buffer format Only)
 >
 
@@ -976,13 +955,10 @@ After you configure the callback of custom audio processing, the SDK will return
 
 > **Note**
 >
-
 > 1. Please avoid time-consuming operations in this callback function. The SDK processes an audio frame every 20 ms, so if your operation takes more than 20 ms, it will cause audio exceptions.
 >
-
 > 2. The audio data returned via this callback can be read and modified, but please keep the duration of your operation short.
 >
-
 > 3. The audio data is returned via this callback after ANS, AEC and AGC, but it **does not include** pre-processing effects like background music, audio effects, or reverb, and therefore has a short delay.
 >
 
@@ -999,11 +975,11 @@ After you configure the callback of custom audio processing, the SDK will return
 
 Instructions:
 
-You could write data to the ` TRTCAudioFrame.extraData ` filed, in order to achieve the purpose of transmitting signaling.
+You could write data to the  `TRTCAudioFrame.extraData`  filed, in order to achieve the purpose of transmitting signaling.
 
 Because the data block of the audio frame header cannot be too large, we recommend you limit the size of the signaling data to only a few bytes when using this API. If extra data more than 100 bytes, it won't be sent.
 
-Other users in the room can receive the message through the ` TRTCAudioFrame.extraData ` in ` onRemoteUserAudioFrame ` callback in TRTCAudioFrameDelegate.
+Other users in the room can receive the message through the  `TRTCAudioFrame.extraData`  in  `onRemoteUserAudioFrame`  callback in TRTCAudioFrameDelegate.
 
 |Param|DESC|
 |---------|---------|
@@ -1011,13 +987,10 @@ Other users in the room can receive the message through the ` TRTCAudioFrame.ext
 
 > **Note**
 >
-
 > 1. Please avoid time-consuming operations in this callback function. The SDK processes an audio frame every 20 ms, so if your operation takes more than 20 ms, it will cause audio exceptions.
 >
-
 > 2. The audio data returned via this callback can be read and modified, but please keep the duration of your operation short.
 >
-
 > 3. Audio data is returned via this callback after ANS, AEC, AGC, effect-processing and BGM-mixing, and therefore the delay is longer than that with onCapturedAudioFrame.
 >
 
@@ -1039,7 +1012,6 @@ After you configure the callback of custom audio processing, the SDK will return
 
 > **Note**
 >
-
 > The audio data returned via this callback can be read but not modified.
 >
 
@@ -1060,13 +1032,10 @@ After you configure the callback of custom audio processing, the SDK will return
 
 > **Note**
 >
-
 > 1. Please avoid time-consuming operations in this callback function. The SDK processes an audio frame every 20 ms, so if your operation takes more than 20 ms, it will cause audio exceptions.
 >
-
 > 2. The audio data returned via this callback can be read and modified, but please keep the duration of your operation short.
 >
-
 > 3. The audio data returned via this callback is the audio data mixed from each channel before it is played. It does not include the in-ear monitoring data.
 >
 
@@ -1087,10 +1056,8 @@ After you configure the callback of custom audio processing, the SDK will return
 
 > **Note**
 >
-
 > 1. This data returned via this callback is mixed from all audio in the SDK, including local audio after pre-processing (ANS, AEC, and AGC), special effects application, and music mixing, as well as all remote audio, but it does not include the in-ear monitoring data.
 >
-
 > 2. The audio data returned via this callback cannot be modified.
 >
 
@@ -1111,10 +1078,8 @@ After you configure the callback of custom audio processing, the SDK will return
 
 > **Note**
 >
-
 > 1. Please avoid time-consuming operations in this callback function, or it will cause audio exceptions.
 >
-
 > 2. The audio data returned via this callback can be read and modified, but please keep the duration of your operation short.
 >
 
@@ -1128,4 +1093,4 @@ If you want to capture the local log printing event, you can configure the log c
 |---------|---------|
 |level|Log level. For more information, please see TRTC_LOG_LEVEL.|
 |log|Log content|
-|module|Reserved field, which is not defined at the moment and has a fixed value of ` TXLiteAVSDK `.|
+|module|Reserved field, which is not defined at the moment and has a fixed value of  `TXLiteAVSDK` .|