@volcengine/react-native-live-pull 1.1.3-rc.1 → 1.2.0-rc.1

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

@@ -2,458 +2,696 @@ import { BOOL, NSInteger, NSString, int, CMTime, NSData, int64_t, CVPixelBufferR
 export declare enum VeLivePlayerResolutionSwitchReason {
     /** {zh}
      * @brief ABR 自动切档。
+     *
      */
+    
     VeLivePlayerResolutionSwitchByAuto = 0,
     /** {zh}
-     * @brief 手动切换档位。
+     * @brief 调用 [switchResolution:](188118#TVLManager(VeLivePlayer)-switchresolution)手动切换档位。
+     *
      */
+    
     VeLivePlayerResolutionSwitchByManual = 1
 }
 export declare class VeLivePlayerConfiguration {
     /** {zh}
-     * @brief 是否开启 SEI 消息的解析，默认值为 NO。<br>
-     *      - YES：开启；
-     *      - NO：关闭。
+     * @brief 是否开启字符串 SEI 消息的解析，默认值为 NO。<br/>
+     *        - YES：开启；
+     *        - NO：关闭。
      */
+    
     enableSei: BOOL;
+    /** {zh}
+     * @brief 是否开启二进制 SEI 消息的解析，默认值为 NO。<br/>
+     *        - YES：开启；
+     *        - NO：关闭。
+     * @notes 二进制 SEI 开启后，字符串 SEI 的回调将不再发送。
+     */
+    
+    enableBinarySei: BOOL;
     /** {zh}
      * @brief 是否开启硬件解码功能，默认值为 YES。开启硬件解码后，如果出现硬件解码启动失败或硬件解码失败的情况，播放器内部会自动切换为软解。<br>
      *      - YES：开启；
      *      - NO：关闭。
      */
+    
     enableHardwareDecode: BOOL;
     /** {zh}
      * @brief 是否开启本地 DNS 预解析，默认值为 NO。开启本地 DNS 预解析可以缩短启播时间。如果本地 DNS 预解析出现异常，可能会影响播放器的正常使用。<br>
      *      - YES：开启；
      *      - NO：关闭。
      */
+    
     enableLiveDNS: BOOL;
     /** {zh}
-     * @brief 是否开启播放信息周期性回调。默认值为 NO。周期性回调参数详细说明请参见 [VeLivePlayerStatistics](188121#VeLivePlayerStatistics) 。当 enableStatisticsCallback 为 YES，且 [statisticsCallbackInterval](188121#VeLivePlayerConfiguration-statisticscallbackinterval) 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。<br>
+     * @brief 是否开启播放信息周期性回调。默认值为 NO。周期性回调参数详细说明请参见 [VeLivePlayerStatistics](#VeLivePlayerStatistics) 。当 enableStatisticsCallback 为 YES，且 [statisticsCallbackInterval](#VeLivePlayerConfiguration-statisticscallbackinterval) 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。<br/>
      *        - YES：开启；
      *        - NO：关闭。
      */
+    
     enableStatisticsCallback: BOOL;
     /** {zh}
-     * @brief 播放信息周期性回调的时间间隔，单位为 s，默认值为 5。当 [enableStatisticsCallback](188121#VeLivePlayerConfiguration-enablestatisticscallback) 为 YES，且 `statisticsCallbackInterval` 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。
+     * @brief 播放信息周期性回调的时间间隔，单位为 s，默认值为 5。当 [enableStatisticsCallback](#VeLivePlayerConfiguration-enablestatisticscallback) 为 YES，且 `statisticsCallbackInterval` 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。
      */
+    
     statisticsCallbackInterval: NSInteger;
     /** {zh}
      * @brief 网络超时时间，单位为 ms，默认值为 5000。播放器发起网络请求，如果超过了该时间仍未收到服务器响应，则认为网络请求失败。
      */
+    
     networkTimeoutMs: NSInteger;
     /** {zh}
      * @brief 重试时间间隔，单位为 ms，默认值为 5000，仅在无备流时生效。<br>
      *     - 在无备流的场景下，若遇到网络异常等问题导致播放中断，播放器会立即进行重试，前三次重试为立即执行，第四次及之后的重试将按照设置的重试时间间隔执行；
      *     - 在有备流的场景下，重试时间间隔将不生效，所有重试均会立即执行。
      */
+    
     retryIntervalTimeMs: NSInteger;
     /** {zh}
      * @brief 在网络连接错误的情况下，播放器最大重试次数，默认值为 5。如果取值为 0，表示关闭播放器内部重试。<br>
      *     - 在无备流的场景下，每次重试，会消耗一次重试次数；
      *     - 在有备流的场景下，每次主备流切换，会消耗一次重试次数。
      */
+    
     retryMaxCount: NSInteger;
     /** {zh}
      * @brief 默认初始化方法。
      */
+    
     init(): this;
 }
 export declare class VeLivePlayerStream {
     /** {zh}
      * @brief 播放地址。
      */
+    
     url: NSString;
     /** {zh}
-     * @brief 清晰度档位，详情请参见 [VeLivePlayerResolution](188121#VeLivePlayerResolution)。
+     * @brief 清晰度档位，详情请参见 [VeLivePlayerResolution](#VeLivePlayerResolution)。
      */
+    
     resolution: VeLivePlayerResolution;
     /** {zh}
-     * @brief 播放码率，单位为 kbps。
+     * @brief 播放码率，单位为 bps。
      */
+    
     bitrate: int;
     /** {zh}
-     * @brief 传输协议，详情请参见 [VeLivePlayerProtocol](188121#VeLivePlayerProtocol)。
+     * @brief 传输协议，详情请参见 [VeLivePlayerProtocol](#VeLivePlayerProtocol)。
      */
+    
     protocol: VeLivePlayerProtocol;
     /** {zh}
-     * @brief 播放格式，详情请参见 [VeLivePlayerFormat](188121#VeLivePlayerFormat)。
+     * @brief 播放格式，详情请参见 [VeLivePlayerFormat](#VeLivePlayerFormat)。
      */
+    
     format: VeLivePlayerFormat;
     /** {zh}
      * @brief 播放流类型为主路或备路，详情请参见 [VeLivePlayerStreamType](188121#VeLivePlayerStreamType)。
      */
+    
     type: VeLivePlayerStreamType;
     /** {zh}
      * @brief 单路直播流配置初始化方法。
      */
+    
     init(): this;
 }
 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](188121#VeLivePlayerAudioBufferType)。
+     * @brief 音频帧数据封装格式，详情请参见 [VeLivePlayerAudioBufferType](#VeLivePlayerAudioBufferType)。
      */
+    
     bufferType: VeLivePlayerAudioBufferType;
     /** {zh}
      * @brief 音频采样率，单位为 Hz。
      */
+    
     sampleRate: int;
     /** {zh}
      * @brief 声道数。<br>
      *     - 1：单声道；
      *     - 2：双声道。
      */
+    
     channels: int;
     /** {zh}
      * @brief 音频位深度。
      */
+    
     bitDepth: int;
     /** {zh}
      * @brief 音频渲染时间戳，单位为 ms。
      */
+    
     pts: CMTime;
     /** {zh}
      * @brief PCM 音频数据。
      */
+    
     data: NSData;
     /** {zh}
      * @brief 音频采样点个数。
      */
+    
     samples: int;
     init(): this;
 }
 export declare class VeLivePlayerVideoFrame {
     /** {zh}
-     * @brief 视频帧数据封装格式，详情请参见 [VeLivePlayerVideoBufferType](188121#VeLivePlayerVideoBufferType)。
+     * @brief 视频帧数据封装格式，详情请参见 [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType)。
      */
+    
     bufferType: VeLivePlayerVideoBufferType;
     /** {zh}
-     * @brief 视频帧像素格式，详情请参见 [VeLivePlayerPixelFormat](188121#VeLivePlayerPixelFormat)。
+     * @brief 视频帧像素格式，详情请参见 [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat)。
      */
+    
     pixelFormat: VeLivePlayerPixelFormat;
     /** {zh}
      * @brief 视频宽度，单位为 px。
      */
+    
     width: NSInteger;
     /** {zh}
      * @brief 视频高度，单位为 px。
      */
+    
     height: NSInteger;
     /** {zh}
      * @brief 视频帧的渲染时间戳，单位为 ms。
      */
+    
     pts: int64_t;
     /** {zh}
      * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypePixelBuffer` 时的视频数据。
      */
+    
     pixelBuffer: CVPixelBufferRef;
     /** {zh}
      * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypeSampleBuffer` 时的视频数据。
      */
+    
     sampleBuffer: CMSampleBufferRef;
     /** {zh}
      * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypeNSData` 时的视频数据。
      */
+    
     data: NSData;
     init(): this;
 }
+export declare enum VeLivePlayerSupportResolutionSwitchError {
+    /** {zh}
+     * @brief 没有找到对应分辨率档位。
+     *
+     */
+    
+    VeLivePlayerErrorResNotFound = -1,
+    /** {zh}
+     * @brief 和当前分辨率档位相同。
+     *
+     */
+    
+    VeLivePlayerErrorSameRes = -2,
+    /** {zh}
+     * @brief 播放器状态为非 prepare 状态。
+     *
+     */
+    
+    VeLivePlayerErrorStatusInvalid = -3,
+    /** {zh}
+     * @brief 分辨率档位错误。
+     *
+     */
+    
+    VeLivePlayerErrorInvalidRes = -4,
+    /** {zh}
+     * @brief 配置不支持。
+     *
+     */
+    
+    VeLivePlayerErrorConfigNotSupport = -5,
+    /** {zh}
+     * @brief 格式不支持。
+     *
+     */
+    
+    VeLivePlayerErrorFormatNotSupport = -6
+}
 export declare class VeLivePlayerStreamData {
     /** {zh}
      * @brief 是否打开 ABR 平滑切档功能，默认为 NO。<br>
      *     - YES：开启；
      *     - NO：关闭。
      */
+    
     enableABR: BOOL;
     /** {zh}
      * @brief 是否打开主备切换，默认为 NO。<br>
      *     - YES：开启；
      *     - NO：关闭。
      */
+    
     enableMainBackupSwitch: BOOL;
     /** {zh}
-     * @brief 播放器的默认清晰度档位，默认使用原始流清晰度，详情请参见 [VeLivePlayerResolution](188121#VeLivePlayerResolution)。
+     * @brief 播放器的默认清晰度档位，默认使用原始流清晰度，详情请参见 [VeLivePlayerResolution](#VeLivePlayerResolution)。
      */
+    
     defaultResolution: VeLivePlayerResolution;
     /** {zh}
-     * @brief 播放器的默认播放格式，默认值为 FLV，详情请参见 [VeLivePlayerFormat](188121#VeLivePlayerFormat)。
+     * @brief 播放器的默认播放格式，默认值为 FLV，详情请参见 [VeLivePlayerFormat](#VeLivePlayerFormat)。
      */
+    
     defaultFormat: VeLivePlayerFormat;
     /** {zh}
-     * @brief 播放器的默认播放传输层协议，默认值为 TCP，详情请参见 [VeLivePlayerProtocol](188121#VeLivePlayerProtocol)。
+     * @brief 播放器的默认播放传输层协议，默认值为 TCP，详情请参见 [VeLivePlayerProtocol](#VeLivePlayerProtocol)。
      */
+    
     defaultProtocol: VeLivePlayerProtocol;
     /** {zh}
-     * @brief 主路流地址列表，详情请参见 [VeLivePlayerStream](188121#VeLivePlayerStream)。
+     * @brief 主路流地址列表，详情请参见 [VeLivePlayerStream](#VeLivePlayerStream)。
      */
+    
     mainStream: NSArray<VeLivePlayerStream>;
     /** {zh}
-     * @brief 备路流地址列表，详情请参见 [VeLivePlayerStream](188121#VeLivePlayerStream)。
+     * @brief 备路流地址列表，详情请参见 [VeLivePlayerStream](#VeLivePlayerStream)。
      */
+    
     backupStream: NSArray<VeLivePlayerStream>;
     init(): this;
 }
 export declare enum VeLivePlayerAudioBufferType {
     /** {zh}
      * @brief 未知格式。
+     *
      */
+    
     VeLivePlayerAudioBufferUnknown = 0,
     /** {zh}
      * @brief CVSampleBufferRef 格式，音频数据以样本缓冲区 sample buffer 的形式进行处理和渲染。
+     *
      */
+    
     VeLivePlayerAudioBufferTypeSampleBuffer = 1,
     /** {zh}
      * @brief NSData 格式，音频数据以 NSData 对象的形式进行处理和渲染。
+     *
      */
+    
     VeLivePlayerAudioBufferTypeNSData = 2
 }
 export declare enum VeLivePlayerVideoBufferType {
     /** {zh}
      * @brief 未知格式。
+     *
      */
+    
     VeLivePlayerVideoBufferTypeUnknown = 0,
     /** {zh}
      * @brief CVPixelBufferRef 格式。
+     *
      */
+    
     VeLivePlayerVideoBufferTypePixelBuffer = 1,
     /** {zh}
      * @brief CVSampleBufferRef 格式。
+     *
      */
+    
     VeLivePlayerVideoBufferTypeSampleBuffer = 2,
     /** {zh}
      * @brief NSData 格式。
+     *
      */
+    
     VeLivePlayerVideoBufferTypeNSData = 3
 }
 export declare enum VeLivePlayerProtocol {
     /** {zh}
      * @brief TCP 协议。
+     *
      */
+    
     VeLivePlayerProtocolTCP = 0,
     /** {zh}
      * @brief QUIC 协议。
+     *
      */
+    
     VeLivePlayerProtocolQUIC = 1,
     /** {zh}
      * @brief TLS 协议。
+     *
+     */
+    
+    VeLivePlayerProtocolTLS = 2,
+    /** {zh}
+     * @brief HTTP 协议。
+     *
      */
-    VeLivePlayerProtocolTLS = 2
+    
+    VeLivePlayerProtocolHTTP2 = 3
 }
 export declare enum VeLivePlayerFillMode {
     /** {zh}
      * @brief 视频填满画布。视频帧等比缩放，直至填满画布，超出屏幕的部分将被裁剪，画面可能不完整。
+     *
      */
+    
     VeLivePlayerFillModeAspectFill = 0,
     /** {zh}
      * @brief 显示完整的视频帧。视频帧等比缩放，直至视频帧恰好在画布上全部显示。如果视频帧长宽比例与画布不同，视窗上未被视频帧填满区域将填充为黑色。
+     *
      */
+    
     VeLivePlayerFillModeAspectFit = 1,
     /** {zh}
      * @brief 视频帧自适应画布。视频帧非等比缩放，直至填满画布。在此过程中，视频帧的长宽比例可能会发生变化。
+     *
      */
+    
     VeLivePlayerFillModeFullFill = 2
 }
 export declare enum VeLivePlayerRotation {
     /** {zh}
      * @brief 关闭旋转。
+     *
      */
+    
     VeLivePlayerRotation0 = 0,
     /** {zh}
      * @brief 顺时针旋转 90 度。
+     *
      */
+    
     VeLivePlayerRotation90 = 90,
     /** {zh}
      * @brief 顺时针旋转 180 度。
+     *
      */
+    
     VeLivePlayerRotation180 = 180,
     /** {zh}
      * @brief 顺时针旋转 270 度。
+     *
      */
+    
     VeLivePlayerRotation270 = 270
 }
 export declare enum VeLivePlayerMirror {
     /** {zh}
      * @brief 关闭镜像。
+     *
      */
+    
     VeLivePlayerMirrorNone = 0,
     /** {zh}
      * @brief 水平镜像。
+     *
      */
+    
     VeLivePlayerMirrorHorizontal = 1,
     /** {zh}
      * @brief 垂直镜像。
+     *
      */
+    
     VeLivePlayerMirrorVertical = 2
 }
 export declare enum VeLivePlayerPixelFormat {
     /** {zh}
      * @brief 未知格式。
+     *
      */
+    
     VeLivePlayerPixelFormatUnknown = 0,
     /** {zh}
      * @brief NV12 格式。
+     *
      */
+    
     VeLivePlayerPixelFormatNV12 = 1,
     /** {zh}
      * @brief YUVI420 格式。
+     *
      */
+    
     VeLivePlayerPixelFormatI420 = 2,
     /** {zh}
      * @brief BGRA 格式。
+     *
      */
+    
     VeLivePlayerPixelFormatBGRA32 = 3
 }
 export declare enum VeLivePlayerStatus {
     /** {zh}
      * @brief 播放器准备完成，等待渲染。
+     *
      */
+    
     VeLivePlayerStatusPrepared = 0,
     /** {zh}
-     * @brief 正在播放，即首帧渲染完成且播放器未发生错误。
+     * @brief 正在播放状态。
+     *
      */
+    
     VeLivePlayerStatusPlaying = 1,
     /** {zh}
      * @brief 暂停播放状态。
+     *
      */
+    
     VeLivePlayerStatusPaused = 2,
     /** {zh}
      * @brief 停止播放状态。
+     *
      */
+    
     VeLivePlayerStatusStopped = 3,
     /** {zh}
      * @brief 播放器发生错误。
+     *
      */
+    
     VeLivePlayerStatusError = 4
 }
 export declare class VeLivePlayerStatistics {
     /** {zh}
      * @brief 当前直播的播放地址。
      */
+    
     url: NSURL;
     /** {zh}
      * @brief 是否使用硬件解码。<br>
      *     - YES：硬解；
      *     - NO：非硬解。
      */
+    
     isHardWareDecode: BOOL;
     /** {zh}
      * @brief 当前播放延时，单位为 ms。仅在使用了火山引擎视频直播推流 SDK 时，支持统计播放延时。
      */
+    
     delayMs: int;
     /** {zh}
      * @brief 从当前视频开始播放起，累计的卡顿时长，单位为 ms。
      */
+    
     stallTimeMs: int;
     /** {zh}
      * @brief 带宽预测 ，单位为 kbps。
      */
+    
     bandwidthEstimation: long;
     /** {zh}
      * @brief 视频的编码类型。
      */
+    
     videoCodec: NSString;
     /** {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: VeLivePlayerFormat;
     /** {zh}
      * @brief 当前播放的传输协议。
      */
+    
     protocol: VeLivePlayerProtocol;
     init(): this;
 }
+export declare enum VeLivePlayerType {
+    /** {zh}
+     * @brief 自研播放器。
+     *
+     */
+    
+    VeLivePlayerTypeOwn = 0,
+    /** {zh}
+     * @brief 系统播放器。
+     *
+     */
+    
+    VeLivePlayerTypeSystem = 1
+}
 export declare enum VeLivePlayerStreamType {
     /** {zh}
      * @brief 主路流。
+     *
      */
+    
     VeLivePlayerStreamTypeMain = 0,
     /** {zh}
      * @brief 备路流。
+     *
      */
+    
     VeLivePlayerStreamTypeBackup = 1
 }
 export declare enum VeLivePlayerFormat {
     /** {zh}
      * @brief FLV 格式。
+     *
      */
+    
     VeLivePlayerFormatFLV = 0,
     /** {zh}
      * @brief HLS 格式。
+     *
      */
+    
     VeLivePlayerFormatHLS = 1,
     /** {zh}
      * @brief RTM 格式。
+     *
      */
+    
     VeLivePlayerFormatRTM = 2
 }
 export declare enum VeLivePlayerResolution {
     /** {zh}
      * @brief 原始流。
+     *
      */
+    
     VeLivePlayerResolutionOrigin = 0,
     /** {zh}
      * @brief UHD 超高清。
+     *
      */
+    
     VeLivePlayerResolutionUHD = 1,
+    /** {zh}
+     * @brief FHD 全高清
+     *
+     */
+    
+    VeLivePlayerResolutionFHD = 2,
     /** {zh}
      * @brief HD 高清。
+     *
      */
-    VeLivePlayerResolutionHD = 2,
+    
+    VeLivePlayerResolutionHD = 3,
     /** {zh}
      * @brief SD 标清。
+     *
      */
-    VeLivePlayerResolutionSD = 3,
+    
+    VeLivePlayerResolutionSD = 4,
     /** {zh}
      * @brief LD 低清。
+     *
+     */
+    
+    VeLivePlayerResolutionLD = 5,
+    /** {zh}
+     * @brief MD 审核档位
+     * @hidden (iOS)
+     *
+     */
+    
+    VeLivePlayerResolutionMD = 6,
+    /** {zh}
+     * @brief 仅音频
+     * @hidden (iOS)
+     *
+     */
+    
+    VeLivePlayerResolutionAO = 7,
+    /** {zh}
+     * @brief 自动档位。
+     *
      */
-    VeLivePlayerResolutionLD = 4
+    
+    VeLivePlayerResolutionAUTO = 8
 }