@byteplus/react-native-live-pull 1.5.1-rc.2 → 1.5.1-rc.3

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

@@ -4,9 +4,19 @@ import { VeLivePlayerResolution, VeLivePlayerFillMode, VeLivePlayerPixelFormat,
 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
+     * @brief 获取播放器 SDK 的版本号。
+     * @return <br>
+     *     播放器 SDK 版本号。
+     * @order 4
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the version number of the Player SDK.
@@ -16,7 +26,13 @@ export declare class VeLivePlayer {
      *
      */
     static getVersion(): string;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置打印的日志级别。
+     * @order 5
+     * @param logLevel 日志级别，详情请参见 [VeLivePlayerLogLevel](188115#VeLivePlayerLogLevel) 。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the level of the output log.
@@ -28,7 +44,11 @@ export declare class VeLivePlayer {
     constructor(context: ApplicationContext);
     constructor();
     protected _instance: any;
-    
+    /** {zh}
+     * @platform ios
+     * @detail keytype
+     * @brief 播放器的回调事件监听器。
+     */
     /** {en}
      * @platform ios
      * @detail keytype
@@ -36,7 +56,11 @@ export declare class VeLivePlayer {
      */
     get observer(): $p_i.id<$p_i.VeLivePlayerObserver>;
     set observer(value: $p_i.id<$p_i.VeLivePlayerObserver>);
-    
+    /** {zh}
+     * @platform ios
+     * @detail keytype
+     * @brief 获取播放器内部用于渲染视频画面的视图 view，调用本方法将 playerView 添加到应用的视图层级中，实现视频内容显示。
+     */
     /** {en}
      * @platform ios
      * @detail keytype
@@ -44,7 +68,11 @@ export declare class VeLivePlayer {
      */
     get playerView(): $p_i.UIView;
     set playerView(value: $p_i.UIView);
-    
+    /** {zh}
+     * @platform ios
+     * @detail keytype
+     * @brief 设置或获取播放器播放音量，默认值为 1.0。取值范围为 0.0～1.0。
+     */
     /** {en}
      * @platform ios
      * @detail keytype
@@ -54,7 +82,13 @@ export declare class VeLivePlayer {
     set 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。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the player volume.
@@ -63,7 +97,18 @@ export declare class VeLivePlayer {
      *
      */
     setPlayerVolume(volume: number): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 切换播放的清晰度档位。
+     * @notes - 需要在调用 [setPlayStreamData](#VeLivePlayer-setplaystreamdata) 设置多档位后，调用本方法切换播放器的清晰度档位。
+     *        - 调用本方法成功切换档位后，会触发清晰度档位变化 [onResolutionSwitch](188112#VeLivePlayerObserver-onresolutionswitch) 回调。
+     * @order 8
+     * @param resolution 设置清晰度的目标档位，详情请参见 [VeLivePlayerResolution](188115#VeLivePlayerResolution) 。
+     * @return <br>
+     *     - true：成功；
+     *     - false：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Changes the video resolution.
@@ -77,7 +122,15 @@ export declare class VeLivePlayer {
      *
      */
     switchResolution(resolution: VeLivePlayerResolution): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 初始化播放器，用于设置是否开启 SEI 消息、是否开启硬件解码和是否开启本地 DNS 预解析等配置信息。
+     * @notes
+     *        需要在调用 [play](#VeLivePlayer-play) 开始播放之前，调用本方法进行播放器的初始化。
+     * @order 1
+     * @param config 播放器配置信息，详情请参见 VeLivePlayerConfiguration{@link #VeLivePlayerConfiguration}。
+     *
+     */
     /** {en}
      * @detail api
      * @brief  Initializes the player and configures whether to turn on SEI messaging, hardware decoding, local DNS prefetch, and other configurations.
@@ -87,7 +140,14 @@ export declare class VeLivePlayer {
      *
      */
     setConfig(config: VeLivePlayerConfiguration): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置播放器回调，用于监听播放器 VeLivePlayer 的播放错误、播放状态、音视频首帧渲染状态和清晰度档位信息等回调事件。
+     * @notes <br>需要在调用 [play](#VeLivePlayer-play) 开始播放之前，调用本方法设置回调。
+     * @order 2
+     * @param observer 播放器的事件回调对象。详情请参见 VeLivePlayerObserver{@link #VeLivePlayerObserver}。
+     *
+     */
     /** {en}
      * @detail api
      * @brief  Sets the player observer to listen to the live player's events, such as playback errors or status updates, rendering of the first audio and video frame, and resolution switching.
@@ -98,7 +158,16 @@ export declare class VeLivePlayer {
      *
      */
     setObserver(observer: VeLivePlayerObserver): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置播放器画面的填充模式。
+     * @notes <br>
+     *        - 如果用于起播设置，需要在调用 [play](#VeLivePlayer-play) 开始播放之前，调用本方法设置视频的填充模式。
+     *        - 如果用于调节填充模式，可以在播放过程中调用本方法动态调节视频的填充模式。
+     * @order 3
+     * @param fillMode 设置 SurfaceView 的填充模式，默认值为 `VeLivePlayerFillModeAspectFill`，详情请参见 [VeLivePlayerFillMode](188115#VeLivePlayerFillMode)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the fill mode of the player screen.
@@ -110,7 +179,16 @@ export declare class VeLivePlayer {
      *
      */
     setRenderFillMode(fillMode: VeLivePlayerFillMode): Promise<void>;
-    
+    /** {zh}
+     * @platform android
+     * @detail api
+     * @brief 使用 SurfaceView 播放视频时，通过设置 SurfaceHolder 对象完成视频图像的渲染和播放。
+     * @notes
+     *        如果同时调用 setSurfaceHolder 和 [setSurface](#VeLivePlayer-setsurface) 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
+     * @order 6
+     * @param surfaceHolder SurfaceHolder 对象。
+     *
+     */
     /** {en}
      * @platform android
      * @detail api
@@ -122,7 +200,16 @@ export declare class VeLivePlayer {
      *
      */
     android_setSurfaceHolder(surfaceHolder: $p_a.SurfaceHolder): void;
-    
+    /** {zh}
+     * @platform android
+     * @detail api
+     * @brief 使用 SurfaceView 或 TextureView 播放视频时，通过设置 Surface 对象完成视频图像的渲染和播放。
+     * @notes
+     *        如果同时调用 [setSurfaceHolder](#VeLivePlayer-setsurfaceholder) 和 setSurface 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
+     * @order 7
+     * @param surface surface 对象的类型。
+     *
+     */
     /** {en}
      * @platform android
      * @detail api
@@ -134,7 +221,15 @@ export declare class VeLivePlayer {
      *
      */
     android_setSurface(surface: $p_a.Surface): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置单个直播播放地址。
+     * @notes <br>
+     *      需要在调用 play{@link #play} 开始播放之前，调用本方法设置单个直播播放地址。
+     * @order 8
+     * @param url 直播播放地址。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets a pull stream address.
@@ -144,7 +239,15 @@ export declare class VeLivePlayer {
      *
      */
     setPlayUrl(url: string): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 多路流信息配置。例如，您需要使用 ABR、手动切档和主备流等依赖多路流的功能，可以调用本方法进行配置。
+     * @notes <br>
+     *      需要在调用 play{@link #play} 开始播放之前，调用本方法设置多路流信息。
+     * @order 8
+     * @param streamData 多路流信息配置，详情请参见 [VeLivePlayerStreamData](188115#VeLivePlayerStreamData) 。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets multiple live streams. Call this method if you need to enable features requiring multiple live streams, such as adaptive bitrate (ABR), manual resolution switching, and primary and backup streams.
@@ -154,7 +257,14 @@ export declare class VeLivePlayer {
      *
      */
     setPlayStreamData(streamData: VeLivePlayerStreamData): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开始/恢复播放。
+     * @notes <br>
+     *     调用本方法，在播放器完成拉流准备和首帧渲染播放后，都会触发 onPlayerStatusUpdate{@link #VeLivePlayerObserver#onPlayerStatusUpdate} 播放器状态回调。
+     * @order 8
+     *
+     */
     /** {en}
      * @detail api
      * @brief Starts or resumes playback.
@@ -164,7 +274,14 @@ export declare class VeLivePlayer {
      *
      */
     play(): Promise<void>;
-    
+    /** {zh}
+     * @detail api
+     * @brief 暂停播放。
+     * @notes <br>
+     *     调用本方法暂停播放后，会触发 onPlayerStatusUpdate{@link #VeLivePlayerObserver#onPlayerStatusUpdate} 播放器状态回调。
+     * @order 8
+     *
+     */
     /** {en}
      * @detail api
      * @brief Pauses playback.
@@ -174,7 +291,14 @@ export declare class VeLivePlayer {
      *
      */
     pause(): Promise<void>;
-    
+    /** {zh}
+     * @detail api
+     * @brief 停止播放，不销毁播放器。
+     * @notes <br>
+     *     调用本方法停止播放后，会触发 onPlayerStatusUpdate{@link #VeLivePlayerObserver#onPlayerStatusUpdate} 播放器状态回调。
+     * @order 8
+     *
+     */
     /** {en}
      * @detail api
      * @brief Stops playback. This method does not destroy the player.
@@ -184,7 +308,12 @@ export declare class VeLivePlayer {
      *
      */
     stop(): Promise<void>;
-    
+    /** {zh}
+     * @detail api
+     * @brief 停止播放，并销毁播放器。
+     * @order 8
+     *
+     */
     /** {en}
      * @detail api
      * @brief Stops playback and destroys the player.
@@ -192,7 +321,15 @@ export declare class VeLivePlayer {
      *
      */
     destroy(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 检查播放器是否正在播放。
+     * @return 是否正在播放。<br>
+     *      - true：正在播放；
+     *      - false：未播放。
+     * @order 8
+     *
+     */
     /** {en}
      * @detail api
      * @brief Checks whether the player is playing.
@@ -203,7 +340,15 @@ export declare class VeLivePlayer {
      *
      */
     isPlaying(): boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置是否静音播放。
+     * @param mute 是否开启静音播放，默认值为 false。<br>
+     *             - true：开启；
+     *             - false：关闭。
+     * @order 9
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets whether to mute playback.
@@ -214,7 +359,15 @@ export declare class VeLivePlayer {
      *
      */
     setMute(mute: boolean): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取是否处于静音状态。
+     * @return 是否处于静音状态。<br>
+     *     - true：静音；
+     *     - false：未静音。
+     * @order 10
+     *
+     */
     /** {en}
      * @detail api
      * @brief Checks whether playback is muted.
@@ -225,7 +378,15 @@ export declare class VeLivePlayer {
      *
      */
     isMute(): boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置域名和服务器的 IP 地址映射关系。
+     * @order 11
+     * @param hostIpMap 域名和服务器 IP 地址的映射关系列表。其中 `Map` 的 Key 是域名，Value 是 `List` 类型，表示该域名对应的服务器 IP 地址列表。
+     * @notes - 使用 setUrlHostIP 对域名和 IP 地址进行映射时，需在初始化配置中关闭 DNS 预解析功能，即 [enableLiveDNS](188115#VeLivePlayerConfiguration-enablelivedns) 设置为 false。
+     *        - 需要在调用 [play](#VeLivePlayer-play) 开始播放前，调用本方法设置域名和 IP 的映射。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the mapping of domain names to server IP addresses.
@@ -236,7 +397,14 @@ export declare class VeLivePlayer {
      *
      */
     setUrlHostIP(hostIpMap: Map<String, List<String>>): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置播放器高级配置。高级配置包括离屏渲染设置、缓冲区最大时长、ABR 码率自适应算法类型等，如需了解详细信息，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     * @order 12
+     * @param key 高级配置的参数名。
+     * @param value 参数对应的参数值。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Configures advanced settings for the player, including offscreen rendering, maximum buffer duration, and adaptive bitrate (ABR) algorithms. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if you need further information.
@@ -246,7 +414,18 @@ export declare class VeLivePlayer {
      *
      */
     setProperty(key: string, value: Object): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 视频截图。
+     * @notes <br>
+     *      - 本方法仅在视频状态为播放时生效。
+     *      - 调用本方法截图成功后，会触发 onSnapshotComplete{@link #VeLivePlayerObserver#onSnapshotComplete} 回调，回调消息中包含截图的 Bitmap 对象。
+     * @return <br>
+     *         - 0：当前状态支持截图；
+     *         - [VeLivePlayerErrorRefused](188113#VeLivePlayerErrorCode-veliveplayererrorrefused) ：当前状态不支持截图。
+     * @order 13
+     *
+     */
     /** {en}
      * @detail api
      * @brief Takes a screenshot of the video.
@@ -260,7 +439,21 @@ export declare class VeLivePlayer {
      *
      */
     snapshot(): number;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频帧回调。
+     * @notes <br>
+     *      - 您可以在使用外部渲染的场景下调用本方法，订阅视频帧的解码数据。
+     *      - 调用本方法后，会触发 onRenderVideoFrame{@link #VeLivePlayerObserver#onRenderVideoFrame} 回调，回调消息中包含每个视频帧的详细数据。
+     *      - 如果您使用外部渲染，需要保证音视频同步。
+     * @order 14
+     * @param enable 是否开启视频帧回调，默认值为 false。 <br>
+     *               - true：开启；
+     *               - false：关闭。
+     * @param pixelFormat 回调的视频帧像素格式，详情请参见 [VeLivePlayerPixelFormat](188115#VeLivePlayerPixelFormat)。
+     * @param bufferType 回调的视频数据封装格式，详情请参见 [VeLivePlayerVideoBufferType](188115#VeLivePlayerVideoBufferType) 。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the video frame observer.
@@ -277,7 +470,23 @@ export declare class VeLivePlayer {
      *
      */
     enableVideoFrameObserver(enable: boolean, pixelFormat: VeLivePlayerPixelFormat, bufferType: VeLivePlayerVideoBufferType): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置音频帧回调。
+     * @param enable 是否开启音频帧回调，默认值为 false。 <br>
+     *               - true：开启；
+     *               - false：关闭。
+     * @param enableRendering 是否开启播放器渲染。默认值为 false。<br/>
+     *        - true：开启；
+     *        - false：关闭。
+     * @param bufferType 音频 buffer 类型，详情请参见 [VeLivePlayerAudioBufferType](188115#VeLivePlayerAudioBufferType)。
+     * @notes <br>
+     *       - 您可以在使用外部渲染的场景下调用本方法，订阅音频帧的解码数据。
+     *       - 调用本方法后，会触发 onRenderAudioFrame{@link #VeLivePlayerObserver#onRenderAudioFrame} 回调，回调消息中包含每个音频帧的详细数据。
+     *       - 如果您使用外部渲染，需要保证音视频同步。
+     * @order 15
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the audio frame observer.
@@ -297,7 +506,17 @@ export declare class VeLivePlayer {
      *
      */
     enableAudioFrameObserver(enable: boolean, enableRendering: boolean, bufferType: VeLivePlayerAudioBufferType): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频顺时针旋转角度。
+     * @notes <br>
+     *      - 支持在播放前和播放中动态修改视频旋转角度。
+     *      - 每次调用本方法，播放器都将基于图像的原始角度进行旋转。
+     *      - 当同时使用旋转和镜像功能，播放器会先进行镜像，再进行旋转。
+     * @order 16
+     * @param rotation 视频旋转角度，默认关闭旋转，详情请参见 [VeLivePlayerRotation](188115#VeLivePlayerRotation) 。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the clockwise rotation angle of the video.
@@ -310,7 +529,17 @@ export declare class VeLivePlayer {
      *
      */
     setRenderRotation(rotation: VeLivePlayerRotation): Promise<void>;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频镜像。
+     * @notes <br>
+     *      - 支持在播放前和播放中动态修改视频镜像方式。
+     *      - 每次调用本方法，播放器都将基于原始图像进行镜像。
+     *      - 当同时使用旋转和镜像功能，播放器会先进行镜像，再进行旋转。
+     * @order 17
+     * @param mirror 视频镜像，默认关闭镜像，详情请参见 [VeLivePlayerMirror](188115#VeLivePlayerMirror) 。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Configures mirroring settings.
@@ -323,7 +552,19 @@ export declare class VeLivePlayer {
      *
      */
     setRenderMirror(mirror: VeLivePlayerMirror): Promise<void>;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置是否开启超分。您需要联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)开通超分功能后才可使用该功能。
+     * @notes <br>
+     *      - 在首帧回调后，调用该接口开启超分。
+     *      - 支持播放中调用该接口动态开启和关闭超分。
+     *      - 如果机型、分辨率和帧率不符合限制，将无法开启超分，并触发 onStreamFailedOpenSuperResolution{@link #VeLivePlayerObserver#onStreamFailedOpenSuperResolution} 回调。
+     * @order 18
+     * @param enable 是否开启超分。默认值为 false。<br>
+     *                        - true：开启；
+     *                        - false：关闭。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Enables or disables super resolution. You must first contact BytePlus [technical support](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to activate the feature before using it.
@@ -338,7 +579,14 @@ export declare class VeLivePlayer {
      *
      */
     setEnableSuperResolution(enable: boolean): void;
-    
+    /** {zh}
+     * @platform android
+     * @brief 设置是否开启视频锐化。
+     * @param enable 是否开启视频锐化，默认值为 `false`。
+     *        - true：开启；
+     *        - false：关闭。
+     *
+     */
     /** {en}
      * @platform android
      * @brief Set whether to enable video sharpening.
@@ -348,14 +596,24 @@ export declare class VeLivePlayer {
      *
      */
     android_setEnableSharpen(enable: boolean): void;
-    
+    /** {zh}
+     * @platform ios
+     * @brief 初始化特定类型的播放器。
+     * @param type 播放器类型，详情请参见 [VeLivePlayerType](188121#VeLivePlayerType)。
+     */
     /** {en}
      * @platform ios
      * @brief Initializes the specified type of player.
      * @param type The player type. Refer to [VeLivePlayerType](docs-player-sdk-for-ios-type-definition#VeLivePlayerType) for details.
      */
     ios_initWithType(type: $p_i.VeLivePlayerType): this;
-    
+    /** {zh}
+     * @platform ios
+     * @brief 检查播放器当前是否支持指定的分辨率档位。
+     * @param resolution 分辨率档位，详情请参见 [VeLivePlayerResolution](188121#VeLivePlayerResolution)。
+     * @return - 0：支持；
+     *         - 其他：不支持。其他返回值详情请参见 [VeLivePlayerSupportResolutionSwitchError](188121#VeLivePlayerSupportResolutionSwitchError)。
+     */
     /** {en}
      * @platform ios
      * @brief Check whether the player currently supports the specified resolution level.