@tencent-rtc/mcp 1.6.4 → 1.6.5

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

@@ -33,21 +33,21 @@ Function: the TRTC SDK reports to you the current real-time audio/video metrics
 | --- | --- |
 | audioBitrate | Field description: local audio bitrate (Kbps) |
 | audioBlockRate | Field description: audio playback lag rate (%)<br>Audio playback lag rate (audioBlockRate) = cumulative audio playback lag duration (audioTotalBlockTime)/total audio playback duration |
-| audioPacketLoss | Field description: total packet loss rate (%) of the audio stream<br><code> audioPacketLoss </code> represents the packet loss rate eventually calculated on the audience side after the audio/video stream goes through the complete transfer linkage of "anchor -> cloud -> audience".<br>The smaller the <code> audioPacketLoss </code>, the better. The packet loss rate of 0 indicates that all data of the audio stream has entirely reached the audience.<br>If <code> downLoss </code> is <code> 0 </code> but <code> audioPacketLoss </code> isn't, there is no packet loss on the linkage of "cloud -> audience" for the audiostream, but there are unrecoverable packet losses on the linkage of "anchor -> cloud". |
+| audioPacketLoss | Field description: total packet loss rate (%) of the audio stream<br><code>audioPacketLoss</code>  represents the packet loss rate eventually calculated on the audience side after the audio/video stream goes through the complete transfer linkage of "anchor -> cloud -> audience".<br>The smaller the  <code>audioPacketLoss</code> , the better. The packet loss rate of 0 indicates that all data of the audio stream has entirely reached the audience.<br>If  <code>downLoss</code>  is  <code>0</code>  but  <code>audioPacketLoss</code>  isn't, there is no packet loss on the linkage of "cloud -> audience" for the audiostream, but there are unrecoverable packet losses on the linkage of "anchor -> cloud". |
 | audioSampleRate | Field description: local audio sample rate (Hz) |
 | audioTotalBlockTime | Field description: cumulative audio playback lag duration (ms) |
 | finalLoss | Field description: total packet loss rate (%) of the audio/video stream<br>Deprecated, please use audioPacketLoss and videoPacketLoss instead. |
 | frameRate | Field description: remote video frame rate (fps) |
 | height | Field description: remote video height in px |
-| jitterBufferDelay | Field description: playback delay (ms)<br>In order to avoid audio/video lags caused by network jitters and network packet disorders, TRTC maintains a playback buffer on the playback side to organize the received network data packets.<br>The size of the buffer is adaptively adjusted according to the current network quality and converted to the length of time in milliseconds, i.e., <code> jitterBufferDelay </code>. |
-| point2PointDelay | Field description: end-to-end delay (ms)<br><code> point2PointDelay </code> represents the delay of "anchor -> cloud -> audience". To be more precise, it represents the delay of the entire linkage of "collection -> encoding -> network transfer -> receiving -> buffering -> decoding -> playback".<br><code> point2PointDelay </code> works only if both the local and remote SDKs are on version 8.5 or above. If the remote SDK is on a version below 8.5, this value will always be 0 and thus meaningless. |
-| remoteNetworkRTT | Field description: round-trip delay (ms) from the SDK to cloud<br>This value represents the total time it takes to send a network packet from the SDK to the cloud and then send a network packet back from the cloud to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> cloud -> SDK".<br>The smaller the value, the better. If <code> remoteNetworkRTT </code> is below 50 ms, it means a short audio/video call delay; if <code> remoteNetworkRTT </code> is above 200 ms, it means a long audio/video call delay.<br>It should be explained that <code> remoteNetworkRTT </code> represents the total time spent on the linkage of "SDK -> cloud -> SDK"; therefore, there is no need to distinguish between <code> remoteNetworkUpRTT </code> and <code> remoteNetworkDownRTT </code>. |
-| remoteNetworkUplinkLoss | Field description: upstream packet loss rate (%) from the SDK to cloud<br>The smaller the value, the better. If <code> remoteNetworkUplinkLoss </code> is <code> 0% </code>, the upstream network quality is very good, and the data packets uploaded to the cloud are basically not lost.<br>If <code> remoteNetworkUplinkLoss </code> is <code> 30% </code>, 30% of the audio/video data packets sent to the cloud by the SDK are lost on the transfer linkage. |
+| jitterBufferDelay | Field description: playback delay (ms)<br>In order to avoid audio/video lags caused by network jitters and network packet disorders, TRTC maintains a playback buffer on the playback side to organize the received network data packets.<br>The size of the buffer is adaptively adjusted according to the current network quality and converted to the length of time in milliseconds, i.e.,  <code>jitterBufferDelay</code> . |
+| point2PointDelay | Field description: end-to-end delay (ms)<br><code>point2PointDelay</code>  represents the delay of "anchor -> cloud -> audience". To be more precise, it represents the delay of the entire linkage of "collection -> encoding -> network transfer -> receiving -> buffering -> decoding -> playback".<br><code>point2PointDelay</code>  works only if both the local and remote SDKs are on version 8.5 or above. If the remote SDK is on a version below 8.5, this value will always be 0 and thus meaningless. |
+| remoteNetworkRTT | Field description: round-trip delay (ms) from the SDK to cloud<br>This value represents the total time it takes to send a network packet from the SDK to the cloud and then send a network packet back from the cloud to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> cloud -> SDK".<br>The smaller the value, the better. If  <code>remoteNetworkRTT</code>  is below 50 ms, it means a short audio/video call delay; if  <code>remoteNetworkRTT</code>  is above 200 ms, it means a long audio/video call delay.<br>It should be explained that  <code>remoteNetworkRTT</code>  represents the total time spent on the linkage of "SDK -> cloud -> SDK"; therefore, there is no need to distinguish between  <code>remoteNetworkUpRTT</code>  and  <code>remoteNetworkDownRTT</code> . |
+| remoteNetworkUplinkLoss | Field description: upstream packet loss rate (%) from the SDK to cloud<br>The smaller the value, the better. If  <code>remoteNetworkUplinkLoss</code>  is  <code>0%</code> , the upstream network quality is very good, and the data packets uploaded to the cloud are basically not lost.<br>If  <code>remoteNetworkUplinkLoss</code>  is  <code>30%</code> , 30% of the audio/video data packets sent to the cloud by the SDK are lost on the transfer linkage. |
 | streamType | Field description: video stream type (HD big image \\| smooth small image \\| substream image) |
 | userId | Field description: user ID |
 | videoBitrate | Field description: remote video bitrate (Kbps) |
 | videoBlockRate | Field description: video playback lag rate (%)<br>Video playback lag rate (videoBlockRate) = cumulative video playback lag duration (videoTotalBlockTime)/total video playback duration |
