@tencent-rtc/mcp 1.6.7 → 1.7.0

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

@@ -132,7 +132,6 @@ Version: 13.4
 **Create TRTCCloud instance (singleton mode).**
 
 > **Note**
->
 > 1. Please use destroySharedInstance to release the object pointer.
 >
 
@@ -159,7 +158,6 @@ If you do not specify a  `delegateQueue` , the SDK will use  `MainQueue`  as the
 In other words, if you do not set the  `delegateQueue`  attribute, all callback functions in TRTCCloudDelegate will be driven by  `MainQueue` .
 
 > **Note**
->
 > If you specify a  `delegateQueue` , please do not manipulate the UI in the TRTCCloudDelegate callback function; otherwise, thread safety issues will occur.
 >
 
@@ -202,7 +200,6 @@ After calling this API, you will receive the  `onEnterRoom(result)`  callback fr
 |scene|Application scenario, which is used to specify the use case. The same TRTCAppScene should be configured for all users in the same room.|
 
 > **Note**
->
 > 1. If  `scene`  is specified as TRTCAppSceneLIVE or TRTCAppSceneVoiceChatRoom, you must use the  `role`  field in TRTCParams to specify the role of the current user in the room.
 >
 > 2. The same  `scene`  should be configured for all users in the same room.
@@ -234,7 +231,6 @@ You can use the  `role`  field in TRTCParams during room entry to specify the us
 | role | Role, which is  <code>anchor</code>  by default:<br>-  TRTCRoleAnchor: anchor, who can publish their audio/video streams. Up to 50 anchors are allowed to publish streams at the same time in one room.<br>-  TRTCRoleAudience: audience, who cannot publish their audio/video streams, but can only watch streams of anchors in the room. If they want to publish their streams, they need to switch to the "anchor" role first through switchRole. One room supports an audience of up to 100,000 concurrent online users. |
 
 > **Note**
->
 > 1. This API is only applicable to two scenarios: live streaming (TRTCAppSceneLIVE) and audio chat room (TRTCAppSceneVoiceChatRoom).
 >
 > 2. If the  `scene`  you specify in enterRoom is TRTCAppSceneVideoCall or TRTCAppSceneAudioCall, please do not call this API.
@@ -255,7 +251,6 @@ You can use the  `role`  field in TRTCParams during room entry to specify the us
 | role | Role, which is  <code>anchor</code>  by default:<br>-  TRTCRoleAnchor: anchor, who can publish their audio/video streams. Up to 50 anchors are allowed to publish streams at the same time in one room.<br>-  TRTCRoleAudience: audience, who cannot publish their audio/video streams, but can only watch streams of anchors in the room. If they want to publish their streams, they need to switch to the "anchor" role first through switchRole. One room supports an audience of up to 100,000 concurrent online users. |
 
 > **Note**
->
 > 1. This API is only applicable to two scenarios: live streaming (TRTCAppSceneLIVE) and audio chat room (TRTCAppSceneVoiceChatRoom).
 >
 > 2. If the  `scene`  you specify in enterRoom is TRTCAppSceneVideoCall or TRTCAppSceneAudioCall, please do not call this API.
@@ -279,7 +274,6 @@ The API call result will be called back through  `onSwitchRoom(errCode, errMsg)`
 |config|Room parameter. For more information, please see TRTCSwitchRoomConfig.|
 
 > **Note**
->
 > Due to the requirement for compatibility with legacy versions of the SDK, the  `config`  parameter contains both  `roomId`  and  `strRoomId`  parameters. You should pay special attention as detailed below when specifying these two parameters:
 >
 > 1. If you decide to use  `strRoomId` , then set  `roomId`  to 0. If both are specified,  `roomId`  will be used.
@@ -363,7 +357,6 @@ In your application scenario, if there are many audio/video streams being publis
 |autoRecvVideo|YES: automatic subscription to video; NO: manual subscription to video by calling  `startRemoteView` . Default value: YES|
 
 > **Note**
->
 > 1. The configuration takes effect only if this API is called before room entry (enterRoom).
 >
 > 2. In the automatic subscription mode, if the user does not call startRemoteView to subscribe to the video stream after room entry, the SDK will automatically stop subscribing to the video stream in order to reduce the traffic consumption.
