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

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

@@ -1,6 +1,6 @@
 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 { VeLivePlayerResolution, VeLivePlayerFillMode, VeLivePlayerPixelFormat, VeLivePlayerVideoBufferType, VeLivePlayerAudioBufferType, VeLivePlayerRotation, VeLivePlayerMirror, VeLivePlayerLogLevel, VeLivePlayerConfiguration, VeLivePlayerStreamData } from './keytype';
 import { VeLivePlayerObserver } from './callback';
 import { Map, type String, List } from './types';
 import { ApplicationContext } from './external';
@@ -28,13 +28,6 @@ export declare class VeLivePlayer {
      */
     
     static setLogLevel(logLevel: VeLivePlayerLogLevel): void;
-    /** {zh}
-     * @platform ios
-     * @brief 设置域名和服务器的 IP 地址映射关系。
-     * @param hostIpMap 域名和服务器 IP 地址的映射关系列表。其中 `Map` 的 Key 是域名，Value 是 `List` 类型，表示该域名对应的服务器 IP 地址列表。
-     */
-    
-    static ios_setHttpDNSHostIP(hostIpMap: $p_i.NSDictionary): void;
     constructor(context: ApplicationContext);
     constructor();
     protected _instance: any;
@@ -44,24 +37,24 @@ export declare class VeLivePlayer {
      * @brief 播放器的回调事件监听器。
      */
     
-    get ios_observer(): $p_i.id<$p_i.VeLivePlayerObserver>;
-    set ios_observer(value: $p_i.id<$p_i.VeLivePlayerObserver>);
+    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 添加到应用的视图层级中，实现视频内容显示。
      */
     
-    get ios_playerView(): $p_i.UIView;
-    set ios_playerView(value: $p_i.UIView);
+    get playerView(): $p_i.UIView;
+    set 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);
+    get volume(): $p_i.float;
+    set volume(value: $p_i.float);
     protected __init(...args: any[]): void;
     protected __new_instance(...args: any[]): any;
     /** {zh}
@@ -78,11 +71,11 @@ export declare class VeLivePlayer {
      * @brief 切换播放的清晰度档位。
      * @notes - 需要在调用 [setPlayStreamData](#VeLivePlayer-setplaystreamdata) 设置多档位后，调用本方法切换播放器的清晰度档位。
      *        - 调用本方法成功切换档位后，会触发清晰度档位变化 [onResolutionSwitch](188112#VeLivePlayerObserver-onresolutionswitch) 回调。
+     * @order 8
+     * @param resolution 设置清晰度的目标档位，详情请参见 [VeLivePlayerResolution](188115#VeLivePlayerResolution) 。
      * @return <br>
      *     - true：成功；
      *     - false：失败。
-     * @order 8
-     * @param resolution 设置清晰度的目标档位，详情请参见 [VeLivePlayerResolution](188115#VeLivePlayerResolution) 。
      *
      */
     
@@ -90,7 +83,8 @@ export declare class VeLivePlayer {
     /** {zh}
      * @detail api
      * @brief 初始化播放器，用于设置是否开启 SEI 消息、是否开启硬件解码和是否开启本地 DNS 预解析等配置信息。
-     * @notes <br>需要在调用 [play](#VeLivePlayer-play) 开始播放之前，调用本方法进行播放器的初始化。
+     * @notes
+     *        需要在调用 [play](#VeLivePlayer-play) 开始播放之前，调用本方法进行播放器的初始化。
      * @order 1
      * @param config 播放器配置信息，详情请参见 VeLivePlayerConfiguration{@link #VeLivePlayerConfiguration}。
      *
@@ -123,8 +117,8 @@ export declare class VeLivePlayer {
      * @platform android
      * @detail api
      * @brief 使用 SurfaceView 播放视频时，通过设置 SurfaceHolder 对象完成视频图像的渲染和播放。
-     * @notes <br>
-     *     如果同时调用 setSurfaceHolder 和 setSurface{@link #setSurface} 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
+     * @notes
+     *        如果同时调用 setSurfaceHolder 和 [setSurface](#VeLivePlayer-setsurface) 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
      * @order 6
      * @param surfaceHolder SurfaceHolder 对象。
      *
@@ -135,8 +129,8 @@ export declare class VeLivePlayer {
      * @platform android
      * @detail api
      * @brief 使用 SurfaceView 或 TextureView 播放视频时，通过设置 Surface 对象完成视频图像的渲染和播放。
-     * @notes <br>
-     *     如果同时调用 setSurfaceHolder{@link #setSurfaceHolder} 和 setSurface 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
+     * @notes
+     *        如果同时调用 [setSurfaceHolder](#VeLivePlayer-setsurfaceholder) 和 setSurface 设置视频播放画面的 Surface，播放器会优先使用 surfaceHolder 的配置。
      * @order 7
      * @param surface surface 对象的类型。
      *
@@ -241,13 +235,15 @@ export declare class VeLivePlayer {
      * @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 的映射。
      *
      */
     
     setUrlHostIP(hostIpMap: Map<String, List<String>>): void;
     /** {zh}
      * @detail api
-     * @brief 设置播放器高级配置。高级配置包括离屏渲染设置、缓冲区最大时长、ABR 码率自适应算法类型等，如需了解详细信息，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=owVvVTNjDkRmjctcsyNW)。
+     * @brief 设置播放器高级配置。高级配置包括离屏渲染设置、缓冲区最大时长、ABR 码率自适应算法类型等，如需了解详细信息，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      * @order 12
      * @param key 高级配置的参数名。
      * @param value 参数对应的参数值。
@@ -292,9 +288,10 @@ export declare class VeLivePlayer {
      * @param enable 是否开启音频帧回调，默认值为 false。 <br>
      *               - true：开启；
      *               - false：关闭。
-     * @param enableRendering 是否开启播放器渲染。默认值为 false。<br>
-     *                        - true：开启；
-     *                        - false：关闭。
+     * @param enableRendering 是否开启播放器渲染。默认值为 false。<br/>
+     *        - true：开启；
+     *        - false：关闭。
+     * @param bufferType 音频 buffer 类型，详情请参见 [VeLivePlayerAudioBufferType](188115#VeLivePlayerAudioBufferType)。
      * @notes <br>
      *       - 您可以在使用外部渲染的场景下调用本方法，订阅音频帧的解码数据。
      *       - 调用本方法后，会触发 onRenderAudioFrame{@link #VeLivePlayerObserver#onRenderAudioFrame} 回调，回调消息中包含每个音频帧的详细数据。
@@ -303,7 +300,7 @@ export declare class VeLivePlayer {
      *
      */
     
-    enableAudioFrameObserver(enable: boolean, enableRendering: boolean): void;
+    enableAudioFrameObserver(enable: boolean, enableRendering: boolean, bufferType: VeLivePlayerAudioBufferType): void;
     /** {zh}
      * @detail api
      * @brief 设置视频顺时针旋转角度。
@@ -358,8 +355,17 @@ export declare class VeLivePlayer {
     /** {zh}
      * @platform ios
      * @brief 初始化特定类型的播放器。
-     * @param type 播放器类型，详情请参见 [VeLivePlayerType](188118#VeLivePlayerType)。
+     * @param type 播放器类型，详情请参见 [VeLivePlayerType](188121#VeLivePlayerType)。
      */
     
     ios_initWithType(type: $p_i.VeLivePlayerType): this;
+    /** {zh}
+     * @platform ios
+     * @brief 检查播放器当前是否支持指定的分辨率档位。
+     * @param resolution 分辨率档位，详情请参见 [VeLivePlayerResolution](188121#VeLivePlayerResolution)。
+     * @return - 0：支持；
+     *         - 其他：不支持。其他返回值详情请参见 [VeLivePlayerSupportResolutionSwitchError](188121#VeLivePlayerSupportResolutionSwitchError)。
+     */
+    
+    ios_isSupportResolutionSwitch(resolution: $p_i.VeLivePlayerResolution): number;
 }

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

@@ -3,7 +3,7 @@ import * as $p_i from '../ios/index';
 import { VeLivePlayerResolution, VeLivePlayerResolutionSwitchReason, VeLivePlayerStreamType, VeLivePlayerStatus, VeLivePlayerStatistics, VeLivePlayerVideoFrame, VeLivePlayerAudioFrame } from './keytype';
 import { VeLivePlayer } from './api';
 import { VeLivePlayerError } from './errorcode';
-import { Bitmap } from './types';
+import { Bitmap, int, BOOL, NSString } from './types';
 /** {zh}
  * @detail callback
  * @brief 播放器事件回调。
@@ -106,7 +106,7 @@ export interface VeLivePlayerObserver {
     onVideoSizeChanged?(player: VeLivePlayer, width: number, height: number): void;
     /** {zh}
      * @detail callback
-     * @brief SEI 信息回调。当播放器 SDK 接收到 SEI 信息时，触发回调。
+     * @brief 字符串 SEI 消息回调，当播放器 SDK 接收到 SEI 消息时，触发该回调。需要开启 VeLivePlayerConfiguration 中 enableSei 属性。当 enableBinarySei 属性开启时，字符串 SEI 消息将不再发送。
      * @order 10
      * @param player 触发该事件回调的播放器对象。
      * @param message SEI 信息。
@@ -114,6 +114,16 @@ export interface VeLivePlayerObserver {
      */
     
     onReceiveSeiMessage?(player: VeLivePlayer, message: string): void;
+    /** {zh}
+     * @detail callback
+     * @brief 二级制 SEI 消息回调，当播放器 SDK 接收到 SEI 消息时，触发该回调。需要开启 VeLivePlayerConfiguration 中 enableBinarySei 属性。当 enableBinarySei 属性开启时，字符串 SEI 消息将不再发送。
+     * @order 10
+     * @param player 触发该事件回调的播放器对象。
+     * @param message SEI 信息。
+     *
+     */
+    
+    onReceiveBinarySeiMessage?(player: VeLivePlayer, message: ArrayBuffer): void;
     /** {zh}
      * @detail callback
      * @brief 主备流切换回调。
@@ -189,6 +199,17 @@ export interface VeLivePlayerObserver {
      */
     
     onStreamFailedOpenSuperResolution?(player: VeLivePlayer, error: VeLivePlayerError): void;
+    /** {zh}
+     * @platform android
+     * @detail callback
+     * @brief 锐化开启失败。调用 setEnableSharpen{@link #VeLivePlayer#setEnableSharpen} 开启锐化后，当播放器不支持超分开启或者超分处理出错时，会触发此回调。
+     * @param player 触发该事件回调的播放器对象。
+     * @param error 锐化开启失败原因。错误码请参见 [VeLivePlayerErrorCode](188113#VeLivePlayerErrorCode)。
+     * @order 18
+     *
+     */
+    
+    onStreamFailedOpenSharpen?(): void;
 }
 export declare class android_VeLivePlayerObserver extends $p_a.VeLivePlayerObserver {
     protected _instance: VeLivePlayerObserver;
@@ -198,11 +219,12 @@ export declare class android_VeLivePlayerObserver extends $p_a.VeLivePlayerObser
     onFirstAudioFrameRender(player: $p_a.VeLivePlayer, isFirstFrame: boolean): void;
     onStallStart(player: $p_a.VeLivePlayer): void;
     onStallEnd(player: $p_a.VeLivePlayer): void;
-    onVideoRenderStall(player: $p_a.VeLivePlayer, stallTime: $p_a.long): void;
-    onAudioRenderStall(player: $p_a.VeLivePlayer, stallTime: $p_a.long): void;
+    onVideoRenderStall(player: $p_a.VeLivePlayer, stallTime: int): void;
+    onAudioRenderStall(player: $p_a.VeLivePlayer, stallTime: int): void;
     onResolutionSwitch(player: $p_a.VeLivePlayer, resolution: $p_a.VeLivePlayerResolution, error: $p_a.VeLivePlayerError, reason: $p_a.VeLivePlayerResolutionSwitchReason): void;
-    onVideoSizeChanged(player: $p_a.VeLivePlayer, width: $p_a.int, height: $p_a.int): void;
+    onVideoSizeChanged(player: $p_a.VeLivePlayer, width: int, height: int): void;
     onReceiveSeiMessage(player: $p_a.VeLivePlayer, message: string): void;
+    onReceiveBinarySeiMessage(player: $p_a.VeLivePlayer, message: ArrayBuffer): void;
     onMainBackupSwitch(player: $p_a.VeLivePlayer, streamType: $p_a.VeLivePlayerStreamType, error: $p_a.VeLivePlayerError): void;
     onPlayerStatusUpdate(player: $p_a.VeLivePlayer, status: $p_a.VeLivePlayerStatus): void;
     onStatistics(player: $p_a.VeLivePlayer, statistics: $p_a.VeLivePlayerStatistics): void;
@@ -210,20 +232,22 @@ export declare class android_VeLivePlayerObserver extends $p_a.VeLivePlayerObser
     onRenderVideoFrame(player: $p_a.VeLivePlayer, videoFrame: $p_a.VeLivePlayerVideoFrame): void;
     onRenderAudioFrame(player: $p_a.VeLivePlayer, audioFrame: $p_a.VeLivePlayerAudioFrame): void;
     onStreamFailedOpenSuperResolution(player: $p_a.VeLivePlayer, error: $p_a.VeLivePlayerError): void;
+    onStreamFailedOpenSharpen(player: $p_a.VeLivePlayer, error: $p_a.VeLivePlayerError): void;
 }
 export declare class ios_VeLivePlayerObserver extends $p_i.VeLivePlayerObserver {
     protected _instance: VeLivePlayerObserver;
     constructor(_instance: VeLivePlayerObserver);
     onError$error(player: $p_i.TVLManager, error: $p_i.VeLivePlayerError): void;
-    onFirstVideoFrameRender$isFirstFrame(player: $p_i.TVLManager, isFirstFrame: $p_i.BOOL): void;
-    onFirstAudioFrameRender$isFirstFrame(player: $p_i.TVLManager, isFirstFrame: $p_i.BOOL): void;
+    onFirstVideoFrameRender$isFirstFrame(player: $p_i.TVLManager, isFirstFrame: BOOL): void;
+    onFirstAudioFrameRender$isFirstFrame(player: $p_i.TVLManager, isFirstFrame: BOOL): void;
     onStallStart(player: $p_i.TVLManager): void;
     onStallEnd(player: $p_i.TVLManager): void;
     onVideoRenderStall$stallTime(player: $p_i.TVLManager, stallTime: $p_i.int64_t): void;
     onAudioRenderStall$stallTime(player: $p_i.TVLManager, stallTime: $p_i.int64_t): void;
     onResolutionSwitch$resolution$error$reason(player: $p_i.TVLManager, resolution: $p_i.VeLivePlayerResolution, error: $p_i.VeLivePlayerError, reason: $p_i.VeLivePlayerResolutionSwitchReason): void;
-    onVideoSizeChanged$width$height(player: $p_i.TVLManager, width: $p_i.int, height: $p_i.int): void;
-    onReceiveSeiMessage$message(player: $p_i.TVLManager, message: $p_i.NSString): void;
+    onVideoSizeChanged$width$height(player: $p_i.TVLManager, width: int, height: int): void;
+    onReceiveSeiMessage$message(player: $p_i.TVLManager, message: NSString): void;
+    onReceiveBinarySeiMessage$message(player: $p_i.TVLManager, message: $p_i.NSData): void;
     onMainBackupSwitch$streamType$error(player: $p_i.TVLManager, streamType: $p_i.VeLivePlayerStreamType, error: $p_i.VeLivePlayerError): void;
     onPlayerStatusUpdate$status(player: $p_i.TVLManager, status: $p_i.VeLivePlayerStatus): void;
     onStatistics$statistics(player: $p_i.TVLManager, statistics: $p_i.VeLivePlayerStatistics): void;

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

@@ -121,20 +121,38 @@ export declare enum VeLivePlayerErrorCode {
     
     VeLivePlayerErrorSRExecuteFail = -307,
     /** {zh}
-     * @brief 您使用的基础版 License 暂不支持 H.265 硬件解码，请登录火山引擎[视频直播控制台](https://console.volcengine.com/live/main/sdk)获取高级版 License。
+     * @brief 您使用的基础版 License 暂不支持 H.265 硬件解码。
      *
      */
     
     VeLivePlayerLicenseUnsupportedH265 = -308,
+    /** {zh}
+     * @platform android
+     * @brief 该台设备系统版本不支持锐化能力；如果有疑问，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=owVvVTNjDkRmjctcsyNW)。
+     *
+     */
+    
+    VeLivePlayerErrorSharpenDeviceUnsupported = -309,
+    /** {zh}
+     * @brief 分辨率档位切换不支持；如果故障未排除，请联系火山引擎技术支持。
+     * @hidden (Android)
+     *
+     */
+    
+    VeLivePlayerErrorNotSupportResolutionSwitch = -310,
     /** {zh}
      * @platform ios
      * @brief DRM 鉴权失败。
+     *
      */
+    
     VeLivePlayerDRMFetchCKCFailed = -400,
     /** {zh}
      * @platform ios
      * @brief 服务器播放上下文（SPC）生成失败。
+     *
      */
+    
     VeLivePlayerDRMFetchSPCFailed = -401,
     /** {zh}
      * @brief 内部错误。请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
@@ -161,10 +179,17 @@ export declare class VeLivePlayerError {
      */
     
     get errorMsg(): string;
+    /** {zh}
+     * @platform android
+     * @brief 直播播放子错误码。
+     *
+     */
+    
+    get mSubCode(): number;
 }
 export declare class t_VeLivePlayerErrorCode {
-    static ts_to_android(value: VeLivePlayerErrorCode): $p_a.VeLivePlayerErrorCode;
-    static android_to_ts(value: $p_a.VeLivePlayerErrorCode): VeLivePlayerErrorCode;
-    static ts_to_ios(value: VeLivePlayerErrorCode): $p_i.VeLivePlayerErrorCode;
-    static ios_to_ts(value: $p_i.VeLivePlayerErrorCode): VeLivePlayerErrorCode;
+    static code_to_android(value: VeLivePlayerErrorCode): $p_a.VeLivePlayerErrorCode;
+    static android_to_code(value: $p_a.VeLivePlayerErrorCode): VeLivePlayerErrorCode;
+    static code_to_ios(value: VeLivePlayerErrorCode): $p_i.VeLivePlayerErrorCode;
+    static ios_to_code(value: $p_i.VeLivePlayerErrorCode): VeLivePlayerErrorCode;
 }