-| videoPacketLoss | Field description: total packet loss rate (%) of the video stream<br><code> videoPacketLoss </code> represents the packet loss rate eventually calculated on the audience side after the audio/video stream goes through the complete transfer linkage of "anchor -> cloud -> audience".<br>The smaller the <code> videoPacketLoss </code>, the better. The packet loss rate of 0 indicates that all data of the video stream has entirely reached the audience.<br>If <code> downLoss </code> is <code> 0 </code> but <code> videoPacketLoss </code> isn't, there is no packet loss on the linkage of "cloud -> audience" for the video stream, but there are unrecoverable packet losses on the linkage of "anchor -> cloud". |
+| videoPacketLoss | Field description: total packet loss rate (%) of the video stream<br><code>videoPacketLoss</code>  represents the packet loss rate eventually calculated on the audience side after the audio/video stream goes through the complete transfer linkage of "anchor -> cloud -> audience".<br>The smaller the  <code>videoPacketLoss</code> , the better. The packet loss rate of 0 indicates that all data of the video stream has entirely reached the audience.<br>If  <code>downLoss</code>  is  <code>0</code>  but  <code>videoPacketLoss</code>  isn't, there is no packet loss on the linkage of "cloud -> audience" for the video stream, but there are unrecoverable packet losses on the linkage of "anchor -> cloud". |
 | videoTotalBlockTime | Field description: cumulative video playback lag duration (ms) |
 | width | Field description: remote video width in px |
 
@@ -57,12 +57,12 @@ Function: the TRTC SDK reports to you the current real-time audio/video metrics
 | EnumType | DESC |
 | --- | --- |
 | appCpu | Field description: CPU utilization (%) of the current application, Android 8.0 and above systems are not supported |
-| downLoss | Field description: downstream packet loss rate (%) from cloud to the SDK<br>The smaller the value, the better. If <code> downLoss </code> is <code> 0% </code>, the downstream network quality is very good, and the data packets received from the cloud are basically not lost.<br>If <code> downLoss </code> is <code> 30% </code>, 30% of the audio/video data packets sent to the SDK by the cloud are lost on the transfer linkage. |
-| gatewayRtt | Field description: round-trip delay (ms) from the SDK to gateway<br>This value represents the total time it takes to send a network packet from the SDK to the gateway and then send a network packet back from the gateway to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> gateway -> SDK".<br>The smaller the value, the better. If <code> gatewayRtt </code> is below 50 ms, it means a short audio/video call delay; if <code> gatewayRtt </code> is above 200 ms, it means a long audio/video call delay.<br>It should be explained that <code> gatewayRtt </code> is invalid for cellular network. |
+| downLoss | Field description: downstream packet loss rate (%) from cloud to the SDK<br>The smaller the value, the better. If  <code>downLoss</code>  is  <code>0%</code> , the downstream network quality is very good, and the data packets received from the cloud are basically not lost.<br>If  <code>downLoss</code>  is  <code>30%</code> , 30% of the audio/video data packets sent to the SDK by the cloud are lost on the transfer linkage. |
+| gatewayRtt | Field description: round-trip delay (ms) from the SDK to gateway<br>This value represents the total time it takes to send a network packet from the SDK to the gateway and then send a network packet back from the gateway to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> gateway -> SDK".<br>The smaller the value, the better. If  <code>gatewayRtt</code>  is below 50 ms, it means a short audio/video call delay; if  <code>gatewayRtt</code>  is above 200 ms, it means a long audio/video call delay.<br>It should be explained that  <code>gatewayRtt</code>  is invalid for cellular network. |
 | localStatistics | Field description: local audio/video statistics<br>As there may be three local audio/video streams (i.e., HD big image, smooth small image, and substream image), the local audio/video statistics are an array. |
 | receivedBytes | Field description: total number of received bytes (including signaling data and audio/video data) |
 | remoteStatistics | Field description: remote audio/video statistics<br>As there may be multiple concurrent remote users, and each of them may have multiple concurrent audio/video streams (i.e., HD big image, smooth small image, and substream image), the remote audio/video statistics are an array. |
