@volcengine/react-native-live-pull 1.0.2 → 1.0.3-rc.0

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

@@ -2,22 +2,27 @@ import { int, String, List, long, float, ByteBuffer, EGLContext } from './types'
 export declare enum VeLivePlayerResolution {
     /** {zh}
      * @brief 原始流。
+     *
      */
     VeLivePlayerResolutionOrigin = 0,
     /** {zh}
      * @brief UHD 超高清。
+     *
      */
     VeLivePlayerResolutionUHD = 1,
     /** {zh}
      * @brief HD 高清。
+     *
      */
     VeLivePlayerResolutionHD = 2,
     /** {zh}
      * @brief SD 标清。
+     *
      */
     VeLivePlayerResolutionSD = 3,
     /** {zh}
      * @brief LD 低清。
+     *
      */
     VeLivePlayerResolutionLD = 4
 }
@@ -26,186 +31,220 @@ export declare class VeLivePlayerConfiguration {
      * @brief 是否开启 SEI 消息的解析，默认值为 false。<br>
      *      - true：开启；
      *      - false：关闭。
+     *
      */
     enableSei: boolean;
     /** {zh}
      * @brief 是否开启硬件解码功能，默认值为 true。开启硬件解码后，如果出现硬件解码启动失败或硬件解码失败的情况，播放器内部会自动切换为软解。<br>
      *      - true：开启；
      *      - false：关闭。
+     *
      */
     enableHardwareDecode: boolean;
     /** {zh}
      * @brief 网络超时时间，单位为 ms，默认值为 5000。播放器发起网络请求，如果超过了该时间仍未收到服务器响应，则认为网络请求失败。
+     *
      */
     networkTimeoutMs: int;
     /** {zh}
      * @brief 重试时间间隔，单位为 ms，默认值为 5000，仅在无备流时生效。<br>
      *     - 在无备流的场景下，若遇到网络异常等问题导致播放中断，播放器会立即进行重试，前三次重试为立即执行，第四次及之后的重试将按照设置的重试时间间隔执行；
      *     - 在有备流的场景下，重试时间间隔将不生效，所有重试均会立即执行。
+     *
      */
     retryIntervalTimeMs: int;
     /** {zh}
      * @brief 在网络连接错误的情况下，播放器最大重试次数，默认值为 5。如果取值为 0，表示关闭播放器内部重试。<br>
      *     - 在无备流的场景下，每次重试，会消耗一次重试次数；
      *     - 在有备流的场景下，每次主备流切换，会消耗一次重试次数。
+     *
      */
     retryMaxCount: int;
     /** {zh}
      * @brief 是否开启本地 DNS 预解析，默认值为 false。开启本地 DNS 预解析可以缩短启播时间。如果本地 DNS 预解析出现异常，可能会影响播放器的正常使用。<br>
      *      - true：开启；
      *      - false：关闭。
+     *
      */
     enableLiveDNS: boolean;
     /** {zh}
      * @brief 是否开启播放信息周期性回调。默认值为 false。周期性回调参数详细说明请参见 [VeLivePlayerStatistics](188115#VeLivePlayerStatistics) 。当 `enableStatisticsCallback` 为 `true`，且 [statisticsCallbackInterval](188115#VeLivePlayerConfiguration-statisticscallbackinterval) 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。<br>
      *        - true：开启；
      *        - false：关闭。
+     *
      */
     enableStatisticsCallback: boolean;
     /** {zh}
      * @brief 播放信息周期性回调的时间间隔，单位为 s，默认值为 5。当 [enableStatisticsCallback](188115#VeLivePlayerConfiguration-enablestatisticscallback) 为 `true`，且 `statisticsCallbackInterval` 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。
+     *
      */
     statisticsCallbackInterval: int;
 }
 export declare enum VeLivePlayerFormat {
     /** {zh}
      * @brief FLV 格式。
+     *
      */
     VeLivePlayerFormatFLV = 0,
     /** {zh}
      * @brief HLS 格式。
+     *
      */
     VeLivePlayerFormatHLS = 1,
     /** {zh}
      * @brief RTM 格式。
+     *
      */
     VeLivePlayerFormatRTM = 2
 }
 export declare enum VeLivePlayerProtocol {
     /** {zh}
      * @brief TCP 协议。
+     *
      */
     VeLivePlayerProtocolTCP = 0,
     /** {zh}
      * @brief QUIC 协议。
+     *
      */
     VeLivePlayerProtocolQUIC = 1,
     /** {zh}
      * @brief TLS 协议。
+     *
      */
     VeLivePlayerProtocolTLS = 2
 }
 export declare enum VeLivePlayerMirror {
     /** {zh}
      * @brief 关闭镜像。
+     *
      */
     VeLivePlayerMirrorNone = 0,
     /** {zh}
      * @brief 水平镜像。
+     *
      */
     VeLivePlayerMirrorHorizontal = 1,
     /** {zh}
      * @brief 垂直镜像。
+     *
      */
     VeLivePlayerMirrorVertical = 2
 }
 export declare enum VeLivePlayerVideoBufferType {
     /** {zh}
      * @brief 未知格式。
+     *
      */
     VeLivePlayerVideoBufferTypeUnknown = 0,
     /** {zh}
      * @brief ByteBuffer 格式。
+     *
      */
     VeLivePlayerVideoBufferTypeByteBuffer = 1,
     /** {zh}
      * @brief ByteArray 格式。
+     *
      */
     VeLivePlayerVideoBufferTypeByteArray = 2,
     /** {zh}
      * @brief 纹理格式。
+     *
      */
     VeLivePlayerVideoBufferTypeTexture = 3
 }
 export declare enum VeLivePlayerStatus {
     /** {zh}
      * @brief 停止播放状态。
+     *
      */
     VeLivePlayerStatusStopped = 0,
     /** {zh}
      * @brief 暂停播放状态。
+     *
      */
     VeLivePlayerStatusPaused = 1,
     /** {zh}
      * @brief 播放器准备完成，等待渲染。
+     *
      */
     VeLivePlayerStatusPrepared = 2,
     /** {zh}
      * @brief 正在播放，即首帧渲染完成且播放器未发生错误。
+     *
      */
     VeLivePlayerStatusPlaying = 3,
     /** {zh}
      * @brief 播放器发生错误。
+     *
      */
     VeLivePlayerStatusError = 4
 }
 export declare class VeLivePlayerLogConfig {
-    /** {zh}
-     * @hidden (Android)
-     */
-    deviceID: String;
     /** {zh}
      * @brief 日志文件保存路径。缺省情况下，使用默认路径 `/cache/Log`。
+     *
      */
     logPath: String;
     /** {zh}
      * @brief 日志文件整体最大尺寸，单位为 M，默认值为 100。
+     *
      */
     maxLogSizeM: int;
     /** {zh}
      * @brief 单个日志文件最大尺寸，单位为 M，默认值为 2。
+     *
      */
     singleLogSizeM: int;
     /** {zh}
      * @brief 日志文件有效期，过期后下次创建日志文件时会删除之前的文件。单位为 s，默认值为 604,800，即 7 天。
+     *
      */
     logExpireTimeS: int;
     /** {zh}
      * @brief 日志是否打印到控制台输出，默认值为 true。<br>
      *                   - true：打印；
      *                   - false：不打印。
+     *
      */
     enableConsole: boolean;
     /** {zh}
      * @brief 日志是否打印到文件，默认值为 true。<br>
      *                   - true：打印；
      *                   - false：不打印。
+     *
      */
     enableLogFile: boolean;
     /** {zh}
      * @brief 日志上报路径。
+     *
      */
     queryUrl: String;
     /** {zh}
      * @brief 是否轮询。<br>
      *      - `true`：开启；
      *      - `false`：关闭。
+     *
      */
     enableThreadLoop: boolean;
     /** {zh}
      * @brief 轮询间隔时间, 单位为 ms。取值范围：大于 0。
+     *
      */
     intervalMS: int;
     /** {zh}
      * @brief HTTP 请求超时时间。取值范围：大于 0。
+     *
      */
     httpTimeoutMS: int;
     /** {zh}
      * @brief 文件上传超时时间。取值范围：大于 0。
+     *
      */
     httpUploadFileTimeoutMS: int;
     /** {zh}
      * @brief 允许写入的日志等级，默认为 VeLivePlayerLogLevelDebug，详情请参见 [VeLivePlayerLogLevel](#VeLivePlayerLogLevel)。
+     *
      */
     logLevel: VeLivePlayerLogLevel;
 }