@@ -408,7 +401,6 @@ Below is the sample code:
 ```
 
 > **Note**
->
 > 1. The same user can enter multiple rooms with different  `roomId`  values by using the same  `userId` .
 >
 > 2. Two devices cannot use the same  `userId`  to enter the same room with a specified  `roomId` .
@@ -492,12 +484,11 @@ You can use the TRTCPublishMode parameter in TRTCPublishTarget to specify the pu
 
 |Param|DESC|
 |---------|---------|
-|config|The On-Cloud MixTranscoding settings. This parameter is invalid in the relay-to-CDN mode. It is required if you transcode and publish the stream to a CDN or to a TRTC room. For details, see TRTCStreamMixingConfig.|
-|params|The encoding settings. This parameter is required if you transcode and publish the stream to a CDN or to a TRTC room. If you relay to a CDN without transcoding, to improve the relaying stability and playback compatibility, we also recommend you set this parameter. For details, see TRTCStreamEncoderParam.|
-|target|The publishing destination. You can relay the stream to a CDN (after transcoding or without transcoding) or transcode and publish the stream to a TRTC room. For details, see TRTCPublishTarget.|
+|config|The On-Cloud MixTranscoding settings. This parameter is invalid in the relay-to-CDN mode. It is required if you transcode and publish the stream to a CDN or to a TRTC room. .|
+|params|The encoding settings. This parameter is required if you transcode and publish the stream to a CDN or to a TRTC room. If you relay to a CDN without transcoding, to improve the relaying stability and playback compatibility, we also recommend you set this parameter. .|
+|target|The publishing destination. You can relay the stream to a CDN (after transcoding or without transcoding) or transcode and publish the stream to a TRTC room. .|
 
 > **Note**
->
 > 1. The SDK will send a task ID to you via the onStartPublishMediaStream callback.
 >
 > 2. You can start a publishing task only once and cannot initiate two tasks that use the same publishing mode and publishing cdn url. Note the task ID returned, which you need to pass to updatePublishMediaStream to modify the publishing parameters or stopPublishMediaStream to stop the task.
@@ -515,13 +506,12 @@ You can use this API to change the parameters of a publishing task initiated by
 
 |Param|DESC|
 |---------|---------|
-|config|The On-Cloud MixTranscoding settings. This parameter is invalid in the relay-to-CDN mode. It is required if you transcode and publish the stream to a CDN or to a TRTC room. For details, see TRTCStreamMixingConfig.|
-|params|The encoding settings. This parameter is required if you transcode and publish the stream to a CDN or to a TRTC room. If you relay to a CDN without transcoding, to improve the relaying stability and playback compatibility, we recommend you set this parameter. For details, see TRTCStreamEncoderParam.|
-|target|The publishing destination. You can relay the stream to a CDN (after transcoding or without transcoding) or transcode and publish the stream to a TRTC room. For details, see TRTCPublishTarget.|
+|config|The On-Cloud MixTranscoding settings. This parameter is invalid in the relay-to-CDN mode. It is required if you transcode and publish the stream to a CDN or to a TRTC room. .|
+|params|The encoding settings. This parameter is required if you transcode and publish the stream to a CDN or to a TRTC room. If you relay to a CDN without transcoding, to improve the relaying stability and playback compatibility, we recommend you set this parameter. .|
+|target|The publishing destination. You can relay the stream to a CDN (after transcoding or without transcoding) or transcode and publish the stream to a TRTC room. .|
 |taskId|The task ID returned to you via the onStartPublishMediaStream callback.|
 
 > **Note**
->
 > 1. You can use this API to add or remove CDN URLs to publish to (you can publish to up to 10 CDNs at a time). To avoid causing errors, do not specify the same URLs for different tasks executed at the same time.
 >
 > 2. You can use this API to switch a relaying task to transcoding or vice versa. For example, in cross-room communication, you can first call startPublishMediaStream to relay to a CDN. When the anchor requests cross-room communication, call this API, passing in the task ID to switch the relaying task to a transcoding task. This can ensure that the live stream and CDN playback are not interrupted (you need to keep the encoding parameters consistent).
@@ -540,7 +530,6 @@ You can use this API to stop a task initiated by startPublishMediaStream.
 |taskId|The task ID returned to you via the onStartPublishMediaStream callback.|
 
 > **Note**
->
 > 1. If the task ID is not saved to your backend, you can call startPublishMediaStream again when an anchor re-enters the room after abnormal exit. The publishing will fail, but the TRTC backend will return the task ID to you.
 >
 > 2. If  `taskId`  is left empty, the TRTC backend will end all tasks you started through startPublishMediaStream. You can leave it empty if you have started only one task or want to stop all publishing tasks started by you.
@@ -562,7 +551,6 @@ When the first camera video frame starts to be rendered, you will receive the  `
 |view|Control that carries the video image|
 
 > **Note**
->
 > If you want to preview the camera image and adjust the beauty filter parameters through  `BeautyManager`  before going live, you can:
 >
 > -  Scheme 1. Call  `startLocalPreview`  before calling enterRoom.