-| rtt | Field description: round-trip delay (ms) from the SDK to cloud<br>This value represents the total time it takes to send a network packet from the SDK to the cloud and then send a network packet back from the cloud to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> cloud -> SDK".<br>The smaller the value, the better. If <code> rtt </code> is below 50 ms, it means a short audio/video call delay; if <code> rtt </code> is above 200 ms, it means a long audio/video call delay.<br>It should be explained that <code> rtt </code> represents the total time spent on the linkage of "SDK -> cloud -> SDK"; therefore, there is no need to distinguish between <code> upRtt </code> and <code> downRtt </code>. |
+| rtt | Field description: round-trip delay (ms) from the SDK to cloud<br>This value represents the total time it takes to send a network packet from the SDK to the cloud and then send a network packet back from the cloud to the SDK, i.e., the total time it takes for a network packet to go through the linkage of "SDK -> cloud -> SDK".<br>The smaller the value, the better. If  <code>rtt</code>  is below 50 ms, it means a short audio/video call delay; if  <code>rtt</code>  is above 200 ms, it means a long audio/video call delay.<br>It should be explained that  <code>rtt</code>  represents the total time spent on the linkage of "SDK -> cloud -> SDK"; therefore, there is no need to distinguish between  <code>upRtt</code>  and  <code>downRtt</code> . |
 | sentBytes | Field description: total number of sent bytes (including signaling data and audio/video data) |
 | systemCpu | Field description: CPU utilization (%) of the current system, Android 8.0 and above systems are not supported |
-| upLoss | Field description: upstream packet loss rate (%) from the SDK to cloud<br>The smaller the value, the better. If <code> upLoss </code> is <code> 0% </code>, the upstream network quality is very good, and the data packets uploaded to the cloud are basically not lost.<br>If <code> upLoss </code> is <code> 30% </code>, 30% of the audio/video data packets sent to the cloud by the SDK are lost on the transfer linkage. |
+| upLoss | Field description: upstream packet loss rate (%) from the SDK to cloud<br>The smaller the value, the better. If  <code>upLoss</code>  is  <code>0%</code> , the upstream network quality is very good, and the data packets uploaded to the cloud are basically not lost.<br>If  <code>upLoss</code>  is  <code>30%</code> , 30% of the audio/video data packets sent to the cloud by the SDK are lost on the transfer linkage. |

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

@@ -56,11 +56,10 @@ Given that not all phones deliver excellent in-ear monitoring effects, we have b
 
 |Param|DESC|
 |---------|---------|
-|enable|` YES: ` enable; ` NO `: disable|
+|enable| `YES:`  enable;  `NO` : disable|
 
 > **Note**
 >
-
 > In-ear monitoring can be enabled only when earphones are used. Please remind anchors to use wired earphones.
 >
 
@@ -76,7 +75,6 @@ This API is used to set the volume of in-ear monitoring.
 
 > **Note**
 >
-
 > The volume of the ear monitor is one of the most important factors affecting the user experience. Considering that different users have different sensitivities to volume, it is strongly recommended to provide a ear monitor volume adjustment slider on the UI interface. The recommended adjustment range is between 0 and 150. The gain effect of 100-150 is very helpful for some Android phones with low recording volume.
 >
 
@@ -88,7 +86,6 @@ This API is used to set reverb effects for human voice. For the effects supporte
 
 > **Note**
 >
-
 > Effects become invalid after room exit. If you want to use the same effect after you enter the room again, you need to set the effect again using this API.
 >
 
@@ -100,7 +97,6 @@ This API is used to set voice changing effects. For the effects supported, pleas
 
 > **Note**
 >
-
 > Effects become invalid after room exit. If you want to use the same effect after you enter the room again, you need to set the effect again using this API.
 >
 
@@ -116,7 +112,6 @@ This API is used to set the volume of speech. It is often used together with the
 
 > **Note**
 >
-
 > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
 >
 
@@ -145,13 +140,10 @@ You must assign an ID to each music track so that you can start, stop, or set th
 
 > **Note**
 >
-
 > 1. If you play the same music track multiple times, please use the same ID instead of a separate ID for each playback.
 >
-
 > 2. If you want to play different music tracks at the same time, use different IDs for them.
 >
-
 > 3. If you use the same ID to play a music track different from the current one, the SDK will stop the current one before playing the new one.
 >
 
@@ -194,7 +186,6 @@ This API is used to set the local and remote playback volume of background music
 
 > **Note**
 >
-
 > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
 >
 
