diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice.dita index fd0ea0fab1b..cfede55331e 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice.dita @@ -31,18 +31,16 @@ type - -

The device type. See .

- + Output parameter; the device type, see . - + deviceName - Output parameter, the name of the system default audio device. The maximum length is . + Output parameter; the name of the system's default audio device. The maximum length is . - + deviceId - Output parameter, the device ID of the the system default audio device. The maximum length is . + Output parameter; the device ID of the system default audio device. The maximum length is .
diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice2.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice2.dita new file mode 100644 index 00000000000..316e9dd0984 --- /dev/null +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice2.dita @@ -0,0 +1,54 @@ + + + + <ph keyref="getDefaultDevice2_IAudioDeviceCollection"/> + Get the system‘s default audio device and its type. + + + + + + + + +
+

+ + + virtual int getDefaultDevice(char deviceName[MAX_DEVICE_ID_LENGTH], char deviceTypeName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + + + + +

+
+
+ Details +
+ +
Since
+
v4.3.1
+ +
+
  • This method applies to macOS only.
    • +
  • You need to call or to get the device list before calling this method.
+
+
+ Parameters + + + + + + + + + + + + + +
+
+ + diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita index 9132ba1cd35..ff6a5de054b 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita @@ -2,7 +2,7 @@ <ph keyref="getDevice_IAudioDeviceCollection" /> - Gets the information of a specified audio device. + Gets the information of a specified audio device by index. @@ -24,18 +24,21 @@ Future<String> getDevice();

+
+

This method is for Windows and macOS only.

+
Parameters - + index An input parameter. The index of the device. - + deviceName An output parameter. The device name. The maximum length is . - + deviceId An output parameter. The device ID. The maximum length is . @@ -46,7 +49,7 @@
  • 0: Success.
  • < 0: Failure. See for details and resolution suggestions.
    • -

    Retrieves the volume of the audio recording device.

    +

    Retrieves the information of the audio recording device.

    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.dita new file mode 100644 index 00000000000..b49d0a0417a --- /dev/null +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.dita @@ -0,0 +1,59 @@ + + + + <ph keyref="getDevice2_IAudioDeviceCollection"/> + Get the audio device information and device type by index. + + + + + + + + +
    +

    + + + virtual int getDevice(int index, char deviceName[MAX_DEVICE_ID_LENGTH], char deviceTypeName[MAX_DEVICE_ID_LENGTH], + char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + + + + +

    +
    +
    + Details +
    + +
    Since
    +
    v4.3.1
    +     +
    +

    You can call this method to get the name, type and ID of a specified audio device.

    + This method is for macOS only. +
    +
    + Parameters + + + + + + + + + + + + + + + deviceTypeName + Output parameter; indicates the type of audio devices, such as built-in, USB and HDMI. The maximum length is . + +
    +
    +     +     diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita index 3b69c452045..ab3804ae4f5 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita @@ -38,7 +38,7 @@
    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    +

    When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    +

    When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    +

    When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    <ph keyref="return-section-title"/> -

    When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    +

    When the method call succeeds, there is no return value; when fails, the exception is thrown. You need to catch the exception and handle it accordingly. See for details and resolution suggestions.

    diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita index dea419bd47d..76ccfc4b230 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita @@ -41,7 +41,7 @@

    When the state of the local video stream changes (including the state of the video capture and encoding), the SDK triggers this callback to report the current state. This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur.

    The SDK triggers the callback with the state code of and error code of in the following situations:

    -

    As of v4.2.0, the parameter name is corrected from publishTrancodedVideoTrack to publishTranscodedVideoTrack.

    + As of v4.2.0, the parameter name is corrected from publishTrancodedVideoTrack to publishTranscodedVideoTrack. @@ -768,10 +769,10 @@ class ChannelMediaOptions { channelProfile - + audioDelayMs -

    The delay in milliseconds for sending audio frames. This is used for explicit control of A/V sync.

    +

    Delay (in milliseconds) for sending audio frames. You can use this parameter to set the delay of the audio frames that need to be sent, to ensure audio and video synchronization.

    To switch off the delay, set the value to 0.

         diff --git a/en-US/dita/RTC-NG/API/class_encryptionconfig.dita b/en-US/dita/RTC-NG/API/class_encryptionconfig.dita index 88ae84f042e..1e0f7f35d37 100644 --- a/en-US/dita/RTC-NG/API/class_encryptionconfig.dita +++ b/en-US/dita/RTC-NG/API/class_encryptionconfig.dita @@ -133,6 +133,14 @@ struct FEncryptionConfig This parameter takes effect only in or encrypted mode. In this case, ensure that this parameter is not 0.     + + datastreamEncryptionEnabled + Whether to enable data stream encryption:
      +
    • : Enable data stream encryption.
      • +
    • : (Default) Disable data stream encryption.
      • +
    +     +
    diff --git a/en-US/dita/RTC-NG/API/class_focallengthinfo.dita b/en-US/dita/RTC-NG/API/class_focallengthinfo.dita new file mode 100644 index 00000000000..13df64743db --- /dev/null +++ b/en-US/dita/RTC-NG/API/class_focallengthinfo.dita @@ -0,0 +1,66 @@ + + + + <ph keyref="FocalLengthInfo"/> + Focal length information supported by the camera, including the camera direction and focal length type. + +
    +

    + public class AgoraFocalLengthInfo { + + public CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection; + + public CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE focalLengthType; + + @CalledByNative + public AgoraFocalLengthInfo(int cameraDirection, int focalLengthType) { + this.cameraDirection = CameraCapturerConfiguration.CAMERA_DIRECTION.values()[cameraDirection]; + this.focalLengthType = CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE.values()[focalLengthType]; + } + + @Override + public String toString() { + return "AgoraFocalLengthInfo{" + + "cameraDirection=" + cameraDirection + + ", focalLengthType=" + focalLengthType + + '}'; + } +} + __attribute__((visibility("default"))) @interface AgoraFocalLengthInfo : NSObject +@property(assign, nonatomic) int cameraDirection; +@property(assign, nonatomic) AgoraFocalLength focalLengthType; +@end + struct FocalLengthInfo { + int cameraDirection; + CAMERA_FOCAL_LENGTH_TYPE focalLengthType; +}; + + + + +

    +
    +
    +
    + +
    Since
    +
    v4.3.1
    +     +
    + This enumeration class applies to Android and iOS only. +

    +

    +
    + Parameters + + + cameraDirection + The camera direction. See . + + + focalLengthType + The focal length type. See . + +
    +     +     diff --git a/en-US/dita/RTC-NG/API/class_ifaceinfoobserver.dita b/en-US/dita/RTC-NG/API/class_ifaceinfoobserver.dita new file mode 100644 index 00000000000..b79985e3275 --- /dev/null +++ b/en-US/dita/RTC-NG/API/class_ifaceinfoobserver.dita @@ -0,0 +1,11 @@ + + + + <ph keyref="IFaceInfoObserver" /> + Facial information observer. + +
    +

    You can call to register or unregister the object.

    +
    +     +     \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita index 3960d016a0a..e3a584db58c 100644 --- a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita @@ -435,6 +435,10 @@ struct FRemoteAudioStats

    + + e2eDelay + End-to-end audio delay (in milliseconds), which refers to the time from when the audio is captured by the remote user to when it is played by the local user. + - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita index a4e292e1600..ffe332811bf 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita @@ -147,7 +147,7 @@ struct FScreenCaptureConfiguration params parameters - (For Windows and macOS only) The screen capture configuration. See . + (For Windows and macOS only) The screen capture configuration. See . regionRect diff --git a/en-US/dita/RTC-NG/API/class_segmentationproperty.dita b/en-US/dita/RTC-NG/API/class_segmentationproperty.dita index a2b8f484e45..1b8c808fdff 100644 --- a/en-US/dita/RTC-NG/API/class_segmentationproperty.dita +++ b/en-US/dita/RTC-NG/API/class_segmentationproperty.dita @@ -109,7 +109,7 @@ struct FSegmentationProperty greenCapacity -

    The range of accuracy for identifying green colors (different shades of green) in the view. The value range is [0,1], and the default value is 0.5. The larger the value, the wider the range of identifiable shades of green. When the value of this parameter is too large, the edge of the portrait and the green color in the portrait range are also detected. Agora recommends that you dynamically adjust the value of this parameter according to the actual effect.

    +

    The accuracy range for recognizing background colors in the image. The value range is [0,1], and the default value is 0.5. The larger the value, the wider the range of identifiable shades of pure color. When the value of this parameter is too large, the edge of the portrait and the pure color in the portrait range are also detected. Agora recommends that you dynamically adjust the value of this parameter according to the actual effect.

    This parameter only takes effect when modelType is set to .     diff --git a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita index 907a7e16c6a..75d8c6e1351 100644 --- a/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita +++ b/en-US/dita/RTC-NG/API/class_simulcaststreamconfig.dita @@ -89,12 +89,12 @@ struct FSimulcastStreamConfig dimensions - The video dimension. See . The default value is 160 × 120. + The video dimension. See . The default value is 50% of the high-quality video stream. bitrate kBitrate - Video receive bitrate (Kbps), represented by an instantaneous value. The default value is 65. + Video receive bitrate (Kbps), represented by an instantaneous value. This parameter does not need to be set. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you set. frameRate diff --git a/en-US/dita/RTC-NG/API/class_videocanvas.dita b/en-US/dita/RTC-NG/API/class_videocanvas.dita index 446851a1a1a..36a4bc8e7c7 100644 --- a/en-US/dita/RTC-NG/API/class_videocanvas.dita +++ b/en-US/dita/RTC-NG/API/class_videocanvas.dita @@ -249,15 +249,19 @@ class VideoCanvas { subviewUid The ID of the user who publishes a specific sub-video stream within the mixed video stream. - Reserved for future use.This parameter applies to Android and iOS only. + Reserved for future use.This parameter is for Android and iOS only. view - The video display window. + The video display window. It must be one or object.In one , you can only choose to set either view or surfaceTexture. If both are set, only the settings in view take effect. The video image. You need to define a pointer of UImage type and pass in this parameter. The sample code is as follows:agora::rtc::VideoCanvas videoCanvas; UImage* LocalVideo; videoCanvas.view = LocalVideo; + + surfaceTexture + A container that provides video images. When you use this member, you need to implement texture drawing in OPENGL yourself. See .In one , you can only choose to set either view or surfaceTexture. If both are set, only the settings in view take effect. + renderMode The rendering mode of the video. See . @@ -266,16 +270,19 @@ class VideoCanvas { mirrorMode -

    The mirror mode of the view. See .

    -

    -

      -
    • -

    - -
      -
    • For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
      • -
    • For the remote user: The mirror mode is disabled by default.
      • -
    +

    The mirror mode of the view. See .

    +

    +

      +
    • +
    +

    + +
      +
    • For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
      • +
    • For the remote user: The mirror mode is disabled by default.
      • +
    +     +     uid @@ -315,17 +322,21 @@ class VideoCanvas { backgroundColor The background color of the video canvas in RGBA format. The default value is 0x00000000, which represents completely transparent black. - - enableAlphaMask - (Optional) Whether the receiver enables alpha mask rendering:
      -
    • : The receiver enables alpha mask rendering.
      • -
    • : (default) The receiver disables alpha mask rendering.
      • -
    -

    Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as portrait-in-picture and watermarking.

    -
    • This property applies to macOS only.
    • The receiver can render alpha channel information only when the sender enables alpha transmission.
    • To enable alpha transmission, .
     -     - Reserved. -     + + enableAlphaMask + (Optional) Whether the receiver enables alpha mask rendering:
      +
    • : The receiver enables alpha mask rendering.
      • +
    • : (Default) The receiver disables alpha mask rendering.
      • +
    +

    Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as portrait-in-picture and watermarking.

    + +
      +
    • The receiver can render alpha channel information only when the sender enables alpha transmission.
      • +
    • To enable alpha transmission, .
      • +
    +     + Reserved. +     position The observation position of the video frame in the video link. See . diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 516cb7736e4..cbabaf63a88 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -605,7 +605,7 @@ struct FVideoEncoderConfiguration mirrorMode

    Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See .

    -

    The mirror mode specified in video encoder configurations only affect the view of remote users.

      +

      Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees.

      • (0): The SDK determines whether to enable the mirror mode. The SDK disables mirror mode by default.
      • (1): Enables the mirror mode for remote users.
      • (2): Disables the mirror mode for remote users.
        • diff --git a/en-US/dita/RTC-NG/API/class_videoformat.dita b/en-US/dita/RTC-NG/API/class_videoformat.dita index bcd38ea3793..381480c7d06 100644 --- a/en-US/dita/RTC-NG/API/class_videoformat.dita +++ b/en-US/dita/RTC-NG/API/class_videoformat.dita @@ -82,15 +82,15 @@ struct FVideoFormat { width - The width (px) of the video frame. + The width (px) of the video frame. The default value is 960. height - The height (px) of the video frame. + The height (px) of the video frame. The default value is 540. fps - The video frame rate (fps). + The video frame rate (fps). The default value is 15. diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita index 595e6104ee4..35c6a129d3a 100644 --- a/en-US/dita/RTC-NG/API/class_videoframe.dita +++ b/en-US/dita/RTC-NG/API/class_videoframe.dita @@ -612,7 +612,7 @@ class VideoFrame { renderTimeMs - The Unix timestamp (ms) when the video frame is rendered. This timestamp can be used to guide the rendering of the video frame. It is required. + The Unix timestamp (ms) when the video frame is rendered. This timestamp can be used to guide the rendering of the video frame. This parameter is required. timestampNs diff --git a/en-US/dita/RTC-NG/API/enum_audioeffectpreset.dita b/en-US/dita/RTC-NG/API/enum_audioeffectpreset.dita index 55cba75ff8c..1fab94c4bc1 100644 --- a/en-US/dita/RTC-NG/API/enum_audioeffectpreset.dita +++ b/en-US/dita/RTC-NG/API/enum_audioeffectpreset.dita @@ -26,7 +26,7 @@ or - Other preset audio effects (except for ) + Other preset audio effects (except for ) or @@ -71,6 +71,10 @@ Virtual surround sound, that is, the SDK generates a simulated surround sound field on the basis of stereo channels, thereby creating a surround sound effect.If the virtual surround sound is enabled, users need to use stereo audio playback devices to hear the anticipated audio effect. + + + The audio effect of chorus. Agora recommends using this effect in chorus scenarios to enhance the sense of depth and dimension in the vocals. + diff --git a/en-US/dita/RTC-NG/API/enum_cameradirection.dita b/en-US/dita/RTC-NG/API/enum_cameradirection.dita index 01e6e55fb8e..82af60e3cbd 100644 --- a/en-US/dita/RTC-NG/API/enum_cameradirection.dita +++ b/en-US/dita/RTC-NG/API/enum_cameradirection.dita @@ -9,11 +9,15 @@ - The rear camera. + 0: The rear camera. - The front camera. + 1: (Default) The front camera. + + + + 2: The external camera. diff --git a/en-US/dita/RTC-NG/API/enum_camerafocallengthtype.dita b/en-US/dita/RTC-NG/API/enum_camerafocallengthtype.dita new file mode 100644 index 00000000000..07ece9464ac --- /dev/null +++ b/en-US/dita/RTC-NG/API/enum_camerafocallengthtype.dita @@ -0,0 +1,37 @@ + + + + <ph keyref="CAMERA_FOCAL_LENGTH_TYPE"/> + The camera focal length types. + +
        +
        + +
        Since
        +
        v4.3.1
        +         +
        + This enumeration class applies to Android and iOS only. +
        +
        + Enumerator + + + + 0: (Default) Standard lens. + + + + 1: Wide-angle lens. + + + + 2: Ultra-wide-angle lens. + + + + 3: (For iOS only) Telephoto lens. + + +
        +         diff --git a/en-US/dita/RTC-NG/API/enum_camerastabilizationmode.dita b/en-US/dita/RTC-NG/API/enum_camerastabilizationmode.dita new file mode 100644 index 00000000000..538ce4bb972 --- /dev/null +++ b/en-US/dita/RTC-NG/API/enum_camerastabilizationmode.dita @@ -0,0 +1,41 @@ + + + + <ph keyref="CAMERA_STABILIZATION_MODE"/> + Camera stabilization modes. + +
        +
        + +
        Since
        +
        v4.3.1
        +         +
        +

        The camera stabilization effect increases in the order of 1 < 2 < 3, and the latency will also increase accordingly.

        +
        +
        + Enumerator + + + + -1: (Default) Camera stabilization mode off. + + + + 0: Automatic camera stabilization. The system automatically selects a stabilization mode based on the status of the camera. However, the latency is relatively high in this mode, so it is recommended not to use this enumeration. + + + + 1: (Recommended) Level 1 camera stabilization. + + + + 2: Level 2 camera stabilization. + + + + 3: Level 3 camera stabilization. + + +
        +         diff --git a/en-US/dita/RTC-NG/API/enum_earmonitoringfiltertype.dita b/en-US/dita/RTC-NG/API/enum_earmonitoringfiltertype.dita index bd98d17ff55..dad9d2e7014 100644 --- a/en-US/dita/RTC-NG/API/enum_earmonitoringfiltertype.dita +++ b/en-US/dita/RTC-NG/API/enum_earmonitoringfiltertype.dita @@ -2,29 +2,29 @@ <ph keyref="EAR_MONITORING_FILTER_TYPE"/> - The audio filter of in-ear monitoring. + The audio filter types of in-ear monitoring.
        Enumerator - -

        1<<0: Do not add an audio filter to the in-ear monitor.

        -         + 1<<0: No audio filter added to in-ear monitoring.         - -

        1<<1: Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.

        -         + 1<<1: Add vocal effects audio filter to in-ear monitoring. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.         -

        1<<2: Enable noise suppression to the in-ear monitor.

        +

        1<<2: Add noise suppression audio filter to in-ear monitoring.

                 + + + 1<<15: Reuse the audio filter that has been processed on the sending end for in-ear monitoring. This enumerator reduces CPU usage while increasing in-ear monitoring latency, which is suitable for latency-tolerant scenarios requiring low CPU consumption. +
        diff --git a/en-US/dita/RTC-NG/API/enum_encryptionerrortype.dita b/en-US/dita/RTC-NG/API/enum_encryptionerrortype.dita index b30269f4a4d..836760da73f 100644 --- a/en-US/dita/RTC-NG/API/enum_encryptionerrortype.dita +++ b/en-US/dita/RTC-NG/API/enum_encryptionerrortype.dita @@ -13,11 +13,19 @@         - 1: Decryption errors. Ensure that the receiver and the sender use the same encryption mode and key. + 1: Media stream decryption error. Ensure that the receiver and the sender use the same encryption mode and key. - 2: Encryption errors. + 2: Media stream encryption error. + + + + 3: Data stream decryption error. Ensure that the receiver and the sender use the same encryption mode and key. + + + + 4: Data stream encryption error. diff --git a/en-US/dita/RTC-NG/API/enum_errorcodetype.dita b/en-US/dita/RTC-NG/API/enum_errorcodetype.dita index f79560c63f0..b14fb721e14 100644 --- a/en-US/dita/RTC-NG/API/enum_errorcodetype.dita +++ b/en-US/dita/RTC-NG/API/enum_errorcodetype.dita @@ -167,13 +167,17 @@ - 120: Decryption fails. The user might have entered an incorrect password to join the channel. Check the entered password, or tell the user to try rejoining the channel. + 120: Media streams decryption fails. The user might use an incorrect password to join the channel. Check the entered password, or tell the user to try rejoining the channel. 121: The user ID is invalid. - + + + 122: Data streams decryption fails. The user might use an incorrect password to join the channel. Check the entered password, or tell the user to try rejoining the channel. + + 123: The user is banned from the server. diff --git a/en-US/dita/RTC-NG/API/enum_localaudiostreamreason.dita b/en-US/dita/RTC-NG/API/enum_localaudiostreamreason.dita index f3d2a64ccdf..e3afa6a9d60 100644 --- a/en-US/dita/RTC-NG/API/enum_localaudiostreamreason.dita +++ b/en-US/dita/RTC-NG/API/enum_localaudiostreamreason.dita @@ -39,24 +39,24 @@ - 6: (Windows and macOS only) No local audio capture device. Remind your users to check whether the microphone is connected to the device properly in the control plane of the device or if the microphone is working properly. + 6: (Windows and macOS only) No local audio capture device. Remind your users to check whether the microphone is connected to the device properly in the control panel of the device or if the microphone is working properly. - 7: (Windows and macOS only) No local audio capture device. Remind your users to check whether the speaker is connected to the device properly in the control plane of the device or if the speaker is working properly. + 7: (Windows and macOS only) No local audio capture device. Remind your users to check whether the speaker is connected to the device properly in the control panel of the device or if the speaker is working properly. - 8: (Android and iOS only) The local audio capture is interrupted by a system call, Siri, or alarm clock. Remind your users to end the phone call, Siri, or alarm clock if the local audio capture is required. + 8: (Android and iOS only) The local audio capture is interrupted by a system call, smart assistants, or alarm clock. Prompt your users to end the phone call, smart assistants, or alarm clock if the local audio capture is required. Reserved. - 9: (Windows only) The ID of the local audio-capture device is invalid. Check the audio capture device ID. + 9: (Windows only) The ID of the local audio-capture device is invalid. Prompt the user to check the audio capture device ID. - 10: (Windows only) The ID of the local audio-playback device is invalid. Check the audio playback device ID. + 10: (Windows only) The ID of the local audio-playback device is invalid. Prompt the user to check the audio playback device ID. diff --git a/en-US/dita/RTC-NG/API/enum_localvideostreamreason.dita b/en-US/dita/RTC-NG/API/enum_localvideostreamreason.dita index 34027a33e9d..351b0d58e63 100644 --- a/en-US/dita/RTC-NG/API/enum_localvideostreamreason.dita +++ b/en-US/dita/RTC-NG/API/enum_localvideostreamreason.dita @@ -17,20 +17,20 @@ - 2: No permission to use the local video capturing device. Remind the user to grant permissions and rejoin the channel.
        + 2: No permission to use the local video capturing device. Prompt the user to grant permissions and rejoin the channel.
        Deprecated:
        -
        This enumerator is deprecated. Please use in the callback instead.
        +
        This enumerator is deprecated. Please use in the callback instead.
        - 3: The local video capturing device is in use. Remind the user to check whether another application occupies the camera. + 3: The local video capturing device is in use. Prompt the user to check if the camera is being used by another app, or try to rejoin the channel. - 4: The local video capture fails. Remind your user to check whether the video capture device is working properly, whether the camera is occupied by another application, or try to rejoin the channel. + 4: The local video capture fails. Prompt the user to check whether the video capture device is working properly, whether the camera is used by another app, or try to rejoin the channel. @@ -38,12 +38,12 @@ - 6: (iOS only) The app is in the background. Remind the user that video capture cannot be performed normally when the app is in the background. + 6: (iOS only) The app is in the background. Prompt the user that video capture cannot be performed normally when the app is in the background. 6: Reserved. - 7: (iOS only) The current application window is running in Slide Over, Split View, or Picture in Picture mode, and another app is occupying the camera. Remind the user that the application cannot capture video properly when the app is running in Slide Over, Split View, or Picture in Picture mode and another app is occupying the camera. + 7: (iOS only) The current app window is running in Slide Over, Split View, or Picture in Picture mode, and another app is occupying the camera. Prompt the user that the app cannot capture video properly when it is running in Slide Over, Split View, or Picture in Picture mode and another app is occupying the camera. 7: Reserved. @@ -61,7 +61,7 @@ - 11: (macOS and Windows only) The shared windows is minimized when you call the method to share a window. The SDK cannot share a minimized window. You can cancel the minimization of this window at the application layer, for example by maximizing this window. + 11: (macOS and Windows only) The shared window is minimized when you call the method to share a window. The SDK cannot share a minimized window. Please prompt the user to unminimize the shared window. 11: Reserved. @@ -69,7 +69,7 @@

        12: (macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing.

        Common scenarios reporting this error code:

          -
        • When the local user closes the shared window, the SDK reports this error code.
          • +
        • The local user closes the shared window.
        • The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.
        • The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.

        @@ -79,9 +79,20 @@ 13: (Windows only) The window being shared is overlapped by another window, so the overlapped area is blacked out by the SDK during window sharing.         + + + 14: (Android only) Video capture is interrupted. Possible reasons include the following:
          +
        • The camera is being used by another app. Prompt the user to check if the camera is being used by another app.
          • +
        • The current app has been switched to the background. You can use foreground services to notify the operating system and ensure that the app can still collect video when it switches to the background. See .
          • +
        +         + + + 15: (Android only) The video capture device encounters an error. Prompt the user to close and restart the camera to restore functionality. If this operation does not solve the problem, check if the camera has a hardware failure. + - 20: (Windows only) The SDK does not support sharing this type of window. + 20: (Windows only) The SDK does not support sharing this type of window. Prompt the user that this type of window sharing is not supported. Try sharing the entire screen instead. @@ -103,9 +114,9 @@ 26: (Windows only) The window for screen capture has been restored from hidden state. - + - 27: (Windows only) The window for screen capture has been restored from minimized state. + 27: (macOS and Windows only) The window for screen capture has been restored from the minimized state. diff --git a/en-US/dita/RTC-NG/API/enum_mediasourcetype.dita b/en-US/dita/RTC-NG/API/enum_mediasourcetype.dita index 9517166baf0..87da0f338b8 100644 --- a/en-US/dita/RTC-NG/API/enum_mediasourcetype.dita +++ b/en-US/dita/RTC-NG/API/enum_mediasourcetype.dita @@ -25,7 +25,11 @@ - 6. Custom video source. + 6: Custom video source. + + + + 13: Video processed by the speech driven extension. diff --git a/en-US/dita/RTC-NG/API/enum_videocodectype.dita b/en-US/dita/RTC-NG/API/enum_videocodectype.dita index 981db9a938b..54eb805e99e 100644 --- a/en-US/dita/RTC-NG/API/enum_videocodectype.dita +++ b/en-US/dita/RTC-NG/API/enum_videocodectype.dita @@ -30,6 +30,10 @@

        This type is used for transmitting raw video data, such as encrypted video frames. The SDK returns this type of video frames in callbacks, and you need to decode and render the frames yourself.

         + + + 12：AV1. + 20: Generic JPEG.

        This type consumes minimum computing resources and applies to IoT devices.

        diff --git a/en-US/dita/RTC-NG/API/enum_videosourcetype.dita b/en-US/dita/RTC-NG/API/enum_videosourcetype.dita index a818a8ed65c..ccf81f825f9 100644 --- a/en-US/dita/RTC-NG/API/enum_videosourcetype.dita +++ b/en-US/dita/RTC-NG/API/enum_videosourcetype.dita @@ -59,13 +59,13 @@ 10: One transcoded video source.         - + - 11: (For Windows and macOS only) The third camera. + 11: (For Android, Windows, and macOS only) (For Android only) The third camera. - + - 12: (For Windows and macOS only) The fourth camera. + 12: (For Android, Windows, and macOS only) (For Android only) The fourth camera. @@ -75,6 +75,10 @@ 14: (For Windows and macOS only) The fourth screen. + + + 15: Video processed by the speech driven extension. + 100: An unknown video source. diff --git a/en-US/dita/RTC-NG/API/rtc_api_data_type.dita b/en-US/dita/RTC-NG/API/rtc_api_data_type.dita index a8a61bfdf18..f2ddf563d38 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_data_type.dita @@ -41,6 +41,7 @@
        • +
        • @@ -170,6 +171,7 @@
        • +
        • @@ -1059,6 +1061,8 @@
        • +
        • +
        • @@ -1187,6 +1191,7 @@
        • +
        • @@ -1244,6 +1249,7 @@
        • +
        • diff --git a/en-US/dita/RTC-NG/API/rtc_api_overview.dita b/en-US/dita/RTC-NG/API/rtc_api_overview.dita index 1b7894e0272..29cdb90ede9 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_overview.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_overview.dita @@ -681,8 +681,8 @@ - - + + @@ -871,6 +871,10 @@ + + + (For iOS only) +
        @@ -1025,6 +1029,14 @@ + + + (For iOS and macOS only) + + + + (For iOS and macOS only) + @@ -1049,6 +1061,14 @@ + + + + + + + +
        @@ -1339,6 +1359,10 @@ + + + + @@ -2028,6 +2052,14 @@ + + + + + + + + @@ -2040,6 +2072,14 @@ + + + + + + + + @@ -2167,6 +2207,10 @@ (For Android and iOS only) + + + + (For Android and iOS only) @@ -2243,6 +2287,10 @@ (For Android and iOS only) + + + (For Android and iOS only) + @@ -2372,6 +2420,10 @@ (For Windows and macOS only) + + + (For macOS only) + (For Windows and macOS only) @@ -2404,6 +2456,10 @@ (For Windows and macOS only) + + + (For macOS only) + (For Windows and macOS only) @@ -2448,10 +2504,18 @@ (For Windows and macOS only) + + + (For macOS only) + (For Windows and macOS only) + + + (For macOS only) + (For Windows and macOS only) @@ -2613,6 +2677,10 @@ + + + + @@ -2673,6 +2741,10 @@ + + + +