@byteplus/react-native-live-push 1.0.1 → 1.0.3-rc.0

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

@@ -1,372 +1,1647 @@
-import { int, long, Matrix, ByteBuffer, Runnable, float, String, View, Bitmap, Intent, EGLContext, Context, LiveSdkSetting } from './types';
-import { VeLiveVideoBufferType, VeLivePixelFormat, VeLiveVideoRotation, VeLiveVideoEffectLicenseConfiguration, VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, VeLiveFileRecorderConfiguration, VeLiveOrientation, VeLivePusherLogLevel, VeLivePusherLogConfig, VeLiveAudioMixType, VeLiveStreamMixDescription, VeLiveAudioSampleRate, VeLiveAudioChannel, VeLiveAudioBufferType, VeLiveVideoCaptureConfiguration, VeLiveAudioCaptureConfiguration } from './keytype';
+import { VeLiveVideoBufferType, VeLivePixelFormat, VeLiveVideoRotation, VeLiveVideoEffectLicenseConfiguration, VeLivePusherLogLevel, VeLivePusherLogConfig, VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, VeLiveFileRecorderConfiguration, VeLiveOrientation, VeLiveAudioMixType, VeLiveStreamMixDescription, VeLiveAudioBufferType, VeLiveAudioSampleRate, VeLiveAudioChannel, VeLiveVideoCaptureConfiguration, VeLiveAudioCaptureConfiguration } from './keytype';
+import { int, long, Matrix, ByteBuffer, Runnable, float, String, EGLContext, View, Bitmap, Intent, Context, LiveSdkSetting } from './types';
 import { VeLiveVideoEffectCallback, VeLiveVideoEffectHandleCallback, VeLivePusherObserver, VeLivePusherStatisticsObserver, VeLiveFileRecordingListener, VeLiveVideoFrameFilter, VeLiveAudioFrameFilter, VeLiveVideoFrameListener, VeLiveAudioFrameListener, VeLiveSnapshotListener, VeLiveMediaPlayerListener, VeLiveMediaPlayerFrameListener } from './callback';
 export declare class VeLiveVideoFrame {
+    constructor(width: int, height: int, pts: long, texId: int, isOes: boolean, matrix: Matrix);
+    constructor(width: int, height: int, pts: long, byteBuffer: ByteBuffer);
+    constructor(width: int, height: int, pts: long, data: ArrayBuffer);
+    constructor();
     width: number;
     height: number;
     ptsUs: number;
     textureId: number;
     data: any;
-    static new_VeLiveVideoFrame(): VeLiveVideoFrame;
-    static new_VeLiveVideoFrame_int$int$long$int$boolean$Matrix(width: int, height: int, pts: long, texId: int, isOes: boolean, matrix: Matrix): VeLiveVideoFrame;
-    static new_VeLiveVideoFrame_int$int$long$ByteBuffer(width: int, height: int, pts: long, byteBuffer: ByteBuffer): VeLiveVideoFrame;
-    static new_VeLiveVideoFrame_int$int$long$byte(width: int, height: int, pts: long, data: ArrayBuffer): VeLiveVideoFrame;
     
+    /** {en}
+     * @detail api
+     * @brief Increases the reference count of the `VeLiveVideoFrame` object. Call this method to increase the reference count by 1 if you need to continue using the `VeLiveVideoFrame` object.
+     *
+     */
     retain(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Releases the reference to the `VeLiveVideoFrame` object. Call this method to reduce the reference count by 1 when you no longer need to use the `VeLiveVideoFrame` object. When the reference count is reduced to 0, it means there is no reference to the object, and the object can be safely released or destroyed.
+     *
+     */
     release(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the data type of the video.
+     * @return  <br>
+     *     The data type of the video. See VeLiveVideoBufferType {@link #VeLiveVideoBufferType} for details.
+     *
+     */
     getBufferType(): VeLiveVideoBufferType;
     
-    setBufferType(bufferType: VeLiveVideoBufferType): VeLiveVideoFrame;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the data type of the video.
+     * @param bufferType The data type of the video. See VeLiveVideoBufferType {@link #VeLiveVideoBufferType} for details.
+     * @return  <br>
+     *     The video frame object. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     *
+     */
+    setBufferType(bufferType: VeLiveVideoBufferType): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the pixel format.
+     * @return  <br>
+     *     The pixel format. See VeLivePixelFormat {@link #VeLivePixelFormat} for details.
+     *
+     */
     getPixelFormat(): VeLivePixelFormat;
     
-    setPixelFormat(pixelFormat: VeLivePixelFormat): VeLiveVideoFrame;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the pixel format.
+     * @param pixelFormat The pixel format. See VeLivePixelFormat {@link #VeLivePixelFormat} for details.
+     * @return  <br>
+     *     The video frame object. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     *
+     */
+    setPixelFormat(pixelFormat: VeLivePixelFormat): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the rotation angle in a clockwise direction.
+     * @return  <br>
+     *     The rotation angle in a clockwise direction. See VeLiveVideoRotation {@link #VeLiveVideoRotation} for details.
+     *
+     */
     getRotation(): VeLiveVideoRotation;
     
-    setRotation(rotation: VeLiveVideoRotation): VeLiveVideoFrame;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the rotation angle in a clockwise direction.
+     * @param rotation The rotation angle in a clockwise direction. See VeLiveVideoRotation {@link #VeLiveVideoRotation} for details.
+     * @return  <br>
+     *     The video frame object. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     *
+     */
+    setRotation(rotation: VeLiveVideoRotation): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the width of the video frame.
+     * @return  <br>
+     *     The width of the video frame.
+     *
+     */
     getWidth(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the height of the video frame.
+     * @return  <br>
+     *     The height of the video frame.
+     *
+     */
     getHeight(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the width of the rotated video frame.
+     * @return  <br>
+     *     The width of the rotated video frame.
+     *
+     */
     getRotatedWidth(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the height of the rotated video frame.
+     * @return  <br>
+     *     The height of the rotated video frame.
+     *
+     */
     getRotatedHeight(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the timestamp of the video frame.
+     * @return  <br>
+     *     The timestamp of the video frame, in μs.
+     *
+     */
     getPts(): long;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the texture ID.
+     * @return  <br>
+     *     The texture ID.
+     *
+     */
     getTextureId(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the texture matrix.
+     * @return  <br>
+     *     The texture matrix.
+     *
+     */
     getTextureMatrix(): Matrix;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the video data in the format of ByteBuffer.
+     * @return  <br>
+     *     The video data in the format of ByteBuffer.
+     *
+     */
     getBuffer(): ByteBuffer;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the video data in the format of byte [].
+     * @return  <br>
+     *     The video data in the format of byte [].
+     *
+     */
     getData(): ArrayBuffer;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the internal release callback.
+     * @return  <br>
+     *     The internal release callback.
+     *
+     */
     getReleaseCallback(): Runnable;
     
-    setReleaseCallback(releaseCallback: Runnable): VeLiveVideoFrame;
+    /** {en}
+     * @detail api
+     * @brief Sets the internal release callback.
+     * @param releaseCallback The internal release callback.
+     * @return  <br>
+     *     The video frame object. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     *
+     */
+    setReleaseCallback(releaseCallback: Runnable): this;
 }
 export declare class VeLiveCameraDevice {
     
-    CAMERA_DEVICE_CODE_OK: int;
-    
-    CAMERA_DEVICE_CODE_NOT_LIVE: int;
-    
-    CAMERA_DEVICE_CODE_NOT_SUPPORT: int;
-    
-    CAMERA_DEVICE_CODE_PARAM_ILLEGAL: int;
-    
-    CAMERA_DEVICE_CODE_ERROR_BASE: int;
-    
-    setParameter(parameter: Parameter): int;
-    
-    getParameter(): Parameter;
-    
-    getRealFpsRange(): int[];
-    
+    /** {en}
+     * @detail api
+     * @brief Gets the frame rate range supported by the camera.
+     * @return  <br>
+     *      The frame rate range supported by the camera.
+     * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 66
+     *
+     */
+    getRealFpsRange(): Array<int>;
+    
+    /** {en}
+     * @detail api
+     * @brief Enables or disables the flashlight.
+     * @return  <br>
+     *      - 0: Success;
+     *      - ≠ 0: Failure.
+     * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 67
+     * @param enable Whether to enable the flashlight. <br>
+     *         - true: Enable;
+     *         - false: (Default) Disable.
+     *
+     */
     enableTorch(enable: boolean): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the zoom factor of the camera.
+     * @return  <br>
+     *      - 0: Success;
+     *      - ≠ 0: Failure.
+     * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 68
+     * @param ratio The zoom factor. The SDK uses the original size by default. The range of the zoom factor is [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)].
+     *
+     */
     setZoomRatio(ratio: float): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the current zoom factor of the camera.
+     * @return  <br>
+     *      - ≤ 0: The camera does not support zooming;
+     *      - \\\\> 0: The zoom factor.
+     * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 68
+     *
+     */
     getCurrentZoomRatio(): float;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the maximum zoom factor of the camera.
+     * @return  <br>
+     *      - ≤ 0: The camera does not support zooming;
+     *      - \\\\> 0: The maximum zoom factor.
+     * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 69
+     *
+     */
     getMaxZoomRatio(): float;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the minimum zoom factor of the camera.
+     * @return  <br>
+     *      - ≤ 0: The camera does not support zooming;
+     *      - \\\\> 0: The minimum zoom factor.
+     * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 70
+     *
+     */
     getMinZoomRatio(): float;
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether autofocus is supported.
+     * @return  <br>
+     *      - true: Supported;
+     *      - false: Not supported.
+     * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 71
+     *
+     */
     isAutoFocusEnabled(): boolean;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables autofocus.
+     * @return  <br>
+     *      - 0: Success;
+     *      - ≠ 0: Failure.
+     * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 72
+     * @param enable Whether to enable autofocus.
+     *      - true: (Default) Enable;
+     *      - false: Disable.
+     *
+     */
     enableAutoFocus(enable: boolean): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the focus position of the camera.
+     * @return  <br>
+     *      - 0: Success;
+     *      - ≠ 0: Failure.
+     * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 73
+     * @param viewW The width of the current view.
+     * @param viewH The height of the current view.
+     * @param x The horizontal coordinate of the focus point from the upper left corner of the current view.
+     * @param y The vertical coordinate of the focus point from the upper left corner of the current view.
+     *
+     */
     setFocusPosition(viewW: int, viewH: int, x: int, y: int): int;
     
+    /** {en}
+     * @detail api
+     * @brief Checks if manual exposure setting is available for the currently used camera.
+     * @return - YES: Available.
+     *         - NO: Unavailable.
+     * @notes You must call [startVideoCapture](#VeLivePusher-startvideocapture) to start SDK internal video capturing before calling this API.
+     * @order 74
+     *
+     */
     isExposurePositionSupported(): boolean;
     
+    /** {en}
+     * @return - =0: Success.
+     *         - ≠0: Failure.
+     * @detail api
+     * @brief Sets the manual exposure position for the currently used camera.
+     * @notes - You must call [startVideoCapture](#VeLivePusher-startvideocapture) to start SDK internal video capturing, and use SDK internal rendering before calling this API.
+     *        - The camera exposure point setting will be invalid after calling [stopVideoCapture](#VeLivePusher-stopvideocapture) to stop internal capturing.
+     * @order 75
+     * @param viewW The width of the current view.
+     * @param viewH The height of the current view.
+     * @param x     The horizontal coordinate of the focus point from the upper left corner of the current view.
+     * @param y     The vertical coordinate of the focus point from the upper left corner of the current view.
+     *
+     */
     setExposurePosition(viewW: int, viewH: int, x: int, y: int): int;
     
+    /** {en}
+     * @return - ≤0: The camera does not support exposure;
+     *         - \\>0: The minimum exposure compensation.
+     * @detail api
+     * @brief Gets the minimum exposure compensation of the camera.
+     * @notes Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 76
+     *
+     */
     getMinExposureCompensation(): float;
     
+    /** {en}
+     * @return - ≤0: The camera does not support exposure;
+     *         - \\>0: The maximum exposure compensation.
+     * @detail api
+     * @brief Gets the maximum exposure compensation of the camera.
+     * @notes Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 77
+     *
+     */
     getMaxExposureCompensation(): float;
     
+    /** {en}
+     * @return - =0: Success.
+     *         - ≠0: Failure.
+     * @detail api
+     * @brief Sets the exposure compensation for the currently used camera.
+     * @notes <br>
+     *        - You must call [startVideoCapture](#VeLivePusher-startvideocapture) to start SDK internal video capturing, and use SDK internal rendering before calling this API.
+     *        - The camera exposure compensation setting will be invalid after calling [stopVideoCapture](#VeLivePusher-stopvideocapture) to stop internal capturing.
+     * @order 78
+     * @param value The range of the exposure compensation is [[getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation),[getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation)], Default to 0, which means no exposure compensation.
+     *
+     */
     setExposureCompensation(value: float): int;
 }
 export declare class VeLiveVideoEffectManager {
     
+    /** {en}
+     * @detail api
+     * @brief Initializes the special effects manager.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @order 89
+     * @param config The special effects configurations. See VeLiveVideoEffectLicenseConfiguration for details.
+     *
+     */
     setupWithConfig(config: VeLiveVideoEffectLicenseConfiguration): int;
     
+    /** {en}
+     * @detail api
+     * @brief Updates the special effects license. This method is effective only if you authenticate the license online.
+     * @param callback The result callback.
+     * @notes  <br>
+     *      - Call this method after you set the video effects license by calling setupWithConfig {@link #setupWithConfig};
+     *      - This method is an asynchronous operation.
+     * @order 90
+     *
+     */
     updateLicense(callback: VeLiveVideoEffectCallback): void;
     
+    /** {en}
+     * @detail api
+     * @brief Creates or destroys the special effects engine.
+     * @return <br>
+     *         - 0: Success;
+     *         - -1: Failure.
+     * @notes <br>
+     *        - Call this method after calling [setupWithConfig](broadcast-sdk-for-android-api#VeLiveVideoEffectManager-setupwithconfig) and [setAlgorithmModelPath](broadcast-sdk-for-android-api#VeLiveVideoEffectManager-setalgorithmmodelpath) ;
+     *        - This method does not enable or disable video special effects. Call [setComposeNodes](broadcast-sdk-for-android-api#VeLiveVideoEffectManager-setcomposenodes) after calling this method to enable video special effects;
+     *        - In most cases, the special effects engine will be destroyed when the effects manager is destroyed. However, if you have high performance requirements, you can call this method to manually destroy the special effects engine when you are not using special effects-related features;
+     *        - Creating or destroying the special effects engine repeatedly can result in increased processing time.
+     * @order 92
+     * @param enable Whether to create or destroy the special effects engine.<br>
+     *        - true: Create;
+     *        - false: (Default) Destroy.
+     * @param callback [VeLiveVideoEffectCallback](broadcast-sdk-for-android-callback\\#VeLiveVideoEffectCallback), the listener for special effect events.
+     *
+     */
     setEnable(enable: boolean, callback: VeLiveVideoEffectCallback): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the path to the algorithm model package of the special effects.
+     * @param path The path to the algorithm model package of the special effects.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @notes  <br>
+     *      Call this method after you set the special effects license by calling setupWithConfig {@link #setupWithConfig}.
+     * @order 91
+     *
+     */
     setAlgorithmModelPath(path: String): int;
     
-    setComposeNodes(nodes: String[]): int;
-    
-    appendComposeNodes(nodes: String[]): int;
-    
-    removeComposeNodes(nodes: String[]): int;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the special effects you want to apply to the video. You can choose effects from ComposeMakeup.bundle.
+     * @param nodes The paths to the special effects resource.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @notes  <br>
+     *      - Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable};
+     *      - If you make multiple calls to this method, only the last call takes effect;
+     *      - To add more effects to the existing effects settings, call appendComposeNodes {@link #VeLiveVideoEffectManager#appendComposeNodes}.
+     * @order 93
+     *
+     */
+    setComposeNodes(nodes: Array<String>): int;
+    
+    /** {en}
+     * @detail api
+     * @brief Adds one or more effects to the existing effects settings that you have configured by calling setComposeNodes {@link #VeLiveVideoEffectManager#setComposeNodes}.
+     * @param nodes The paths to the special effects resource.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @notes  <br>
+     *      - Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}.
+     * @order 94
+     *
+     */
+    appendComposeNodes(nodes: Array<String>): int;
+    
+    /** {en}
+     * @detail api
+     * @brief Removes one or more special effects resource set by the setComposeNodes{@link #VeLiveVideoEffectManager#setComposeNodes} or appendComposeNodes{@link #VeLiveVideoEffectManager#appendComposeNodes} methods.
+     * @param nodes The paths to the special effects resource.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @notes  <br>
+     *      - Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}.
+     * @order 94
+     *
+     */
+    removeComposeNodes(nodes: Array<String>): int;
+    
+    /** {en}
+     * @detail api
+     * @brief Sets the intensity of a special effect.
+     * @param node The path to the special effects resource.
+     * @param key The key of the resource.
+     * @param intensity The intensity of the effect. The value range is [0.0, 1.0].
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @notes  <br>
+     *      - Call this method after calling setComposeNodes {@link #VeLiveVideoEffectManager#setComposeNodes} or appendComposeNodes {@link #VeLiveVideoEffectManager#appendComposeNodes};
+     *      - This method is only applicable to special effects that contain the three parameters mentioned above. For effects that do not have the intensity parameter, such as stickers, the method does not have any effect.
+     * @order 95
+     *
+     */
     updateComposerNodeIntensity(node: String, key: String, intensity: float): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the color filter.
+     * @param path The absolute path to the filter resource.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @notes  <br>
+     *     Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}.
+     * @order 96
+     *
+     */
     setFilter(path: String): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the intensity of the color filter.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @notes <br>Call this method after calling setFilter.
+     * @order 97
+     * @param intensity The intensity. The value range is [0.0, 1.0].
+     *
+     */
     updateFilterIntensity(intensity: float): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the sticker.
+     * @param path The absolute path to the sticker resource.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @notes  <br>
+     *     Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}.
+     * @order 98
+     *
+     */
     setSticker(path: String): int;
     
+    /** {en}
+     * @detail api
+     * @brief Advanced settings for special effects.
+     * @param callback A callback function that takes a handle as an argument.
+     * @param isGLThread Whether the callback is called in the GL thread.
+     * @param isAsync Whether the callback is executed synchronously.
+     * @notes  <br>
+     *     Call the method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}. Do not perform frequent synchronization operations in the main thread.
+     * @order 99
+     *
+     */
     setAdvancedFeature(callback: VeLiveVideoEffectHandleCallback, isGLThread: boolean, isAsync: boolean): int;
 }
-export declare class WrappedI420BufferFrame {
-    constructor(width: int, height: int, pts: long, rotation: VeLiveVideoRotation);
-    getDataY(): ByteBuffer;
-    getDataU(): ByteBuffer;
-    getDataV(): ByteBuffer;
-}
 export declare class VeLivePusher {
     
+    /** {en}
+     * @detail api
+     * @hidden
+     * @brief Gets the version number of the current SDK.
+     * @return  <br>
+     *    The version number of the current SDK.
+     *
+     */
     static getVersion(): String;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the level of the output log.
+     * @param logLevel The log level. See VeLivePusherLogLevel {@link #VeLivePusherLogLevel} for details.
+     * @order 60
+     *
+     */
     static setLogLevel(logLevel: VeLivePusherLogLevel): void;
     
+    /** {en}
+     * @detail api
+     * @hidden
+     * @brief Sets log configurations.
+     * @param config The log level. See VeLivePusherLogConfig {@link #VeLivePusherLogConfig} for details。
+     *
+     */
     static setLogConfig(config: VeLivePusherLogConfig): void;
     
-    static setEGLVersion(version: int): void;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the context of OpenGL.
+     * @param context The context of OpenGL.
+     * @order 61
+     *
+     */
     static setEGLContext(context: EGLContext): void;
     
-    static getEGLContext(): EGLContext;
-    
+    /** {en}
+     * @detail api
+     * @brief Stops capturing and pushing streams and destroys the pusher. Call this method after stopPush {@link #VeLivePusher#stopPush} is called.
+     * @order 13
+     *
+     */
     release(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets an observer to listen for live pusher events, including errors, statuses, network quality, device information, and first frame rendering.
+     * @param observer The observer. Refer to VeLivePusherObserver {@link #VeLivePusherObserver} for details.
+     * @notes  <br>
+     *      - This method must be called after the live pusher is created;
+     *      - If you make multiple calls to this method, only the last call takes effect.
+     * @order 1
+     *
+     */
     setObserver(observer: VeLivePusherObserver): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets an observer to periodically report push-stream statistics.
+     * @param observer The observer. Refer to VeLivePusherStatisticsObserver {@link #VeLivePusherStatisticsObserver} for details.
+     * @param interval The time interval between two callbacks, in seconds. The default value is `5`.
+     * @notes  <br>
+     *      - This method must be called after the live pusher is created;
+     *      - If you make multiple calls to this method, only the last call takes effect.
+     * @order 15
+     *
+     */
     setStatisticsObserver(observer: VeLivePusherStatisticsObserver, interval: int): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the preview for the local camera. If beauty AR is applied to the captured video or if it undergoes any other processing, the preview will display the processed video.
+     * @param view The preview view.
+     * @order 16
+     *
+     */
     setRenderView(view: View): Promise<void>;
     
+    /** {en}
+     * @detail api
+     * @brief Sets fill mode for the local camera preview.
+     * @param mode The fill mode.
+     *
+     */
     setRenderFillMode(mode: VeLivePusherRenderMode): void;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables mirroring for the local preview and the streamed video.
+     * @param type Mirror mode. See VeLiveVideoMirrorType {@link #VeLiveVideoMirrorType} for details.
+     * @param mirror Whether to enable mirroring. <br>
+     *                - true: Enable;
+     *                - false: Disable.
+     * @order 17
+     *
+     */
     setVideoMirror(type: VeLiveVideoMirrorType, mirror: boolean): void;
     
+    /** {en}
+     * @detail api
+     * @brief Starts video capture.
+     * @notes <br>After calling this method, you can stop video capture by calling [stopVideoCapture](#VeLivePusher-stopvideocapture).
+     * @order 18
+     * @param type The video capture type. See VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} for details.
+     *
+     *
+     */
     startVideoCapture(type: VeLiveVideoCaptureType): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stops video capture.
+     * @notes <br>After calling this method, you can start video capture by calling [startVideoCapture](#VeLivePusher-startvideocapture).
+     * @order 19
+     *
+     */
     stopVideoCapture(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Starts audio capture.
+     * @notes <br>After calling this method, you can stop audio capture by calling [stopAudioCapture](#VeLivePusher-stopaudiocapture).
+     * @order 20
+     * @param type The audio capture type. See VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} for details.
+     *
+     */
     startAudioCapture(type: VeLiveAudioCaptureType): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stops audio capture.
+     * @notes <br>After calling this method, you can start audio capture by calling [startAudioCapture](#VeLivePusher-startaudiocapture).
+     * @order 21
+     *
+     */
     stopAudioCapture(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Switches the video capture type.
+     * @notes <br>This method must be called after [startVideoCapture](#VeLivePusher-startvideocapture) is called.
+     * @order 22
+     * @param type The video capture type. See VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} for details.
+     *
+     */
     switchVideoCapture(type: VeLiveVideoCaptureType): void;
     
+    /** {en}
+     * @detail api
+     * @brief Switches audio capture type.
+     * @notes <br>This method must be called after [startVideoCapture](#VeLivePusher-startvideocapture) is called.
+     * @order 23
+     * @param type The audio capture type. See VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} for details.
+     *
+     */
     switchAudioCapture(type: VeLiveAudioCaptureType): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the current video capture type.
+     * @return  <br>
+     *      The video capture type. See VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} for details.
+     * @order 24
+     *
+     */
     getCurrentVideoCaptureType(): VeLiveVideoCaptureType;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the current audio capture type.
+     * @return  <br>
+     *      The audio capture type. See VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} for details.
+     * @order 25
+     *
+     */
     getCurrentAudioCaptureType(): VeLiveAudioCaptureType;
     
+    /** {en}
+     * @detail api
+     * @brief Sets a static image to push. When using this method, you must call startVideoCapture {@link #VeLivePusher#startVideoCapture} and set VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} to `VeLiveVideoCaptureCustomImage`.
+     * @param image The static image to push.
+     * @order 26
+     *
+     */
     updateCustomImage(image: Bitmap): Promise<void>;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the camera manager. With the camera manager, you can do the following:
+     *         - Control the flashlight
+     *         - Set the camera zoom
+     *         - Set autofocus
+     * @return  <br>
+     *      The camera manager. See VeLiveCameraDevice {@link #VeLiveCameraDevice} for details.
+     * @notes  <br>
+     *     To use this method, you must first call startVideoCapture {@link #startVideoCapture} and set VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} to `VeLiveVideoCaptureFrontCamera` or `VeLiveVideoCaptureBackCamera`.
+     * @order 27
+     *
+     */
     getCameraDevice(): VeLiveCameraDevice;
     
+    /** {en}
+     * @detail api
+     * @brief Sets video encoding parameters for the pushed stream.
+     * @notes This method can be called before or after live streaming starts.
+     * @order 28
+     * @param config The video encoding parameters, including the video resolution, encoding format, target bitrate, and GOP size. For details, see VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration}.
+     *
+     */
     setVideoEncoderConfiguration(config: VeLiveVideoEncoderConfiguration): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets video encoding parameters for the pushed stream.
+     * @return  <br>
+     *      The video encoding parameters, including the video resolution, encoding format, target bitrate, and GOP size. For details, see VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration}.
+     * @order 29
+     *
+     */
     getVideoEncoderConfiguration(): VeLiveVideoEncoderConfiguration;
     
+    /** {en}
+     * @detail api
+     * @brief Sets audio encoding parameters for the pushed stream.
+     * @notes <br>This method must be called before calling [startPush](#VeLivePusher-startpush) or [startPushWithUrls](#VeLivePusher-startpushwithurls).
+     * @order 30
+     * @param config The audio encoding parameters. See [VeLiveAudioEncoderConfiguration](147521#VeLiveAudioEncoderConfiguration) for details.
+     *
+     */
     setAudioEncoderConfiguration(config: VeLiveAudioEncoderConfiguration): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets audio encoding parameters for the pushed stream.
+     * @return <br>The audio encoding parameters. See VeLiveAudioEncoderConfiguration for details.
+     * @order 31
+     *
+     */
     getAudioEncoderConfiguration(): VeLiveAudioEncoderConfiguration;
     
+    /** {en}
+     * @detail api
+     * @brief Starts streaming.
+     * @param url The push stream address.
+     * @order 32
+     *
+     */
     startPush(url: String): void;
     
-    startPushWithUrls(urls: String[]): void;
-    
+    /** {en}
+     * @detail api
+     * @brief Starts streaming with one or more push stream addresses.
+     * @param urls A list of push stream addresses.
+     * @notes  <br>
+     *    When the first push stream address in the array is unavailable, the SDK will automatically switch to the subsequent addresses.
+     * @order 33
+     *
+     */
+    startPushWithUrls(urls: Array<String>): void;
+    
+    /** {en}
+     * @detail api
+     * @brief Stops streaming.
+     * @notes  <br>
+     *    After you have stopped streaming, you can restart streaming by calling startPush {@link #startPush} or startPushWithUrls {@link #startPushWithUrls}.
+     * @order 34
+     *
+     */
     stopPush(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether the streaming is currently ongoing. You can use this method to query the status of the live pusher.
+     * @return  <br>
+     *      Whether the streaming is currently ongoing. <br>
+     *          - true: The streaming is currently ongoing;
+     *          - false: The streaming has stopped.
+     * @order 35
+     *
+     */
     isPushing(): boolean;
     
+    /** {en}
+     * @detail api
+     * @brief Sets a watermark for the pushed stream.
+     * @param image The watermark image. Setting it to null means disabling watermarking.
+     * @param x The horizontal offset of the watermark, which represents the ratio of the distance between the left edge of the watermark and the left edge of the video to the width of the video. The value range is [0.0,1.0].
+     * @param y The vertical offset of the watermark, which represents the ratio of the distance between the top edge of the watermark and the top edge of the video to the height of the video. The value range is [0.0,1.0].
+     * @param scale The uniform scaling of the watermark. The value range is [0.0, 1.0].
+     * @return  <br>
+     *      - 0: Success;
+     *      - < 0: Failure.
+     * @order 36
+     *
+     */
     setWatermark(image: Bitmap, x: float, y: float, scale: float): Promise<int>;
     
+    /** {en}
+     * @detail api
+     * @brief Starts local recording.
+     * @order 37
+     * @param path The directory for saving the recording file. You cannot leave this parameter empty.
+     * @param config The recording configurations. See VeLiveFileRecorderConfiguration for details.
+     * @param listener The listener for recording events. See VeLiveFileRecordingListener for details.
+     *
+     */
     startFileRecording(path: String, config: VeLiveFileRecorderConfiguration, listener: VeLiveFileRecordingListener): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stops local recording.
+     * @notes <br>This method must be called after calling [startFileRecording](#VeLivePusher-startfilerecording).
+     * @order 38
+     *
+     */
     stopFileRecording(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Set advanced configurations. You can contact BytePlus technical support for more information about how to use this method.
+     * @param key The JSON key.
+     * @param value The JSON value.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     * @order 39
+     *
+     */
     setProperty(key: String, value: Object): int;
     
+    /** {en}
+     * @detail api
+     * @brief Pushes an external video frame.
+     * @param frame The external video frame. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     * @return  <br>
+     *      - 0: Success;
+     *      - < 0: Failure.
+     * @notes  <br>
+     *    To use this method, you must first call startVideoCapture {@link #startVideoCapture} and set VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} to `VeLiveVideoCaptureExternal`.
+     * @order 40
+     *
+     */
     pushExternalVideoFrame(frame: VeLiveVideoFrame): int;
     
+    /** {en}
+     * @detail api
+     * @brief Pushes an external audio frame.
+     * @param frame The external audio frame. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     * @return  <br>
+     *       - 0: Success;
+     *       - < 0: Failure.
+     * @notes  <br>
+     *    To use this method, you must first call startAudioCapture {@link #AustartdioCapture} and set VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} to `VeLiveAudioCaptureExternal`.
+     * @order 41
+     *
+     */
     pushExternalAudioFrame(frame: VeLiveAudioFrame): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the orientation of the pushed video frame. The default orientation is portrait.
+     * @param orientation The orientation of the pushed video frame. See VeLiveOrientation {@link #VeLiveOrientation} for details.
+     * @order 42
+     *
+     */
     setOrientation(orientation: VeLiveOrientation): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sends an SEI message through the video frame. The SEI messages are strings in JSON format.
+     * @return  <br>
+     *      - 0: Success;
+     *      - < 0: Failure.
+     * @notes <br>This method must be called after calling [startPush](#VeLivePusher-startpush) or [startPushWithUrls](#VeLivePusher-startpushwithurls).
+     * @order 43
+     * @param key The JSON key.
+     * @param value The JSON value.
+     * @param repeat The number of times the message is sent. For example, if you set `repeat` to `20` and set `isKeyFrame` to `true`, the SDK will add the SEI message to 20 consecutive key frames starting from the time the method is called.
+     * @param isKeyFrame Whether SEI messages are only included in key frames. <br>
+     *         - true: Add the SEI message to key frames only;
+     *         - false: Add the SEI message to all types of frames.
+     * @param allowsCovered Whether to allow overwriting. <br>
+     *         - true: Allow overwriting;
+     *         - false: Do not allow overwriting.
+     *
+     */
     sendSeiMessage(key: String, value: Object, repeat: int, isKeyFrame: boolean, allowsCovered: boolean): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets whether to mute the stream.
+     * @param mute Whether to mute the stream. <br>
+     *              - true: Mute;
+     *              - false: (Default) Do not mute.
+     * @order 44
+     *
+     */
     setMute(mute: boolean): void;
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether the stream is muted.
+     * @return  <br>
+     *      - true: The stream is muted;
+     *      - false: The stream is not muted.
+     * @order 45
+     *
+     */
     isMute(): boolean;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the special effects manager. With the special effects manager, you can do the following:
+     *         - Set beauty AR
+     *         - Set special effects
+     *         - Set materials
+     *         - Set stickers
+     *         - Set filters
+     * @return  <br>
+     *      The special effects manager. See VeLiveVideoEffectManager {@link #VeLiveVideoEffectManager} for details.
+     * @notes  <br>
+     *    You must first integrate the BytePlus Effects SDK before calling this method.
+     * @order 46
+     *
+     */
     getVideoEffectManager(): VeLiveVideoEffectManager;
     
+    /** {en}
+     * @detail api
+     * @brief Sets custom video processing.
+     * @order 47
+     * @param filter The video filter. See VeLiveVideoFrameFilter for details.
+     *
+     */
     setVideoFrameFilter(filter: VeLiveVideoFrameFilter): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the audio device manager.
+     * @return  <br>
+     *      The audio device manager. See VeLiveAudioDevice {@link #VeLiveAudioDevice} for details.
+     * @notes  <br>
+     *    To use this method, you must first call startAudioCapture {@link #startAudioCapture} and set VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} to `VeLiveAudioCaptureMicrophone`.
+     * @order 48
+     *
+     */
     getAudioDevice(): VeLiveAudioDevice;
     
+    /** {en}
+     * @detail api
+     * @brief Sets custom audio processing.
+     * @order 49
+     * @param filter The audio filter. See VeLiveAudioFrameFilter for details.
+     *
+     */
     setAudioFrameFilter(filter: VeLiveAudioFrameFilter): void;
     
+    /** {en}
+     * @detail api
+     * @brief Creates the media player.
+     * @return  <br>
+     *      The media player. See VeLiveMediaPlayer {@link #VeLiveMediaPlayer} for details.
+     * @order 50
+     *
+     */
     createPlayer(): VeLiveMediaPlayer;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the audio and video mixer.
+     * @return  <br>
+     *      The audio and video mixer. See VeLiveMixerManager {@link #VeLiveMixerManager} for details.
+     * @order 51
+     *
+     */
     getMixerManager(): VeLiveMixerManager;
     
+    /** {en}
+     * @detail api
+     * @brief Starts screen capture.
+     * @param enableAppAudio Whether to record in-app audio data. Currently, you can only set it to `true`, which is the default value.
+     * @param screenIntent The system screen recording permission.
+     * @order 52
+     *
+     *
+     */
     startScreenRecording(enableAppAudio: boolean, screenIntent: Intent): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stops screen capture.
+     * @order 53
+     *
+     */
     stopScreenRecording(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets whether the SDK is capturing the screen at this moment.
+     * @order 54
+     *
+     */
     isScreenRecording(): boolean;
     
+    /** {en}
+     * @detail api
+     * @brief Adds a video frame listener.
+     * @return  <br>
+     *       - 0: Success;
+     *       - < 0: Failure.
+     * @order 55
+     * @param listener The listener. See VeLiveVideoFrameListener for details.
+     *
+     */
     addVideoFrameListener(listener: VeLiveVideoFrameListener): int;
     
+    /** {en}
+     * @detail api
+     * @brief Removes the video frame listener.
+     * @return  <br>
+     *       - 0: Success;
+     *       - < 0: Failure.
+     * @notes  <br>
+     *    Calling this method will return a failure if the listener has not been added or has been removed.
+     * @order 56
+     * @param listener The listener. See VeLiveVideoFrameListener for details.
+     *
+     */
     removeVideoFrameListener(listener: VeLiveVideoFrameListener): int;
     
+    /** {en}
+     * @detail api
+     * @brief Adds an audio frame listener.
+     * @return  <br>
+     *       - 0: Success;
+     *       - < 0: Failure.
+     * @order 57
+     * @param listener The listener. See VeLiveAudioFrameListener for details.
+     *
+     */
     addAudioFrameListener(listener: VeLiveAudioFrameListener): int;
     
+    /** {en}
+     * @detail api
+     * @brief Removes the audio frame listener.
+     * @return  <br>
+     *       - 0: Success;
+     *       - < 0: Failure.
+     * @notes  <br>
+     *    Calling this method will return a failure if the listener has not been added or has been removed.
+     * @order 58
+     * @param listener The listener. See VeLiveAudioFrameListener for details.
+     *
+     */
     removeAudioFrameListener(listener: VeLiveAudioFrameListener): int;
     
+    /** {en}
+     * @detail api
+     * @brief Takes a screenshot.
+     * @order 59
+     * @param listener The listener for the screenshot. See VeLiveSnapshotListener for details.
+     *
+     */
     snapshot(listener: VeLiveSnapshotListener): void;
 }
-export declare class Parameter {
-    static readonly WIDTH: String;
-    static readonly HEIGHT: String;
-    static readonly FPS: String;
-    static readonly ZOOM: String;
-    static readonly FOCUS_MODE: String;
-    static readonly FOCUS_MODE_AUTO: String;
-    static readonly CURRENT_ISO: String;
-    setInt(key: String, value: int): int;
-    getInt(key: String): int;
-    setFloat(key: String, value: float): int;
-    getFloat(key: String): float;
-}
 export declare class VeLiveMixerManager {
     
+    /** {en}
+     * @detail api
+     * @brief Adds a video stream to the mixer.
+     * @return  <br>
+     *     The video stream ID.
+     * @order 79
+     *
+     */
     addVideoStream(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Adds an audio stream to the mixer.
+     * @return  <br>
+     *     The audio stream ID.
+     * @order 80
+     *
+     */
     addAudioStream(): int;
     
-    addAudioStream_VeLiveAudioMixType(type: VeLiveAudioMixType): int;
-    
+    /** {en}
+     * @detail api
+     * @brief Adds an audio stream to the mixer.
+     * @return  <br>
+     *     The audio stream ID.
+     * @order 80
+     *
+     */
+    addAudioStream_type(type: VeLiveAudioMixType): int;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the ID of the primary video stream.
+     * @order 83
+     *
+     */
     getOriginVideoStream(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the ID of the primary audio stream.
+     * @order 84
+     *
+     */
     getOriginAudioStream(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the ID of the primary screen stream.
+     * @order 85
+     *
+     */
     getOriginScreenStream(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the ID of the primary system audio stream.
+     * @order 86
+     *
+     */
     getOriginSystemAudioStream(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sends a custom video frame with a specified stream ID.
+     * @param frame The custom video frame. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     * @param streamId The ID of the video stream to mix.
+     * @order 87
+     *
+     */
     sendCustomVideoFrame(frame: VeLiveVideoFrame, streamId: int): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sends a custom audio frame with a specified stream ID.
+     * @param frame The custom audio frame. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     * @param streamId The ID of the audio stream to mix.
+     * @order 88
+     *
+     */
     sendCustomAudioFrame(frame: VeLiveAudioFrame, streamId: int): void;
     
+    /** {en}
+     * @detail api
+     * @brief Updates the configurations for audio and video mixing.
+     * @param mixDescription The updated configurations for audio and video mixing. See VeLiveStreamMixDescription {@link #VeLiveStreamMixDescription} for details.
+     *
+     */
     updateStreamMixDescription(mixDescription: VeLiveStreamMixDescription): void;
     
+    /** {en}
+     * @detail api
+     * @brief Removes a non-primary video stream from the mixer.
+     * @param streamId The ID of the video stream to remove.
+     * @order 80
+     *
+     */
     removeVideoStream(streamId: int): void;
     
+    /** {en}
+     * @detail api
+     * @brief Removes a non-primary audio stream from the mixer.
+     * @param streamId The ID of the audio stream to remove.
+     * @order 82
+     *
+     */
     removeAudioStream(streamId: int): void;
 }
 export declare class VeLiveMediaPlayer {
     
+    /** {en}
+     * @detail api
+     * @brief Destroys the media player instance.
+     * @order 100
+     *
+     */
     release(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the observer for playback statuses.
+     * @notes  <br>
+     *      If you make multiple calls to this method, only the last call takes effect.
+     * @order 101
+     * @param listener The observer that listens for playback statuses. For details, see VeLiveMediaPlayerListener.
+     *
+     */
     setListener(listener: VeLiveMediaPlayerListener): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the file path. Supported file formats include MP3, AAC, M4A, WAV.
+     * @param url The file path.
+     * @return  <br>
+     *         - 0: Success;
+     *         - ≠ 0: Failure.
+     * @order 102
+     *
+     */
     prepare(url: String): int;
     
+    /** {en}
+     * @detail api
+     * @brief Pauses playback.
+     * @notes  <br>
+     *     This method must be called after you call start {@link #start} to start playback.
+     * @order 103
+     *
+     */
     start(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Stops playback.
+     * @return  <br>
+     *         - 0: Success;
+     *         - ≠ 0: Failure.
+     * @notes  <br>
+     *     This method must be called after you call start {@link #start} to start playback.
+     * @order 104
+     *
+     */
     stop(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Pauses playback.
+     * @notes  <br>
+     *     This method must be called after you call start {@link #start} to start playback.
+     * @order 105
+     *
+     */
     pause(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Resumes playback.
+     * @notes <br>This method must be called after you call [pause](#VeLiveMediaPlayer-pause) to pause playback.
+     * @order 106
+     *
+     */
     resume(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the duration of the media file.
+     * @return  <br>
+     *      - \\\\> 0: The duration of the media file, in milliseconds;
+     *      - ≤ 0: Failure.
+     * @notes <br>This method must be called after you call [start](#VeLiveMediaPlayer-start) to start playback.
+     * @order 107
+     *
+     */
     getDuration(): long;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the playback progress.
+     * @param posMs The playback progress, in milliseconds.
+     * @return  <br>
+     *         - 0: Success;
+     *         - ≠ 0: Failure.
+     * @order 108
+     *
+     */
     seek(posMs: long): int;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables mixing the audio to the live stream.
+     * @param enable Whether to enable or disable mixing the audio to the live stream. <br>
+     *         - ture: Enable;
+     *         - false: (Default) Disable.
+     * @order 109
+     *
+     */
     enableMixer(enable: boolean): void;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables automatic volume equalization.
+     * @param sourceLufs The source volume.
+     * @param targetLufs The target volume.
+     * @order 110
+     *
+     */
     enableAutoEq(sourceLufs: float, targetLufs: float): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the view for rendering the video. Supports MP4 format.
+     * @param view The view used by the media player to render video.
+     * @order 111
+     *
+     */
     setRenderView(view: View): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the observer for audio and video frames.
+     * @notes  <br>
+     *      If you make multiple calls to this method, only the last call takes effect.
+     * @order 112
+     * @param listener The observer that listens for audio and video frames. For details, see VeLiveMediaPlayerFrameListener
+     *
+     */
     setFrameListener(listener: VeLiveMediaPlayerFrameListener): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the playback volume.
+     * @param volume The playback volume. The value range is [0.0, 4.0].
+     * @order 113
+     *
+     */
     setBGMVolume(volume: float): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the audio capture volume.
+     * @notes <br>This method must be called after you call [start](#VeLiveMediaPlayer-start) to start playing background music.
+     * @order 114
+     * @param volume The audio capture volume. The value range is [0.0, 4.0].
+     *
+     */
     setVoiceVolume(volume: float): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets whether to loop the video.
+     * @param loop Whether to loop the video. <br>
+     *                - true: Loop;
+     *                - false: (Default) Do not loop.
+     * @order 115
+     *
+     */
     enableBGMLoop(loop: boolean): void;
 }
 export declare class VeLiveAudioFrame {
+    constructor();
+    constructor(sampleRate: VeLiveAudioSampleRate, channel: VeLiveAudioChannel, pts: long, buffer: ByteBuffer);
     bufferType: any;
     sampleRate: any;
     channels: any;
     ptsUs: any;
     buffer: any;
     samplesPerChannel: any;
-    static new_VeLiveAudioFrame_VeLiveAudioSampleRate$VeLiveAudioChannel$long$ByteBuffer(sampleRate: VeLiveAudioSampleRate, channel: VeLiveAudioChannel, pts: long, buffer: ByteBuffer): VeLiveAudioFrame;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the audio data type.
+     * @return  <br>
+     *     The audio data type. See VeLiveAudioBufferType {@link #VeLiveAudioBufferType} for details.
+     *
+     */
     getBufferType(): VeLiveAudioBufferType;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the audio sample rate.
+     * @return  <br>
+     *     The audio sample rate. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
+     *
+     */
     getSampleRate(): VeLiveAudioSampleRate;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the number of audio channels.
+     * @return  <br>
+     *     The number of audio channels. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
+     *
+     */
     getChannels(): VeLiveAudioChannel;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the audio bit depth.
+     * @return  <br>
+     *     The audio bit depth.
+     *
+     */
     getSamplesPerChannel(): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the audio timestamp, in μs.
+     * @return  <br>
+     *     The timestamp of the audio frame, in μs.
+     *
+     */
     getPts(): long;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the audio data. The audio data is of type float32 and is stored in little-endian byte order.
+     * @return  <br>
+     *      The audio data in the format of ByteBuffer.
+     *
+     */
     getBuffer(): ByteBuffer;
 }
 export declare class VeLiveAudioDevice {
     
+    /** {en}
+     * @detail api
+     * @brief Sets the volume.
+     * @param level The volume. The value range is [0.0, 4.0].
+     * @order 74
+     *
+     */
     setVoiceLoudness(level: float): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the current volume.
+     * @return  <br>
+     *      The current volume.
+     * @order 75
+     *
+     */
     getVoiceLoudness(): float;
     
+    /** {en}
+     * @detail api
+     * @brief  Checks whether in-ear monitoring is supported.
+     * @return  <br>
+     *      - true: Supported;
+     *      - false: Not supported.
+     * @order 76
+     *
+     */
     isSupportHardwareEcho(): boolean;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables in-ear monitoring.
+     * @param enable Whether to enable in-ear monitoring. <br>
+     *       - true: Enable;
+     *       - false: (Default) Disable.
+     * @order 77
+     *
+     */
     enableEcho(enable: boolean): void;
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether in-ear monitoring is enabled.
+     * @return  <br>
+     *      - true: Enabled;
+     *      - false: Disabled.
+     * @order 78
+     *
+     */
     isEnableEcho(): boolean;
 }
 export declare class VeLivePusherConfiguration {
     
-    setReconnectIntervalSeconds(interval: int): VeLivePusherConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief  Sets the time interval between each attempt to reconnect.
+     * @param interval The time interval between each attempt to reconnect, in seconds. The default value is `5`.
+     * @order 2
+     *
+     */
+    setReconnectIntervalSeconds(interval: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the time interval between each attempt to reconnect.
+     * @return  <br>
+     *      The time interval between each attempt to reconnect, in seconds.
+     * @order 3
+     *
+     */
     getReconnectIntervalSeconds(): int;
     
-    setReconnectCount(maxCount: int): VeLivePusherConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief  Sets the number of attempts to reconnect after the initial attempt fails.
+     * @param maxCount The number of attempts to reconnect after the initial attempt fails. The default value is `3`.
+     * @order 4
+     *
+     */
+    setReconnectCount(maxCount: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the number of attempts to reconnect after the initial attempt fails.
+     * @return  <br>
+     *      The number of attempts to reconnect after the initial attempt fails.
+     * @order 5
+     *
+     *
+     */
     getReconnectCount(): int;
     
-    setVideoCaptureConfig(config: VeLiveVideoCaptureConfiguration): VeLivePusherConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the video capture configurations.
+     * @return  <br>
+     *      The pusher configurations. See VeLivePusherConfiguration {@link #VeLivePusherConfiguration} for details.
+     * @order 6
+     * @param config The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
+     *
+     */
+    setVideoCaptureConfig(config: VeLiveVideoCaptureConfiguration): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the video capture configurations.
+     * @return <br>The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
+     * @order 7
+     *
+     */
     getVideoCaptureConfig(): VeLiveVideoCaptureConfiguration;
     
-    setAudioCaptureConfig(config: VeLiveAudioCaptureConfiguration): VeLivePusherConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the audio capture configurations.
+     * @return  <br>
+     *      The pusher configurations. See VeLivePusherConfiguration {@link #VeLivePusherConfiguration} for details.
+     * @order 7
+     * @param config The audio capture configurations. See VeLiveAudioCaptureConfiguration for details.
+     *
+     */
+    setAudioCaptureConfig(config: VeLiveAudioCaptureConfiguration): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the audio capture configurations.
+     * @return <br>The audio capture configurations. See VeLiveAudioCaptureConfiguration for details.
+     * @order 8
+     *
+     *
+     */
     getAudioCaptureConfig(): VeLiveAudioCaptureConfiguration;
     
-    setContext(context: Context): VeLivePusherConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the context of the application.
+     * @param context The context of the application.
+     * @return  <br>
+     *      The pusher configurations. See VeLivePusherConfiguration {@link #VeLivePusherConfiguration} for details.
+     * @order 9
+     *
+     */
+    setContext(context: Context): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the context of the application.
+     * @return  <br>
+     *      The context of the application.
+     * @order 10
+     *
+     *
+     */
     getContext(): Context;
     
-    setExtraParameters(params: String): VeLivePusherConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets advanced parameters. You can leave this parameter empty. If you need to use it, please contact BytePlus technical support.
+     * @param params Extension parameters.
+     * @return  <br>
+     *      The pusher configurations. See VeLivePusherConfiguration {@link #VeLivePusherConfiguration} for details.
+     * @order 11
+     *
+     *
+     */
+    setExtraParameters(params: String): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets advanced parameters.
+     * @return  <br>
+     *      Advanced parameters.
+     * @order 12
+     *
+     *
+     */
     getExtraParams(): LiveSdkSetting;
     
+    /** {en}
+     * @detail api
+     * @brief Creates the live pusher.
+     * @return  <br>
+     *      The live pusher. See VeLivePusher {@link #VeLivePusher} for details.
+     * @order 1
+     *
+     *
+     */
     build(): VeLivePusher;
 }