@@ -214,294 +253,359 @@ export declare class VeLivePlayerStreamData {
      * @brief 是否打开 ABR 平滑切档功能，默认为 false。<br>
      *     - true：开启；
      *     - false：关闭。
+     *
      */
     enableABR: boolean;
     /** {zh}
      * @brief 是否打开主备切换，默认为 false。<br>
      *     - true：开启；
      *     - false：关闭。
+     *
      */
     enableMainBackupSwitch: boolean;
     /** {zh}
-     * @brief 播放器的默认清晰度档位，默认使用原始流清晰度。详情请参见 {@link #VeLivePlayerResolution VeLivePlayerResolution}。
+     * @brief 播放器的默认清晰度档位，默认使用原始流清晰度。详情请参见 VeLivePlayerResolution{@link #VeLivePlayerResolution}。
+     *
      */
     defaultResolution: VeLivePlayerResolution;
     /** {zh}
-     * @brief 播放器的默认播放格式，默认值为 FLV。详情请参见 {@link #VeLivePlayerFormat VeLivePlayerFormat}。
+     * @brief 播放器的默认播放格式，默认值为 FLV。详情请参见 VeLivePlayerFormat{@link #VeLivePlayerFormat}。
+     *
      */
     defaultFormat: VeLivePlayerFormat;
     /** {zh}
-     * @brief 播放器的默认播放传输层协议，默认值为 TCP。详情请参见 {@link #VeLivePlayerProtocol VeLivePlayerProtocol}。
+     * @brief 播放器的默认播放传输层协议，默认值为 TCP。详情请参见 VeLivePlayerProtocol{@link #VeLivePlayerProtocol}。
+     *
      */
     defaultProtocol: VeLivePlayerProtocol;
     /** {zh}
      * @brief 主路流地址列表，详情请参见 [VeLivePlayerStream](#VeLivePlayerStreamData-VeLivePlayerStream)。
+     *
      */
     mainStreamList: List<VeLivePlayerStream>;
     /** {zh}
      * @brief 备路流地址列表。详情请参见 [VeLivePlayerStream](#VeLivePlayerStreamData-VeLivePlayerStream)。
+     *
      */
     backupStreamList: List<VeLivePlayerStream>;
 }
 export declare enum VeLivePlayerResolutionSwitchReason {
     /** {zh}
      * @brief ABR 自动切档。
+     *
      */
     VeLiveplayerResolutionSwitchByAuto = 0,
     /** {zh}
      * @brief 手动切换档位。
+     *
      */
     VeLiveplayerResolutionSwitchByManual = 1
 }
 export declare class VeLivePlayerStream {
+    constructor();
     /** {zh}
      * @brief 播放地址。
+     *
      */
     url: String;
     /** {zh}
-     * @brief 清晰度档位。详情请参见 {@link #VeLivePlayerResolution VeLivePlayerResolution}。
+     * @brief 清晰度档位。详情请参见 VeLivePlayerResolution{@link #VeLivePlayerResolution}。
+     *
      */
     resolution: VeLivePlayerResolution;
     /** {zh}
      * @brief 播放码率，单位为 kbps。
+     *
      */
     bitrate: long;
     /** {zh}
-     * @brief 播放格式。详情请参见 {@link #VeLivePlayerFormat VeLivePlayerFormat}。
+     * @brief 播放格式。详情请参见 VeLivePlayerFormat{@link #VeLivePlayerFormat}。
+     *
      */
     format: VeLivePlayerFormat;
     /** {zh}
-     * @brief 播放流类型为主路或备路。详情请参见 {@link #VeLivePlayerStreamType VeLivePlayerStreamType}。
+     * @brief 播放流类型为主路或备路。详情请参见 VeLivePlayerStreamType{@link #VeLivePlayerStreamType}。
+     *
      */
     streamType: VeLivePlayerStreamType;
-    constructor();
 }
 export declare enum VeLivePlayerFillMode {
     /** {zh}
      * @brief 显示完整的视频帧。视频帧等比缩放，直至视频帧恰好在画布上全部显示。如果视频帧长宽比例与画布不同，视窗上未被视频帧填满区域将填充为黑色。
+     *
      */
     VeLivePlayerFillModeAspectFit = 0,
     /** {zh}
      * @brief 视频帧自适应画布。视频帧非等比缩放，直至填满画布。在此过程中，视频帧的长宽比例可能会发生变化。
+     *
      */
     VeLivePlayerFillModeFullFill = 1,
     /** {zh}
      * @brief 视频填满画布。视频帧等比缩放，直至填满画布，超出屏幕的部分将被裁剪，画面可能不完整。
+     *
      */
     VeLivePlayerFillModeAspectFill = 2
 }
 export declare enum VeLivePlayerPixelFormat {
     /** {zh}
      * @brief 未知格式。
+     *
      */
     VeLivePlayerPixelFormatUnknown = 0,
     /** {zh}
      * @brief RGBA8888 格式。
+     *
      */
     VeLivePlayerPixelFormatRGBA32 = 1,
     /** {zh}
      * @brief 纹理格式。
+     *
      */
     VeLivePlayerPixelFormatTexture = 2
 }
 export declare class VeLivePlayerStatistics {
+    constructor();
     /** {zh}
      * @brief 当前直播的播放地址。
+     *
      */
     url: String;
     /** {zh}
      * @brief 是否使用硬件解码。<br>
      *     - true：硬解；
      *     - false：非硬解。
+     *
      */
     isHardwareDecode: boolean;
     /** {zh}
      * @brief 视频的编码类型。
+     *
      */
     videoCodec: String;
     /** {zh}
      * @brief 从当前视频开始播放起，累计的卡顿时长，单位为 ms。
+     *
      */
     stallTimeMs: long;
     /** {zh}
      * @brief 带宽预测 ，单位为 kbps
+     *
      */
     bandwidthEstimation: long;
     /** {zh}
      * @brief 当前播放延时，单位为 ms。仅在使用了火山引擎视频直播推流 SDK 时，支持统计播放延时。
+     *
      */
     delayMs: long;
     /** {zh}
      * @brief 当前播放视频的宽度，单位为 px。
+     *
      */
     width: int;
     /** {zh}
      * @brief 当前播放视频的高度，单位为 px。
+     *
      */
     height: int;
     /** {zh}
      * @brief 当前播放视频的帧率，单位为 fps。
+     *
      */
     fps: float;
     /** {zh}
      * @brief 实时下载的码率，单位为 kbps。
+     *
      */
     bitrate: long;
     /** {zh}
      * @brief 视频播放的缓冲区 buffer 大小，单位为 ms。
+     *
      */
     videoBufferMs: long;
     /** {zh}
      * @brief 音频播放的缓冲区 buffer 大小，单位为 ms。
+     *
      */
     audioBufferMs: long;
     /** {zh}
      * @brief 当前播放的视频格式。
+     *
      */
     format: String;
     /** {zh}
      * @brief 当前播放的传输协议。
+     *
      */
     protocol: String;
-    constructor();
 }
 export declare class VeLivePlayerVideoFrame {
     /** {zh}
-     * @brief 视频帧数据封装格式。详情请参见 {@link #VeLivePlayerVideoBufferType VeLivePlayerVideoBufferType}。
+     * @brief 视频帧数据封装格式。详情请参见 VeLivePlayerVideoBufferType{@link #VeLivePlayerVideoBufferType}。
+     *
      */
     bufferType: VeLivePlayerVideoBufferType;
     /** {zh}
-     * @brief 视频帧像素格式。详情请参见 {@link #VeLivePlayerPixelFormat VeLivePlayerPixelFormat}。
+     * @brief 视频帧像素格式。详情请参见 VeLivePlayerPixelFormat{@link #VeLivePlayerPixelFormat}。
+     *
      */
     pixelFormat: VeLivePlayerPixelFormat;
     /** {zh}
      * @brief 视频宽度，单位为 px。
+     *
      */
     width: int;
     /** {zh}
      * @brief 视频高度，单位为 px。
+     *
      */
     height: int;
     /** {zh}
      * @brief 视频帧的渲染时间戳。单位为 ms。
+     *
      */
     pts: long;
     /** {zh}
-     * @brief `pixelFormat` 为 `VeLivePlayerPixelFormatTexture` 时的视频数据，承载用于 OpenGL 渲染的纹理数据。详情请参见 {@link #VeLivePlayerVideoTexture VeLivePlayerVideoTexture}。
+     * @brief `pixelFormat` 为 `VeLivePlayerPixelFormatTexture` 时的视频数据，承载用于 OpenGL 渲染的纹理数据。详情请参见 VeLivePlayerVideoTexture{@link #VeLivePlayerVideoTexture}。
+     *
      */
     texture: VeLivePlayerVideoTexture;
     /** {zh}
      * @brief `pixelFormat` 为 `VeLivePlayerPixelFormatRGBA32` 时的视频数据，ByteBuffer 格式。
+     *
      */
     buffer: ByteBuffer;
     /** {zh}
      * @brief `pixelFormat` 为 `VeLivePlayerPixelFormatRGBA32` 时的视频数据，ByteArray 格式。
+     *
      */
     data: ArrayBuffer;
 }
 export declare class VeLivePlayerVideoTexture {
     /** {zh}
      * @brief 视频纹理 ID。
+     *
      */
     texId: int;
     /** {zh}
      * @brief OpenGL ES 图形上下文环境，用于自定义渲染。将 EGLContext 绑定到 GLSurfaceView 或 TextureView 上，您可以在被绑定的 View 上进行自定义的 OpenGL ES 渲染。
+     *
      */
     eglContext: EGLContext;
 }
 export declare enum VeLivePlayerStreamType {
     /** {zh}
      * @brief 主路流。
+     *
      */
     VeLivePlayerStreamTypeMain = 0,
     /** {zh}
      * @brief 备路流。
+     *
      */
     VeLivePlayerStreamTypeBackup = 1
 }
 export declare enum VeLivePlayerLogLevel {
     /** {zh}
      * @brief 输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     *
      */
     VeLivePlayerLogLevelVerbose = 0,
     /** {zh}
      * @brief 输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     *
      */
     VeLivePlayerLogLevelDebug = 1,
     /** {zh}
      * @brief 输出 INFO、WARNING 和 ERROR 级别的日志。
+     *
      */
     VeLivePlayerLogLevelInfo = 2,
     /** {zh}
      * @brief 输出 WARNING 和 ERROR 级别的日志。
+     *
      */
     VeLivePlayerLogLevelWarn = 3,
     /** {zh}
      * @brief 输出 ERROR 级别的日志。
+     *
      */
     VeLivePlayerLogLevelError = 4,
     /** {zh}
      * @brief 关闭日志打印。
+     *
      */
     VeLivePlayerLogLevelNone = 5
 }
 export declare class VeLivePlayerAudioFrame {
     /** {zh}
      * @brief 音频帧数据封装格式，详情请参见 [VeLivePlayerAudioBufferType](188115#VeLivePlayerAudioBufferType)。
+     *
      */
     bufferType: VeLivePlayerAudioBufferType;
     /** {zh}
      * @brief 音频采样率，单位为 Hz。
+     *
      */
     sampleRate: int;
     /** {zh}
      * @brief 声道数。<br>
      *     - 1：单声道；
      *     - 2：双声道。
+     *
      */
     channels: int;
     /** {zh}
      * @brief 音频位深度。
+     *
      */
     bitDepth: int;
     /** {zh}
      * @brief 音频渲染时间戳。单位为 ms。
+     *
      */
     pts: long;
     /** {zh}
      * @brief PCM 音频数据。
+     *
      */
     buffer: ArrayBuffer;
     /** {zh}
      * @brief 音频采样点个数。
+     *
      */
     samples: int;
 }
 export declare enum VeLivePlayerAudioBufferType {
     /** {zh}
      * @brief 未知格式。
+     *
      */
     VeLivePlayerAudioBufferTypeUnknown = 0,
     /** {zh}
      * @brief ByteArray 格式。
+     *
      */
     VeLivePlayerAudioBufferTypeByteArray = 1
 }
 export declare enum VeLivePlayerRotation {
     /** {zh}
      * @brief 关闭旋转。
+     *
      */
     VeLivePlayerRotation0 = 0,
     /** {zh}
      * @brief 顺时针旋转 90 度。
+     *
      */
     VeLivePlayerRotation90 = 1,
     /** {zh}
      * @brief 顺时针旋转 180 度。
+     *
      */
     VeLivePlayerRotation180 = 2,
     /** {zh}
      * @brief 顺时针旋转 270 度。
+     *
      */
     VeLivePlayerRotation270 = 3
 }

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

@@ -7,11 +7,13 @@ export type double = number;
 export type long = number;
 export type Integer = number;
 export type Double = number;
-export type List<T> = Array<T>;
-export type list<T> = Array<T>;
-export type ArrayList<T> = Array<T>;
-export type Map<K extends keyof any, V> = Record<K, V>;
-export type set<T> = Set<T>;
+export type List<T = any> = Array<T>;
+export type list<T = any> = Array<T>;
+export type ArrayList<T = any> = Array<T>;
+export type Map<K extends keyof any = any, V = any> = Record<K, V>;
+export type HashMap<K extends keyof any = any, V = any> = Record<K, V>;
+export type Pair<K extends keyof any = any, V = any> = Record<K, V>;
+export type set<T = any> = Set<T>;
 export type map = Object;
 export type struct = Object;
 export type Bitmap = unknown;
@@ -26,5 +28,4 @@ export type View = unknown;
 export type Intent = unknown;
 export type Context = unknown;
 export type Bundle = any;
-export type Error = any;
 export type JSONObject = any;