@byteplus/react-native-live-pull 1.1.3-rc.3 → 1.2.0-rc.0

package/lib/typescript/codegen/android/api.d.ts

@@ -1,5 +1,5 @@
 import { String, SurfaceHolder, Surface, float, Map, List, int } from './types';
-import { VeLivePlayerLogLevel, VeLivePlayerConfiguration, VeLivePlayerFillMode, VeLivePlayerStreamData, VeLivePlayerResolution, VeLivePlayerPixelFormat, VeLivePlayerVideoBufferType, VeLivePlayerRotation, VeLivePlayerMirror } from './keytype';
+import { VeLivePlayerLogLevel, VeLivePlayerConfiguration, VeLivePlayerFillMode, VeLivePlayerStreamData, VeLivePlayerResolution, VeLivePlayerPixelFormat, VeLivePlayerVideoBufferType, VeLivePlayerAudioBufferType, VeLivePlayerRotation, VeLivePlayerMirror } from './keytype';
 import { VeLivePlayerObserver } from './callback';
 import { ApplicationContext } from './external';
 export declare class VeLivePlayer {
@@ -29,7 +29,7 @@ export declare class VeLivePlayer {
      * @brief  Initializes the player and configures whether to turn on SEI messaging, hardware decoding, local DNS prefetch, and other configurations.
      * @notes <br>Call this method to initialize the player before calling [play](#VeLivePlayer-play) .
      * @order 1
-     * @param config Player configurations. Refer to VeLivePlayerConfiguration {@link #VeLivePlayerConfiguration} for details.
+     * @param config Player configurations. Refer to VeLivePlayerConfiguration{@link #VeLivePlayerConfiguration} for details.
      *
      */
     setConfig(config: VeLivePlayerConfiguration): void;
@@ -37,9 +37,9 @@ export declare class VeLivePlayer {
     /** {en}
      * @detail api
      * @brief  Sets the player observer to listen to the live player's events, such as playback errors or status updates, rendering of the first audio and video frame, and resolution switching.
-     * @notes  <br>
-     *      Call this method before calling play {@link #play}.
-     * @param observer The player observer. See VeLivePlayerObserver {@link #VeLivePlayerObserver} for details.
+     * @notes
+     *        Call this method before calling [play](#VeLivePlayer-play).
+     * @param observer The player observer. See VeLivePlayerObserver{@link #VeLivePlayerObserver} for details.
      * @order 2
      *
      */
@@ -52,7 +52,7 @@ export declare class VeLivePlayer {
      *        - Call this method before calling [play](#VeLivePlayer-play) to set the initial fill mode of the player.
      *        - You can call this method during playback to dynamically adjust the fill mode.
      * @order 3
-     * @param fillMode The fill mode of SurfaceView. The default value is `VeLivePlayerFillModeAspectFill`. For details, see VeLivePlayerFillMode {@link #VeLivePlayerFillMode}.
+     * @param fillMode The fill mode of SurfaceView. The default value is `VeLivePlayerFillModeAspectFill`. For details, see VeLivePlayerFillMode{@link #VeLivePlayerFillMode}.
      *
      */
     setRenderFillMode(fillMode: VeLivePlayerFillMode): Promise<void>;
@@ -60,8 +60,8 @@ export declare class VeLivePlayer {
     /** {en}
      * @detail api
      * @brief Sets the `SurfaceHolder` object for video rendering and playback. Use this method if you use `SurfaceView` for playback.
-     * @notes  <br>
-     *     If you call both `setSurfaceHolder` and setSurface {@link #setSurface} to set the `Surface` object, the player will prioritize the configurations of `surfaceHolder`.
+     * @notes
+     *        If you call both setSurfaceHolder and [setSurface](#VeLivePlayer-setsurface) to set the `Surface` object, the player will prioritize the configurations of `surfaceHolder`.
      * @param surfaceHolder The `SurfaceHolder` object.
      * @order 6
      *
@@ -71,8 +71,8 @@ export declare class VeLivePlayer {
     /** {en}
      * @detail api
      * @brief Sets the `Surface` object for video rendering and playback. Use this method if you use `SurfaceView` or `TextureView` for playback.
-     * @notes  <br>
-     *     If you call both setSurfaceHolder {@link #setSurfaceHolder} and `setSurface` to set the `Surface` object, the player will prioritize the configurations of `surfaceHolder`.
+     * @notes
+     *        If you call both [setSurfaceHolder](#VeLivePlayer-setsurfaceholder) and `setSurface` to set the `Surface` object, the player will prioritize the configurations of `surfaceHolder`.
      * @param surface The `Surface` object.
      * @order 7
      *
@@ -94,7 +94,7 @@ export declare class VeLivePlayer {
      * @brief Sets multiple live streams. Call this method if you need to enable features requiring multiple live streams, such as adaptive bitrate (ABR), manual resolution switching, and primary and backup streams.
      * @notes <br>Call this method before calling play.
      * @order 8
-     * @param streamData Configurations for multiple pull stream addresses. For details, see VeLivePlayerStreamData {@link #VeLivePlayerStreamData}.
+     * @param streamData Configurations for multiple pull stream addresses. For details, see [VeLivePlayerStreamData](player-android-api-keytype#VeLivePlayerStreamData).
      *
      */
     setPlayStreamData(streamData: VeLivePlayerStreamData): void;
@@ -102,8 +102,8 @@ export declare class VeLivePlayer {
     /** {en}
      * @detail api
      * @brief Starts or resumes playback.
-     * @notes  <br>
-     *     After you call this method, the onPlayerStatusUpdate {@link #VeLivePlayerObserver #onPlayerStatusUpdate} callback is triggered both when the player finishes preparing for stream pulling and when the first frame is rendered.
+     * @notes
+     *        After you call this method, the [onPlayerStatusUpdate](docs-player-android-api-callback#VeLivePlayerObserver-onplayerstatusupdate) callback is triggered both when the player finishes preparing for stream pulling and when the first frame is rendered.
      * @order 8
      *
      */
@@ -112,8 +112,8 @@ export declare class VeLivePlayer {
     /** {en}
      * @detail api
      * @brief Pauses playback.
-     * @notes  <br>
-     *     When playback is paused after you call this method, the onPlayerStatusUpdate {@link #VeLivePlayerObserver #onPlayerStatusUpdate} callback is triggered.
+     * @notes
+     *        When playback is paused after you call this method, the [onPlayerStatusUpdate](docs-player-android-api-callback#VeLivePlayerObserver-onplayerstatusupdate) callback is triggered.
      * @order 8
      *
      */
@@ -122,8 +122,8 @@ export declare class VeLivePlayer {
     /** {en}
      * @detail api
      * @brief Stops playback. This method does not destroy the player.
-     * @notes  <br>
-     *     When playback stops after you call this method, the onPlayerStatusUpdate {@link #VeLivePlayerObserver #onPlayerStatusUpdate} callback is triggered.
+     * @notes
+     *        When playback stops after you call this method, the [onPlayerStatusUpdate](docs-player-android-api-callback#VeLivePlayerObserver-onplayerstatusupdate) callback is triggered.
      * @order 8
      *
      */
@@ -141,12 +141,12 @@ export declare class VeLivePlayer {
      * @detail api
      * @brief Changes the video resolution.
      * @notes - Call [setPlayStreamData](#VeLivePlayer-setplaystreamdata) to set multiple resolutions before calling this method.
-     *        - Once the player switches to the new resolution after you call this method, the [onResolutionSwitch](player-android-api-callback#VeLivePlayerObserver-onresolutionswitch) callback is triggered.
+     *        - Once the player switches to the new resolution after you call this method, the [onResolutionSwitch](docs-player-android-api-callback#VeLivePlayerObserver-onresolutionswitch) callback is triggered.
+     * @order 8
+     * @param resolution The video resolution. For details, refer to VeLivePlayerResolution
      * @return <br>
      *     - true: Success;
      *     - false: Failure.
-     * @order 8
-     * @param resolution The video resolution. For details, refer to VeLivePlayerResolution {@link #VeLivePlayerResolution}.
      *
      */
     switchResolution(resolution: VeLivePlayerResolution): boolean;
@@ -198,13 +198,15 @@ export declare class VeLivePlayer {
      * @brief Sets the mapping of domain names to server IP addresses.
      * @param hostIpMap The mapping of domain names to server IP addresses. The `Map` object uses the domain name as the key, and the corresponding value is a list of IP addresses for the servers associated with that domain. The value is of the `List` type.
      * @order 11
+     * @notes - When using setUrlHostIP to map domain names and IP addresses, disable the DNS pre-resolution feature in the initial configuration by setting [enableLiveDNS](docs-player-android-api-keytype#VeLivePlayerConfiguration-enablelivedns) to false.
+     *        - Call this method to set the mapping of domain names and IP addresses before calling [play](#VeLivePlayer-play) to start playback.
      *
      */
     setUrlHostIP(hostIpMap: Map<String, List<String>>): void;
     
     /** {en}
      * @detail api
-     * @brief Configures advanced settings for the player, including offscreen rendering, maximum buffer duration, and adaptive bitrate (ABR) algorithms. Contact BytePlus technical support if you need further information.
+     * @brief Configures advanced settings for the player, including offscreen rendering, maximum buffer duration, and adaptive bitrate (ABR) algorithms. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if you need further information.
      * @param key The parameter name of the advanced setting.
      * @param value The parameter value of the advanced setting.
      * @order 12
@@ -215,13 +217,13 @@ export declare class VeLivePlayer {
     /** {en}
      * @detail api
      * @brief Takes a screenshot of the video.
-     * @notes  <br>
-     *       - This method only takes effect during playback.
-     *       - When a screenshot is captured after you call this method, the onSnapshotComplete {@link #VeLivePlayerObserver #onSnapshotComplete} callback is triggered containing the Bitmap object of the screenshot.
-     * @return <br>
-     *         - 0: Screenshot capturing is allowed.
-     *         - [VeLivePlayerErrorRefused](player-android-api-errorcode#VeLivePlayerErrorCode-veliveplayererrorrefused) : Screenshot capturing is not allowed.
+     * @notes
+     *        - This method only takes effect during playback.
+     *        - When a screenshot is captured after you call this method, the [onSnapshotComplete](docs-player-android-api-callback#VeLivePlayerObserver-onsnapshotcomplete) callback is triggered containing the Bitmap object of the screenshot.
      * @order 13
+     * @return
+     *         - 0: Screenshot capturing is allowed.
+     *         - [VeLivePlayerErrorRefused](docs-player-android-api-errorcode#VeLivePlayerErrorCode-veliveplayererrorrefused) : Screenshot capturing is not allowed.
      *
      */
     snapshot(): int;
@@ -232,12 +234,12 @@ export declare class VeLivePlayer {
      * @param enable Whether to enable the video frame callback. The default value is `false`. <br>
      *                - true: Enable;
      *                - false: Disable.
-     * @param pixelFormat The pixel format of the video frame in the callback. See VeLivePlayerPixelFormat {@link #VeLivePlayerPixelFormat} for details.
-     * @param bufferType The encapsulation format of the video data in the callback. For details, see VeLivePlayerVideoBufferType {@link #VeLivePlayerVideoBufferType}.
-     * @notes  <br>
-     *       - You can call this method to subscribe to decoded video data for external rendering.
-     *       - After you call this method, the onRenderVideoFrame {@link #VeLivePlayerObserver #onRenderVideoFrame} callback is triggered once the SDK receives a video frame. The callback contains detailed information about the video frame.
-     *       - If you use external rendering, you need to make sure the video and audio are synchronized.
+     * @param pixelFormat The pixel format of the video frame in the callback. See VeLivePlayerPixelFormat{@link #VeLivePlayerPixelFormat} for details.
+     * @param bufferType The encapsulation format of the video data in the callback. For details, see VeLivePlayerVideoBufferType{@link #VeLivePlayerVideoBufferType}.
+     * @notes
+     *        - You can call this method to subscribe to decoded video data for external rendering.
+     *        - After you call this method, the [onRenderVideoFrame](docs-player-android-api-callback#VeLivePlayerObserver-onrendervideoframe) callback is triggered once the SDK receives a video frame. The callback contains detailed information about the video frame.
+     *        - If you use external rendering, you need to make sure the video and audio are synchronized.
      * @order 14
      *
      */
@@ -246,25 +248,27 @@ export declare class VeLivePlayer {
     /** {en}
      * @detail api
      * @brief Sets the audio frame observer.
-     * @notes <br>
+     * @notes
      *        - You can call this method to subscribe to decoded audio data if you want to use external rendering.
-     *        - After you call this method, the [onRenderAudioFrame](player-android-api-callback#VeLivePlayerObserver-onrenderaudioframe) callback is triggered once the SDK receives an audio frame. The callback contains detailed information about the audio frame.
+     *        - After you call this method, the [onRenderAudioFrame](docs-player-android-api-callback#VeLivePlayerObserver-onrenderaudioframe) callback is triggered once the SDK receives an audio frame. The callback contains detailed information about the audio frame.
      *        - If you use external rendering, you need to make sure the video and audio are synchronized.
      * @order 15
+     *
      * @param enable Whether to enable the audio frame callback. The default value is `false`. <br>
      *                - true: Enable;
      *                - false: Disable.
      * @param enableRendering Whether to enable player rendering. The default value is `false`. <br>
      *                         - true: Enable;
      *                         - false: Disable.
+     * @param bufferType Audio buffer type. For details, please refer to [VeLivePlayerAudioBufferType](docs-player-android-api-keytype#VeLivePlayerAudioBufferType).
      *
      */
-    enableAudioFrameObserver(enable: boolean, enableRendering: boolean): void;
+    enableAudioFrameObserver(enable: boolean, enableRendering: boolean, bufferType: VeLivePlayerAudioBufferType): void;
     
     /** {en}
      * @detail api
      * @brief Sets the clockwise rotation angle of the video.
-     * @param rotation The clockwise rotation angle of the video. Rotation is disabled by default. See VeLivePlayerRotation {@link #VeLivePlayerRotation} for details.
+     * @param rotation The clockwise rotation angle of the video. Rotation is disabled by default. See VeLivePlayerRotation{@link #VeLivePlayerRotation} for details.
      * @notes  <br>
      *       - You can change the rotation angle before and during playback.
      *       - Each time this method is called, the player rotates the video based on the original video.
@@ -277,7 +281,7 @@ export declare class VeLivePlayer {
     /** {en}
      * @detail api
      * @brief Configures mirroring settings.
-     * @param mirror Mirroring settings. Mirroring is disabled by default. See VeLivePlayerMirror {@link #VeLivePlayerMirror} for details.
+     * @param mirror Mirroring settings. Mirroring is disabled by default. See VeLivePlayerMirror{@link #VeLivePlayerMirror} for details.
      * @notes  <br>
      *       - You can change the mirroring settings before and during playback.
      *       - Each time this method is called, the player applies the mirroring settings to the original video.
@@ -289,11 +293,14 @@ export declare class VeLivePlayer {
     
     /** {en}
      * @detail api
-     * @brief Enables or disables super resolution. You must first contact the BytePlus [technical support](https://www.byteplus.com/en/support) to activate the feature before using it.
-     * @param enable Whether to enable super resolution.
-     * @notes <br>
-     *      - Call this method after receiving the onFirstVideoFrameRender{@link #VeLivePlayerObserver#onFirstVideoFrameRender} callback, or during playback.
-     *      - If the SDK fails to enable super resolution due to device model, video resolution or frame rate, you will receive the onStreamFailedOpenSuperResolution{@link #VeLivePlayerObserver#onStreamFailedOpenSuperResolution} callback.
+     * @brief Enables or disables super resolution. You must first contact BytePlus [technical support](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to activate the feature before using it.
+     * @param enable Whether to enable super resolution. The default value is false.
+     *        - true: enable;
+     *        - false: disable.
+     * @notes
+     *        - Call this method after receiving the [onFirstVideoFrameRender](docs-player-android-api-callback#VeLivePlayerObserver-onfirstvideoframerender) callback, or during playback.
+     *        - Support dynamically enabling and disabling super-resolution by calling this interface during playback.
+     *        - If the SDK fails to enable super resolution due to device model, video resolution or frame rate, you will receive the [onStreamFailedOpenSuperResolution](docs-player-android-api-callback#VeLivePlayerObserver-onstreamfailedopensuperresolution) callback.
      * @order 18
      *
      */
@@ -307,4 +314,5 @@ export declare class VeLivePlayer {
      *
      */
     setEnableSharpen(enable: boolean): void;
+    addExtraHttpRequestHeadersByUser(headers: Map): void;
 }

package/lib/typescript/codegen/android/callback.d.ts

@@ -4,37 +4,203 @@ import { long, int, String, Bitmap } from './types';
 import { VeLivePlayerResolution, VeLivePlayerResolutionSwitchReason, VeLivePlayerStreamType, VeLivePlayerStatus, VeLivePlayerStatistics, VeLivePlayerVideoFrame, VeLivePlayerAudioFrame } from './keytype';
 export declare class VeLivePlayerObserver {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a player error occurs.
+     * @param player The player object that triggers the callback function.
+     * @param error The error message. Refer to VeLivePlayerError{@link #VeLivePlayerError} for details.
+     * @order 1
+     *
+     */
     onError?(player: VeLivePlayer, error: VeLivePlayerError): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the first video frame is rendered at the beginning of playback or after a retry during playback.
+     * @param player The player object that triggers the callback function.
+     * @param isFirstFrame Whether the video frame is the first video frame rendered at the beginning of playback. <br>
+     *                      - true: The video frame is the first video frame rendered at the beginning of playback;
+     *                      - false: The video frame is the first video frame rendered after a retry during playback.
+     * @order 2
+     *
+     */
     onFirstVideoFrameRender?(player: VeLivePlayer, isFirstFrame: boolean): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the first audio frame is rendered at the beginning of playback or after a retry during playback.
+     * @param player The player object that triggers the callback function.
+     * @param isFirstFrame Whether the audio frame is the first audio frame rendered at the beginning of playback. <br>
+     *                      - true: The audio frame is the first audio frame rendered at the beginning of playback;
+     *                      - false: The audio frame is the first audio frame rendered after a retry during playback.
+     * @order 3
+     *
+     */
     onFirstAudioFrameRender?(player: VeLivePlayer, isFirstFrame: boolean): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a playback stutter starts.
+     * @param player The player object that triggers the callback function.
+     * @order 4
+     *
+     */
     onStallStart?(player: VeLivePlayer): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a playback stutter stops, that is, when playback resumes after there is enough audio buffer.
+     * @param player The player object that triggers the callback function.
+     * @order 5
+     *
+     */
     onStallEnd?(player: VeLivePlayer): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when video rendering stutters.
+     * @param player The player object that triggers the callback function.
+     * @param stallTime The stutter duration, in milliseconds.
+     * @order 6
+     *
+     */
     onVideoRenderStall?(player: VeLivePlayer, stallTime: long): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when audio rendering stutters.
+     * @param player The player object that triggers the callback function.
+     * @param stallTime The stutter duration, in milliseconds.
+     * @order 7
+     *
+     */
     onAudioRenderStall?(player: VeLivePlayer, stallTime: long): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the video resolution changes.
+     * @param player The player object that triggers the callback function.
+     * @param resolution The updated resolution. See [VeLivePlayerResolution](docs-player-android-api-keytype#VeLivePlayerResolution) for details.
+     * @param error Whether an error occurred during resolution switching. See VeLivePlayerError{@link #VeLivePlayerError} for details.
+     * @param reason The reason for resolution switching. See VeLivePlayerResolutionSwitchReason{@link #VeLivePlayerResolutionSwitchReason} for details.
+     * @order 8
+     *
+     */
     onResolutionSwitch?(player: VeLivePlayer, resolution: VeLivePlayerResolution, error: VeLivePlayerError, reason: VeLivePlayerResolutionSwitchReason): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the video size changes.
+     * @param player The player object that triggers the callback function.
+     * @param width The updated width of the video, in pixels.
+     * @param height The updated height of the video, in pixels.
+     * @order 9
+     *
+     */
     onVideoSizeChanged?(player: VeLivePlayer, width: int, height: int): void;
     
+    /** {en}
+     * @detail callback
+     * @brief String SEI message callback. This callback is triggered when the player SDK receives an SEI message. It is necessary to enable the `enableSei` property in `VeLivePlayerConfiguration`. When the `enableBinarySei` property is enabled, the string SEI message will no longer be sent.
+     * @param player The player object that triggers the callback function.
+     * @param message The SEI message.
+     * @order 10
+     *
+     */
     onReceiveSeiMessage?(player: VeLivePlayer, message: String): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Binary SEI message callback. This callback is triggered when the player SDK receives an SEI message. It is necessary to enable the `enableBinarySei` property in `VeLivePlayerConfiguration`. When the `enableBinarySei` property is enabled, the string SEI message will no longer be sent.
+     * @param player The player object that triggers the callback function.
+     * @param message The SEI message.
+     * @order 10
+     *
+     */
+    onReceiveBinarySeiMessage?(player: VeLivePlayer, message: ArrayBuffer): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the player switches between the primary stream and the backup stream.
+     * @param player The player object that triggers the callback function.
+     * @param streamType The type of the updated stream. For details, see VeLivePlayerStreamType{@link #VeLivePlayerStreamType}.
+     * @param error The reason for the switch. For details, see VeLivePlayerError{@link #VeLivePlayerError}.
+     * @order 11
+     *
+     */
     onMainBackupSwitch?(player: VeLivePlayer, streamType: VeLivePlayerStreamType, error: VeLivePlayerError): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the playback status changes.
+     * @param player The player object that triggers the callback function.
+     * @param status The updated status of the player. See VeLivePlayerStatus{@link #VeLivePlayerStatus} for details.
+     * @order 12
+     *
+     */
     onPlayerStatusUpdate?(player: VeLivePlayer, status: VeLivePlayerStatus): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs periodically to report information such as the current pull stream address, bitrate, and frame rate.
+     * @param player The player object that triggers the callback function.
+     * @param statistics The playback statistics. For details, see VeLivePlayerStatistics{@link #VeLivePlayerStatistics}.
+     * @order 13
+     *
+     */
     onStatistics?(player: VeLivePlayer, statistics: VeLivePlayerStatistics): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a screenshot is taken after snapshot{@link #VeLivePlayer#snapshot} is called.
+     * @param player The player object that triggers the callback function.
+     * @param bitmap The Bitmap object of the screenshot.
+     * @order 14
+     *
+     */
     onSnapshotComplete?(player: VeLivePlayer, bitmap: Bitmap): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the player decodes a video frame. Call [enableVideoFrameObserver](docs-player-android-api-reference#VeLivePlayer-enablevideoframeobserver) to enable video frame callback.
+     * @notes  <br>
+     *       If you use the texture format for external rendering, we recommend that you render the video in the callback thread.
+     * @order 15
+     * @param player The player object that triggers the callback function.
+     * @param videoFrame The video frame, including the pixel format, encapsulation format, width and height of the video, and other information. See VeLivePlayerVideoFrame{@link #VeLivePlayerVideoFrame} for details.
+     *
+     */
     onRenderVideoFrame?(player: VeLivePlayer, videoFrame: VeLivePlayerVideoFrame): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the player decodes an audio frame. Call enableAudioFrameObserver{@link #VeLivePlayer#enableAudioFrameObserver} to enable audio frame callback.
+     * @param player The player object that triggers the callback function.
+     * @param audioFrame The audio frame. See VeLivePlayerAudioFrame{@link #VeLivePlayerAudioFrame} for details.
+     * @notes  <br>
+     *      The audio data returned by the callback is of type Float32 and in big-endian byte order.
+     * @order 16
+     *
+     */
     onRenderAudioFrame?(player: VeLivePlayer, audioFrame: VeLivePlayerAudioFrame): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the SDK fails to enable super resolution after setEnableSuperResolution{@link #VeLivePlayer#setEnableSuperResolution} is called.
+     * @order 17
+     * @param player The player object that triggers the callback function.
+     * @param error The reason of the failure. See [VeLivePlayerErrorCode](docs-player-android-api-errorcode#VeLivePlayerErrorCode) for details.
+     *
+     */
     onStreamFailedOpenSuperResolution?(player: VeLivePlayer, error: VeLivePlayerError): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the SDK fails to enable sharpen after [setEnableSuperResolution](docs-player-android-api-reference#VeLivePlayer-setenablesuperresolution) is called.
+     * @param player The player object that triggers the callback function.
+     * @param error The reason of the failure. See [VeLivePlayerErrorCode](docs-player-android-api-errorcode#VeLivePlayerErrorCode) for details.
+     * @order 18
+     *
+     */
+    onStreamFailedOpenSharpen?(player: VeLivePlayer, error: VeLivePlayerError): void;
 }

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

@@ -1,53 +1,174 @@
 import { int, String } from './types';
 export declare class VeLivePlayerError {
-    constructor(errorCode: int, errorMsg: String);
-    constructor(errorCode: int);
+    constructor(errorCode: int, subCode: int, errorMsg: String);
     
+    /** {en}
+     * @brief The error code.
+     *
+     */
     mErrorCode: int;
     
+    /** {en}
+     * @brief The error message.
+     *
+     */
     mErrorMsg: String;
+    
+    /** {en}
+     * @brief The sub error code.
+     *
+     */
+    mSubCode: int;
 }
 export declare enum VeLivePlayerErrorCode {
     
+    /** {en}
+     * @brief No error.
+     *
+     */
     VeLivePlayerNoError = 0,
     
+    /** {en}
+     * @brief The SDK license is invalid. This error may occur due to incorrect integration of the license or if the license has expired. Review how the license was integrated and ensure that it is still valid.
+     *
+     */
     VeLivePlayerInvalidLicense = -1,
     
+    /** {en}
+     * @brief Invalid parameters. Check the input parameter and call the method again.
+     *
+     */
     VeLivePlayerInvalidParameter = -2,
     
+    /** {en}
+     * @brief The method call has been rejected. This error occurs when the method is called at an incorrect time.
+     *
+     */
     VeLivePlayerErrorRefused = -3,
     
+    /** {en}
+     * @brief Failed to load the library file. This error may occur due to incorrect integration of the SDK.
+     *
+     */
     VeLivePlayerErrorLibraryLoadFailed = -4,
     
+    /** {en}
+     * @brief The pull stream address does not exist or is invalid. This error may occur if the pull stream address is empty, or if the format or length of the address is invalid.
+     *
+     */
     VeLivePlayerErrorPlayUrl = -100,
     
+    /** {en}
+     * @brief Unable to get the stream data. This error may occur if the live stream does not exist, is interrupted, or has ended. Please check the status of the live stream.
+     *
+     */
     VeLivePlayerErrorNoStreamData = -101,
     
+    /** {en}
+     * @brief An internal retry to play the live stream, which might happen due to an internal player error.
+     *
+     */
     VeLivePlayerErrorInternalRetryStart = -102,
     
+    /** {en}
+     * @brief An internal retry failed and the maximum number of internal retries is reached. The player has stopped retrying. You may attempt a manual retry.
+     *
+     */
     VeLivePlayerErrorInternalRetryFailed = -103,
     
+    /** {en}
+     * @brief DNS parsing failed. This error may occur due to an error in the pull stream address or the client's network conditions. If the error persists after you verify the pull stream address and network conditions, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
+     *
+     */
     VeLivePlayerErrorDnsParseFailed = -200,
     
+    /** {en}
+     * @brief The network request failed. Check the network conditions. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
+     *
+     */
     VeLivePlayerErrorNetworkRequestFailed = -201,
     
+    /** {en}
+     * @brief Video decapsulation failed. This error may occur if the live stream uses an unsupported format or protocol, or if there is an audio or video error. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
+     *
+     */
     VeLivePlayerErrorDemuxFailed = -300,
     
+    /** {en}
+     * @brief Decoding failed. This error may occur if the live stream uses an unsupported audio or video format. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
+     *
+     */
     VeLivePlayerErrorDecodeFailed = -301,
     
+    /** {en}
+     * @brief Rendering failed. This error may occur if there is an issue with the audio or video output devices. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
+     *
+     */
     VeLivePlayerErrorAVOutputFailed = -302,
     
+    /** {en}
+     * @brief The device model does not support super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
+     *
+     */
     VeLivePlayerErrorSRDeviceUnsupported = -303,
     
+    /** {en}
+     * @brief The current resolution exceeds the upper limit allowed for super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
+     *
+     */
     VeLivePlayerErrorSRResolutionUnsupported = -304,
     
+    /** {en}
+     * @brief The current frame rate exceeds the upper limit allowed for super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
+     *
+     */
     VeLivePlayerErrorSRFpsUnsupported = -305,
     
+    /** {en}
+     * @brief Fails to initialize super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if the error persists.
+     *
+     */
     VeLivePlayerErrorSRInitFail = -306,
     
+    /** {en}
+     * @brief Fails to apply super resolution to the video. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if the error persists.
+     *
+     */
     VeLivePlayerErrorSRExecuteFail = -307,
     
+    /** {en}
+     * @brief The current SDK license does not provide support for the H.265 feature.
+     *
+     */
     VeLivePlayerLicenseUnsupportedH265 = -308,
     
+    /** {en}
+     * @brief The device model does not support sharpen. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
+     *
+     */
+    VeLivePlayerErrorSharpenDeviceUnsupported = -309,
+    
+    /** {en}
+     * @hidden (Android)
+     *
+     */
+    VeLivePlayerErrorNotSupportTextureRender = -508,
+    
+    /** {en}
+     * @hidden (Android)
+     *
+     */
+    VeLivePlayerErrorInitICEffectFail = -509,
+    
+    /** {en}
+     * @hidden (Android)
+     *
+     */
+    VeLivePlayerErrorNotSupportResolutionSwitch = -510,
+    
+    /** {en}
+     * @brief Internal error. Please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
+     *
+     */
     VeLivePlayerErrorInternal = -999
 }