Rc/3.2.+

src/common/Classes.ts

@@ -1227,6 +1227,10 @@ export interface RemoteAudioStats {
   networkTransportDelay: number;
   /**
    * Network delay (ms) from the receiver to the jitter buffer.
+   *
+   * **Note**
+   *
+   * When the receiver is an audience member and `AudienceLatencyLevelType` is `1`, this parameter does not take effect.
    */
   jitterBufferDelay: number;
   /**

src/common/Enums.ts

@@ -1162,7 +1162,7 @@ export enum ErrorCode {
    */
   PublishStreamNotFound = 155,
   /**
-   * 156: The format of the RTMP stream URL is not supported. Check whether the URL format is correct.
+   * 156: The format of the RTMP or RTMPS stream URL is not supported. Check whether the URL format is correct.
    */
   PublishStreamFormatNotSuppported = 156,
   /**
@@ -1537,7 +1537,7 @@ export enum NetworkType {
  */
 export enum RtmpStreamingErrorCode {
   /**
-   * 0: The RTMP streaming publishes successfully.
+   * 0: The RTMP or RTMPS streaming publishes successfully.
    */
   OK = 0,
   /**
@@ -1547,23 +1547,23 @@ export enum RtmpStreamingErrorCode {
    */
   InvalidParameters = 1,
   /**
-   * 2: The RTMP streaming is encrypted and cannot be published.
+   * 2: The RTMP or RTMPS streaming is encrypted and cannot be published.
    */
   EncryptedStreamNotAllowed = 2,
   /**
-   * 3: Timeout for the RTMP streaming. Call the [`addPublishStreamUrl`]{@link RtcEngine.addPublishStreamUrl} method to publish the streaming again.
+   * 3: Timeout for the RTMP or RTMPS streaming. Call the [`addPublishStreamUrl`]{@link RtcEngine.addPublishStreamUrl} method to publish the streaming again.
    */
   ConnectionTimeout = 3,
   /**
    * 4: An error occurs in Agora’s streaming server. Call the [`addPublishStreamUrl`]{@link RtcEngine.addPublishStreamUrl} method to publish the streaming again.
    */
   InternalServerError = 4,
   /**
-   * 5: An error occurs in the RTMP server.
+   * 5: An error occurs in the CDN server.
    */
   RtmpServerError = 5,
   /**
-   * 6: The RTMP streaming publishes too frequently.
+   * 6: The RTMP or RTMPS streaming publishes too frequently.
    */
   TooOften = 6,
   /**
@@ -1575,36 +1575,36 @@ export enum RtmpStreamingErrorCode {
    */
   NotAuthorized = 8,
   /**
-   * 9: Agora’s server fails to find the RTMP streaming.
+   * 9: Agora’s server fails to find the RTMP or RTMPS streaming.
    */
   StreamNotFound = 9,
   /**
-   * 10: The format of the RTMP streaming URL is not supported. Check whether the URL format is correct.
+   * 10: The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct.
    */
   FormatNotSupported = 10,
 }
 
 /**
- * The RTMP streaming state.
+ * The RTMP or RTMPS streaming state.
  */
 export enum RtmpStreamingState {
   /**
-   * 0: The RTMP streaming has not started or has ended. This state is also triggered after you
-   * remove an RTMP address from the CDN by calling [`removePublishStreamUrl`]{@link RtcEngine.removePublishStreamUrl}.
+   * 0: The RTMP or RTMPS streaming has not started or has ended. This state is also triggered after you
+   * remove an RTMP or RTMPS stream* from the CDN by calling [`removePublishStreamUrl`]{@link RtcEngine.removePublishStreamUrl}.
    */
   Idle = 0,
   /**
-   * 1: The SDK is connecting to Agora’s streaming server and the RTMP server.
+   * 1: The SDK is connecting to Agora’s streaming server and the CDN server.
    * This state is triggered after you call the [`addPublishStreamUrl`]{@link RtcEngine.addPublishStreamUrl} method.
    */
   Connecting = 1,
   /**
-   * 2: The RTMP streaming is being published. The SDK successfully publishes the RTMP streaming and returns this state.
+   * 2: The RTMP or RTMPS streaming is being published. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state.
    */
   Running = 2,
   /**
-   * 3: The RTMP streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted,
-   * the SDK attempts to resume RTMP streaming and returns this state.
+   * 3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted,
+   * the SDK attempts to resume RTMP or RTMPS streaming and returns this state.
    *
    * - If the SDK successfully resumes the streaming, [`Running`]{@link RtmpStreamingState.Running} returns.
    * - If the streaming does not resume within 60 seconds or server errors occur,
@@ -1614,8 +1614,8 @@ export enum RtmpStreamingState {
    */
   Recovering = 3,
   /**
-   * 4: The RTMP streaming fails. See the errorCode parameter for the detailed error information.
-   * You can also call the [`addPublishStreamUrl`]{@link RtcEngine.addPublishStreamUrl} method to publish the RTMP streaming again.
+   * 4: The RTMP or RTMPS streaming fails. See the errorCode parameter for the detailed error information.
+   * You can also call the [`addPublishStreamUrl`]{@link RtcEngine.addPublishStreamUrl} method to publish the RTMP or RTMPS streaming again.
    */
   Failure = 4,
 }
@@ -2355,11 +2355,11 @@ export enum StreamSubscribeState {
 }
 
 /**
- * Events during the RTMP streaming.
+ * Events during the RTMP or RTMPS streaming.
  */
 export enum RtmpStreamingEvent {
   /**
-   * 1: An error occurs when you add a background image or a watermark image to the RTMP stream.
+   * 1: An error occurs when you add a background image or a watermark image to the RTMP or RTMPS stream.
    */
   FailedLoadImage = 1,
 }

src/common/RtcChannel.native.ts

@@ -498,7 +498,9 @@ export default class RtcChannel implements RtcChannelInterface {
   }
 
   /**
-   * Publishes the local stream to the CDN.
+   * Publishes the local stream to a specified CDN streaming URL.
+   *
+   * After calling this method, you can push media streams in RTMP or RTMPS protocol to the CDN.
    *
    * This method call triggers the [`RtmpStreamingStateChanged`]{@link RtcChannelEvents.RtmpStreamingStateChanged}
    * callback on the local client to report the state of adding a local stream to the CDN.
@@ -507,10 +509,11 @@ export default class RtcChannel implements RtcChannelInterface {
    * - Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in *Push Streams to CDN*.
    * - Ensure that the user joins a channel before calling this method.
    * - This method can only be called by a host in a `LiveBroadcasting` channel.
-   * - This method adds only one stream HTTP/HTTPS URL address each time it is called.
+   * - This method adds only one CDN streaming URL each time it is called.
+   * - Agora supports pushing media streams in RTMPS protocol to the CDN only when you enable transcoding.
    *
-   * @param url The CDN streaming URL in the RTMP format. The maximum length of this parameter is 1024 bytes. The URL address must not contain special characters, such as Chinese language characters.
-   * @param transcodingEnabled Sets whether transcoding is enabled/disabled. If you set this parameter as true,
+   * @param url The CDN streaming URL in the RTMP or RTMPS format. The maximum length of this parameter is 1024 bytes. The URL address must not contain special characters, such as Chinese language characters.
+   * @param transcodingEnabled Whether to enable transcoding. If you set this parameter as true,
    * ensure that you call the [`setLiveTranscoding`]{@link RtcChannel.setLiveTranscoding} method before this method.
    * - `true`: Enable transcoding. To transcode the audio or video streams when publishing them to CDN live, often used for combining the audio and video streams of multiple hosts in CDN live.
    * - `false`: Disable transcoding.
@@ -526,17 +529,17 @@ export default class RtcChannel implements RtcChannelInterface {
   }
 
   /**
-   * Removes an RTMP stream from the CDN.
+   * Removes an RTMP or RTMPS stream from the CDN.
    *
-   * This method removes the RTMP URL address (added by [`addPublishStreamUrl`]{@link RtcChannel.addPublishStreamUrl}) from a CDN live stream.
+   * This method removes the CDN streaming URL (added by [`addPublishStreamUrl`]{@link RtcChannel.addPublishStreamUrl}) from a CDN live stream.
    * The SDK reports the result of this method call in the [`RtmpStreamingStateChanged`]{@link RtcChannelEvents.RtmpStreamingStateChanged} callback.
    *
    * **Note**
    * - Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in *Push Streams to CDN*.
    * - This method can only be called by a host in a `LiveBroadcasting` channel.
-   * - This method removes only one stream HTTP/HTTPS URL address each time it is called.
+   * - This method removes only one CDN streaming URL each time it is called.
    *
-   * @param url The RTMP URL address to be removed. The maximum length of this parameter is 1024 bytes. The URL address must not contain special characters,
+   * @param url The CDN streaming URL to be removed. The maximum length of this parameter is 1024 bytes. The URL address must not contain special characters,
    * such as Chinese language characters.
    */
   removePublishStreamUrl(url: string): Promise<void> {
@@ -555,6 +558,7 @@ export default class RtcChannel implements RtcChannelInterface {
    * - Ensure that the user joins a channel before calling this method.
    * - This method can only be called by a host in a `LiveBroadcasting` channel.
    * - Ensure that you call this method before calling the [`addPublishStreamUrl`]{@link RtcChannel.addPublishStreamUrl} method.
+   * - Agora supports pushing media streams in RTMPS protocol to the CDN only when you enable transcoding.
    *
    * @param transcoding Sets the CDN live audio/video transcoding settings.
    */
@@ -727,7 +731,7 @@ export default class RtcChannel implements RtcChannelInterface {
    * All users in the same channel must use the same encryption mode and encryption key. Once all users leave the channel, the encryption key of this channel is automatically cleared.
    *
    * **Note**
-   * - If you enable the built-in encryption, you cannot use the RTMP streaming function.
+   * - If you enable the built-in encryption, you cannot use the RTMP or RTMPS streaming function.
    * - Agora supports four encryption modes. If you choose an encryption mode (excepting `SM4128ECB` mode), you need to add an external encryption library when integrating the SDK. For details, see the advanced guide *Channel Encryption*.
    *
    *