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

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

@@ -1,11 +1,11 @@
-import { int, double, String, ArrayList, float, long } from './types';
+import { int, long, Matrix, ByteBuffer, Runnable, double, String, ArrayList, float, Context, LiveSdkSetting } from './types';
+import { VeLivePusher } from './api';
 export declare class VeLiveVideoEncoderConfiguration {
     
     /** {en}
      * @detail api
      * @brief Gets the video resolution.
-     * @return  <br>
-     *      The video resolution. See VeLiveVideoResolution {@link #VeLiveVideoResolution} for details.
+     * @return The video resolution. See [VeLiveVideoResolution](#VeLivePusherDef-VeLiveVideoResolution) for details.
      *
      */
     getResolution(): VeLiveVideoResolution;
@@ -13,9 +13,8 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the video resolution.
-     * @param resolution The video resolution. The default value is `VeLiveVideoResolution720P`. See VeLiveVideoResolution {@link #VeLiveVideoResolution} for details.
-     * @return  <br>
-     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     * @param resolution The video resolution. The default value is `VeLiveVideoResolution720P`. See [VeLiveVideoResolution](#VeLivePusherDef-VeLiveVideoResolution) for details.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration) for details.
      *
      */
     setResolution(resolution: VeLiveVideoResolution): this;
@@ -23,8 +22,7 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the video codec.
-     * @return  <br>
-     *      The video codec. See VeLiveVideoCodec {@link #VeLiveVideoCodec} for details.
+     * @return The video codec. See [VeLiveVideoCodec](#VeLiveVideoCodec) for details.
      *
      */
     getCodec(): VeLiveVideoCodec;
@@ -32,8 +30,8 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the video codec.
-     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](broadcast-sdk-for-android-type-definition#VeLiveVideoEncoderConfiguration) for details.
-     * @param codec <br>The video codec. See [VeLiveVideoCodec](broadcast-sdk-for-android-type-definition#VeLiveVideoCodec) for details.
+     * @param codec The video codec. See [VeLiveVideoCodec](#VeLiveVideoCodec) for details.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration) for details.
      *
      */
     setCodec(codec: VeLiveVideoCodec): this;
@@ -41,8 +39,7 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Get the encoded video bitrate.
-     * @return  <br>
-     *      The encoded video bitrate.
+     * @return The encoded video bitrate.
      *
      */
     getBitrate(): int;
@@ -51,8 +48,7 @@ export declare class VeLiveVideoEncoderConfiguration {
      * @detail api
      * @brief Sets the encoded video bitrate.
      * @param bitrate The encoded video bitrate, in Kbps. The default value depends on the value of the `resolution` parameter.
-     * @return  <br>
-     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration) for details.
      *
      */
     setBitrate(bitrate: int): this;
@@ -60,8 +56,7 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the minimum encoded video bitrate.
-     * @return  <br>
-     *      The minimum encoded video bitrate.
+     * @return The minimum encoded video bitrate.
      *
      */
     getMinBitrate(): int;
@@ -70,8 +65,7 @@ export declare class VeLiveVideoEncoderConfiguration {
      * @detail api
      * @brief Sets the minimum encoded video bitrate.
      * @param minBitrate The minimum encoded video bitrate, in Kbps, when the adaptive bitrate (ABR) feature is enabled. The default value depends on the value of the `resolution` parameter.
-     * @return  <br>
-     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration) for details.
      *
      */
     setMinBitrate(minBitrate: int): this;
@@ -79,8 +73,7 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the maximum encoded video bitrate.
-     * @return  <br>
-     *      The maximum encoded video bitrate.
+     * @return The maximum encoded video bitrate.
      *
      */
     getMaxBitrate(): int;
@@ -89,8 +82,7 @@ export declare class VeLiveVideoEncoderConfiguration {
      * @detail api
      * @brief Sets the maximum encoded video bitrate.
      * @param maxBitrate The maximum video encoding bitrate, in Kbps, when the adaptive bitrate (ABR) feature is enabled. The default value depends on the value of the `resolution` parameter.
-     * @return  <br>
-     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration) for details.
      *
      */
     setMaxBitrate(maxBitrate: int): this;
@@ -98,8 +90,7 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the encoded video GOP size.
-     * @return  <br>
-     *      The encoded video GOP size.
+     * @return The encoded video GOP size.
      *
      */
     getGopSize(): int;
@@ -108,8 +99,7 @@ export declare class VeLiveVideoEncoderConfiguration {
      * @detail api
      * @brief Sets the encoded video GOP size.
      * @param gopSize The encoded video GOP size, in seconds. The default value is `2`.
-     * @return  <br>
-     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration) for details.
      *
      */
     setGopSize(gopSize: int): this;
@@ -117,8 +107,7 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the encoded frame rate.
-     * @return  <br>
-     *      The encoded frame rate.
+     * @return The encoded frame rate.
      *
      */
     getFps(): int;
@@ -127,8 +116,7 @@ export declare class VeLiveVideoEncoderConfiguration {
      * @detail api
      * @brief Sets the encoded frame rate.
      * @param fps The encoded frame rate, in fps. The default value is `15`.
-     * @return  <br>
-     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration) for details.
      *
      */
     setFps(fps: int): this;
@@ -136,10 +124,9 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief  Gets whether to enable B frames.
-     * @return  <br>
-     *      Whether to enable B frames. <br>
-     *          - true: Enable;
-     *          - false: Disable.
+     * @return Whether to enable B frames.<br/>
+     *         - true: Enable;
+     *         - false: Disable.
      *
      */
     isEnableBFrame(): boolean;
@@ -150,8 +137,7 @@ export declare class VeLiveVideoEncoderConfiguration {
      * @param enableBFrame Whether to enable B frames. <br>
      *                - true: Enable;
      *                - false: (Default) Disable.
-     * @return  <br>
-     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration) for details.
      *
      */
     setEnableBFrame(enableBFrame: boolean): this;
@@ -159,10 +145,9 @@ export declare class VeLiveVideoEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief  Gets whether to enable hardware encoding.
-     * @return  <br>
-     *      Whether to enable hardware encoding. <br>
-     *          - true: Enable;
-     *          - false: Disable.
+     * @return Whether to enable hardware encoding.<br/>
+     *         - true: Enable;
+     *         - false: Disable.
      *
      */
     isEnableAccelerate(): boolean;
@@ -173,158 +158,562 @@ export declare class VeLiveVideoEncoderConfiguration {
      * @param enableAccelerate Whether to enable hardware encoding. <br>
      *                - true: (Default) Enable;
      *                - false: Disable.
-     * @return  <br>
-     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration) for details.
      *
      */
     setEnableAccelerate(enableAccelerate: boolean): this;
 }
+export declare class VeLiveVideoFrame {
+    constructor(width: int, height: int, pts: long, data: ArrayBuffer);
+    
+    /** {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 The data type of the video. See [VeLiveVideoBufferType](#VeLiveVideoBufferType) for details.
+     *
+     */
+    getBufferType(): VeLiveVideoBufferType;
+    
+    /** {en}
+     * @detail api
+     * @brief Sets the data type of the video.
+     * @param bufferType The data type of the video. See [VeLiveVideoBufferType](#VeLiveVideoBufferType) for details.
+     * @return The video frame object. See [VeLiveVideoFrame](#VeLiveVideoFrame) for details.
+     *
+     */
+    setBufferType(bufferType: VeLiveVideoBufferType): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the pixel format.
+     * @return
+     *         The pixel format. See [VeLivePixelFormat](#VeLivePixelFormat) for details.
+     *
+     */
+    getPixelFormat(): VeLivePixelFormat;
+    
+    /** {en}
+     * @detail api
+     * @brief Sets the pixel format.
+     * @param pixelFormat The pixel format. See [VeLivePixelFormat](#VeLivePixelFormat) for details.
+     * @return The video frame object. See [VeLiveVideoFrame](#VeLiveVideoFrame) for details.
+     *
+     */
+    setPixelFormat(pixelFormat: VeLivePixelFormat): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the rotation angle in a clockwise direction.
+     * @return The rotation angle in a clockwise direction. See [VeLiveVideoRotation](#VeLiveVideoRotation) for details.
+     *
+     */
+    getRotation(): VeLiveVideoRotation;
+    
+    /** {en}
+     * @detail api
+     * @brief Sets the rotation angle in a clockwise direction.
+     * @param rotation The rotation angle in a clockwise direction. See [VeLiveVideoRotation](#VeLiveVideoRotation) for details.
+     * @return
+     *         The video frame object. See [VeLiveVideoFrame](#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 The texture matrix.
+     *
+     */
+    getTextureMatrix(): Matrix;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the video data in the format of ByteBuffer.
+     * @return The video data in the format of ByteBuffer.
+     *
+     */
+    getBuffer(): ByteBuffer;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the video data in the format of byte [].
+     * @return The video data in the format of byte [].
+     *
+     */
+    getData(): ArrayBuffer;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the internal release callback.
+     * @return The internal release callback.
+     *
+     */
+    getReleaseCallback(): Runnable;
+    
+    /** {en}
+     * @detail api
+     * @brief Sets the internal release callback.
+     * @param releaseCallback The internal release callback.
+     * @return The video frame object. See [VeLiveVideoFrame](#VeLiveVideoFrame) for details.
+     *
+     */
+    setReleaseCallback(releaseCallback: Runnable): this;
+}
 export declare enum VeLiveAudioCodec {
     
+    /** {en}
+     * @brief FDKAAC.
+     *
+     */
     VeLiveAudioCodecFdkAAC = 0,
     
+    /** {en}
+     * @brief Mediacodec AAC.
+     *
+     */
     VeLiveAudioCodecMediaCodecAAC = 1,
     
+    /** {en}
+     * @brief FFMPEG AAC.
+     *
+     */
     VeLiveAudioCodecFFmpegAAC = 2
 }
 export declare enum VeLiveVideoCodec {
     
+    /** {en}
+     * @brief H.264.
+     *
+     */
     VeLiveVideoCodecH264 = 0,
     
+    /** {en}
+     * @brief ByteVC1, an encoding format developed by BytePlus.
+     *
+     */
     VeLiveVideoCodecByteVC1 = 1
 }
 export declare class VeLivePusherStatistics {
     
+    /** {en}
+     * @brief The width of the encoded video, in pixels.
+     *
+     */
     encodeWidth: int;
     
+    /** {en}
+     * @brief The height of the encoded video, in pixels.
+     *
+     */
     encodeHeight: int;
     
+    /** {en}
+     * @brief The width of the captured video, in pixels.
+     *
+     */
     captureWidth: int;
     
+    /** {en}
+     * @brief The height of the captured video, in pixels.
+     *
+     */
     captureHeight: int;
     
+    /** {en}
+     * @brief The captured frame rate, in fps.
+     *
+     */
     captureFps: double;
     
+    /** {en}
+     * @brief The encoded frame rate, in fps.
+     *
+     */
     encodeFps: double;
     
+    /** {en}
+     * @brief The transmission frame rate, in fps. You can use this parameter to showcase the real-time frame rate on the user interface.
+     *
+     */
     transportFps: double;
     
+    /** {en}
+     * @brief The encoded frame rate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in fps.
+     *
+     */
     fps: int;
     
+    /** {en}
+     * @brief The encoded bitrate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
+     *
+     */
     videoBitrate: int;
     
+    /** {en}
+     * @brief The minimum encoded bitrate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
+     *
+     */
     minVideoBitrate: int;
     
+    /** {en}
+     * @brief The maximum encoded bitrate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
+     *
+     */
     maxVideoBitrate: int;
     
+    /** {en}
+     * @brief The encoded video bitrate, in Kbps.
+     *
+     */
     encodeVideoBitrate: double;
     
+    /** {en}
+     * @brief The transmission bitrate, in Kbps. You can use this parameter to showcase the real-time bitrate on the user interface.
+     *
+     */
     transportVideoBitrate: double;
     
+    /** {en}
+     * @brief The audio encoding bitrate, in Kbps.
+     *
+     */
     encodeAudioBitrate: double;
     
+    /** {en}
+     * @brief The push stream address.
+     *
+     */
     url: String;
     
+    /** {en}
+     * @brief The video codec.
+     *
+     */
     codec: String;
 }
 export declare enum VeLivePusherRenderMode {
     
+    /** {en}
+     * @brief Stretch the video to fill the screen. The aspect ratio of the video might change.
+     *
+     */
     VeLivePusherRenderModeFill = 0,
     
+    /** {en}
+     * @brief Display the full video. The video is uniformly scaled until one dimension of the video hits the boundary of the screen. Any remaining space on the screen will be filled with background color.
+     *
+     */
     VeLivePusherRenderModeFit = 1,
     
+    /** {en}
+     * @brief Uniformly scale the video until the screen is completely filled. Part of the video may be cropped.
+     *
+     */
     VeLivePusherRenderModeHidden = 2
 }
 export declare enum VeLiveVideoEffectLicenseType {
     
+    /** {en}
+     * @brief Authenticate offline.
+     *
+     */
     VeLiveVideoEffectLicenseTypeOffLine = 0,
     
+    /** {en}
+     * @brief Authenticate online.
+     *
+     */
     VeLiveVideoEffectLicenseTypeOnLine = 1
 }
 export declare enum VeLiveAudioBufferType {
     
+    /** {en}
+     * @brief Unknown data type.
+     *
+     */
     VeLiveAudioBufferTypeUnknown = 0,
     
+    /** {en}
+     * @brief ByteBuffer.
+     *
+     */
     VeLiveAudioBufferTypeByteBuffer = 1
 }
 export declare enum VeLiveAudioChannel {
     
+    /** {en}
+     * @brief Mono, which is suitable for voice communication and saves bandwidth.
+     *
+     */
     VeLiveAudioChannelMono = 1,
     
+    /** {en}
+     * @brief Stereo, which provides a richer audio experience and is suitable for music playback.
+     *
+     */
     VeLiveAudioChannelStereo = 2
 }
 export declare enum VeLiveFirstFrameType {
     
+    /** {en}
+     * @brief The first audio or video frame captured by the microphone or the camera.
+     *
+     */
     VeLiveFirstCaptureFrame = 0,
     
+    /** {en}
+     * @brief The first video frame rendered, which is the first frame displayed on the screen.
+     *
+     */
     VeLiveFirstRenderFrame = 1,
     
+    /** {en}
+     * @brief The first audio or video frame encoded in a certain format.
+     *
+     */
     VeLiveFirstEncodedFrame = 2,
     
+    /** {en}
+     * @brief The first audio or video frame transmitted through the network.
+     *
+     */
     VeLiveFirstSendFrame = 3
 }
 export declare enum VeLiveVideoCaptureType {
     
+    /** {en}
+     * @brief Capture the video with the front-facing camera.
+     *
+     */
     VeLiveVideoCaptureFrontCamera = 0,
     
+    /** {en}
+     * @brief Capture the video with the rear camera.
+     *
+     */
     VeLiveVideoCaptureBackCamera = 1,
     
+    /** {en}
+     * @brief Capture the video with dual cameras.
+     *
+     */
     VeLiveVideoCaptureDualCamera = 2,
     
+    /** {en}
+     * @brief Capture the screen.
+     *
+     */
     VeLiveVideoCaptureScreen = 3,
     
+    /** {en}
+     * @brief Capture the video with an external device or source.
+     *
+     */
     VeLiveVideoCaptureExternal = 4,
     
+    /** {en}
+     * @brief Use a static image as the video source.
+     *
+     */
     VeLiveVideoCaptureCustomImage = 5,
     
+    /** {en}
+     * @brief Use the last frame as the video source.
+     *
+     */
     VeLiveVideoCaptureLastFrame = 6,
     
+    /** {en}
+     * @brief Use a black frame as the video source. This is usually used for debugging purposes or in special circumstances.
+     *
+     */
     VeLiveVideoCaptureDummyFrame = 7
 }
 export declare enum VeLiveVideoProfile {
     
+    /** {en}
+     * @brief  Unknown codec.
+     *
+     */
     VeLiveVideoProfileUnknown = 0,
     
+    /** {en}
+     * @brief  H.264, using Baseline level.
+     *
+     */
     VeLiveVideoProfileH264Baseline = 1,
     
+    /** {en}
+     * @brief  H.264, using Main level.
+     *
+     */
     VeLiveVideoProfileH264Main = 2,
     
+    /** {en}
+     * @brief  H.264, using High level.
+     *
+     */
     VeLiveVideoProfileH264High = 3,
     
+    /** {en}
+     * @brief  ByteVC1, using Main level.
+     *
+     */
     VeLiveVideoProfileByteVC1Main = 4
 }
 export declare enum VeLiveVideoRotation {
     
+    /** {en}
+     * @brief Do not rotate.
+     *
+     */
     VeLiveVideoRotation0 = 0,
     
+    /** {en}
+     * @brief Rotate by 90 degrees clockwise.
+     *
+     */
     VeLiveVideoRotation90 = 90,
     
+    /** {en}
+     * @brief Rotate by 180 degrees clockwise.
+     *
+     */
     VeLiveVideoRotation180 = 180,
     
+    /** {en}
+     * @brief Rotate by 270 degrees clockwise.
+     *
+     */
     VeLiveVideoRotation270 = 270
 }
 export declare enum VeLiveVideoFrameSource {
     
+    /** {en}
+     * @brief The original video frame captured by the camera or other video sources.
+     *
+     */
     VeLiveVideoFrameSourceCapture = 1,
     
+    /** {en}
+     * @brief The video frame to be encoded after undergoing various processes, such as filtering and rotation.
+     *
+     */
     VeLiveVideoFrameSourcePreEncode = "1 << 1"
 }
 export declare enum VeLiveAudioProfile {
     
+    /** {en}
+     * @brief LC-AAC.
+     *
+     */
     VeLiveAudioAACProfileLC = 0,
     
+    /** {en}
+     * @brief HEv1-AAC.
+     *
+     */
     VeLiveAudioAACProfileHEv1 = 1,
     
+    /** {en}
+     * @brief HEv2-AAC.
+     *
+     */
     VeLiveAudioAACProfileHEv2 = 2
 }
 export declare enum VeLiveVideoBufferType {
     
+    /** {en}
+     * @brief Unknown data type, which is the default type if you do not specify any type.
+     *
+     */
     VeLiveVideoBufferTypeUnknown = 0,
     
+    /** {en}
+     * @brief OpenGL texture.
+     *
+     */
     VeLiveVideoBufferTypeTexture = 1,
     
+    /** {en}
+     * @brief ByteBuffer.
+     *
+     */
     VeLiveVideoBufferTypeByteBuffer = 2,
     
+    /** {en}
+     * @brief ByteArray.
+     *
+     */
     VeLiveVideoBufferTypeByteArray = 3
 }
 export declare class VeLiveAudioCaptureConfiguration {
@@ -332,8 +721,7 @@ export declare class VeLiveAudioCaptureConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the sample rate.
-     * @return  <br>
-     *      The sample rate. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
+     * @return The sample rate. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details.
      *
      */
     getSampleRate(): VeLiveAudioSampleRate;
@@ -341,8 +729,8 @@ export declare class VeLiveAudioCaptureConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the sample rate.
-     * @return <br>The audio capture configurations. See VeLiveAudioCaptureConfiguration for details.
-     * @param sampleRate The sample rate. The default value is `VeLiveAudioSampleRate44100`. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
+     * @param sampleRate The sample rate. The default value is `VeLiveAudioSampleRate44100`. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details.
+     * @return The audio capture configurations. See [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration) for details.
      *
      */
     setSampleRate(sampleRate: VeLiveAudioSampleRate): this;
@@ -350,8 +738,7 @@ export declare class VeLiveAudioCaptureConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the number of audio channels.
-     * @return  <br>
-     *      The number of audio channels. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
+     * @return The number of audio channels. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details.
      *
      */
     getChannel(): VeLiveAudioChannel;
@@ -359,44 +746,100 @@ export declare class VeLiveAudioCaptureConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the number of audio channels.
-     * @return <br>The audio capture configurations. See VeLiveAudioCaptureConfiguration for details.
-     * @param channel The number of audio channels. The default value is `VeLiveAudioChannelStereo`. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
+     * @param channel The number of audio channels. The default value is `VeLiveAudioChannelStereo`. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details.
+     * @return The audio capture configurations. See [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration) for details.
      *
      */
     setChannel(channel: VeLiveAudioChannel): this;
 }
 export declare class VeLiveStreamMixDescription {
     
+    /** {en}
+     * @brief An array of video mixing configurations, where each array element represents the mixing configurations of a video stream. See [VeLiveMixVideoLayout](#VeLivePusherDef-VeLiveMixVideoLayout) for details.
+     *
+     */
     mixVideoStreams: ArrayList<VeLiveMixVideoLayout>;
     
+    /** {en}
+     * @brief An array of audio mixing configurations, where each array element represents the mixing configurations of an audio stream. See [VeLiveMixAudioLayout](#VeLivePusherDef-VeLiveMixAudioLayout) for details.
+     *
+     */
     mixAudioStreams: ArrayList<VeLiveMixAudioLayout>;
     
+    /** {en}
+     * @brief The background color of the mixed video, in #RRGGBB format.
+     *
+     */
     backgroundColor: String;
 }
 export declare enum VeLiveAudioSampleRate {
     
+    /** {en}
+     * @brief 8K.
+     *
+     */
     VeLiveAudioSampleRate8000 = 8000,
     
+    /** {en}
+     * @brief 16K.
+     *
+     */
     VeLiveAudioSampleRate16000 = 16000,
     
+    /** {en}
+     * @brief 32K.
+     *
+     */
     VeLiveAudioSampleRate32000 = 32000,
     
+    /** {en}
+     * @brief 44.1K.
+     *
+     */
     VeLiveAudioSampleRate44100 = 44100,
     
+    /** {en}
+     * @brief 48K.
+     *
+     */
     VeLiveAudioSampleRate48000 = 48000
 }
 export declare enum VeLiveAudioPowerLevel {
     
+    /** {en}
+     * @brief Muted. The volume is 1 dB or less.
+     *
+     */
     VeLiveAudioPowerLevelSilent = 0,
     
+    /** {en}
+     * @brief Quiet. The volume is below 15 dB.
+     *
+     */
     VeLiveAudioPowerLevelQuiet = 1,
     
+    /** {en}
+     * @brief Soft, close to whisper. The volume is between 16 dB and 30 dB.
+     *
+     */
     VeLiveAudioPowerLevelLight = 2,
     
+    /** {en}
+     * @brief Normal, similar to the volume in a daily conversation. The volume is between 30 dB and 60 dB.
+     *
+     */
     VeLiveAudioPowerLevelNormal = 3,
     
+    /** {en}
+     * @brief Loud, similar to the volume of the noise at cafes. The volume is between 61 dB and 85 dB.
+     *
+     */
     VeLiveAudioPowerLevelLoud = 4,
     
+    /** {en}
+     * @brief Noisy, similar to the volume of the noise on a busy street or at a concert. The volume is higher than 85 dB.
+     *
+     */
     VeLiveAudioPowerLevelNoise = 5
 }
 export declare class VeLiveVideoCaptureConfiguration {
@@ -404,8 +847,7 @@ export declare class VeLiveVideoCaptureConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the width of the captured video.
-     * @return  <br>
-     *      The width of the captured video.
+     * @return The width of the captured video.
      *
      */
     getWidth(): int;
@@ -413,181 +855,507 @@ export declare class VeLiveVideoCaptureConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the width of the captured video.
-     * @return <br>The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
      * @param width The width of the captured video. The default value is `720`.
+     * @return The video capture configurations. See [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration) for details.
+     *
+     */
+    setWidth(width: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the height of the captured video.
+     * @return  <br>
+     *      The height of the captured video.
+     *
+     */
+    getHeight(): int;
+    
+    /** {en}
+     * @detail api
+     * @brief Sets the height of the captured video.
+     * @param height The height of the captured video. The default value is `1280`.
+     * @return The video capture configurations. See [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration) for details.
+     *
+     */
+    setHeight(height: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the captured frame rate.
+     * @return The captured frame rate.
+     *
+     */
+    getFps(): int;
+    
+    /** {en}
+     * @detail api
+     * @brief Sets the captured frame rate.
+     * @param fps The captured frame rate. The default value is `15`.
+     * @return The video capture configurations. See [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration) for details.
+     *
+     */
+    setFps(fps: int): this;
+}
+export declare enum VeLivePixelFormat {
+    
+    /** {en}
+     * @brief Unknown format.
+     *
+     */
+    VeLivePixelFormatUnknown = 0,
+    
+    /** {en}
+     * @brief I420.
+     *
+     */
+    VeLivePixelFormatI420 = 1,
+    
+    /** {en}
+     * @brief NV12.
+     *
+     */
+    VeLivePixelFormatNV12 = 2,
+    
+    /** {en}
+     * @brief NV21.
+     *
+     */
+    VeLivePixelFormatNV21 = 3,
+    
+    /** {en}
+     * @brief 2D texture.
+     *
+     */
+    VeLivePixelFormat2DTexture = 4,
+    
+    /** {en}
+     * @brief OES texture.
+     *
+     */
+    VeLivePixelFormatOesTexture = 5
+}
+export declare enum VeLivePusherStatus {
+    
+    /** {en}
+     * @brief The initial state.
+     *
+     */
+    VeLivePushStatusNone = 0,
+    
+    /** {en}
+     * @brief Connecting to the server.
+     *
+     */
+    VeLivePushStatusConnecting = 1,
+    
+    /** {en}
+     * @brief The connection with the server is established.
+     *
+     */
+    VeLivePushStatusConnectSuccess = 2,
+    
+    /** {en}
+     * @brief Reconnecting to the server.
+     *
+     */
+    VeLivePushStatusReconnecting = 3,
+    
+    /** {en}
+     * @brief Stops connecting to the server.
+     *
+     */
+    VeLivePushStatusConnectStop = 4,
+    
+    /** {en}
+     * @brief Fails to connect to the server.
+     *
+     */
+    VeLivePushStatusConnectError = 5,
+    
+    /** {en}
+     * @brief The connection with the server is lost.
+     *
+     */
+    VeLivePushStatusDisconnected = 6
+}
+export declare enum VeLiveVideoResolution {
+    
+    /** {en}
+     * @brief 360P.
+     *         - Resolution in landscape mode: 640x360
+     *         - Resolution in portrait mode: 360x640
+     *         - Frame rate: 15 fps
+     *         - Target bitrate: 500 Kbps
+     *         - Minimum bitrate: 250 Kbps
+     *         - Maximum bitrate: 800 Kbps
+     *
+     */
+    VeLiveVideoResolution360P = "VeLiveVideoResolution360P",
+    
+    /** {en}
+     * @brief 480P.
+     *         - Resolution in landscape mode: 864x480
+     *         - Resolution in portrait mode: 480x864
+     *         - Frame rate: 15 fps
+     *         - Target bitrate: 800 Kbps
+     *         - Minimum bitrate: 320 Kbps
+     *         - Maximum bitrate: 1266 Kbps
+     *
+     */
+    VeLiveVideoResolution480P = "VeLiveVideoResolution480P",
+    
+    /** {en}
+     * @brief 540P.
+     *         - Resolution in landscape mode: 960x540
+     *         - Resolution in portrait mode: 540x960
+     *         - Frame rate: 15 fps
+     *         - Target bitrate: 1000 Kbps
+     *         - Minimum bitrate: 500 Kbps
+     *         - Maximum bitrate: 1520 Kbps
+     *
+     */
+    VeLiveVideoResolution540P = "VeLiveVideoResolution540P",
+    
+    /** {en}
+     * @brief 720P.
+     *         - Resolution in landscape mode: 1280x720
+     *         - Resolution in portrait mode: 720x1280
+     *         - Frame rate: 15 fps
+     *         - Target bitrate: 1200 Kbps
+     *         - Minimum bitrate: 800 Kbps
+     *         - Maximum bitrate: 1900 Kbps
+     *
+     */
+    VeLiveVideoResolution720P = "VeLiveVideoResolution720P",
+    
+    /** {en}
+     * @brief 1080P.
+     *         - Resolution in landscape mode: 1920x1080
+     *         - Resolution in portrait mode: 1080x1920
+     *         - Frame rate: 20 fps
+     *         - Target bitrate: 2500 Kbps
+     *         - Minimum bitrate: 1000 Kbps
+     *         - Maximum bitrate: 3800 Kbps
+     *
+     */
+    VeLiveVideoResolution1080P = "VeLiveVideoResolution1080P"
+}
+export declare class VeLiveAudioFrame {
+    constructor();
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the audio data type.
+     * @return The audio data type. See [VeLiveAudioBufferType](#VeLiveAudioBufferType) for details.
+     *
+     */
+    getBufferType(): VeLiveAudioBufferType;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the audio sample rate.
+     * @return The audio sample rate. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details.
      *
      */
-    setWidth(width: int): this;
+    getSampleRate(): VeLiveAudioSampleRate;
     
     /** {en}
      * @detail api
-     * @brief Gets the height of the captured video.
-     * @return  <br>
-     *      The height of the captured video.
+     * @brief Gets the number of audio channels.
+     * @return The number of audio channels. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details.
      *
      */
-    getHeight(): int;
+    getChannels(): VeLiveAudioChannel;
     
     /** {en}
      * @detail api
-     * @brief Sets the height of the captured video.
-     * @return <br>The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
-     * @param height The height of the captured video. The default value is `1280`.
+     * @brief Get the number of sampling points of each channel.
+     * @return Number of sampling points.
      *
      */
-    setHeight(height: int): this;
+    getSamplesPerChannel(): int;
     
     /** {en}
      * @detail api
-     * @brief Gets the captured frame rate.
+     * @brief Gets the audio timestamp, in μs.
      * @return  <br>
-     *      The captured frame rate.
+     *     The timestamp of the audio frame, in μs.
      *
      */
-    getFps(): int;
+    getPts(): long;
     
     /** {en}
      * @detail api
-     * @brief Sets the captured frame rate.
-     * @return <br>The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
-     * @param fps The captured frame rate. The default value is `15`.
+     * @brief Gets the audio data. The audio data is stored in little-endian byte order.
+     * @return  <br>
+     *      The audio data in the format of ByteBuffer.
      *
      */
-    setFps(fps: int): this;
-}
-export declare enum VeLivePixelFormat {
-    
-    VeLivePixelFormatUnknown = 0,
-    
-    VeLivePixelFormatI420 = 1,
-    
-    VeLivePixelFormatNV12 = 2,
-    
-    VeLivePixelFormatNV21 = 3,
-    
-    VeLivePixelFormat2DTexture = 4,
-    
-    VeLivePixelFormatOesTexture = 5
-}
-export declare enum VeLivePusherStatus {
-    
-    VeLivePushStatusNone = 0,
-    
-    VeLivePushStatusConnecting = 1,
-    
-    VeLivePushStatusConnectSuccess = 2,
-    
-    VeLivePushStatusReconnecting = 3,
-    
-    VeLivePushStatusConnectStop = 4,
-    
-    VeLivePushStatusConnectError = 5,
-    
-    VeLivePushStatusDisconnected = 6
-}
-export declare enum VeLiveVideoResolution {
-    
-    VeLiveVideoResolution360P = "VeLiveVideoResolution360P",
-    
-    VeLiveVideoResolution480P = "VeLiveVideoResolution480P",
-    
-    VeLiveVideoResolution540P = "VeLiveVideoResolution540P",
-    
-    VeLiveVideoResolution720P = "VeLiveVideoResolution720P",
-    
-    VeLiveVideoResolution1080P = "VeLiveVideoResolution1080P"
+    getBuffer(): ByteBuffer;
 }
 export declare enum VeLiveNetworkQuality {
     
+    /** {en}
+     * @brief Network status not found.
+     *
+     */
     VeLiveNetworkQualityUnknown = 0,
     
+    /** {en}
+     * @brief Bad network condition.
+     *
+     */
     VeLiveNetworkQualityBad = 1,
     
+    /** {en}
+     * @brief Poor network condition.
+     *
+     */
     VeLiveNetworkQualityPoor = 2,
     
+    /** {en}
+     * @brief Good network condition.
+     *
+     */
     VeLiveNetworkQualityGood = 3
 }
 export declare enum VeLivePusherLogLevel {
     
+    /** {en}
+     * @brief Output VERBOSE, DEBUG, INFO, WARNING and ERROR.
+     *
+     */
     VeLiveLogLevelVerbose = 0,
     
+    /** {en}
+     * @brief Output DEBUG, INFO, WARNING and ERROR.
+     *
+     */
     VeLiveLogLevelDebug = 1,
     
+    /** {en}
+     * @brief Output INFO, WARNING and ERROR.
+     *
+     */
     VeLiveLogLevelInfo = 2,
     
+    /** {en}
+     * @brief Output WARNING and ERROR.
+     *
+     */
     VeLiveLogLevelWarn = 3,
     
+    /** {en}
+     * @brief Output ERROR.
+     *
+     */
     VeLiveLogLevelError = 4,
     
+    /** {en}
+     * @brief Disable logging.
+     *
+     */
     VeLiveLogLevelNone = 5
 }
 export declare enum VeLiveAudioBitDepth {
     
+    /** {en}
+     * @brief 16bit.
+     *
+     */
     VeLiveAudioBitDepth16 = 16
 }
 export declare class VeLiveMixAudioLayout {
     
+    /** {en}
+     * @brief The unique identifier for an audio stream.
+     *
+     */
     streamId: int;
     
+    /** {en}
+     * @detail api
+     * @brief The volume of the mixed audio stream. The value range is [0.0,4.0]. If you set [VeLiveAudioMixType](#VeLiveAudioMixType) to `VeLiveAudioMixPlayAndPush`, this variable takes effect on both the host and the audience sides.
+     *
+     */
     volume: float;
     
     /** {en}
      * @detail api
      * @brief Updates audio mixing configurations.
-     * @param other New audio mixing configurations. See VeLiveMixAudioLayout for details.
+     * @param other New audio mixing configurations. See [VeLiveMixAudioLayout](#VeLivePusherDef-VeLiveMixAudioLayout) for details.
      *
      */
     update(other: VeLiveMixAudioLayout): void;
 }
-export declare enum VeLiveOrientation {
+export declare class VeLivePusherConfiguration {
     
-    VeLiveOrientationLandscape = 0,
+    /** {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;
     
-    VeLiveOrientationPortrait = 1
-}
-export declare enum VeLiveVideoMirrorType {
+    /** {en}
+     * @detail api
+     * @brief Gets the time interval between each attempt to reconnect.
+     * @order 3
+     * @return  <br>
+     *      The time interval between each attempt to reconnect, in seconds.
+     *
+     */
+    getReconnectIntervalSeconds(): int;
     
-    VeLiveVideoMirrorCapture = 0,
+    /** {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;
     
-    VeLiveVideoMirrorPreview = 1,
+    /** {en}
+     * @detail api
+     * @brief Gets the number of attempts to reconnect after the initial attempt fails.
+     * @order 5
+     * @return  <br>
+     *      The number of attempts to reconnect after the initial attempt fails.
+     *
+     */
+    getReconnectCount(): int;
     
-    VeLiveVideoMirrorPushStream = 2
-}
-export declare class VeLivePusherLogConfig {
+    /** {en}
+     * @detail api
+     * @brief Sets the video capture configurations.
+     * @order 6
+     * @param config The video capture configurations. See [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration) for details.
+     * @return
+     *         The pusher configurations. See [VeLivePusherConfiguration](#VeLivePusherConfiguration) for details.
+     *
+     */
+    setVideoCaptureConfig(config: VeLiveVideoCaptureConfiguration): this;
     
-    logPath: String;
+    /** {en}
+     * @detail api
+     * @brief Gets the video capture configurations.
+     * @order 7
+     * @return The video capture configurations. See [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration) for details.
+     *
+     */
+    getVideoCaptureConfig(): VeLiveVideoCaptureConfiguration;
     
-    maxLogSizeM: int;
+    /** {en}
+     * @detail api
+     * @brief Sets the audio capture configurations.
+     * @order 7
+     * @param config The audio capture configurations. See [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration) for details.
+     * @return The pusher configurations. See [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration) for details.
+     *
+     */
+    setAudioCaptureConfig(config: VeLiveAudioCaptureConfiguration): this;
     
-    singleLogSizeM: int;
+    /** {en}
+     * @detail api
+     * @brief Gets the audio capture configurations.
+     * @order 8
+     * @return The audio capture configurations. See [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration) for details.
+     *
+     */
+    getAudioCaptureConfig(): VeLiveAudioCaptureConfiguration;
     
-    logExpireTimeS: long;
+    /** {en}
+     * @detail api
+     * @brief Sets the context of the application.
+     * @param context The context of the application.
+     * @order 9
+     * @return The pusher configurations. See [VeLivePusherConfiguration](#VeLivePusherConfiguration) for details.
+     *
+     */
+    setContext(context: Context): this;
     
-    enableThreadLoop: int;
+    /** {en}
+     * @detail api
+     * @brief Gets the context of the application.
+     * @order 10
+     * @return  <br>
+     *      The context of the application.
+     *
+     */
+    getContext(): Context;
     
-    enableStdout: int;
+    /** {en}
+     * @detail api
+     * @brief Sets advanced parameters. You can leave this parameter empty. If you need to use it, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support.
+     * @param params Extension parameters.
+     * @order 11
+     * @return The pusher configurations. See [VeLivePusherConfiguration](#VeLivePusherConfiguration) for details.
+     *
+     */
+    setExtraParameters(params: String): this;
     
-    enableLogFile: int;
+    /** {en}
+     * @detail api
+     * @brief Gets advanced parameters.
+     * @order 12
+     * @return  <br>
+     *      Advanced parameters.
+     *
+     */
+    getExtraParams(): LiveSdkSetting;
     
-    logLevel: int;
+    /** {en}
+     * @detail api
+     * @brief Creates the live pusher.
+     * @order 1
+     * @return The live pusher. See [VeLivePusher](docs-broadcast-sdk-for-android-api#VeLivePusher) for details.
+     *
+     */
+    build(): VeLivePusher;
+}
+export declare enum VeLiveOrientation {
     
-    intervalMs: long;
+    /** {en}
+     * @brief The landscape mode.
+     *
+     */
+    VeLiveOrientationLandscape = 0,
     
-    queryUrl: String;
+    /** {en}
+     * @brief The portrait mode.
+     *
+     */
+    VeLiveOrientationPortrait = 1
+}
+export declare enum VeLiveVideoMirrorType {
     
-    device_id: String;
+    /** {en}
+     * @brief Mirror the captured video. When turned on, both the preview and the pushed video are mirrored.
+     *
+     */
+    VeLiveVideoMirrorCapture = 0,
     
-    httpTimeoutMS: int;
+    /** {en}
+     * @brief Mirror the preview. When turned on, only the preview is mirrored.
+     *
+     */
+    VeLiveVideoMirrorPreview = 1,
     
-    httpUploadFileTimeoutMS: int;
+    /** {en}
+     * @brief Mirror the video before encoding. When turned on, only the pushed video is mirrored.
+     *
+     */
+    VeLiveVideoMirrorPushStream = 2
 }
 export declare class VeLiveFileRecorderConfiguration {
     
     /** {en}
      * @detail api
      * @brief Gets the width of the recorded video.
-     * @return  <br>
-     *      The width of the recorded video.
+     * @return The width of the recorded video.
      *
      */
     getWidth(): int;
@@ -595,8 +1363,8 @@ export declare class VeLiveFileRecorderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the width of the recorded video.
-     * @return <br>The local recording configurations. See VeLiveFileRecorderConfiguration for details.
      * @param width The width of the recorded video. The default value is `360`.
+     * @return The local recording configurations. See [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration) for details.
      *
      */
     setWidth(width: int): this;
@@ -604,8 +1372,7 @@ export declare class VeLiveFileRecorderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the height of the recorded video.
-     * @return  <br>
-     *      The height of the recorded video.
+     * @return The height of the recorded video.
      *
      */
     getHeight(): int;
@@ -613,8 +1380,8 @@ export declare class VeLiveFileRecorderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the height of the recorded video.
-     * @return <br>The local recording configurations. See VeLiveFileRecorderConfiguration for details.
      * @param height The height of the recorded video, the default value is `640`.
+     * @return The local recording configurations. See [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration) for details.
      *
      */
     setHeight(height: int): this;
@@ -622,8 +1389,7 @@ export declare class VeLiveFileRecorderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the frame rate of the recorded video.
-     * @return  <br>
-     *      The frame rate of the recorded video.
+     * @return The frame rate of the recorded video.
      *
      */
     getFps(): int;
@@ -631,8 +1397,8 @@ export declare class VeLiveFileRecorderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the frame rate of the recorded video.
-     * @return <br>The local recording configurations. See VeLiveFileRecorderConfiguration for details.
      * @param fps The frame rate of the recorded video. The default value is `15`.
+     * @return The local recording configurations. See [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration) for details.
      *
      */
     setFps(fps: int): this;
@@ -640,8 +1406,7 @@ export declare class VeLiveFileRecorderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the bitrate of the recorded video.
-     * @return  <br>
-     *      The bitrate of the recorded video.
+     * @return The bitrate of the recorded video.
      *
      */
     getBitrate(): int;
@@ -649,34 +1414,75 @@ export declare class VeLiveFileRecorderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the bitrate of the recorded video.
-     * @return <br>The local recording configurations. See VeLiveFileRecorderConfiguration for details.
      * @param bitrate The bitrate of the recorded video, in Kbps. The default value is `2000`.
+     * @return The local recording configurations. See [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration) for details.
      *
      */
     setBitrate(bitrate: int): this;
 }
 export declare class VeLiveMixVideoLayout {
     
+    /** {en}
+     * @brief The unique identifier for a video stream.
+     *
+     */
     streamId: int;
     
+    /** {en}
+     * @brief The horizontal offset, which represents the ratio of the distance between the left edge of the video and the left edge of the screen to the width of the screen. The value range is [0.0,1.0], where `0.0` indicates the left edge and `1.0` indicates the right edge.
+     *
+     */
     x: float;
     
+    /** {en}
+     * @brief The vertical offset, which represents the ratio of the distance between the top edge of the video and the top edge of the screen to the height of the screen. The value range is [0.0,1.0], where `0.0` indicates the top edge and `1.0` indicates the bottom edge.
+     *
+     */
     y: float;
     
+    /** {en}
+     * @brief The ratio of the video width to the screen width. The value range is [0.0,1.0], where `1.0` indicates that the video occupies the entire screen width.
+     *
+     */
     width: float;
     
+    /** {en}
+     * @brief The ratio of the video height to the screen height. The value range is [0.0,1.0], where `1.0` indicates that the video occupies the entire screen height.
+     *
+     */
     height: float;
     
+    /** {en}
+     * @brief The video transparency. The value range is [0.0, 1.0], where `0.0` indicates full transparency and `1.0` indicates full opacity.
+     *
+     */
     alpha: float;
     
+    /** {en}
+     * @brief The level of video within the final mixed video. The value range is [0,100], where `0` represents the bottom layer. The higher the value, the higher the level of the video in the final output.
+     *
+     */
     zOrder: int;
     
+    /** {en}
+     * @brief The render mode of the video. See [VeLivePusherRenderMode](#VeLivePusherRenderMode) for details.
+     *
+     */
     renderMode: VeLivePusherRenderMode;
     
+    /** {en}
+     * @brief Whether to retain the original Alpha channel value of the video stream. The default is retain. When the value of [alpha](#VeLiveMixVideoLayout-alpha) is within the range of [0.0, 1.0], this configuration is ignored.<br/>
+     *
+     *        - YES: Retain;
+     *        - NO: Do not retain.
+     *
+     */
+    enableAlpha: boolean;
+    
     /** {en}
      * @detail api
      * @brief Updates video mixing configurations.
-     * @param other New video mixing configurations. See VeLiveMixVideoLayout {@link #VeLiveMixVideoLayout} for details.
+     * @param other New video mixing configurations. See [VeLiveMixVideoLayout](#VeLivePusherDef-VeLiveMixVideoLayout) for details.
      *
      */
     update(other: VeLiveMixVideoLayout): void;
@@ -686,8 +1492,8 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
     /** {en}
      * @detail api
      * @brief Initializes the license configurations in local authentication mode.
-     * @return <br>A VeLiveVideoEffectLicenseConfiguration object that uses the specified local path for license authentication.
-     * @param path The local cache path for the video effects license. You can get the path through the getPath {@link #getPath} property.
+     * @param path The local cache path for the video effects license. You can get the path through the [getPath](#VeLiveVideoEffectLicenseConfiguration-getpath) property.
+     * @return A VeLiveVideoEffectLicenseConfiguration object that uses the specified local path for license authentication.
      *
      */
     static create(path: String): VeLiveVideoEffectLicenseConfiguration;
@@ -695,8 +1501,8 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
     /** {en}
      * @detail api
      * @brief Initializes the license configurations in local authentication mode.
-     * @return <br>A VeLiveVideoEffectLicenseConfiguration object that uses the specified local path for license authentication.
-     * @param path The local cache path for the video effects license. You can get the path through the getPath {@link #getPath} property.
+     * @param path The local cache path for the video effects license. You can get the path through the [getPath](#VeLiveVideoEffectLicenseConfiguration-getpath) property.
+     * @return A VeLiveVideoEffectLicenseConfiguration object that uses the specified local path for license authentication.
      *
      */
     static create_key$secret$url(key: String, secret: String, url: String): VeLiveVideoEffectLicenseConfiguration;
@@ -704,52 +1510,55 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the special effects license type.
-     * @return  <br>
-     *      The special effects license type. See VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} for details..
+     * @return The special effects license type. See [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) for details..
      *
      */
     getType(): VeLiveVideoEffectLicenseType;
     
     /** {en}
      * @detail api
-     * @brief Gets the local path to the video effects license.
-     * @return  <br>
-     *     The local path to the video effects license, when VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} is `VeLiveVideoEffectLicenseTypeOffLine`.
+     * @brief Gets the local path to the video effects license. When [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOffLine`, return the local path of the license file.
+     * @return The local path to the video effects license.
      *
      */
     getPath(): String;
     
     /** {en}
      * @detail api
-     * @brief Gets the online authentication key for the video effects licenses.
-     * @return  <br>
-     *     The online authentication key for the video effects license, when VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} is `VeLiveVideoEffectLicenseTypeOnLine`.
+     * @brief Gets the online authentication key for the video effects licenses, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
+     * @return The online authentication key for the video effects license.
      *
      */
     getKey(): String;
     
     /** {en}
      * @detail api
-     * @brief Gets the online authentication secret for the video effects license.
-     * @return  <br>
-     *     The online authentication secret for the video effects license, when VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} is `VeLiveVideoEffectLicenseTypeOnLine`.
+     * @brief Gets the online authentication secret for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
+     * @return The online authentication secret for the video effects license.
      *
      */
     getSecret(): String;
     
     /** {en}
      * @detail api
-     * @brief Gets the online authentication address for the video effects license.
-     * @return  <br>
-     *     The online authentication address for the video effects license, when VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} is `VeLiveVideoEffectLicenseTypeOnLine`.
+     * @brief Gets the online authentication address for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
+     * @return The online authentication address for the video effects license.
      *
      */
     getUrl(): String;
 }
 export declare enum VeLiveAudioFrameSource {
     
+    /** {en}
+     * @brief The original audio frame captured by the microphone or other audio sources.
+     *
+     */
     VeLiveAudioFrameSourceCapture = 1,
     
+    /** {en}
+     * @brief The audio frame to be encoded after undergoing various processes, such as noise cancellation and echo cancellation.
+     *
+     */
     VeLiveAudioFrameSourcePreEncode = "1 << 1"
 }
 export declare class VeLiveAudioEncoderConfiguration {
@@ -757,8 +1566,7 @@ export declare class VeLiveAudioEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the audio encoding bitrate.
-     * @return  <br>
-     *      The audio encoding bitrate.
+     * @return The audio encoding bitrate.
      *
      */
     getBitrate(): int;
@@ -766,8 +1574,8 @@ export declare class VeLiveAudioEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the audio encoding bitrate.
-     * @return <br>The audio encoding configurations. See VeLiveAudioEncoderConfiguration for details.
      * @param bitrate The audio encoding bitrate, in Kbps. The default value is `64`.
+     * @return The audio encoding configurations. See [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration) for details.
      *
      */
     setBitrate(bitrate: int): this;
@@ -775,8 +1583,7 @@ export declare class VeLiveAudioEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the encoding sample rate.
-     * @return  <br>
-     *      The encoding sample rate. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
+     * @return The encoding sample rate. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details.
      *
      */
     getSampleRate(): VeLiveAudioSampleRate;
@@ -784,8 +1591,8 @@ export declare class VeLiveAudioEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the encoding sample rate.
-     * @return <br>The audio encoding configurations. See VeLiveAudioEncoderConfiguration for details.
-     * @param sampleRate The encoding sample rate. The default value is `VeLiveAudioSampleRate44100`. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
+     * @param sampleRate The encoding sample rate. The default value is `VeLiveAudioSampleRate44100`. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details.
+     * @return The audio encoding configurations. See [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration) for details.
      *
      */
     setSampleRate(sampleRate: VeLiveAudioSampleRate): this;
@@ -793,8 +1600,7 @@ export declare class VeLiveAudioEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the number of audio channels for streaming.
-     * @return  <br>
-     *      The number of audio channels for streaming. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
+     * @return The number of audio channels for streaming. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details.
      *
      */
     getChannel(): VeLiveAudioChannel;
@@ -802,8 +1608,8 @@ export declare class VeLiveAudioEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the number of audio channels for streaming.
-     * @return <br>The audio encoding configurations. See VeLiveAudioEncoderConfiguration for details.
-     * @param channel The number of audio channels for streaming. The default value is `VeLiveAudioChannelStereo`. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
+     * @param channel The number of audio channels for streaming. The default value is `VeLiveAudioChannelStereo`. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details.
+     * @return The audio encoding configurations. See [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration) for details.
      *
      */
     setChannel(channel: VeLiveAudioChannel): this;
@@ -811,8 +1617,7 @@ export declare class VeLiveAudioEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Gets the audio encoding format.
-     * @return  <br>
-     *      The audio encoding format. See VeLiveAudioProfile {@link #VeLiveAudioProfile} for details.
+     * @return The audio encoding format. See [VeLiveAudioProfile](#VeLiveAudioProfile) for details.
      *
      */
     getProfile(): VeLiveAudioProfile;
@@ -820,27 +1625,55 @@ export declare class VeLiveAudioEncoderConfiguration {
     /** {en}
      * @detail api
      * @brief Sets the audio encoding format.
-     * @return <br>The audio encoding configurations. See VeLiveAudioEncoderConfiguration for details.
-     * @param profile The audio encoding format. The default value is `VeLiveAudioAACProfileLC`. See VeLiveAudioProfile {@link #VeLiveAudioProfile} for details.
+     * @param profile The audio encoding format. The default value is `VeLiveAudioAACProfileLC`. See [VeLiveAudioProfile](#VeLiveAudioProfile) for details.
+     * @return The audio encoding configurations. See [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration) for details.
      *
      */
     setProfile(profile: VeLiveAudioProfile): this;
 }
 export declare enum VeLiveAudioMixType {
     
+    /** {en}
+     * @brief The audience can hear the mixed audio, but the host cannot.
+     *
+     */
     VeLiveAudioMixPush = 0,
     
+    /** {en}
+     * @brief Both the host and audience can hear the mixed audio.
+     *
+     */
     VeLiveAudioMixPlayAndPush = 1
 }
 export declare enum VeLiveAudioCaptureType {
     
+    /** {en}
+     * @brief Capture the audio with the default microphone.
+     *
+     */
     VeLiveAudioCaptureMicrophone = 0,
     
+    /** {en}
+     * @brief Capture the audio in voice call mode, which will activate the 3A features of the hardware, including automatic gain control, automatic frequency control, and automatic noise suppression.
+     *
+     */
     VeLiveAudioCaptureVoiceCommunication = 1,
     
+    /** {en}
+     * @brief Capture the audio in screen recording.
+     *
+     */
     VeLiveAudioCaptureVoiceRecognition = 2,
     
+    /** {en}
+     * @brief Capture the audio with an external device or source.
+     *
+     */
     VeLiveAudioCaptureExternal = 3,
     
+    /** {en}
+     * @brief Use muted frames as the audio source.
+     *
+     */
     VeLiveAudioCaptureMuteFrame = 4
 }