@@ -211,7 +202,6 @@ This API is used to control the remote playback volume (the volume heard by audi
 
 > **Note**
 >
-
 > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
 >
 
@@ -228,7 +218,6 @@ This API is used to control the local playback volume (the volume heard by ancho
 
 > **Note**
 >
-
 > If 100 is still not loud enough for you, you can set the volume to up to 150, but there may be side effects.
 >
 
@@ -283,13 +272,10 @@ The length of the specified music file is returned. -1 indicates failure to get
 
 > **Note**
 >
-
 > Do not call this API frequently as the music file may be read and written to each time the API is called, which can be time-consuming.
 >
-
 > Wait till users finish dragging the progress bar before you call this API.
 >
-
 > The progress bar controller on the UI tends to update the progress at a high frequency as users drag the progress bar. This will result in poor user experience unless you limit the frequency.
 >
 
@@ -304,7 +290,6 @@ The length of the specified music file is returned. -1 indicates failure to get
 
 > **Note**
 >
-
 > Precondition preloadMusic succeeds.
 >
 
@@ -320,14 +305,11 @@ You must assign an ID to each music track so that you can start, stop, or set th
 
 > **Note**
 >
-
 > 1. Preload supports up to 2 preloads with different IDs at the same time, and the preload time does not exceed 10 minutes,you need to call stopPlayMusic API after use, otherwise the memory will not be released.
 >
-
 > 2. If the music corresponding to the ID is being played, the preloading fails, and stopPlayMusic must be called first.
 >
-
-> 3. When the ` musicParam ` passed to startPlayMusic is exactly the same, preloading works.
+> 3. When the  `musicParam`  passed to startPlayMusic is exactly the same, preloading works.
 >
 
 ## getMusicTrackCount:
@@ -349,7 +331,6 @@ You must assign an ID to each music track so that you can start, stop, or set th
 
 > **Note**
 >
-
 > The total number of tracks can be obtained through the [getMusicTrackCount interface.
 >
 
@@ -414,10 +395,10 @@ The information, including playback ID, file path, and loop times, is passed in
 3. If you use the same ID to play a music track different from the current one, the SDK will stop the current one before playing the new one.
 | EnumType | DESC |
 | --- | --- |
-| ID | <code> Field description: </code> music ID<br><strong>Note</strong><br>the SDK supports playing multiple music tracks. IDs are used to distinguish different music tracks and control their start, end, volume, etc. |
-| endTimeMS | <code> Field description: </code> the point in time in milliseconds for ending music playback. 0 indicates that playback continues till the end of the music track. |
-| isShortFile | <code> Field description: </code> whether the music played is a short music track<br><code> Valid values: </code><code> YES </code>: short music track that needs to be looped; <code> NO </code> (default): normal-length music track |
-| loopCount | <code> Field description: </code> number of times the music track is looped<br><code> Valid values: </code>0 or any positive integer. 0 (default) indicates that the music is played once, 1 twice, and so on. |
-| path | <code> Field description: </code> absolute path of the music file or url.the mp3,aac,m4a,wav supported. |
-| publish | <code> Field description: </code> whether to send the music to remote users<br><code> Valid values: </code><code> YES </code> (default): remote users can hear the music played locally; <code> NO </code>: only the local user can hear the music. |
-| startTimeMS | <code> Field description: </code> the point in time in milliseconds for starting music playback |
+| ID | <code>Field description:</code>  music ID<br><strong>Note</strong><br>the SDK supports playing multiple music tracks. IDs are used to distinguish different music tracks and control their start, end, volume, etc. |
+| endTimeMS | <code>Field description:</code>  the point in time in milliseconds for ending music playback. 0 indicates that playback continues till the end of the music track. |
+| isShortFile | <code>Field description:</code>  whether the music played is a short music track<br><code>Valid values:</code>  <code>YES</code> : short music track that needs to be looped;  <code>NO</code>  (default): normal-length music track |
+| loopCount | <code>Field description:</code>  number of times the music track is looped<br><code>Valid values:</code> 0 or any positive integer. 0 (default) indicates that the music is played once, 1 twice, and so on. |
+| path | <code>Field description:</code>  absolute path of the music file or url.the mp3,aac,m4a,wav supported. |
+| publish | <code>Field description:</code>  whether to send the music to remote users<br><code>Valid values:</code>  <code>YES</code>  (default): remote users can hear the music played locally;  <code>NO</code> : only the local user can hear the music. |
+| startTimeMS | <code>Field description:</code>  the point in time in milliseconds for starting music playback |

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

@@ -53,7 +53,7 @@ TRTC has multiple built-in skin smoothing algorithms. You can select the one mos
 
 |Param|DESC|
 |---------|---------|
-|beautyStyle|Beauty filter style. ` TXBeautyStyleSmooth `: smooth; ` TXBeautyStyleNature `: natural; ` TXBeautyStylePitu `: Pitu|
+|beautyStyle|Beauty filter style.  `TXBeautyStyleSmooth` : smooth;  `TXBeautyStyleNature` : natural;  `TXBeautyStylePitu` : Pitu|
 
 ## setBeautyLevel:
 
@@ -61,7 +61,7 @@ TRTC has multiple built-in skin smoothing algorithms. You can select the one mos
 
 |Param|DESC|
 |---------|---------|
-|beautyLevel|Strength of the beauty filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|beautyLevel|Strength of the beauty filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 
 ## setWhitenessLevel:
 
@@ -69,7 +69,7 @@ TRTC has multiple built-in skin smoothing algorithms. You can select the one mos
 
 |Param|DESC|
 |---------|---------|
-|whitenessLevel|Strength of the brightening filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|whitenessLevel|Strength of the brightening filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 
 ## enableSharpnessEnhancement:
 
@@ -81,7 +81,7 @@ TRTC has multiple built-in skin smoothing algorithms. You can select the one mos
 
 |Param|DESC|
 |---------|---------|
-|ruddyLevel|Strength of the rosy skin filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|ruddyLevel|Strength of the rosy skin filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 
 ## setFilter:
 
@@ -130,7 +130,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|eyeScaleLevel|Strength of the eye enlarging filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|eyeScaleLevel|Strength of the eye enlarging filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -143,7 +143,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|faceSlimLevel|Strength of the face slimming filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|faceSlimLevel|Strength of the face slimming filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -156,7 +156,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|faceVLevel|Strength of the chin slimming filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|faceVLevel|Strength of the chin slimming filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -169,7 +169,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|chinLevel|Strength of the chin lengthening/shortening filter. Value range: [-9, 9]. ` 0 ` indicates to disable the filter, a value smaller than 0 indicates that the chin is shortened, and a value greater than 0 indicates that the chin is lengthened.|
+|chinLevel|Strength of the chin lengthening/shortening filter. Value range: [-9, 9].  `0`  indicates to disable the filter, a value smaller than 0 indicates that the chin is shortened, and a value greater than 0 indicates that the chin is lengthened.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -182,7 +182,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|faceShortLevel|Strength of the face shortening filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|faceShortLevel|Strength of the face shortening filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -195,7 +195,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|level|Strength of the face narrowing filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|level|Strength of the face narrowing filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -208,7 +208,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|noseSlimLevel|Strength of the nose slimming filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|noseSlimLevel|Strength of the nose slimming filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -221,7 +221,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|eyeLightenLevel|Strength of the eye brightening filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|eyeLightenLevel|Strength of the eye brightening filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -234,7 +234,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|toothWhitenLevel|Strength of the teeth whitening filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|toothWhitenLevel|Strength of the teeth whitening filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -247,7 +247,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|wrinkleRemoveLevel|Strength of the wrinkle removal filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|wrinkleRemoveLevel|Strength of the wrinkle removal filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -260,7 +260,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|pounchRemoveLevel|Strength of the eye bag removal filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|pounchRemoveLevel|Strength of the eye bag removal filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -273,7 +273,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|smileLinesRemoveLevel|Strength of the smile line removal filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|smileLinesRemoveLevel|Strength of the smile line removal filter. Value range: [0, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -286,7 +286,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|foreheadLevel|Strength of the hairline adjustment filter. Value range: [-9, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|foreheadLevel|Strength of the hairline adjustment filter. Value range: [-9, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -299,7 +299,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|eyeDistanceLevel|Strength of the eye distance adjustment filter. Value range: [-9, 9]. ` 0 ` indicates to disable the filter, a value smaller than 0 indicates to widen, and a value greater than 0 indicates to narrow.|
+|eyeDistanceLevel|Strength of the eye distance adjustment filter. Value range: [-9, 9].  `0`  indicates to disable the filter, a value smaller than 0 indicates to widen, and a value greater than 0 indicates to narrow.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -312,7 +312,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|eyeAngleLevel|Strength of the eye corner adjustment filter. Value range: [-9, 9]. ` 0 ` indicates to disable the filter, and ` 9 ` indicates the most obvious effect.|
+|eyeAngleLevel|Strength of the eye corner adjustment filter. Value range: [-9, 9].  `0`  indicates to disable the filter, and  `9`  indicates the most obvious effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -325,7 +325,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|mouthShapeLevel|Strength of the mouth shape adjustment filter. Value range: [-9, 9]. ` 0 ` indicates to disable the filter, a value smaller than 0 indicates to widen, and a value greater than 0 indicates to narrow.|
+|mouthShapeLevel|Strength of the mouth shape adjustment filter. Value range: [-9, 9].  `0`  indicates to disable the filter, a value smaller than 0 indicates to widen, and a value greater than 0 indicates to narrow.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -338,7 +338,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|noseWingLevel|Strength of the nose wing adjustment filter. Value range: [-9, 9]. ` 0 ` indicates to disable the filter, a value smaller than 0 indicates to widen, and a value greater than 0 indicates to narrow.|
+|noseWingLevel|Strength of the nose wing adjustment filter. Value range: [-9, 9].  `0`  indicates to disable the filter, a value smaller than 0 indicates to widen, and a value greater than 0 indicates to narrow.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -351,7 +351,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|nosePositionLevel|Strength of the nose position adjustment filter. Value range: [-9, 9]. ` 0 ` indicates to disable the filter, a value smaller than 0 indicates to lift, and a value greater than 0 indicates to lower.|
+|nosePositionLevel|Strength of the nose position adjustment filter. Value range: [-9, 9].  `0`  indicates to disable the filter, a value smaller than 0 indicates to lift, and a value greater than 0 indicates to lower.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -364,7 +364,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|lipsThicknessLevel|Strength of the lip thickness adjustment filter. Value range: [-9, 9]. ` 0 ` indicates to disable the filter, a value smaller than 0 indicates to thicken, and a value greater than 0 indicates to thin.|
+|lipsThicknessLevel|Strength of the lip thickness adjustment filter. Value range: [-9, 9].  `0`  indicates to disable the filter, a value smaller than 0 indicates to thicken, and a value greater than 0 indicates to thin.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -377,7 +377,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|faceBeautyLevel|Strength of the face shape adjustment filter. Value range: [0, 9]. ` 0 ` indicates to disable the filter, and the greater the value, the more obvious the effect.|
+|faceBeautyLevel|Strength of the face shape adjustment filter. Value range: [0, 9].  `0`  indicates to disable the filter, and the greater the value, the more obvious the effect.|
 **Return Desc:**
 
 0: Success; -5: feature of license not supported.
@@ -401,7 +401,7 @@ This interface is only available in the enterprise version SDK (the old version
 
 |Param|DESC|
 |---------|---------|
-|motionMute|` YES `: mute; ` NO `: unmute|
+|motionMute| `YES` : mute;  `NO` : unmute|
 
 ## TXBeautyStyle
 

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

@@ -71,7 +71,7 @@ The SDK returns this callback when a local device (camera, mic, or speaker) is c
 |Param|DESC|
 |---------|---------|
 |deviceId|Device ID|
-|state|Device status. ` 0 `: connected; ` 1 `: disconnected; ` 2 `: started|
+|state|Device status.  `0` : connected;  `1` : disconnected;  `2` : started|
 |type|Device type|
 
 ## isFrontCamera
@@ -126,9 +126,9 @@ This API can be used to achieve the following:
 
 > **Note**
 >
-
 > Before using this API, you must first disable auto focus using enableCameraAutoFocus.
 >
+
 **Return Desc:**
 
 0: operation successful; negative number: operation failed.
@@ -165,9 +165,9 @@ If the audio route is set to the speaker, the volume is relatively high, and the
 
 > **Note**
 >
-> -  To ensure that the SDK can manage the lifecycle of the ` ITXDeviceCollection ` object, after using this API, please call the ` release ` method to release the resources.
-> -  Do not use ` delete ` to release the Collection object returned as deleting the ITXDeviceCollection* pointer will cause crash.
-> -  The valid values of ` type ` are ` TXMediaDeviceTypeMic `, ` TXMediaDeviceTypeSpeaker `, and ` TXMediaDeviceTypeCamera `.
+> -  To ensure that the SDK can manage the lifecycle of the  `ITXDeviceCollection`  object, after using this API, please call the  `release`  method to release the resources.
+> -  Do not use  `delete`  to release the Collection object returned as deleting the ITXDeviceCollection* pointer will cause crash.
+> -  The valid values of  `type`  are  `TXMediaDeviceTypeMic` ,  `TXMediaDeviceTypeSpeaker` , and  `TXMediaDeviceTypeCamera` .
 > -  This API can be used only on macOS and Windows.
 
 ## setCurrentDevice:deviceId:
@@ -177,7 +177,7 @@ If the audio route is set to the speaker, the volume is relatively high, and the
 |Param|DESC|
 |---------|---------|
 |deviceId|Device ID. You can get the ID of a device using the getDevicesList API.|
-|type|Device type. For details, please see the definition of ` TXMediaDeviceType `.|
+|type|Device type. For details, please see the definition of  `TXMediaDeviceType` .|
 **Return Desc:**
 
 0: operation successful; negative number: operation failed.
@@ -222,7 +222,7 @@ This API is used to set the microphone and speaker types. Camera following the s
 | Param | DESC |
 | --- | --- |
 | enable | Whether to follow the system default audio device.<br>-  true: following. When the default audio device of the system is changed or new audio device is plugged in, the SDK immediately switches the audio device.<br>-  false：not following. When the default audio device of the system is changed or new audio device is plugged in, the SDK doesn't switch the audio device. |
-| type | Device type. For details, please see the definition of <code> TXMediaDeviceType </code>. |
+| type | Device type. For details, please see the definition of  <code>TXMediaDeviceType</code> . |
 
 ## startCameraDeviceTest:
 
@@ -230,7 +230,6 @@ This API is used to set the microphone and speaker types. Camera following the s
 
 > **Note**
 >
-
 > You can use the setCurrentDevice API to switch between cameras during testing.
 >
 
@@ -250,7 +249,6 @@ This API is used to test whether the mic functions properly. The mic volume dete
 
 > **Note**
 >
-
 > When this interface is called, the sound recorded by the microphone will be played back to the speakers by default.
 >
 
@@ -263,7 +261,7 @@ This API is used to test whether the mic functions properly. The mic volume dete
 |Param|DESC|
 |---------|---------|
 |interval|Interval of volume callbacks, in milliseconds.|
-|playback|Whether to play back the microphone sound. The user will hear his own sound when testing the microphone if ` playback ` is true.|
+|playback|Whether to play back the microphone sound. The user will hear his own sound when testing the microphone if  `playback`  is true.|
 
 ## stopMicDeviceTest
 
@@ -295,7 +293,7 @@ This API is used to test whether the audio playback device functions properly by
 
 **Setting the system volume type (for mobile OS).**
 
-@deprecated This API is not recommended after v9.5. Please use the ` startLocalAudio(quality) ` API in ` TRTCCloud ` instead, which param ` quality ` is used to decide audio quality.
+@deprecated This API is not recommended after v9.5. Please use the  `startLocalAudio(quality)`  API in  `TRTCCloud`  instead, which param  `quality`  is used to decide audio quality.
 
 ## TXSystemVolumeType(Deprecated)
 

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

@@ -48,18 +48,18 @@
 | ERR_UNSUPPORTED_SAMPLERATE | -1306 | Unsupported audio sample rate. |
 | ERR_SYSTEM_LOOPBACK_START_FAILED | -1307 | System audio loopback startup encountered an error. Common error reasons and solutions are: 1. The current system version does not support the include or excluded specified process loopback function, which requires Windows system version 10.0.19042 (20H2) or higher. For x64 specified path loopback function, it also requires Windows system version 10.0.19042 (20H2) or higher. Please check the current system version. 2. Invalid input parameters (including empty parameters, non-existent input paths, non-existent process IDs, and non-existent device names). Please check whether the input parameters are legal. 3. No available speaker device, please check whether it is available. |
 | ERR_SYSTEM_LOOPBACK_THIRD_PARTY_APP_EXIT | -1324 | The third party app loopback capture encountered an error. This error occurred after the third party app loopback was successfully started. During the sound collection process, the specified process or application unexpectedly exited. Please check the status of the specified process or application and try again by re-entering the process number |
-| ERR_TRTC_ENTER_ROOM_FAILED | -3301 | Failed to enter the room. For the reason, refer to the error message for -3301 in <code> onError </code>. |
+| ERR_TRTC_ENTER_ROOM_FAILED | -3301 | Failed to enter the room. For the reason, refer to the error message for -3301 in  <code>onError</code> . |
 | ERR_TRTC_REQUEST_IP_TIMEOUT | -3307 | IP and signature request timed out. Check your network connection and whether your firewall allows UDP.<br>Try visiting the IP address 162.14.22.165:8000 or 162.14.6.105:8000 and the domain default-query.trtc.tencent-cloud.com:8000. |
 | ERR_TRTC_CONNECT_SERVER_TIMEOUT | -3308 | Room entry request timed out. Check your network connection and whether VPN is used. You can also switch to 4G to run a test. |
-| ERR_TRTC_ROOM_PARAM_NULL | -3316 | Empty room entry parameters. Please check whether valid parameters were passed in to the <code> enterRoom:appScene: </code> API. |
-| ERR_TRTC_INVALID_SDK_APPID | -3317 | Incorrect room entry parameter. Check whether <code> TRTCParams.sdkAppId </code> is empty. |
-| ERR_TRTC_INVALID_ROOM_ID | -3318 | Incorrect room entry parameter. Check whether <code> TRTCParams.roomId </code> or <code> TRTCParams.strRoomId </code> is empty. Note that you cannot set both parameters. |
-| ERR_TRTC_INVALID_USER_ID | -3319 | Incorrect room entry parameter. Check whether <code> TRTCParams.userId </code> is empty. |
-| ERR_TRTC_INVALID_USER_SIG | -3320 | Incorrect room entry parameter. Check whether <code> TRTCParams.userSig </code> is empty. |
-| ERR_TRTC_ENTER_ROOM_REFUSED | -3340 | Request to enter room denied. Check whether you called <code> enterRoom </code> twice to enter the same room. |
-| ERR_TRTC_INVALID_PRIVATE_MAPKEY | -100006 | Advanced permission control is enabled but failed to verify <code> TRTCParams.privateMapKey </code>.<br>For details, see <a href="https://intl.cloud.tencent.com/document/product/647/35157">Enabling Advanced Permission Control</a>. |
+| ERR_TRTC_ROOM_PARAM_NULL | -3316 | Empty room entry parameters. Please check whether valid parameters were passed in to the  <code>enterRoom:appScene:</code>  API. |
+| ERR_TRTC_INVALID_SDK_APPID | -3317 | Incorrect room entry parameter. Check whether  <code>TRTCParams.sdkAppId</code>  is empty. |
+| ERR_TRTC_INVALID_ROOM_ID | -3318 | Incorrect room entry parameter. Check whether  <code>TRTCParams.roomId</code>  or  <code>TRTCParams.strRoomId</code>  is empty. Note that you cannot set both parameters. |
+| ERR_TRTC_INVALID_USER_ID | -3319 | Incorrect room entry parameter. Check whether  <code>TRTCParams.userId</code>  is empty. |
+| ERR_TRTC_INVALID_USER_SIG | -3320 | Incorrect room entry parameter. Check whether  <code>TRTCParams.userSig</code>  is empty. |
+| ERR_TRTC_ENTER_ROOM_REFUSED | -3340 | Request to enter room denied. Check whether you called  <code>enterRoom</code>  twice to enter the same room. |
+| ERR_TRTC_INVALID_PRIVATE_MAPKEY | -100006 | Advanced permission control is enabled but failed to verify  <code>TRTCParams.privateMapKey</code> .<br>For details, see <a href="https://intl.cloud.tencent.com/document/product/647/35157">Enabling Advanced Permission Control</a>. |
 | ERR_TRTC_SERVICE_SUSPENDED | -100013 | The service is unavailable. Check if you have used up your package or whether your Tencent Cloud account has overdue payments. |
-| ERR_TRTC_USER_SIG_CHECK_FAILED | -100018 | Failed to verify <code> UserSig </code>. Check whether <code> TRTCParams.userSig </code> is correct or valid.<br>For details, see <a href="https://intl.cloud.tencent.com/document/product/647/39074">UserSig Generation and Verification</a>. |
+| ERR_TRTC_USER_SIG_CHECK_FAILED | -100018 | Failed to verify  <code>UserSig</code> . Check whether  <code>TRTCParams.userSig</code>  is correct or valid.<br>For details, see <a href="https://intl.cloud.tencent.com/document/product/647/39074">UserSig Generation and Verification</a>. |
 | ERR_TRTC_PUSH_THIRD_PARTY_CLOUD_TIMEOUT | -3321 | The relay to CDN request timed out |
 | ERR_TRTC_MIX_TRANSCODING_TIMEOUT | -3322 | The On-Cloud MixTranscoding request timed out. |
 | ERR_TRTC_PUSH_THIRD_PARTY_CLOUD_FAILED | -3323 | Abnormal response packets for relay. |
@@ -71,7 +71,7 @@
 | ERR_TRTC_CONNECT_OTHER_ROOM_TIMEOUT | -3326 | The co-anchoring request timed out. |
 | ERR_TRTC_DISCONNECT_OTHER_ROOM_TIMEOUT | -3327 | The request to stop co-anchoring timed out. |
 | ERR_TRTC_CONNECT_OTHER_ROOM_INVALID_PARAMETER | -3328 | Invalid parameter. |
-| ERR_TRTC_CONNECT_OTHER_ROOM_AS_AUDIENCE | -3330 | The current user is an audience member and cannot request or stop cross-room communication. Please call <code> switchRole </code> to switch to an anchor first. |
+| ERR_TRTC_CONNECT_OTHER_ROOM_AS_AUDIENCE | -3330 | The current user is an audience member and cannot request or stop cross-room communication. Please call  <code>switchRole</code>  to switch to an anchor first. |
 | ERR_BGM_OPEN_FAILED | -4001 | Failed to open the file, such as invalid data found when processing input, ffmpeg protocol not found, etc. |
 | ERR_BGM_DECODE_FAILED | -4002 | Audio file decoding failed. |
 | ERR_BGM_OVER_LIMIT | -4003 | The number exceeds the limit, such as preloading two background music at the same time. |
@@ -88,7 +88,7 @@
 | Enum | Value | DESC |
 | --- | --- | --- |
 | WARNING_HW_ENCODER_START_FAIL | 1103 | Failed to start the hardware encoder. Switched to software encoding. |
-| WARNING_CURRENT_ENCODE_TYPE_CHANGED | 1104 | The codec changed.<br>The additional field <code> type </code> in <code> onWarning </code> indicates the codec currently in use. <code> 0 </code> indicates H.264, and <code> 1 </code> indicates H.265.<br>The additional field <code> hardware </code> in <code> onWarning </code> indicates the encoder type currently in use. <code> 0 </code> indicates software encoder, and <code> 1 </code> indicates hardware encoder.<br>The additional field <code> stream </code> in <code> onWarning </code> indicates the stream type currently in use. <code> 0 </code> indicates big stream, and <code> 1 </code> indicates small stream, and <code> 2 </code> indicates sub stream. |
+| WARNING_CURRENT_ENCODE_TYPE_CHANGED | 1104 | The codec changed.<br>The additional field  <code>type</code>  in  <code>onWarning</code>  indicates the codec currently in use.  <code>0</code>  indicates H.264, and  <code>1</code>  indicates H.265.<br>The additional field  <code>hardware</code>  in  <code>onWarning</code>  indicates the encoder type currently in use.  <code>0</code>  indicates software encoder, and  <code>1</code>  indicates hardware encoder.<br>The additional field  <code>stream</code>  in  <code>onWarning</code>  indicates the stream type currently in use.  <code>0</code>  indicates big stream, and  <code>1</code>  indicates small stream, and  <code>2</code>  indicates sub stream. |
 | WARNING_VIDEO_ENCODER_SW_TO_HW | 1107 | Insufficient CPU for software encoding. Switched to hardware encoding. |
 | WARNING_INSUFFICIENT_CAPTURE_FPS | 1108 | The capturing frame rate of the camera is insufficient. This error occurs on some Android phones with built-in beauty filters. |
 | WARNING_SW_ENCODER_START_FAIL | 1109 | Failed to start the software encoder. |
@@ -102,7 +102,7 @@
 | WARNING_CAMERA_START_FAILED | 1117 | The camera is started failed. |
 | WARNING_CAMERA_SERVER_DIED | 1118 | The camera sever is died. |
 | WARNING_SCREEN_CAPTURE_NOT_AUTHORIZED | 1206 | The user didn’t grant the application screen recording permission. |
-| WARNING_CURRENT_DECODE_TYPE_CHANGED | 2008 | The codec changed. The additional field <code> type </code> in <code> onWarning </code> indicates the codec currently in use. <code> 1 </code> indicates H.265, and <code> 0 </code> indicates H.264. This field is not supported on Windows. |
+| WARNING_CURRENT_DECODE_TYPE_CHANGED | 2008 | The codec changed. The additional field  <code>type</code>  in  <code>onWarning</code>  indicates the codec currently in use.  <code>1</code>  indicates H.265, and  <code>0</code>  indicates H.264. This field is not supported on Windows. |
 | WARNING_VIDEO_FRAME_DECODE_FAIL | 2101 | Failed to decode the current video frame. |
 | WARNING_HW_DECODER_START_FAIL | 2106 | Failed to start the hardware decoder. The software decoder is used instead. |
 | WARNING_VIDEO_DECODER_HW_TO_SW | 2108 | The hardware decoder failed to decode the first I-frame of the current stream. The SDK automatically switched to the software decoder. |