@@ -585,7 +573,6 @@ When the first camera video frame starts to be rendered, you will receive the  `
 |view|Control that carries the video image|
 
 > **Note**
->
 > If you want to preview the camera image and adjust the beauty filter parameters through  `BeautyManager`  before going live, you can:
 >
 > -  Scheme 1. Call  `startLocalPreview`  before calling enterRoom.
@@ -648,7 +635,6 @@ Calling this API only starts pulling the video stream, and the image needs to be
 | view | Rendering control that carries the video image |
 
 > **Note**
->
 > The following requires your attention:
 >
 > 1. The SDK supports watching the big image and substream image or small image and substream image of a  `userId`  at the same time, but does not support watching the big image and small image at the same time.
@@ -687,7 +673,6 @@ Calling this API will cause the SDK to stop receiving the user's video stream an
 Calling this API will cause the SDK to stop receiving all remote video streams and release all decoding and rendering resources.
 
 > **Note**
->
 > If a substream image (screen sharing) is being displayed, it will also be stopped.
 >
 
@@ -703,7 +688,6 @@ This API only pauses/resumes receiving the specified user's video stream but doe
 | userId | ID of the specified remote user |
 
 > **Note**
->
 > This API can be called before room entry (enterRoom), and the pause status will be reset after room exit (exitRoom). After calling this API to pause receiving the video stream from a specific user, simply calling the startRemoteView API will not be able to play the video from that user. You need to call muteRemoteVideoStream(NO) or muteAllRemoteVideoStreams(NO) to resume it.
 >
 
@@ -718,7 +702,6 @@ This API only pauses/resumes receiving all users' video streams but does not rel
 |mute|Whether to pause receiving|
 
 > **Note**
->
 > This API can be called before room entry (enterRoom), and the pause status will be reset after room exit (exitRoom).
 >
 > After calling this interface to pause receiving video streams from all users, simply calling the startRemoteView interface will not be able to play the video from a specific user. You need to call muteRemoteVideoStream(NO) or muteAllRemoteVideoStreams(NO) to resume it.
@@ -735,7 +718,6 @@ This setting can determine the quality of image viewed by remote users, which is
 |param|It is used to set relevant parameters for the video encoder. For more information, please see TRTCVideoEncParam.|
 
 > **Note**
->
 > Begin from v11.5 version, the encoding output resolution will be aligned according to width 8 and height 2 bytes, and will be adjusted downward, eg: input resolution 540x960, actual encoding output resolution 536x960.
 >
 
@@ -747,7 +729,7 @@ This setting determines the quality control policy in a poor network environment
 
 |Param|DESC|
 |---------|---------|
-|param|It is used to set relevant parameters for network quality control. For details, please refer to TRTCNetworkQosParam.|
+|param|It is used to set relevant parameters for network quality control. For details, please .|
 
 ## setLocalRenderParams:
 
@@ -785,7 +767,6 @@ In this way, other users in the room can choose to subscribe to the **HD big ima
 |smallVideoEncParam|Video parameters of small image stream|
 
 > **Note**
->
 > Dual-channel encoding will consume more CPU resources and network bandwidth; therefore, this feature can be enabled on macOS, Windows, or high-spec tablets, but is not recommended for phones.
 >
 
@@ -807,7 +788,6 @@ You can use this API to select whether the image subscribed to is the big image
 |userId|ID of the specified remote user|
 
 > **Note**
->
 > To implement this feature, the target user must have enabled the dual-channel encoding mode through enableEncSmallVideoStream; otherwise, this API will not work.
 >
 
@@ -824,7 +804,6 @@ You can use this API to screencapture the local video image or the primary strea
 |userId|User ID. A null value indicates to screencapture the local video.|
 
 > **Note**
->
 > On Windows, only video image from the TRTCSnapshotSourceTypeStream source can be screencaptured currently.
 >
 
@@ -868,7 +847,6 @@ After local audio capturing and publishing is enabled, other users in the room w
 | quality | Sound quality<br>-  TRTCAudioQualitySpeech - Smooth: mono channel; audio bitrate: 18 Kbps. This is suitable for audio call scenarios, such as online meeting and audio call.<br>-  TRTCAudioQualityDefault - Default: mono channel; audio bitrate: 50 Kbps. This is the default sound quality of the SDK and recommended if there are no special requirements.<br>-  TRTCAudioQualityMusic - HD: dual channel + full band; audio bitrate: 128 Kbps. This is suitable for scenarios where Hi-Fi music transfer is required, such as online karaoke and music live streaming. |
 
 > **Note**
->
 > This API will check the mic permission. If the current application does not have permission to use the mic, the SDK will automatically ask the user to grant the mic permission.
 >
 
@@ -908,7 +886,6 @@ When you mute the remote audio of a specified user, the SDK will stop playing ba
 |userId|ID of the specified remote user|
 
 > **Note**
->
 > This API works when called either before or after room entry (enterRoom), and the mute status will be reset to  `NO`  after room exit (exitRoom).
 >
 
@@ -923,7 +900,6 @@ When you mute the audio of all remote users, the SDK will stop playing back all
 |mute|YES: mute; NO: unmute|
 
 > **Note**
->
 > This API works when called either before or after room entry (enterRoom), and the mute status will be reset to  `NO`  after room exit (exitRoom).
 >
 
@@ -955,7 +931,6 @@ You can mute the audio of a remote user through  `setRemoteAudioVolume(userId, 0
 |volume|Volume. 100 is the original volume. Value range: [0,150]. Default value: 100|
 
 > **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.
 >
 
@@ -968,7 +943,6 @@ You can mute the audio of a remote user through  `setRemoteAudioVolume(userId, 0
 |volume|Volume. 100 is the original volume. Value range: [0,150]. Default value: 100|
 
 > **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.
 >
 
@@ -989,7 +963,6 @@ This API controls the volume of the sound ultimately delivered by the SDK to the
 |volume|Volume. 100 is the original volume. Value range: [0,150]. Default value: 100|
 
 > **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.
 >
 
@@ -1009,7 +982,6 @@ After this feature is enabled, the SDK will return the audio volume assessment i
 |params|Volume evaluation and other related parameters, please see TRTCAudioVolumeEvaluateParams|
 
 > **Note**
->
 > To enable this feature, call this API before calling startLocalAudio.
 >
 
@@ -1028,7 +1000,6 @@ The startup and completion status of the recording will be notified through loca
 |param|Recording parameter. For more information, please see TRTCAudioRecordingParams|
 
 > **Note**
->
 > Since version 11.5, the results of audio recording have been changed to be notified through asynchronous callbacks instead of return values. Please refer to the relevant callbacks of TRTCCloudDelegate .
 >
 
@@ -1092,7 +1063,6 @@ Update self position and orientation in the world coordinate system. The SDK wil
 |position|The coordinate of self in the world coordinate system. The three values represent the forward, right and up coordinate values in turn.|
 
 > **Note**
->
 > 1. The length of array should be 3.
 >
 > 2. Please limit the calling frequency appropriately. It's recommended that the interval between two operations be at least 100ms.
@@ -1110,7 +1080,6 @@ Update the specified remote user's position in the world coordinate system. The
 |userId|ID of the specified remote user.|
 
 > **Note**
->
 > 1. The length of array should be 3.
 >
 > 2. Please limit the calling frequency appropriately. It's recommended that the interval between two operations of the same remote user be at least 100ms.
@@ -1181,7 +1150,6 @@ then the coordinates of the top-left point of the watermark will be (540 * 0.1,
 |streamType|Specify for which image to set the watermark. For more information, please see TRTCVideoStreamType.|
 
 > **Note**
->
 > If you want to set watermarks for both the primary image (generally for the camera) and the substream image (generally for screen sharing), you need to call this API twice with  `streamType`  set to different values.
 >
 
@@ -1212,7 +1180,6 @@ This API captures audio data from the sound card of a macOS computer and mixes i
 In use cases such as video teaching or music live streaming, the teacher can use this feature to let the SDK capture the sound in the video played back by the teacher, so that students in the same room can also hear the sound in the video.
 
 > **Note**
->
 > 1. This feature needs to install a virtual audio device plugin on the user's macOS system. After the installation is completed, the SDK will capture sound from the installed virtual device.
 >
 > 2. The SDK will automatically download the appropriate plugin from the internet for installation, but the download may be slow. If you want to speed up this process, you can package the virtual audio plugin file into the  `Resources`  directory of your app bundle.
@@ -1298,7 +1265,6 @@ This API can capture the content of the entire screen or a specified application
 |view|Parent control of the rendering control, which can be set to a null value, indicating not to display the preview of the shared screen.|
 
 > **Note**
->
 > 1. A user can publish at most one primary stream (TRTCVideoStreamTypeBig) and one substream (TRTCVideoStreamTypeSub) at the same time.
 >
 > 2. By default, screen sharing uses the substream image. If you want to use the primary stream for screen sharing, you need to stop camera capturing (through stopLocalPreview) in advance to avoid conflicts.
@@ -1317,7 +1283,6 @@ This API can capture the content of the entire screen or a specified application
 **Pause screen sharing.**
 
 > **Note**
->
 > Begin from v11.5 version, paused screen capture will use the last frame to output at a frame rate of 1fps.
 >
 
@@ -1339,7 +1304,6 @@ Through this API, you can query the IDs, names, and thumbnails of sharable windo
 |thumbnailSize|Specify the thumbnail size of the window to be obtained. The thumbnail can be drawn on the window selection UI.|
 
 > **Note**
->
 > The returned list contains the screen and the application windows. The screen is the first element in the list. If the user has multiple displays, then each display is a sharing target.
 >
 
@@ -1400,7 +1364,6 @@ You can set the filtered windows before starting screen sharing or dynamically a
 |window|Window not to be shared|
 
 > **Note**
->
 > 1. This API takes effect only if the  `type`  in TRTCScreenCaptureSourceInfo is specified as TRTCScreenCaptureSourceTypeScreen; that is, the feature of excluding specified windows works only when the entire screen is shared.
 >
 > 2. The windows added to the exclusion list through this API will be automatically cleared by the SDK after room exit.
@@ -1433,7 +1396,6 @@ You can call it before or after startScreenCapture.
 |windowID|Window to be shared (which is a window handle  `HWND`  on Windows)|
 
 > **Note**
->
 > The windows added to the inclusion list by this method will be automatically cleared by the SDK after room exit.
 >
 
@@ -1495,11 +1457,10 @@ For more information, please see [Custom Capturing and Rendering](https://www.te
 
 |Param|DESC|
 |---------|---------|
-|frame|Video data. For  `bufferType` , TRTCVideoBufferType_PixelBuffer is recommended; for  `pixelFormat` , TRTCVideoPixelFormat_NV12 is recommended. Refer to TRTCVideoFrame for more supported formats.|
+|frame|Video data. For `bufferType` , TRTCVideoBufferType_PixelBuffer is recommended; for `pixelFormat` , TRTCVideoPixelFormat_NV12 is recommended. .|
 |streamType|Specify video stream type (TRTCVideoStreamTypeBig: HD big image; TRTCVideoStreamTypeSub: substream image).|
 
 > **Note**
->
 > 1. We recommend you call the generateCustomPTS API to get the  `timestamp`  value of a video frame immediately after capturing it, so as to achieve the best audio/video sync effect.
 >
 > 2. The video frame rate eventually encoded by the SDK is not determined by the frequency at which you call this API, but by the FPS you set in setVideoEncoderParam.
@@ -1520,7 +1481,6 @@ You need to use sendCustomAudioData to continuously insert the captured audio da
 |enable|Whether to enable. Default value: NO|
 
 > **Note**
->
 > As acoustic echo cancellation (AEC) requires strict control over the audio capturing and playback time, after custom audio capturing is enabled, AEC may fail.
 >
 
@@ -1546,7 +1506,6 @@ For more information, please see [Custom Capturing and Rendering](https://www.te
 |frame|Audio data|
 
 > **Note**
->
 > Please call this API accurately at intervals of the frame length; otherwise, sound lag may occur due to uneven data delivery intervals.
 >
 
@@ -1562,7 +1521,6 @@ After this feature is enabled, you can mix a custom audio track into the SDK thr
 |enablePublish|Whether the mixed audio track should be played back remotely. Default value: NO|
 
 > **Note**
->
 > If you specify both  `enablePublish`  and  `enablePlayout`  as  `NO` , the custom audio track will be completely closed.
 >
 
@@ -1675,7 +1633,6 @@ For more information, please see [Custom Capturing and Rendering](https://www.te
 |userId|ID of the specified remote user|
 
 > **Note**
->
 > Before this API is called,  `startRemoteView(nil)`  needs to be called to get the video stream of the remote user ( `view`  can be set to  `nil`  for this end); otherwise, there will be no data called back.
 >
 
@@ -1697,7 +1654,6 @@ After this callback is set, the SDK will internally call back the audio data (in
 -  onMixedPlayAudioFrame: callback of the audio data that will be played back by the system after audio streams are mixed
 
 > **Note**
->
 > Setting the callback to null indicates to stop the custom audio callback, while setting it to a non-null value indicates to start the custom audio callback.
 >
 
@@ -1792,7 +1748,6 @@ After you enable custom audio playback, the SDK will stop using its audio API to
 |enable|Whether to enable custom audio playback. It's disabled by default.|
 
 > **Note**
->
 > The parameter must be set before room entry to take effect.
 >
 
@@ -1818,7 +1773,6 @@ Assume that the sample rate is 48000, and sound channels mono-channel. The buffe
 |audioFrame|Audio frames|
 
 > **Note**
->
 > 1. You must set  `sampleRate`  and  `channel`  in  `audioFrame` , and allocate memory for one frame of audio in advance.
 >
 > 2. The SDK will fill the data automatically based on  `sampleRate`  and  `channel` .
@@ -1842,7 +1796,6 @@ Other users in the room can receive the message through the  `onRecvCustomCmdMsg
 |reliable|Whether reliable sending is enabled. Reliable sending can achieve a higher success rate but with a longer reception delay than unreliable sending.|
 
 > **Note**
->
 > 1. Up to 30 messages can be sent per second to all users in the room (this is not supported for web and mini program currently. this limit is shared with sendSEIMsg).
 >
 > 2. A packet can contain up to 1 KB of data; if the threshold is exceeded, the packet is very likely to be discarded by the intermediate router or server.(this limit is shared with sendSEIMsg).
@@ -1882,7 +1835,6 @@ Other users in the room can receive the message through the  `onRecvSEIMsg`  cal
 |repeatCount|Data sending count|
 
 > **Note**
->
 > This API has the following restrictions:
 >
 > 1. The data will not be instantly sent after this API is called; instead, it will be inserted into the next video frame after the API call.
@@ -1911,7 +1863,6 @@ YES: the message is allowed and will be sent with subsequent video frames; NO: t
 |params|speed test options|
 
 > **Note**
->
 > 1. The speed measurement process will incur a small amount of basic service fees, See [Purchase Guide > Base Services](https://intl.cloud.tencent.com/document/product/647/34610).
 >
 > 2. Please perform the Network speed test before room entry, because if performed after room entry, the test will affect the normal audio/video transfer, and its result will be inaccurate due to interference in the room.
@@ -1975,7 +1926,6 @@ You can use this API to change the default storage path of the SDK's local logs,
 |path|Log storage path|
 
 > **Note**
->
 > Please be sure to call this API before all other APIs and make sure that the directory you specify exists and your application has read/write permissions of the directory.
 >
 
@@ -2022,10 +1972,9 @@ After the user exits the room, the SDK will automatically close the private encr
 |enabled|Whether to enable media stream private encryption.|
 
 > **Note**
->
 > TRTC has built-in encryption for media streams before transmission. After private encryption of media streams is enabled, it will be re-encrypted with the key and initial vector you pass in.
 >
 
 **Return Desc:**
 
-Interface call result, 0: Method call succeeded, -1: The incoming parameter is invalid, -2: Your subscription has expired. If you want to renew it, Please go to purchase the [TRTC Professional Edition](https://console.trtc.io/subscription/buy/rtc), and [contact us](https://trtc.io/zh/contact) for review before use.
+Interface call result, 0: Method call succeeded, -1: The incoming parameter is invalid, -2: Your subscription has expired. If you want to renew it, Please go to purchase the [TRTC Professional Edition](https://console.trtc.io/subscription/buy/rtc)

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

@@ -122,7 +122,6 @@ TRTC provides three different video streams, including:
 -  Substream image: it is generally used for screen sharing. Only one user in the room is allowed to publish the substream video image at any time, while other users must wait for this user to close the substream before they can publish their own substream.
 
 > **Note**
->
 > The SDK does not support enabling the smooth small image alone, which must be enabled together with the big image. It will automatically set the resolution and bitrate of the small image.
 >
 
@@ -674,9 +673,9 @@ You can test the network speed through the startSpeedTest: interface before the
 | expectedDownBandwidth | Expected downstream bandwidth (kbps, value range: 10 to 5000, no downlink bandwidth test when it is 0).<br><strong>Note</strong><br>When the parameter  <code>scene</code>  is set to TRTCSpeedTestScene_OnlineChorusTesting, in order to obtain more accurate information such as  <code>rtt / jitter</code> , the value range is limited to [10, 1000]. |
 | expectedUpBandwidth | Expected upstream bandwidth (kbps, value range: 10 to 5000, no uplink bandwidth test when it is 0).<br><strong>Note</strong><br>When the parameter  <code>scene</code>  is set to TRTCSpeedTestScene_OnlineChorusTesting, in order to obtain more accurate information such as  <code>rtt / jitter</code> , the value range is limited to [10, 1000]. |
 | scene | Speed test scene. |
-| sdkAppId | Application identification, please refer to the relevant instructions in TRTCParams. |
-| userId | User identification, please refer to the relevant instructions in TRTCParams. |
-| userSig | User signature, please refer to the relevant instructions in TRTCParams. |
+| sdkAppId | Application identification, please . |
+| userId | User identification, please . |
+| userSig | User signature, please . |
 
 ## TRTCSpeedTestResult
 
@@ -763,7 +762,7 @@ These parameters are used to specify the layout position information of each vid
 | mixUsers | Field description: specify the position, size, layer, and stream type of each video image in On-Cloud MixTranscoding<br>Recommended value: this field is an array in  <code>TRTCMixUser</code>  type, where each element represents the information of a video image. |
 | mode | Field description: layout mode<br>Recommended value: please choose a value according to your business needs. The preset mode has better applicability. |
 | streamId | Field description: ID of the live stream output to CDN<br>Recommended value: default value: null, that is, the audio/video streams in the room will be mixed into the audio/video stream of the caller of this API.<br>-  If you don't set this parameter, the SDK will execute the default logic, that is, it will mix the multiple audio/video streams in the room into the audio/video stream of the caller of this API, i.e., A + B => A.<br>-  If you set this parameter, the SDK will mix the audio/video streams in the room into the live stream you specify, i.e., A + B => C (C is the  <code>streamId</code>  you specify). |
-| videoBitrate | Field description: specify the target video bitrate (Kbps) of On-Cloud MixTranscoding<br>Recommended value: if you enter 0, TRTC will estimate a reasonable bitrate value based on  <code>videoWidth</code>  and  <code>videoHeight</code> . You can also refer to the recommended bitrate value in the video resolution enumeration definition (in the comment section). |
+| videoBitrate | Field description: specify the target video bitrate (Kbps) of On-Cloud MixTranscoding<br>Recommended value: if you enter 0, TRTC will estimate a reasonable bitrate value based on <code>videoWidth</code> and <code>videoHeight</code> . You can also . |
 | videoFramerate | Field description: specify the target video frame rate (fps) of On-Cloud MixTranscoding<br>Recommended value: default value: 15 fps. Value range: (0,30]. |
 | videoGOP | Field description: specify the target video keyframe interval (GOP) of On-Cloud MixTranscoding<br>Recommended value: default value: 2 (in seconds). Value range: [1,8]. |
 | videoHeight | Field description: specify the target resolution (height) of On-Cloud MixTranscoding<br>Recommended value: 640 px. If you only mix audio streams, please set both  <code>width</code>  and  <code>height</code>  to 0; otherwise, there will be a black background in the live stream after mixtranscoding. |
@@ -813,7 +812,7 @@ The startLocalRecording API is an enhanced version of the startAudioRecording AP
 
 **Sound effect parameter (disused).**
 
-"Sound effects" in TRTC refer to some short audio files (usually only a few seconds), such as "applause" and "laughter".
+"Sound effects" in TRTC .
 
 This parameter is used to specify the path and number of playback times of a sound effect file (short audio file) in the sound effect playback API TRTCCloud#playAudioEffect on legacy versions.
 
@@ -931,7 +930,7 @@ This enum type is used by the On-Cloud MixTranscoding parameter TRTCStreamMixing
 | videoEncodedFPS | <code>Description:</code>  The frame rate (fps) of the stream to publish.<br><code>Value:</code>  Value range: (0,30]. Default: 20. |
 | videoEncodedGOP | <code>Description:</code>  The keyframe interval (GOP) of the stream to publish.<br><code>Value:</code>  Value range: [1,5]. Default: 3 (seconds). |
 | videoEncodedHeight | <code>Description:</code>  The resolution (height) of the stream to publish.<br><code>Value:</code>  Recommended value: 640. If you mix only audio streams, to avoid displaying a black video in the transcoded stream, set both  <code>width</code>  and  <code>height</code>  to  <code>0</code> . |
-| videoEncodedKbps | <code>Description:</code>  The video bitrate (Kbps) of the stream to publish.<br><code>Value:</code>  If you set this parameter to  <code>0</code> , TRTC will work out a bitrate based on  <code>videoWidth</code>  and  <code>videoHeight</code> . For details, refer to the recommended bitrates for the constants of the resolution enum type (see comment). |
+| videoEncodedKbps | <code>Description:</code> The video bitrate (Kbps) of the stream to publish.<br><code>Value:</code> If you set this parameter to <code>0</code> , TRTC will work out a bitrate based on <code>videoWidth</code> and <code>videoHeight</code> . . |
 | videoEncodedWidth | <code>Description:</code>  The resolution (width) of the stream to publish.<br><code>Value:</code>  Recommended value: 368. If you mix only audio streams, to avoid displaying a black video in the transcoded stream, set both  <code>width</code>  and  <code>height</code>  to  <code>0</code> . |
 | videoSeiParams | <code>Description:</code>  SEI parameters. Default: null<br><code>Note:</code>  the parameter is passed in the form of a JSON string. Here is an example to use it:<br>`{`<br>`  "payLoadContent":"xxx",`<br>`  "payloadType":5,`<br>`  "payloadUuid":"1234567890abcdef1234567890abcdef",`<br>`  "interval":1000,`<br>`  "followIdr":false`<br>`}`<br>The currently supported fields and their meanings are as follows:<br>-  payloadContent: Required. The payload content of the passthrough SEI, which cannot be empty.<br>-  payloadType: Required. The type of the SEI message, with a value range of 5 or an integer within the range of [100, 254] (excluding 244, which is an internally defined timestamp SEI).<br>-  payloadUuid: Required when payloadType is 5, and ignored in other cases. The value must be a 32-digit hexadecimal number.<br>-  interval: Optional, default is 1000. The sending interval of the SEI, in milliseconds.<br>-  followIdr: Optional, default is false. When this value is true, the SEI will be ensured to be carried when sending a key frame, otherwise it is not guaranteed. |
 

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

@@ -143,7 +143,6 @@ For more information on the error codes for room entry failure, see [Error Codes
 |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.
 >
 > 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.
@@ -245,7 +244,6 @@ Due to performance concerns, this callback works differently in different scenar
 |userId|User ID of the remote user|
 
 > **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.
 >
 > 2. If you want to know whether a user enabled video, we recommend you use the onUserVideoAvailable callback.
@@ -294,7 +292,6 @@ You can then call startRemoteView to subscribe to the remote user’s video. If
 |userId|User ID of the remote user|
 
 > **Note**
->
 > The API used to display substream images is startRemoteView, not startRemoteSubStreamView, startRemoteSubStreamView is deprecated.
 >
 
@@ -313,7 +310,6 @@ If you receive the  `onUserAudioAvailable(userId, YES)`  callback, it indicates
 |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.
 >
 
@@ -334,7 +330,6 @@ The SDK returns this event callback when it starts rendering your first video fr
 |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.
@@ -445,7 +440,6 @@ This callback is returned every 2 seconds and notifies you of the statistics on
 |statistics|Statistics, including local statistics and the statistics of remote users. For details, please see TRTCStatistics.|
 
 > **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.
 >
 
@@ -457,7 +451,7 @@ The callback is triggered by startSpeedTest.
 
 |Param|DESC|
 |---------|---------|
-|result|Speed test data, including loss rates, rtt and bandwidth rates, please refer to TRTCSpeedTestResult for details.|
+|result|Speed test data, including loss rates, rtt and bandwidth rates, please .|
 
 ## onConnectionLost
 
@@ -537,7 +531,6 @@ Note that the SDK returns this callback at the specified interval regardless of
 |userVolumes|An array that represents the volume of all users who are speaking in the room. Value range: [0, 100]|
 
 > **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.
 >
 
@@ -571,7 +564,6 @@ When users set the mic capturing volume via the UI or a keyboard shortcut, the S
 |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` .
 >
 
@@ -591,7 +583,6 @@ When users set the system’s playback volume via the UI or a keyboard shortcut,
 |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` .
 >
 
@@ -640,7 +631,6 @@ If the sender sets  `reliable`  to  `YES` , the SDK will use this callback to no
 |userId|User ID|
 
 > **Note**
->
 > The recipient receives this callback only if the sender sets  `reliable`  to  `YES` .
 >
 
@@ -695,7 +685,6 @@ The SDK will then receive the execution result from the CVM and return the resul
 |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.
 >
 
@@ -930,7 +919,6 @@ uint32_t onProcessVideoFrame(TRTCVideoFrame * _Nonnull)srcFrame dstFrame:(TRTCVi
 |srcFrame|Used to carry images captured by TRTC via the camera|
 
 > **Note**
->
 > Currently, only the OpenGL texture scheme is supported(PC supports TRTCVideoBufferType_Buffer format Only)
 >
 
@@ -954,7 +942,6 @@ After you configure the callback of custom audio processing, the SDK will return
 |frame|Audio frames in PCM format|
 
 > **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.
@@ -986,7 +973,6 @@ Other users in the room can receive the message through the  `TRTCAudioFrame.ext
 |frame|Audio frames in PCM format|
 
 > **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.
@@ -1011,7 +997,6 @@ After you configure the callback of custom audio processing, the SDK will return
 |userId|User ID|
 
 > **Note**
->
 > The audio data returned via this callback can be read but not modified.
 >
 
@@ -1031,7 +1016,6 @@ After you configure the callback of custom audio processing, the SDK will return
 |frame|Audio frames in PCM format|
 
 > **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.
@@ -1055,7 +1039,6 @@ After you configure the callback of custom audio processing, the SDK will return
 |frame|Audio frames in PCM format|
 
 > **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.
@@ -1077,7 +1060,6 @@ After you configure the callback of custom audio processing, the SDK will return
 |frame|Audio frames in PCM format|
 
 > **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.