@byteplus/react-native-rtc 1.0.0 → 1.0.2

package/lib/typescript/codegen/pack/errorcode.d.ts

@@ -194,35 +194,35 @@ export declare enum SubtitleErrorCode {
 export declare enum ErrorCode {
     /** {en}
      * @platform android
-     * @brief Token  is invalid. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}. <br>
+     * @brief Token  is invalid. Returned by {@link onRoomStateChanged onRoomStateChanged}. <br>
      *        The token used when entering the room is invalid or expired. The user is required to retrieve the token and call the `updateToken` method to update the token.
      *
      */
     ERROR_CODE_INVALID_TOKEN = 0,
     /** {en}
      * @platform android
-     * @brief Join room error. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}. <br>
+     * @brief Join room error. Returned by {@link onRoomStateChanged onRoomStateChanged}. <br>
      * An unknown error occurred while entering the room, which caused the joining room to fail. Users are required to rejoin the room.
      *
      */
     ERROR_CODE_JOIN_ROOM = 1,
     /** {en}
      * @platform android
-     * @brief No permission to publish audio & video streams. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}. <br>
+     * @brief No permission to publish audio & video streams. Returned by {@link onRoomStateChanged onRoomStateChanged}. <br>
      *        The user failed to publish the audio & video stream in the room. The reason for the failure is that the user does not have permission to publish the stream.
      *
      */
     ERROR_CODE_NO_PUBLISH_PERMISSION = 2,
     /** {en}
      * @platform android
-     * @brief No subscription permissions for audio & video streams. Returned by onStreamStateChanged{@link #IRTCRoomEventHandler#onStreamStateChanged}. <br>
+     * @brief No subscription permissions for audio & video streams. Returned by {@link onStreamStateChanged onStreamStateChanged}. <br>
      *        The user failed to subscribe to the audio & video stream in the room where the user is located. The reason for the failure is that the user does not have permission to subscribe to the stream.
      *
      */
     ERROR_CODE_NO_SUBSCRIBE_PERMISSION = 3,
     /** {en}
      * @platform android
-     * @brief The user has been removed from the room because the same user joined the room on the other client. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
+     * @brief The user has been removed from the room because the same user joined the room on the other client. Returned by {@link onRoomStateChanged onRoomStateChanged}.
      *
      */
     ERROR_CODE_DUPLICATE_LOGIN = 4,
@@ -235,69 +235,69 @@ export declare enum ErrorCode {
     ERROR_CODE_APP_ID_NULL = 5,
     /** {en}
      * @platform android
-     * @brief The user has been remove from the room by the administrator via a OpenAPI call. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
+     * @brief The user has been remove from the room by the administrator via a OpenAPI call. Returned by {@link onRoomStateChanged onRoomStateChanged}.
      *
      */
     ERROR_CODE_KICKED_OUT = 6,
     /** {en}
      * @platform android
-     * @brief When calling `createRoom`, if the roomId is illegal, it will return null and throw the error. Returned by onCreateRoomStateChanged{@link #IRTCVideoEventHandler#onCreateRoomStateChanged}.
+     * @brief When calling `createRoom`, if the roomId is illegal, it will return null and throw the error. Returned by {@link onCreateRoomStateChanged onCreateRoomStateChanged}.
      *
      */
     ERROR_CODE_ROOM_ID_ILLEGAL = 7,
     /** {en}
      * @platform android
-     * @brief Token expired. Call `joinRoom` to rejoin with a valid Token. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
+     * @brief Token expired. Call `joinRoom` to rejoin with a valid Token. Returned by {@link onRoomStateChanged onRoomStateChanged}.
      *
      */
     ERROR_CODE_TOKEN_EXPIRED = 8,
     /** {en}
      * @platform android
-     * @brief The Token you provided when calling `updateToken` is invalid. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
+     * @brief The Token you provided when calling `updateToken` is invalid. Returned by {@link onRoomStateChanged onRoomStateChanged}.
      *
      */
     ERROR_CODE_UPDATE_TOKEN_WITH_INVALID_TOKEN = 9,
     /** {en}
      * @platform android
-     * @brief Users have been removed from the room because the administrator dismissed the room by calling OpenAPI. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
+     * @brief Users have been removed from the room because the administrator dismissed the room by calling OpenAPI. Returned by {@link onRoomStateChanged onRoomStateChanged}.
      *
      */
     ERROR_CODE_ROOM_DISMISS = 10,
     /** {en}
      * @platform android
-     * @brief A room with the same roomId already exists during the call echo test. Returned by onCreateRoomStateChanged{@link #IRTCVideoEventHandler#onCreateRoomStateChanged}.
+     * @brief A room with the same roomId already exists during the call echo test. Returned by {@link onCreateRoomStateChanged onCreateRoomStateChanged}.
      *
      */
     ERROR_CODE_ROOM_ALREADY_EXIST = 12,
     /** {en}
      * @platform android
-     * @brief The local user joins multiple rooms with different uid. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}. <br>
+     * @brief The local user joins multiple rooms with different uid. Returned by {@link onRoomStateChanged onRoomStateChanged}. <br>
      *        In the same engine instance, users need to use the same uid to join different rooms.
      *
      */
     ERROR_CODE_USER_ID_DIFFERENT = 13,
     /** {en}
      * @platform android
-     * @brief The room has banned before the user calls `joinRoom`. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
+     * @brief The room has banned before the user calls `joinRoom`. Returned by {@link onRoomStateChanged onRoomStateChanged}.
      *
      */
     ERROR_CODE_JOIN_ROOM_ROOM_FORBIDDEN = 22,
     /** {en}
      * @platform android
-     * @brief The user has banned before calling `joinRoom`. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
+     * @brief The user has banned before calling `joinRoom`. Returned by {@link onRoomStateChanged onRoomStateChanged}.
      *
      */
     ERROR_CODE_JOIN_ROOM_USER_FORBIDDEN = 23,
     /** {en}
      * @platform android
-     * @brief Failed to subscribe to streams because the total number of subscribed streams has exceeded the upper limit. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}. <br>
+     * @brief Failed to subscribe to streams because the total number of subscribed streams has exceeded the upper limit. Returned by {@link onRoomStateChanged onRoomStateChanged}. <br>
      *        In order to ensure the performance and quality of audio & video calls in the game scenario, the server will limit the total number of audio & video streams subscribed by the user. When the total number of audio & video streams subscribed by the user has reached the maximum, continuing to subscribe to more streams will fail, and the user will receive this error notification.
      *
      */
     ERROR_CODE_OVER_SUBSCRIBE_LIMIT = 25,
     /** {en}
      * @platform android
-     * @brief Failed to publish video stream because the total number of published streams has exceeded the upper limit. Returned by onStreamStateChanged{@link #IRTCRoomEventHandler#onStreamStateChanged}. <br>
+     * @brief Failed to publish video stream because the total number of published streams has exceeded the upper limit. Returned by {@link onStreamStateChanged onStreamStateChanged}. <br>
      *        RTC will limit the total number of streams published in a single room, including video, audio, and screen streams. Local users will fail to publish streams to the room when the maximum number of published streams in the room has been reached, and will receive this error notification.
      *
      */
@@ -307,13 +307,13 @@ export declare enum ErrorCode {
      * @brief A/V synchronization failed. <br>
      *        Current source audio ID has been set by other video publishers in the same room. <br>
      *        One single audio source cannot be synchronized with multiple video sources at the same time. <br>
-     *        Returned by onStreamStateChanged{@link #IRTCRoomEventHandler#onStreamStateChanged}.
+     *        Returned by {@link onStreamStateChanged onStreamStateChanged}.
      *
      */
     ERROR_CODE_INVALID_AUDIO_SYNC_USERID_REPEATED = 28,
     /** {en}
      * @platform android
-     * @brief The user has been removed from the room due to the abnormal status of server. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}. <br>
+     * @brief The user has been removed from the room due to the abnormal status of server. Returned by {@link onRoomStateChanged onRoomStateChanged}. <br>
      *        SDK  is disconnected with the signaling server. It will not reconnect automatically. Please contact technical support.
      *
      */
@@ -359,35 +359,35 @@ export declare enum ErrorCode {
 export declare enum WarningCode {
     /** {en}
      * @platform android
-     * @brief Failed to enter the room. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}. <br>
+     * @brief Failed to enter the room. Returned by {@link onRoomStateChanged onRoomStateChanged}. <br>
      *        When you enter the room for the first time or disconnect and reconnect due to poor network condition, the room entry failed due to a server error. The SDK automatically retries to join the room.
      *
      */
     WARNING_CODE_JOIN_ROOM_FAILED = 0,
     /** {en}
      * @platform android
-     * @brief Release audio & video stream failed. Returned by onStreamStateChanged{@link #IRTCRoomEventHandler#onStreamStateChanged}. <br>
+     * @brief Release audio & video stream failed. Returned by {@link onStreamStateChanged onStreamStateChanged}. <br>
      *        When you publish audio & video streams in your room, the publication fails due to a server error. The SDK automatically retries the release.
      *
      */
     WARNING_CODE_PUBLISH_STREAM_FAILED = 1,
     /** {en}
      * @platform android
-     * @brief Subscription to audio & video stream failed. Returned by onStreamStateChanged{@link #IRTCRoomEventHandler#onStreamStateChanged}. <br>
+     * @brief Subscription to audio & video stream failed. Returned by {@link onStreamStateChanged onStreamStateChanged}. <br>
      *         The subscription failed because the audio & video stream for the subscription could not be found in the current room. The SDK will automatically retry the subscription. If the subscription fails, it is recommended that you exit the retry.
      *
      */
     WARNING_CODE_SUBSCRIBE_STREAM_FAILED404 = 2,
     /** {en}
      * @platform android
-     * @brief Subscription to audio & video stream failed. Returned by onStreamStateChanged{@link #IRTCRoomEventHandler#onStreamStateChanged}. <br>
+     * @brief Subscription to audio & video stream failed. Returned by {@link onStreamStateChanged onStreamStateChanged}. <br>
      *        When you subscribe to audio & video streams in your room, the subscription fails due to a server error. The SDK automatically retries the subscription.
      *
      */
     WARNING_CODE_SUBSCRIBE_STREAM_FAILED5XX = 3,
     /** {en}
      * @platform android
-     * @brief This warning is triggered when a call to `setUserVisibility` sets its own visibility to false and then attempts to publish the flow. Returned by onStreamStateChanged{@link #IRTCRoomEventHandler#onStreamStateChanged}.
+     * @brief This warning is triggered when a call to `setUserVisibility` sets its own visibility to false and then attempts to publish the flow. Returned by {@link onStreamStateChanged onStreamStateChanged}.
      *
      */
     WARNING_CODE_PUBLISH_STREAM_FORBIDEN = 6,
@@ -399,19 +399,19 @@ export declare enum WarningCode {
     WARNING_CODE_SEND_CUSTOM_MESSAGE = 7,
     /** {en}
      * @platform android
-     * @brief When the number of people in the room exceeds 500, stop sending `onUserJoined` and `onUserLeave` callbacks to existing users in the room, and prompt all users in the room via broadcast. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
+     * @brief When the number of people in the room exceeds 500, stop sending `onUserJoined` and `onUserLeave` callbacks to existing users in the room, and prompt all users in the room via broadcast. Returned by {@link onRoomStateChanged onRoomStateChanged}.
      *
      */
     WARNING_CODE_RECEIVE_USER_NOTIFY_STOP = 8,
     /** {en}
      * @platform android
-     * @brief User had published in other room. Returned by onStreamStateChanged{@link #IRTCRoomEventHandler#onStreamStateChanged}.
+     * @brief User had published in other room. Returned by {@link onStreamStateChanged onStreamStateChanged}.
      *
      */
     WARNING_CODE_USER_IN_PUBLISH = 9,
     /** {en}
      * @platform android
-     * @brief A room with the same roomId already exists. The newly created room instance has replaced the old one. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
+     * @brief A room with the same roomId already exists. The newly created room instance has replaced the old one. Returned by {@link onRoomStateChanged onRoomStateChanged}.
      *
      */
     WARNING_CODE_OLD_ROOM_BEEN_REPLACED = 10,
@@ -429,13 +429,13 @@ export declare enum WarningCode {
     WARNING_CODE_NO_CAMERA_PERMISSION = 12,
     /** {en}
      * @platform android
-     * @brief Setting the screen audio capture type by calling setScreenAudioSourceType{@link #RTCVideo#setScreenAudioSourceType} after publishScreen{@link #RTCRoom#publishScreen} is not supported.
+     * @brief Setting the screen audio capture type by calling {@link setScreenAudioSourceType setScreenAudioSourceType} after {@link publishScreen publishScreen} is not supported.
      *
      */
     WARNING_CODE_SET_SCREEN_AUDIO_SOURCE_TYPE_FAILED = 13,
     /** {en}
      * @platform android
-     * @brief After publishScreen{@link #RTCRoom#publishScreen}, calling setScreenAudioStreamIndex{@link #RTCVideo#setScreenAudioStreamIndex} to set the screen audio share publication type is not supported
+     * @brief After {@link publishScreen publishScreen}, calling {@link setScreenAudioStreamIndex setScreenAudioStreamIndex} to set the screen audio share publication type is not supported
      *
      */
     WARNING_CODE_SET_SCREEN_STREAM_INDEX_FAILED = 14,
@@ -489,7 +489,7 @@ export declare enum WarningCode {
      * @platform android
      * @deprecated since 3.45 and will be deleted in 3.51.
      * @brief When automatic subscription mode is not turned off, trying to turn on manual subscription mode will trigger this warning. <br>
-     *        You need to turn off the automatic subscription mode before entering the room, and then call the subscribeUserStream{@link #RTCRoom#subscribeUserStream} method to manually subscribe to the audio & video stream.
+     *        You need to turn off the automatic subscription mode before entering the room, and then call the {@link subscribeUserStream subscribeUserStream} method to manually subscribe to the audio & video stream.
      *
      */
     WARNING_CODE_SUBSCRIBE_STREAM_FORBIDEN = 22,
@@ -503,7 +503,7 @@ export declare enum WarningCode {
     /** {en}
      * @platform android
      * @brief The microphone permission is abnormal, and the current application does not obtain microphone permission.
-     * @deprecated since 3.45 and will be deleted in 3.51, use MediaDeviceError{@link #MediaDeviceError}.MEDIA_DEVICE_ERROR_NOPERMISSION instead.
+     * @deprecated since 3.45 and will be deleted in 3.51, use {@link MediaDeviceError MediaDeviceError}.MEDIA_DEVICE_ERROR_NOPERMISSION instead.
      *
      */
     WARNING_CODE_NO_MICROPHONE_PERMISSION = 24,
@@ -511,7 +511,7 @@ export declare enum WarningCode {
      * @platform android
      * @brief The audio capture device failed to start. <br>
      *        Failed to start the audio capture device, the current device may be occupied by other applications.
-     * @deprecated since 3.45 and will be deleted in 3.51, use MediaDeviceError{@link #MediaDeviceError}.MEDIA_DEVICE_ERROR_DEVICEFAILURE instead.
+     * @deprecated since 3.45 and will be deleted in 3.51, use {@link MediaDeviceError MediaDeviceError}.MEDIA_DEVICE_ERROR_DEVICEFAILURE instead.
      *
      */
     WARNING_CODE_RECODING_DEVICE_START_FAILED = 25,
@@ -519,7 +519,7 @@ export declare enum WarningCode {
      * @platform android
      * @brief Audio playback device startup failure warning. <br>
      *        It may be due to insufficient system resources or wrong parameters.
-     * @deprecated since 3.45 and will be deleted in 3.51, use MediaDeviceError{@link #MediaDeviceError}.MEDIA_DEVICE_ERROR_DEVICEFAILURE instead.
+     * @deprecated since 3.45 and will be deleted in 3.51, use {@link MediaDeviceError MediaDeviceError}.MEDIA_DEVICE_ERROR_DEVICEFAILURE instead.
      *
      */
     WARNING_CODE_PLAYOUT_DEVICE_START_FAILED = 26,
@@ -527,7 +527,7 @@ export declare enum WarningCode {
      * @platform android
      * @brief No audio acquisition equipment available. <br>
      *        Failed to start the audio capture device, please insert the available audio capture device.
-     * @deprecated since 3.45 and will be deleted in 3.51, use MediaDeviceError{@link #MediaDeviceError}.MEDIA_DEVICE_ERROR_DEVICENOTFOUND instead.
+     * @deprecated since 3.45 and will be deleted in 3.51, use {@link MediaDeviceError MediaDeviceError}.MEDIA_DEVICE_ERROR_DEVICENOTFOUND instead.
      *
      */
     WARNING_CODE_NO_RECORDING_DEVICE = 27,
@@ -535,14 +535,14 @@ export declare enum WarningCode {
      * @platform android
      * @brief No audio playback device available. <br>
      *        Failed to start the audio playback device, please insert the available audio playback device.
-     * @deprecated since 3.45 and will be deleted in 3.51, use MediaDeviceError{@link #MediaDeviceError}.MEDIA_DEVICE_ERROR_DEVICENOTFOUND instead.
+     * @deprecated since 3.45 and will be deleted in 3.51, use {@link MediaDeviceError MediaDeviceError}.MEDIA_DEVICE_ERROR_DEVICENOTFOUND instead.
      *
      */
     WARNING_CODE_NO_PLAYOUT_DEVICE = 28,
     /** {en}
      * @platform android
      * @brief The current audio equipment has not collected valid sound data, please check and replace the audio acquisition equipment.
-     * @deprecated since 3.45 and will be deleted in 3.51, use MediaDeviceWarning{@link #MediaDeviceWarning}.MEDIA_DEVICE_WARNING_CAPTURE_SILENCE instead.
+     * @deprecated since 3.45 and will be deleted in 3.51, use {@link MediaDeviceWarning MediaDeviceWarning}.MEDIA_DEVICE_WARNING_CAPTURE_SILENCE instead.
      *
      */
     WARNING_CODE_RECORDING_SILENCE = 29,
@@ -550,7 +550,7 @@ export declare enum WarningCode {
      * @platform android
      * @brief Media device misoperation warning. <br>
      *        When using custom acquisition, the internal acquisition switch cannot be called, and this warning will be triggered when called.
-     * @deprecated since 3.45 and will be deleted in 3.51, use MediaDeviceWarning{@link #MediaDeviceWarning}.MEDIA_DEVICE_WARNING_OPERATION_DENIED instead.
+     * @deprecated since 3.45 and will be deleted in 3.51, use {@link MediaDeviceWarning MediaDeviceWarning}.MEDIA_DEVICE_WARNING_OPERATION_DENIED instead.
      *
      */
     WARNING_CODE_MEDIA_DEVICE_OPERATION_DENIED = 30,