@volcengine/react-native-live-push 1.0.0

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

@@ -0,0 +1,1069 @@
+import { int, double, String, ArrayList, float, long } from './types';
+export declare class VeLiveVideoEncoderConfiguration {
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频分辨率。
+     * @return <br>
+     *      推流视频分辨率 {@link #VeLiveVideoResolution VeLiveVideoResolution}。
+     */
+    getResolution(): VeLiveVideoResolution;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频分辨率。
+     * @param resolution 推流视频分辨率，默认值为 VeLiveVideoResolution720P，详情请参见 {@link #VeLiveVideoResolution VeLiveVideoResolution}
+     * @return <br>
+     *      推流视频编码参数配置对象，详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
+     */
+    setResolution(resolution: VeLiveVideoResolution): VeLiveVideoEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码格式。
+     * @return <br>
+     *      推流视频编码格式，详情请参见 {@link #VeLiveVideoCodec VeLiveVideoCodec}。
+     */
+    getCodec(): VeLiveVideoCodec;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码格式。
+     * @return 推流视频编码参数，详见 [VeLiveVideoEncoderConfiguration](147521#velivevideoencoderconfiguration)。
+     * @param codec <br>推流视频编码格式，详情请参见 [VeLiveVideoCodec](147521#VeLiveVideoCodec) 。
+     */
+    setCodec(codec: VeLiveVideoCodec): VeLiveVideoEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码码率。
+     * @return <br>
+     *      推流视频编码码率。
+     */
+    getBitrate(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码码率。
+     * @param bitrate 推流视频编码码率，单位为 kbps，默认值由 `resolution` 参数值决定。
+     * @return <br>
+     *      推流视频编码参数配置对象，详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
+     */
+    setBitrate(bitrate: int): VeLiveVideoEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码最小码率。
+     * @return <br>
+     *      推流视频编码最小码率。
+     */
+    getMinBitrate(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码最小码率。
+     * @param minBitrate 推流视频编码最小码率，单位为 kbps，默认值由 `resolution` 参数值决定；如果开启自适应码率，推流 SDK 根据网络情况进行编码码率自适应调整的最小码率
+     * @return <br>
+     *      推流视频编码参数配置对象，详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
+     */
+    setMinBitrate(minBitrate: int): VeLiveVideoEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码最大码率。
+     * @return <br>
+     *      推流视频编码最大码率。
+     */
+    getMaxBitrate(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码最大码率。
+     * @return <br>
+     *      推流视频编码参数配置对象，详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
+     * @param maxBitrate 推流视频编码最大码率，单位为 kbps，默认值由 `resolution` 参数值决定；如果开启自适应码率，推流 SDK 根据网络情况进行编码码率自适应调整的最大码率。
+     */
+    setMaxBitrate(maxBitrate: int): VeLiveVideoEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码 GOP。
+     * @return <br>
+     *      推流视频编码 GOP。
+     */
+    getGopSize(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码 GOP。
+     * @param gopSize 视频 GOP 大小，单位为 s，默认值为 2
+     * @return <br>
+     *      推流视频编码参数配置对象，详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
+     */
+    setGopSize(gopSize: int): VeLiveVideoEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码帧率。
+     * @return <br>
+     *      推流视频编码帧率。
+     */
+    getFps(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码帧率。
+     * @param fps 视频编码帧率，单位为 fps，默认值为 15
+     * @return <br>
+     *      推流视频编码参数配置对象，详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
+     */
+    setFps(fps: int): VeLiveVideoEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取是否开启 B 帧。
+     * @return <br>
+     *      是否开启B帧。<br>
+     *         - true：B 帧开启；
+     *         - false：B 帧关闭。
+     */
+    isEnableBFrame(): boolean;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码开启 B 帧。
+     * @param enableBFrame 是否开启 B 帧。默认为 false。 <br>
+     *               - true：开启；
+     *               - false：关闭。
+     * @return <br>
+     *      推流视频编码参数配置对象，详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
+     */
+    setEnableBFrame(enableBFrame: boolean): VeLiveVideoEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取是否开启硬件编码。
+     * @return <br>
+     *      是否开启硬件编码。<br>
+     *         - true：开启；
+     *         - false：关闭。
+     */
+    isEnableAccelerate(): boolean;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码开启硬件编码。
+     * @param enableAccelerate 是否开启硬件编码。默认值为 true。 <br>
+     *               - true：开启；
+     *               - false：关闭。
+     * @return <br>
+     *      推流视频编码参数配置对象，详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
+     */
+    setEnableAccelerate(enableAccelerate: boolean): VeLiveVideoEncoderConfiguration;
+}
+export declare enum VeLiveAudioCodec {
+    /** {zh}
+     * @brief FDKAAC 编码。
+     */
+    VeLiveAudioCodecFdkAAC = 0,
+    /** {zh}
+     * @brief Mediacodec AAC 编码。
+     */
+    VeLiveAudioCodecMediaCodecAAC = 1,
+    /** {zh}
+     * @brief FFMPEG AAC 编码。
+     */
+    VeLiveAudioCodecFFmpegAAC = 2
+}
+export declare enum VeLiveVideoCodec {
+    /** {zh}
+     * @brief 使用 H.264 视频编码。
+     */
+    VeLiveVideoCodecH264 = 0,
+    /** {zh}
+     * @brief 使用火山引擎自研 ByteVC1 视频编码。
+     */
+    VeLiveVideoCodecByteVC1 = 1
+}
+export declare class VeLivePusherStatistics {
+    /** {zh}
+     * @brief 视频编码宽度，单位为 px。
+     */
+    encodeWidth: int;
+    /** {zh}
+     * @brief 视频编码高度，单位为 px。
+     */
+    encodeHeight: int;
+    /** {zh}
+     * @brief 视频采集宽度，单位为 px。
+     */
+    captureWidth: int;
+    /** {zh}
+     * @brief 视频采集高度，单位为 px。
+     */
+    captureHeight: int;
+    /** {zh}
+     * @brief 视频采集帧率，单位为 fps。
+     */
+    captureFps: double;
+    /** {zh}
+     * @brief 视频编码帧率，单位为 fps。
+     */
+    encodeFps: double;
+    /** {zh}
+     * @brief 视频发送帧率，可用展示实时帧率，单位为 fps。
+     */
+    transportFps: double;
+    /** {zh}
+     * @brief 视频推流帧率，即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的帧率，单位为 fps。
+     */
+    fps: int;
+    /** {zh}
+     * @brief 视频推流码率，即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的码率，单位为 kbps。
+     */
+    videoBitrate: int;
+    /** {zh}
+     * @brief 视频推流最小码率，即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最小码率，单位为 kbps。
+     */
+    minVideoBitrate: int;
+    /** {zh}
+     * @brief 视频推流最大码率，即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最大码率，单位为 kbps。
+     */
+    maxVideoBitrate: int;
+    /** {zh}
+     * @brief 视频编码码率，单位为 kbps。
+     */
+    encodeVideoBitrate: double;
+    /** {zh}
+     * @brief 视频发送码率，可用于展示实时码率，单位为 kbps。
+     */
+    transportVideoBitrate: double;
+    /** {zh}
+     * @brief 音频编码码率，单位为 kbps。
+     */
+    encodeAudioBitrate: double;
+    /** {zh}
+     * @brief 推流地址。
+     */
+    url: String;
+    /** {zh}
+     * @brief 视频编码格式。
+     */
+    codec: String;
+}
+export declare enum VeLivePusherRenderMode {
+    /** {zh}
+     * @brief 视频帧自适应画布。视频帧非等比缩放，直至画布被填满。在此过程中，视频帧的长宽比例可能会发生变化。
+     */
+    VeLivePusherRenderModeFill = 0,
+    /** {zh}
+     * @brief 视频帧内容全部显示优先。视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成背景颜色。
+     */
+    VeLivePusherRenderModeFit = 1,
+    /** {zh}
+     * @brief 视窗填满优先。视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。
+     */
+    VeLivePusherRenderModeHidden = 2
+}
+export declare enum VeLiveVideoEffectLicenseType {
+    /** {zh}
+     * @brief 离线认证视频特效许可证。
+     */
+    VeLiveVideoEffectLicenseTypeOffLine = 0,
+    /** {zh}
+     * @brief 在线认证视频特效许可证。
+     */
+    VeLiveVideoEffectLicenseTypeOnLine = 1
+}
+export declare enum VeLiveAudioBufferType {
+    /** {zh}
+     * @brief 未知的音频数据类型。
+     */
+    VeLiveAudioBufferTypeUnknown = 0,
+    /** {zh}
+     * @brief ByteBuffer 音频数据类型。
+     */
+    VeLiveAudioBufferTypeByteBuffer = 1
+}
+export declare enum VeLiveAudioChannel {
+    /** {zh}
+     * @brief 单声道，适用于语音通信，节省带宽。
+     */
+    VeLiveAudioChannelMono = 0,
+    /** {zh}
+     * @brief 立体声，适用于音乐播放，提供更丰富的音频体验。
+     */
+    VeLiveAudioChannelStereo = 1
+}
+export declare enum VeLiveFirstFrameType {
+    /** {zh}
+     * @brief 视频/音频采集首帧，采集首帧是从音频设备或视频设备（如麦克风、摄像头）获取的第一帧数据。
+     */
+    VeLiveFirstCaptureFrame = 0,
+    /** {zh}
+     * @brief 视频渲染首帧，渲染首帧是在渲染过程中在屏幕上显示的第一帧视频数据。
+     */
+    VeLiveFirstRenderFrame = 1,
+    /** {zh}
+     * @brief 视频/音频编码完成首帧，编码完成首帧是编码为某种特定格式的第一帧数据。
+     */
+    VeLiveFirstEncodedFrame = 2,
+    /** {zh}
+     * @brief 视频/音频发送首帧，发送首帧是在发送过程中，通过网络传输的第一帧数据。
+     */
+    VeLiveFirstSendFrame = 3
+}
+export declare enum VeLiveVideoFluencyLevel {
+    /** {zh}
+     * @brief 流畅，帧率能达到预设的目标帧率
+     */
+    VeLiveVideoFluencyLevelSmooth = 0,
+    /** {zh}
+     * @brief 一般卡顿，帧率比预设的目标帧率低 1fps～3fps
+     */
+    VeLiveVideoFluencyLevelSluggish = 1,
+    /** {zh}
+     * @brief 严重卡顿，帧率比预设的目标帧率低 4fps 以上
+     */
+    VeLiveVideoFluencyLevelBlocked = 2
+}
+export declare enum VeLiveVideoCaptureType {
+    /** {zh}
+     * @brief 使用前置摄像头进行视频采集。
+     */
+    VeLiveVideoCaptureFrontCamera = 0,
+    /** {zh}
+     * @brief 使用后置摄像头进行视频采集。
+     */
+    VeLiveVideoCaptureBackCamera = 1,
+    /** {zh}
+     * @brief 使用设备的双摄进行视频采集。
+     */
+    VeLiveVideoCaptureDualCamera = 2,
+    /** {zh}
+     * @brief 使用屏幕采集。
+     */
+    VeLiveVideoCaptureScreen = 3,
+    /** {zh}
+     * @brief 使用外部设备或源进行视频采集。
+     */
+    VeLiveVideoCaptureExternal = 4,
+    /** {zh}
+     * @brief 使用指定的静态图片作为视频源。
+     */
+    VeLiveVideoCaptureCustomImage = 5,
+    /** {zh}
+     * @brief 使用最近采集的一帧图像重复作为视频源。
+     */
+    VeLiveVideoCaptureLastFrame = 6,
+    /** {zh}
+     * @brief 使用黑色帧作为视频源，一般用于调试或特殊需求。
+     */
+    VeLiveVideoCaptureDummyFrame = 7
+}
+export declare enum VeLiveVideoProfile {
+    /** {zh}
+     * @brief 未知的视频配置类型。
+     */
+    VeLiveVideoProfileUnknown = 0,
+    /** {zh}
+     * @brief H.264 编码配置，使用 Baseline 级别。
+     */
+    VeLiveVideoProfileH264Baseline = 1,
+    /** {zh}
+     * @brief H.264 编码配置，使用 Main 级别。
+     */
+    VeLiveVideoProfileH264Main = 2,
+    /** {zh}
+     * @brief H.264 编码配置，使用 High 级别。
+     */
+    VeLiveVideoProfileH264High = 3,
+    /** {zh}
+     * @brief ByteVC1 编码配置，使用 Main 级别。
+     */
+    VeLiveVideoProfileByteVC1Main = 4
+}
+export declare enum VeLiveVideoRotation {
+    /** {zh}
+     * @brief 不旋转。
+     */
+    VeLiveVideoRotation0 = 0,
+    /** {zh}
+     * @brief 顺时针旋转 90 度。
+     */
+    VeLiveVideoRotation90 = 1,
+    /** {zh}
+     * @brief 顺时针旋转 180 度。
+     */
+    VeLiveVideoRotation180 = 2,
+    /** {zh}
+     * @brief 顺时针旋转 270 度。
+     */
+    VeLiveVideoRotation270 = 3
+}
+export declare enum VeLiveVideoFrameSource {
+    /** {zh}
+     * @brief 采集到的原始视频帧。这是从设备的摄像头或其他视频输入源获取的视频帧。
+     */
+    VeLiveVideoFrameSourceCapture = 1,
+    /** {zh}
+     * @brief 编码前的视频帧。这是通过各种处理（例如滤镜、旋转等）后，准备进行编码的视频帧。
+     */
+    VeLiveVideoFrameSourcePreEncode = "1 << 1"
+}
+export declare enum VeLiveAudioProfile {
+    /** {zh}
+     * @brief LC-AAC 编码方式。
+     */
+    VeLiveAudioAACProfileLC = 0,
+    /** {zh}
+     * @brief HEv1-AAC 编码方式。
+     */
+    VeLiveAudioAACProfileHEv1 = 1,
+    /** {zh}
+     * @brief HEv2-AAC 编码方式。
+     */
+    VeLiveAudioAACProfileHEv2 = 2
+}
+export declare enum VeLiveVideoBufferType {
+    /** {zh}
+     * @brief 未知视频数据类型，当未指定输入视频数据的格式时，会默认为此类型。
+     */
+    VeLiveVideoBufferTypeUnknown = 0,
+    /** {zh}
+     * @brief 视频数据类型为 OpenGL 纹理。
+     */
+    VeLiveVideoBufferTypeTexture = 1,
+    /** {zh}
+     * @brief 视频数据类型为 ByteBuffer 类型。
+     */
+    VeLiveVideoBufferTypeByteBuffer = 2,
+    /** {zh}
+     * @brief 视频数据类型为 ByteArray 类型。
+     */
+    VeLiveVideoBufferTypeByteArray = 3
+}
+export declare class VeLiveAudioCaptureConfiguration {
+    /** {zh}
+     * @detail api
+     * @brief 获取采集音频采样率。
+     * @return <br>
+     *      音频采样率，详情请参见 {@link #VeLiveAudioSampleRate VeLiveAudioSampleRate}。
+     */
+    getSampleRate(): VeLiveAudioSampleRate;
+    /** {zh}
+     * @detail api
+     * @brief 设置采集音频采样率。
+     * @return <br>推流音频采集参数配置对象，详情请参见 [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration)
+     * @param sampleRate 音频采样率，默认值为 VeLiveAudioSampleRate44100，详情请参见 [VeLiveAudioSampleRate](147521#VeLiveAudioSampleRate)。
+     */
+    setSampleRate(sampleRate: VeLiveAudioSampleRate): VeLiveAudioCaptureConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取采集音频声道数。
+     * @return <br>
+     *      音频声道数，详情请参见 {@link #VeLiveAudioChannel VeLiveAudioChannel}。
+     */
+    getChannel(): VeLiveAudioChannel;
+    /** {zh}
+     * @detail api
+     * @brief 设置采集音频声道数。
+     * @return <br>推流音频采集参数配置对象，详情请参见 [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration)。
+     * @param channel 音频声道数，默认值为 VeLiveAudioChannelStereo，详情请参见 {@link #VeLiveAudioChannel VeLiveAudioChannel}
+     */
+    setChannel(channel: VeLiveAudioChannel): VeLiveAudioCaptureConfiguration;
+}
+export declare class VeLiveStreamMixDescription {
+    /** {zh}
+     * @brief 视频混流布局设置的数组，其中每个元素代表一路视频流的布局。详情请参见 {@link #VeLiveMixVideoLayout VeLiveMixVideoLayout}。
+     */
+    mixVideoStreams: ArrayList<VeLiveMixVideoLayout>;
+    /** {zh}
+     * @brief 音频混流设置的数组，其中每个元素代表一路音频流的。详情请参见 [VeLiveMixAudioLayout](#VeLiveMixAudioLayout)。
+     */
+    mixAudioStreams: ArrayList<VeLiveMixAudioLayout>;
+    /** {zh}
+     * @brief 视频混流画布的背景色设置，采用 #RRGGBB 格式。
+     */
+    backgroundColor: String;
+}
+export declare enum VeLiveAudioSampleRate {
+    /** {zh}
+     * @brief 8k 采样。
+     */
+    VeLiveAudioSampleRate8000 = 0,
+    /** {zh}
+     * @brief 16k 采样。
+     */
+    VeLiveAudioSampleRate16000 = 1,
+    /** {zh}
+     * @brief 32k 采样。
+     */
+    VeLiveAudioSampleRate32000 = 2,
+    /** {zh}
+     * @brief 44.1k 采样。
+     */
+    VeLiveAudioSampleRate44100 = 3,
+    /** {zh}
+     * @brief 48k 采样。
+     */
+    VeLiveAudioSampleRate48000 = 4
+}
+export declare enum VeLiveAudioPowerLevel {
+    /** {zh}
+     * @brief 无声，音量 ≤1db。
+     */
+    VeLiveAudioPowerLevelSilent = 0,
+    /** {zh}
+     * @brief 安静，音量 15db 以下。
+     */
+    VeLiveAudioPowerLevelQuiet = 1,
+    /** {zh}
+     * @brief 轻声，接近耳语音量，音量为 16db～30db 之间。
+     */
+    VeLiveAudioPowerLevelLight = 2,
+    /** {zh}
+     * @brief 正常，音量适宜，类似正常对话的音量，音量为 30db～60db 之间。
+     */
+    VeLiveAudioPowerLevelNormal = 3,
+    /** {zh}
+     * @brief 较大，音量较高，类似咖啡馆、餐厅的环境噪音，音量为 61db～85db 之间。
+     */
+    VeLiveAudioPowerLevelLoud = 4,
+    /** {zh}
+     * @brief 吵闹，音量极高，类似于繁忙的街道或者是音乐会现场，音量超过 85db。
+     */
+    VeLiveAudioPowerLevelNoise = 5
+}
+export declare class VeLiveVideoCaptureConfiguration {
+    /** {zh}
+     * @detail api
+     * @brief 获取采集视频宽度。
+     * @return <br>
+     *      采集视频宽度。
+     */
+    getWidth(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置采集视频宽度。
+     * @return <br>推流视频采集参数配置对象，详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
+     * @param width 采集视频宽度，默认值为 720。
+     */
+    setWidth(width: int): VeLiveVideoCaptureConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取采集视频高度。
+     * @return <br>
+     *      采集视频高度。
+     */
+    getHeight(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置采集视频高度。
+     * @return <br>推流视频采集参数配置对象，详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
+     * @param height 采集视频高度，默认值为 1280。
+     */
+    setHeight(height: int): VeLiveVideoCaptureConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取采集视频帧率。
+     * @return <br>
+     *      采集视频帧率。
+     */
+    getFps(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置采集视频帧率。
+     * @return <br>推流视频采集参数配置对象，详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
+     * @param fps 采集视频帧率，默认值为 15。
+     */
+    setFps(fps: int): VeLiveVideoCaptureConfiguration;
+}
+export declare enum VeLivePixelFormat {
+    /** {zh}
+     * @brief 未知格式。
+     */
+    VeLivePixelFormatUnknown = 0,
+    /** {zh}
+     * @brief I420 格式。
+     */
+    VeLivePixelFormatI420 = 1,
+    /** {zh}
+     * @brief NV12 格式。
+     */
+    VeLivePixelFormatNV12 = 2,
+    /** {zh}
+     * @brief NV21 格式。
+     */
+    VeLivePixelFormatNV21 = 3,
+    /** {zh}
+     * @brief 2D 纹理格式。
+     */
+    VeLivePixelFormat2DTexture = 4,
+    /** {zh}
+     * @brief OES 纹理格式。
+     */
+    VeLivePixelFormatOesTexture = 5
+}
+export declare enum VeLivePusherStatus {
+    /** {zh}
+     * @brief 初始状态。
+     */
+    VeLivePushStatusNone = 0,
+    /** {zh}
+     * @brief 正在连接服务器。
+     */
+    VeLivePushStatusConnecting = 1,
+    /** {zh}
+     * @brief 连接服务器成功。
+     */
+    VeLivePushStatusConnectSuccess = 2,
+    /** {zh}
+     * @brief 重连服务器中。
+     */
+    VeLivePushStatusReconnecting = 3,
+    /** {zh}
+     * @brief 推流连接被终止。
+     */
+    VeLivePushStatusConnectStop = 4,
+    /** {zh}
+     * @brief 推流连接失败。
+     */
+    VeLivePushStatusConnectError = 5,
+    /** {zh}
+     * @brief 与服务器断开连接。
+     */
+    VeLivePushStatusDisconnected = 6
+}
+export declare enum VeLiveVideoResolution {
+    /** {zh}
+     * @brief 360P 分辨率。档位详细配置如下所示。
+     *        - 横屏分辨率：640x360
+     *        - 竖屏分辨率：360x640
+     *        - 帧率：15fps
+     *        - 目标码率：500kbps
+     *        - 最小码率：250kbps
+     *        - 最大码率：800kbps
+     */
+    VeLiveVideoResolution360P = "VeLiveVideoResolution360P",
+    /** {zh}
+     * @brief 480P 分辨率。档位详细配置如下所示。
+     *        - 横屏分辨率：864x480
+     *        - 竖屏分辨率：480x864
+     *        - 帧率：15fps
+     *        - 目标码率：800kbps
+     *        - 最小码率：320kbps
+     *        - 最大码率：1266kbps
+     */
+    VeLiveVideoResolution480P = "VeLiveVideoResolution480P",
+    /** {zh}
+     * @brief 540P 分辨率。档位详细配置如下所示。
+     *        - 横屏 960x540
+     *        - 竖屏 540x960
+     *        - 帧率：15fps
+     *        - 目标码率：1000kbps
+     *        - 最小码率：500kbps
+     *        - 最大码率：1520kbps
+     */
+    VeLiveVideoResolution540P = "VeLiveVideoResolution540P",
+    /** {zh}
+     * @brief 720P 分辨率。档位详细配置如下所示。
+     *        - 横屏 1280x720
+     *        - 竖屏 720x1280
+     *        - 帧率：15fps
+     *        - 目标码率：1200kbps
+     *        - 最小码率：800kbps
+     *        - 最大码率：1900kbps
+     */
+    VeLiveVideoResolution720P = "VeLiveVideoResolution720P",
+    /** {zh}
+     * @brief 1080P 分辨率。档位详细配置如下所示。
+     *        - 横屏 1920x1080
+     *        - 竖屏 1080x1920
+     *        - 帧率：20 fps
+     *        - 目标码率：2500kbps
+     *        - 最小码率：1000kbps
+     *        - 最大码率：3800kbps
+     */
+    VeLiveVideoResolution1080P = "VeLiveVideoResolution1080P"
+}
+export declare enum VeLiveNetworkQuality {
+    /** {zh}
+     * @brief 未查询到网络状态。
+     */
+    VeLiveNetworkQualityUnknown = 0,
+    /** {zh}
+     * @brief 网络差。
+     */
+    VeLiveNetworkQualityBad = 1,
+    /** {zh}
+     * @brief 网络一般。
+     */
+    VeLiveNetworkQualityPoor = 2,
+    /** {zh}
+     * @brief 网络状态佳。
+     */
+    VeLiveNetworkQualityGood = 3
+}
+export declare enum VeLivePusherLogLevel {
+    /** {zh}
+     * @brief 输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     */
+    VeLiveLogLevelVerbose = 0,
+    /** {zh}
+     * @brief 输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     */
+    VeLiveLogLevelDebug = 1,
+    /** {zh}
+     * @brief 输出 INFO、WARNING 和 ERROR 级别的日志。
+     */
+    VeLiveLogLevelInfo = 2,
+    /** {zh}
+     * @brief 输出 WARNING 和 ERROR 级别的日志。
+     */
+    VeLiveLogLevelWarn = 3,
+    /** {zh}
+     * @brief 输出 ERROR 级别的日志。
+     */
+    VeLiveLogLevelError = 4,
+    /** {zh}
+     * @brief 关闭日志。
+     */
+    VeLiveLogLevelNone = 5
+}
+export declare enum VeLiveAudioBitDepth {
+    /** {zh}
+     * @brief 16bit 位深度。
+     */
+    VeLiveAudioBitDepth16 = 0
+}
+export declare class VeLiveMixAudioLayout {
+    /** {zh}
+     * @brief 音频流 ID，唯一标识，用于区分不同的音频流。
+     */
+    streamId: int;
+    /** {zh}
+     * @detail api
+     * @brief 混流音频的音量，范围为 [0.0,4.0]。当您将 [VeLiveAudioMixType](147521#VeLiveAudioMixType) 设置为 `VeLiveAudioMixPlayAndPush` 时，该变量同时控制混流音频在拉流端和本地的播放音量。
+     */
+    volume: float;
+    /** {zh}
+     * @detail api
+     * @brief 更新音频混流设置。
+     * @param other 新的音频混流设置，详情请参见 [VeLiveMixAudioLayout](#VeLiveMixAudioLayout)。
+     */
+    update(other: VeLiveMixAudioLayout): void;
+}
+export declare enum VeLiveOrientation {
+    /** {zh}
+     * @brief 横屏模式。
+     */
+    VeLiveOrientationLandscape = 0,
+    /** {zh}
+     * @brief 竖屏模式。
+     */
+    VeLiveOrientationPortrait = 1
+}
+export declare enum VeLiveVideoMirrorType {
+    /** {zh}
+     * @brief 对采集画面的镜像控制。开启时，预览和推流画面都会呈现为镜像状态。
+     */
+    VeLiveVideoMirrorCapture = 0,
+    /** {zh}
+     * @brief 对预览画面的镜像控制。开启时，只有主播预览画面呈现镜像状态。
+     */
+    VeLiveVideoMirrorPreview = 1,
+    /** {zh}
+     * @brief 对编码前画面的镜像控制。开启时，主播推流画面呈现镜像状态。
+     */
+    VeLiveVideoMirrorPushStream = 2
+}
+export declare class VeLivePusherLogConfig {
+    /** {zh}
+     * @brief 日志文件保存路径。
+     */
+    logPath: String;
+    /** {zh}
+     * @brief 日志文件整体最大尺寸，单位为 M，默认值为 100。
+     */
+    maxLogSizeM: int;
+    /** {zh}
+     * @brief 单个日志文件最大尺寸，单位为 M，默认值为 2。
+     */
+    singleLogSizeM: int;
+    /** {zh}
+     * @brief 日志文件有效期，单位为 s，默认值为 604,800，即 7 天。
+     */
+    logExpireTimeS: long;
+    /** {zh}
+     * @brief 是否开启线程轮询，默认值为 `1` <br>
+     *      - `0`：关闭；
+     *      - `1`：开启。
+     */
+    enableThreadLoop: int;
+    /** {zh}
+     * @brief 日志是否打印到控制台输出，默认为不打印。
+     */
+    enableStdout: int;
+    /** {zh}
+     * @brief 日志是否打印到文件输出，默认为打印。
+     */
+    enableLogFile: int;
+    /** {zh}
+     * @brief 日志级别，默认值为 `kVolcLogLevelWarning`。
+     */
+    logLevel: int;
+    /** {zh}
+     * @brief 日志刷新频率，单位为 ms，默认值为 120,000，即 2 分钟。
+     */
+    intervalMs: long;
+    /** {zh}
+     * @brief 日志上报路径。
+     */
+    queryUrl: String;
+    /** {zh}
+     * @brief 设备唯一 ID。
+     */
+    device_id: String;
+    /** {zh}
+     * @brief HTTP 请求超时时间。取值范围：大于 0。
+     */
+    httpTimeoutMS: int;
+    /** {zh}
+     * @brief 文件上传超时时间。取值范围：大于 0。
+     */
+    httpUploadFileTimeoutMS: int;
+}
+export declare class VeLiveFileRecorderConfiguration {
+    /** {zh}
+     * @detail api
+     * @brief 获取录制视频宽度。
+     * @return <br>
+     *      录制视频宽度。
+     */
+    getWidth(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置录制视频宽度。
+     * @return <br>推流本地文件录制配置对象，详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
+     * @param width 录制视频宽度，默认值为 360
+     */
+    setWidth(width: int): VeLiveFileRecorderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取录制视频高度。
+     * @return <br>
+     *      录制视频高度。
+     */
+    getHeight(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置录制视频高度。
+     * @return <br>推流本地文件录制配置对象，详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
+     * @param height 录制视频宽度，默认值为 640。
+     */
+    setHeight(height: int): VeLiveFileRecorderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取录制视频帧率。
+     * @return <br>
+     *      录制视频帧率。
+     */
+    getFps(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置录制视频帧率。
+     * @return <br>推流本地文件录制配置对象，详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
+     * @param fps 录制视频帧率，默认值为 15。
+     */
+    setFps(fps: int): VeLiveFileRecorderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取录制视频码率。
+     * @return <br>
+     *      录制视频码率。
+     */
+    getBitrate(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置录制视频码率。
+     * @return <br>推流本地文件录制配置对象，详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
+     * @param bitrate 录制视频码率，单位为 kbps，默认值为 2000。
+     */
+    setBitrate(bitrate: int): VeLiveFileRecorderConfiguration;
+}
+export declare class VeLiveMixVideoLayout {
+    /** {zh}
+     * @brief 视频流 ID，唯一标识，用于区分不同的视频流。
+     */
+    streamId: int;
+    /** {zh}
+     * @brief 视频流对应区域左上角的横坐标，该坐标是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。
+     */
+    x: float;
+    /** {zh}
+     * @brief 视频流对应区域左上角的纵坐标，该坐标是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。
+     */
+    y: float;
+    /** {zh}
+     * @brief 视频流对应区域宽度，该宽度是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。
+     */
+    width: float;
+    /** {zh}
+     * @brief 视频流对应区域高度，该高度是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。
+     */
+    height: float;
+    /** {zh}
+     * @brief 视频流在混流中的透明度，取值范围为 [0.0,1.0]，取值 0.0 表示全透明，取值 1.0 表示不透明。
+     */
+    alpha: float;
+    /** {zh}
+     * @brief 视频流在混流中的层级。取值范围为 [0,100]，取值 0 表示最底层，取值越大，层级越高。
+     */
+    zOrder: int;
+    /** {zh}
+     * @brief 视频流的渲染模式。详情请参见 {@link #VeLivePusherRenderMode VeLivePusherRenderMode}。
+     */
+    renderMode: VeLivePusherRenderMode;
+    /** {zh}
+     * @detail api
+     * @brief 更新视频混流设置。
+     * @param other 新的视频混流设置，详情请参见 [VeLiveMixVideoLayout](147521#VeLiveMixVideoLayout)。
+     */
+    update(other: VeLiveMixVideoLayout): void;
+}
+export declare class VeLiveVideoEffectLicenseConfiguration {
+    /** {zh}
+     * @detail api
+     * @brief 初始化配置为本地验证模式。
+     * @return <br>返回 VeLiveVideoEffectLicenseConfiguration 类的实例，该实例使用指定的本地路径进行许可证验证。
+     * @param path 视频特效许可证的本地缓存路径。可通过 [getPath](#VeLiveVideoEffectLicenseConfiguration-getpath) 获取。
+     */
+    static create_String(path: String): VeLiveVideoEffectLicenseConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 初始化配置为在线验证模式。
+     * @return <br>返回 VeLiveVideoEffectLicenseConfiguration 类的实例，该实例使用指定的 key、secret 和 url 进行在线许可证验证。
+     * @param key 视频特效许可证的在线认证 key。可通过 [getKey](#VeLiveVideoEffectLicenseConfiguration-getkey) 获取。
+     * @param secret 视频特效许可证的在线认证 secret。可通过 [getSecret](#VeLiveVideoEffectLicenseConfiguration-getsecret) 获取。
+     * @param url 视频特效许可证的在线认证地址，如果传入 `null`，可通过 [getUrl](147521#VeLiveVideoEffectLicenseConfiguration-geturl) 获取在线认证地址。
+     */
+    static create_String$String$String(key: String, secret: String, url: String): VeLiveVideoEffectLicenseConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证类型。
+     * @return <br>
+     *      视频特效许可证类型，许可证类型请参见 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType}。
+     */
+    getType(): VeLiveVideoEffectLicenseType;
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证的本地路径。当 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOffLine` 时，返回许可证文件的本地路径。
+     * @return <br>
+     *     视频特效许可证的本地路径。
+     */
+    getPath(): String;
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证的在线认证 key。当 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时，返回在线认证的 key。
+     * @return <br>
+     *     视频特效许可证的在线认证 key。
+     */
+    getKey(): String;
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证的在线认证 secret。当 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时，返回在线认证的 secret。
+     * @return <br>
+     *     视频特效许可证的在线认证 secret。
+     */
+    getSecret(): String;
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证的在线认证地址。当 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时，返回在线认证地址。
+     * @return <br>
+     *     视频特效许可证的在线认证地址。
+     */
+    getUrl(): String;
+}
+export declare enum VeLiveAudioFrameSource {
+    /** {zh}
+     * @brief 采集到的原始音频帧。这是从设备的麦克风或其他音频输入源获取的音频帧。
+     */
+    VeLiveAudioFrameSourceCapture = 1,
+    /** {zh}
+     * @brief 编码前的音频帧。这是通过各种处理（例如噪音消除、回声消除等）后，准备进行编码的音频帧。
+     */
+    VeLiveAudioFrameSourcePreEncode = "1 << 1"
+}
+export declare class VeLiveAudioEncoderConfiguration {
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频编码码率。
+     * @return <br>
+     *      推流音频编码码率。
+     */
+    getBitrate(): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频编码码率。
+     * @return <br>推流音频编码参数配置对象，详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
+     * @param bitrate 推流音频编码码率，单位为 kbps，默认值为 64。
+     */
+    setBitrate(bitrate: int): VeLiveAudioEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频采样率。
+     * @return <br>
+     *      推流音频采样率。详情请参见 {@link #VeLiveAudioSampleRate VeLiveAudioSampleRate}。
+     */
+    getSampleRate(): VeLiveAudioSampleRate;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频采样率。
+     * @return <br>推流音频编码参数配置对象，详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
+     * @param sampleRate 推流音频采样率，默认值为 VeLiveAudioSampleRate44100，详情请参见 [VeLiveAudioSampleRate](147521#VeLiveAudioSampleRate)。
+     */
+    setSampleRate(sampleRate: VeLiveAudioSampleRate): VeLiveAudioEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频声道。
+     * @return <br>
+     *      推流音频声道。详情请参见 {@link #VeLiveAudioChannel VeLiveAudioChannel}。
+     */
+    getChannel(): VeLiveAudioChannel;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频声道。
+     * @return <br>推流音频编码参数配置对象，详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
+     * @param channel 推流音频声道，默认值为 VeLiveAudioChannelStereo，详情请参见 [VeLiveAudioChannel](147521#VeLiveAudioChannel)。
+     */
+    setChannel(channel: VeLiveAudioChannel): VeLiveAudioEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频编码类型。
+     * @return <br>
+     *      推流音频编码类型。详情请参见 {@link #VeLiveAudioProfile VeLiveAudioProfile}。
+     */
+    getProfile(): VeLiveAudioProfile;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频编码类型。
+     * @return <br>推流音频编码参数配置对象，详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
+     * @param profile 推流音频编码类型，默认值为 VeLiveAudioAACProfileLC，详情请参见 [VeLiveAudioProfile](147521#VeLiveAudioProfile)。
+     */
+    setProfile(profile: VeLiveAudioProfile): VeLiveAudioEncoderConfiguration;
+}
+export declare enum VeLiveAudioMixType {
+    /** {zh}
+     * @brief 拉流端可以听到混音效果，本地无法听到。
+     */
+    VeLiveAudioMixPush = 0,
+    /** {zh}
+     * @brief 拉流端和本地都可以听到混音效果。
+     */
+    VeLiveAudioMixPlayAndPush = 1
+}
+export declare enum VeLiveAudioCaptureType {
+    /** {zh}
+     * @brief 使用默认麦克风设备进行音频采集。
+     */
+    VeLiveAudioCaptureMicrophone = 0,
+    /** {zh}
+     * @brief 使用语音通话模式进行音频采集，此模式下会启动硬件的 3A 功能，即自动增益控制、自动频率控制和自动噪声抑制。
+     */
+    VeLiveAudioCaptureVoiceCommunication = 1,
+    /** {zh}
+     * @brief 使用录屏直播无障碍音频模式进行音频采集。
+     */
+    VeLiveAudioCaptureVoiceRecognition = 2,
+    /** {zh}
+     * @brief 使用外部设备或源进行音频采集。
+     */
+    VeLiveAudioCaptureExternal = 3,
+    /** {zh}
+     * @brief 使用静音帧作为音频源。
+     */
+    VeLiveAudioCaptureMuteFrame = 4
+}