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

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

@@ -1,13 +1,13 @@
-import { VeLivePlayerConfiguration, VeLivePlayerFillMode, VeLivePlayerStreamData, VeLivePlayerResolution, VeLivePlayerPixelFormat, VeLivePlayerVideoBufferType, VeLivePlayerRotation, VeLivePlayerMirror, VeLivePlayerLogLevel } from './keytype';
-import { VeLivePlayerObserver } from './callback';
-import { ApplicationContext } from '../../platforms/android/extends';
 import * as $p_a from '../android/index';
 import * as $p_i from '../ios/index';
+import { VeLivePlayerResolution, VeLivePlayerFillMode, VeLivePlayerPixelFormat, VeLivePlayerVideoBufferType, VeLivePlayerRotation, VeLivePlayerMirror, VeLivePlayerLogLevel, VeLivePlayerConfiguration, VeLivePlayerStreamData } from './keytype';
+import { VeLivePlayerObserver } from './callback';
+import { Map, type String, List } from './types';
+import { ApplicationContext } from './external';
 /** {zh}
  * @detail api
  * @brief 直播播放器。
  */
-
 export declare class VeLivePlayer {
     /** {zh}
      * @detail api
@@ -15,6 +15,7 @@ export declare class VeLivePlayer {
      * @return <br>
      *     播放器 SDK 版本号。
      * @order 4
+     *
      */
     
     static getVersion(): string;
@@ -23,6 +24,7 @@ export declare class VeLivePlayer {
      * @brief 设置打印的日志级别。
      * @order 5
      * @param logLevel 日志级别，详情请参见 [VeLivePlayerLogLevel](188115#VeLivePlayerLogLevel) 。
+     *
      */
     
     static setLogLevel(logLevel: VeLivePlayerLogLevel): void;
@@ -32,11 +34,10 @@ export declare class VeLivePlayer {
      * @param hostIpMap 域名和服务器 IP 地址的映射关系列表。其中 `Map` 的 Key 是域名，Value 是 `List` 类型，表示该域名对应的服务器 IP 地址列表。
      */
     
-    static ios_setHttpDNSHostIP(hostIpMap: Object): void;
+    static ios_setHttpDNSHostIP(hostIpMap: $p_i.NSDictionary): void;
     constructor(context: ApplicationContext);
+    constructor();
     protected _instance: any;
-    protected __init(...args: any[]): void;
-    protected __new_instance(...args: any[]): $p_a.VeLivePlayer | $p_i.TVLManager;
     /** {zh}
      * @platform ios
      * @detail keytype
@@ -53,12 +54,46 @@ export declare class VeLivePlayer {
     
     get ios_playerView(): $p_i.UIView;
     set ios_playerView(value: $p_i.UIView);
+    /** {zh}
+     * @platform ios
+     * @detail keytype
+     * @brief 设置或获取播放器播放音量，默认值为 1.0。取值范围为 0.0～1.0。
+     */
+    
+    get ios_volume(): $p_i.float;
+    set ios_volume(value: $p_i.float);
+    protected __init(...args: any[]): void;
+    protected __new_instance(...args: any[]): any;
+    /** {zh}
+     * @detail api
+     * @brief 设置播放器音量。
+     * @order 8
+     * @param volume 音量大小，默认值为 1.0。取值范围为 0.0～1.0。
+     *
+     */
+    
+    setPlayerVolume(volume: number): void;
+    /** {zh}
+     * @detail api
+     * @brief 切换播放的清晰度档位。
+     * @notes - 需要在调用 [setPlayStreamData](#VeLivePlayer-setplaystreamdata) 设置多档位后，调用本方法切换播放器的清晰度档位。
+     *        - 调用本方法成功切换档位后，会触发清晰度档位变化 [onResolutionSwitch](188112#VeLivePlayerObserver-onresolutionswitch) 回调。
+     * @return <br>
+     *     - true：成功；
+     *     - false：失败。
+     * @order 8
+     * @param resolution 设置清晰度的目标档位，详情请参见 [VeLivePlayerResolution](188115#VeLivePlayerResolution) 。
+     *
+     */
+    
+    switchResolution(resolution: VeLivePlayerResolution): void;
     /** {zh}
      * @detail api
      * @brief 初始化播放器，用于设置是否开启 SEI 消息、是否开启硬件解码和是否开启本地 DNS 预解析等配置信息。
      * @notes <br>需要在调用 [play](#VeLivePlayer-play) 开始播放之前，调用本方法进行播放器的初始化。
      * @order 1
-     * @param config 播放器配置信息，详情请参见 {@link #VeLivePlayerConfiguration VeLivePlayerConfiguration}。
+     * @param config 播放器配置信息，详情请参见 VeLivePlayerConfiguration{@link #VeLivePlayerConfiguration}。
+     *
      */
     
     setConfig(config: VeLivePlayerConfiguration): void;
@@ -67,7 +102,8 @@ export declare class VeLivePlayer {
      * @brief 设置播放器回调，用于监听播放器 VeLivePlayer 的播放错误、播放状态、音视频首帧渲染状态和清晰度档位信息等回调事件。
      * @notes <br>需要在调用 [play](#VeLivePlayer-play) 开始播放之前，调用本方法设置回调。
      * @order 2
-     * @param observer 播放器的事件回调对象。详情请参见 {@link #VeLivePlayerObserver VeLivePlayerObserver}。
+     * @param observer 播放器的事件回调对象。详情请参见 VeLivePlayerObserver{@link #VeLivePlayerObserver}。
+     *
      */
     
     setObserver(observer: VeLivePlayerObserver): void;
@@ -79,6 +115,7 @@ export declare class VeLivePlayer {
      *        - 如果用于调节填充模式，可以在播放过程中调用本方法动态调节视频的填充模式。
      * @order 3
      * @param fillMode 设置 SurfaceView 的填充模式，默认值为 `VeLivePlayerFillModeAspectFill`，详情请参见 [VeLivePlayerFillMode](188115#VeLivePlayerFillMode)。
+     *
      */
     
     setRenderFillMode(fillMode: VeLivePlayerFillMode): Promise<void>;
@@ -87,30 +124,33 @@ export declare class VeLivePlayer {
      * @detail api
      * @brief 使用 SurfaceView 播放视频时，通过设置 SurfaceHolder 对象完成视频图像的渲染和播放。
      * @notes <br>
-     *     如果同时调用 setSurfaceHolder 和 {@link #setSurface setSurface} 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
+     *     如果同时调用 setSurfaceHolder 和 setSurface{@link #setSurface} 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
      * @order 6
      * @param surfaceHolder SurfaceHolder 对象。
+     *
      */
     
-    android_setSurfaceHolder(surfaceHolder: any): void;
+    android_setSurfaceHolder(surfaceHolder: $p_a.SurfaceHolder): void;
     /** {zh}
      * @platform android
      * @detail api
      * @brief 使用 SurfaceView 或 TextureView 播放视频时，通过设置 Surface 对象完成视频图像的渲染和播放。
      * @notes <br>
-     *     如果同时调用 {@link #setSurfaceHolder setSurfaceHolder} 和 setSurface 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
+     *     如果同时调用 setSurfaceHolder{@link #setSurfaceHolder} 和 setSurface 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
      * @order 7
      * @param surface surface 对象的类型。
+     *
      */
     
-    android_setSurface(surface: any): void;
+    android_setSurface(surface: $p_a.Surface): void;
     /** {zh}
      * @detail api
      * @brief 设置单个直播播放地址。
      * @notes <br>
-     *      需要在调用 {@link #play play} 开始播放之前，调用本方法设置单个直播播放地址。
+     *      需要在调用 play{@link #play} 开始播放之前，调用本方法设置单个直播播放地址。
      * @order 8
      * @param url 直播播放地址。
+     *
      */
     
     setPlayUrl(url: string): void;
@@ -118,9 +158,10 @@ export declare class VeLivePlayer {
      * @detail api
      * @brief 多路流信息配置。例如，您需要使用 ABR、手动切档和主备流等依赖多路流的功能，可以调用本方法进行配置。
      * @notes <br>
-     *      需要在调用 {@link #play play} 开始播放之前，调用本方法设置多路流信息。
+     *      需要在调用 play{@link #play} 开始播放之前，调用本方法设置多路流信息。
      * @order 8
      * @param streamData 多路流信息配置，详情请参见 [VeLivePlayerStreamData](188115#VeLivePlayerStreamData) 。
+     *
      */
     
     setPlayStreamData(streamData: VeLivePlayerStreamData): void;
@@ -128,8 +169,9 @@ export declare class VeLivePlayer {
      * @detail api
      * @brief 开始/恢复播放。
      * @notes <br>
-     *     调用本方法，在播放器完成拉流准备和首帧渲染播放后，都会触发 {@link #VeLivePlayerObserver#onPlayerStatusUpdate onPlayerStatusUpdate} 播放器状态回调。
+     *     调用本方法，在播放器完成拉流准备和首帧渲染播放后，都会触发 onPlayerStatusUpdate{@link #VeLivePlayerObserver#onPlayerStatusUpdate} 播放器状态回调。
      * @order 8
+     *
      */
     
     play(): Promise<void>;
@@ -137,8 +179,9 @@ export declare class VeLivePlayer {
      * @detail api
      * @brief 暂停播放。
      * @notes <br>
-     *     调用本方法暂停播放后，会触发 {@link #VeLivePlayerObserver#onPlayerStatusUpdate onPlayerStatusUpdate} 播放器状态回调。
+     *     调用本方法暂停播放后，会触发 onPlayerStatusUpdate{@link #VeLivePlayerObserver#onPlayerStatusUpdate} 播放器状态回调。
      * @order 8
+     *
      */
     
     pause(): Promise<void>;
@@ -146,8 +189,9 @@ export declare class VeLivePlayer {
      * @detail api
      * @brief 停止播放，不销毁播放器。
      * @notes <br>
-     *     调用本方法停止播放后，会触发 {@link #VeLivePlayerObserver#onPlayerStatusUpdate onPlayerStatusUpdate} 播放器状态回调。
+     *     调用本方法停止播放后，会触发 onPlayerStatusUpdate{@link #VeLivePlayerObserver#onPlayerStatusUpdate} 播放器状态回调。
      * @order 8
+     *
      */
     
     stop(): Promise<void>;
@@ -155,57 +199,40 @@ export declare class VeLivePlayer {
      * @detail api
      * @brief 停止播放，并销毁播放器。
      * @order 8
+     *
      */
     
     destroy(): void;
-    /** {zh}
-     * @detail api
-     * @brief 切换播放的清晰度档位。
-     * @notes - 需要在调用 [setPlayStreamData](#VeLivePlayer-setplaystreamdata) 设置多档位后，调用本方法切换播放器的清晰度档位。
-     *        - 调用本方法成功切换档位后，会触发清晰度档位变化 [onResolutionSwitch](188112#VeLivePlayerObserver-onresolutionswitch) 回调。
-     * @return <br>
-     *     - true：成功；
-     *     - false：失败。
-     * @order 8
-     * @param resolution 设置清晰度的目标档位，详情请参见 [VeLivePlayerResolution](188115#VeLivePlayerResolution) 。
-     */
-    
-    switchResolution(resolution: VeLivePlayerResolution): void;
     /** {zh}
      * @detail api
      * @brief 检查播放器是否正在播放。
-     * @return 是否正在播放。
+     * @return 是否正在播放。<br>
      *      - true：正在播放；
      *      - false：未播放。
      * @order 8
+     *
      */
     
     isPlaying(): boolean;
-    /** {zh}
-     * @detail api
-     * @brief 设置播放器音量。
-     * @order 8
-     * @param volume 音量大小，默认值为 1.0。取值范围为 0.0～1.0。
-     */
-    
-    setPlayerVolume(volume: number): void;
     /** {zh}
      * @detail api
      * @brief 设置是否静音播放。
-     * @param mute 是否开启静音播放，默认值为 false。
+     * @param mute 是否开启静音播放，默认值为 false。<br>
      *             - true：开启；
      *             - false：关闭。
      * @order 9
+     *
      */
     
     setMute(mute: boolean): void;
     /** {zh}
      * @detail api
      * @brief 获取是否处于静音状态。
-     * @return 是否处于静音状态。
+     * @return 是否处于静音状态。<br>
      *     - true：静音；
      *     - false：未静音。
      * @order 10
+     *
      */
     
     isMute(): boolean;
@@ -214,37 +241,40 @@ export declare class VeLivePlayer {
      * @brief 设置域名和服务器的 IP 地址映射关系。
      * @order 11
      * @param hostIpMap 域名和服务器 IP 地址的映射关系列表。其中 `Map` 的 Key 是域名，Value 是 `List` 类型，表示该域名对应的服务器 IP 地址列表。
+     *
      */
     
-    setUrlHostIP(hostIpMap: Record<string, Array<string>>): void;
+    setUrlHostIP(hostIpMap: Map<String, List<String>>): void;
     /** {zh}
      * @detail api
      * @brief 设置播放器高级配置。高级配置包括离屏渲染设置、缓冲区最大时长、ABR 码率自适应算法类型等，如需了解详细信息，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=owVvVTNjDkRmjctcsyNW)。
      * @order 12
      * @param key 高级配置的参数名。
      * @param value 参数对应的参数值。
+     *
      */
     
     setProperty(key: string, value: Object): void;
     /** {zh}
      * @detail api
      * @brief 视频截图。
-     * @notes
+     * @notes <br>
      *      - 本方法仅在视频状态为播放时生效。
-     *      - 调用本方法截图成功后，会触发 {@link #VeLivePlayerObserver#onSnapshotComplete onSnapshotComplete} 回调，回调消息中包含截图的 Bitmap 对象。
+     *      - 调用本方法截图成功后，会触发 onSnapshotComplete{@link #VeLivePlayerObserver#onSnapshotComplete} 回调，回调消息中包含截图的 Bitmap 对象。
      * @return <br>
      *         - 0：当前状态支持截图；
      *         - [VeLivePlayerErrorRefused](188113#VeLivePlayerErrorCode-veliveplayererrorrefused) ：当前状态不支持截图。
      * @order 13
+     *
      */
     
     snapshot(): number;
     /** {zh}
      * @detail api
      * @brief 设置视频帧回调。
-     * @notes
+     * @notes <br>
      *      - 您可以在使用外部渲染的场景下调用本方法，订阅视频帧的解码数据。
-     *      - 调用本方法后，会触发 {@link #VeLivePlayerObserver#onRenderVideoFrame onRenderVideoFrame} 回调，回调消息中包含每个视频帧的详细数据。
+     *      - 调用本方法后，会触发 onRenderVideoFrame{@link #VeLivePlayerObserver#onRenderVideoFrame} 回调，回调消息中包含每个视频帧的详细数据。
      *      - 如果您使用外部渲染，需要保证音视频同步。
      * @order 14
      * @param enable 是否开启视频帧回调，默认值为 false。 <br>
@@ -252,61 +282,66 @@ export declare class VeLivePlayer {
      *               - false：关闭。
      * @param pixelFormat 回调的视频帧像素格式，详情请参见 [VeLivePlayerPixelFormat](188115#VeLivePlayerPixelFormat)。
      * @param bufferType 回调的视频数据封装格式，详情请参见 [VeLivePlayerVideoBufferType](188115#VeLivePlayerVideoBufferType) 。
+     *
      */
     
     enableVideoFrameObserver(enable: boolean, pixelFormat: VeLivePlayerPixelFormat, bufferType: VeLivePlayerVideoBufferType): void;
     /** {zh}
      * @detail api
      * @brief 设置音频帧回调。
-     * @param enable 是否开启音频帧回调，默认值为 false。
+     * @param enable 是否开启音频帧回调，默认值为 false。 <br>
      *               - true：开启；
      *               - false：关闭。
-     * @param enableRendering 是否开启播放器渲染。默认值为 false。
+     * @param enableRendering 是否开启播放器渲染。默认值为 false。<br>
      *                        - true：开启；
      *                        - false：关闭。
-     * @notes
+     * @notes <br>
      *       - 您可以在使用外部渲染的场景下调用本方法，订阅音频帧的解码数据。
-     *       - 调用本方法后，会触发 {@link #VeLivePlayerObserver#onRenderAudioFrame onRenderAudioFrame} 回调，回调消息中包含每个音频帧的详细数据。
+     *       - 调用本方法后，会触发 onRenderAudioFrame{@link #VeLivePlayerObserver#onRenderAudioFrame} 回调，回调消息中包含每个音频帧的详细数据。
      *       - 如果您使用外部渲染，需要保证音视频同步。
      * @order 15
+     *
      */
     
     enableAudioFrameObserver(enable: boolean, enableRendering: boolean): void;
     /** {zh}
      * @detail api
      * @brief 设置视频顺时针旋转角度。
-     * @notes
+     * @notes <br>
      *      - 支持在播放前和播放中动态修改视频旋转角度。
      *      - 每次调用本方法，播放器都将基于图像的原始角度进行旋转。
      *      - 当同时使用旋转和镜像功能，播放器会先进行镜像，再进行旋转。
      * @order 16
      * @param rotation 视频旋转角度，默认关闭旋转，详情请参见 [VeLivePlayerRotation](188115#VeLivePlayerRotation) 。
+     *
      */
     
     setRenderRotation(rotation: VeLivePlayerRotation): Promise<void>;
     /** {zh}
      * @detail api
      * @brief 设置视频镜像。
-     * @notes
+     * @notes <br>
      *      - 支持在播放前和播放中动态修改视频镜像方式。
      *      - 每次调用本方法，播放器都将基于原始图像进行镜像。
      *      - 当同时使用旋转和镜像功能，播放器会先进行镜像，再进行旋转。
      * @order 17
      * @param mirror 视频镜像，默认关闭镜像，详情请参见 [VeLivePlayerMirror](188115#VeLivePlayerMirror) 。
+     *
      */
     
     setRenderMirror(mirror: VeLivePlayerMirror): Promise<void>;
     /** {zh}
      * @detail api
      * @brief 设置是否开启超分。您需要联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)开通超分功能后才可使用该功能。
-     * @notes
+     * @notes <br>
      *      - 在首帧回调后，调用该接口开启超分。
      *      - 支持播放中调用该接口动态开启和关闭超分。
-     *      - 如果机型、分辨率和帧率不符合限制，将无法开启超分，并触发 {@link #VeLivePlayerObserver#onStreamFailedOpenSuperResolution onStreamFailedOpenSuperResolution} 回调。
+     *      - 如果机型、分辨率和帧率不符合限制，将无法开启超分，并触发 onStreamFailedOpenSuperResolution{@link #VeLivePlayerObserver#onStreamFailedOpenSuperResolution} 回调。
      * @order 18
-     * @param enable 是否开启超分。默认值为 false。
+     * @param enable 是否开启超分。默认值为 false。<br>
      *                        - true：开启；
      *                        - false：关闭。
+     *
      */
     
     setEnableSuperResolution(enable: boolean): void;
@@ -316,6 +351,7 @@ export declare class VeLivePlayer {
      * @param enable 是否开启视频锐化，默认值为 `false`。
      *        - true：开启；
      *        - false：关闭。
+     *
      */
     
     android_setEnableSharpen(enable: boolean): void;
@@ -325,65 +361,5 @@ export declare class VeLivePlayer {
      * @param type 播放器类型，详情请参见 [VeLivePlayerType](188118#VeLivePlayerType)。
      */
     
-    ios_initWithType(type: VeLivePlayerType): this;
-    /** {zh}
-     * @platform ios
-     * @hidden (iOS)
-     * @brief 预创建播放器。
-     * @notes <br>调用本方法会提前触发播放准备工作，包括预建连等。
-     * @param item 待播放的直播流信息。
-     */
-    
-    ios_prepare(item: $p_i.TVLManager): void;
-}
-/** {zh}
- * @platform ios
- * @brief 播放器类型。
- */
-
-export declare enum VeLivePlayerType {
-    /** {zh}
-     * @platform ios
-     * @brief 自研播放器。
-     */
-    
-    VeLivePlayerTypeOwn = 0,
-    /** {zh}
-     * @platform ios
-     * @brief 系统播放器。
-     */
-    
-    VeLivePlayerTypeSystem = 1
-}
-export declare class t_VeLivePlayerType {
-    static ts_to_android(value: VeLivePlayerType): never;
-    static android_to_ts(value: unknown): never;
-    static ts_to_ios(value: VeLivePlayerType): $p_i.VeLivePlayerType;
-    static ios_to_ts(value: $p_i.VeLivePlayerType): VeLivePlayerType;
-}
-/**
- * @platform ios
- * 直播特效模型类型
- */
-export declare enum VeLivePlayerEffectType {
-    /** {zh}
-     * @platform ios
-     * @hidden (iOS)
-     * @brief 未知模型
-     */
-    
-    VeLivePlayerEffectUnknown = 0,
-    /** {zh}
-     * @platform ios
-     * @hidden (iOS)
-     * @brief 音量均衡三期模型
-     */
-    
-    VeLivePlayerEffectAudioBalance = 1
-}
-export declare class t_VeLivePlayerEffectType {
-    static ts_to_android(value: VeLivePlayerEffectType): never;
-    static android_to_ts(value: unknown): never;
-    static ts_to_ios(value: VeLivePlayerEffectType): $p_i.VeLivePlayerEffectType;
-    static ios_to_ts(value: $p_i.VeLivePlayerEffectType): VeLivePlayerEffectType;
+    ios_initWithType(type: $p_i.VeLivePlayerType): this;
 }