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

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

@@ -1,5 +1,5 @@
 import { String, SurfaceHolder, Surface, float, Map, List, int } from './types';
-import { VeLivePlayerLogLevel, VeLivePlayerConfiguration, VeLivePlayerFillMode, VeLivePlayerStreamData, VeLivePlayerResolution, VeLivePlayerPixelFormat, VeLivePlayerVideoBufferType, VeLivePlayerRotation, VeLivePlayerMirror } from './keytype';
+import { VeLivePlayerLogLevel, VeLivePlayerConfiguration, VeLivePlayerFillMode, VeLivePlayerStreamData, VeLivePlayerResolution, VeLivePlayerPixelFormat, VeLivePlayerVideoBufferType, VeLivePlayerAudioBufferType, VeLivePlayerRotation, VeLivePlayerMirror } from './keytype';
 import { VeLivePlayerObserver } from './callback';
 import { ApplicationContext } from './external';
 export declare class VeLivePlayer {
@@ -26,7 +26,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}。
      *
@@ -58,8 +59,8 @@ export declare class VeLivePlayer {
     /** {zh}
      * @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 对象。
      *
@@ -69,8 +70,8 @@ export declare class VeLivePlayer {
     /** {zh}
      * @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 对象的类型。
      *
@@ -142,11 +143,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) 。
      *
      */
     
@@ -198,13 +199,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 参数对应的参数值。
@@ -249,9 +252,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} 回调，回调消息中包含每个音频帧的详细数据。
@@ -260,7 +264,7 @@ export declare class VeLivePlayer {
      *
      */
     
-    enableAudioFrameObserver(enable: boolean, enableRendering: boolean): void;
+    enableAudioFrameObserver(enable: boolean, enableRendering: boolean, bufferType: VeLivePlayerAudioBufferType): void;
     /** {zh}
      * @detail api
      * @brief 设置视频顺时针旋转角度。
@@ -311,4 +315,5 @@ export declare class VeLivePlayer {
      */
     
     setEnableSharpen(enable: boolean): void;
+    addExtraHttpRequestHeadersByUser(headers: Map): void;
 }

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

@@ -11,6 +11,7 @@ export declare class VeLivePlayerObserver {
      * @param error 错误信息，详情请参见 [VeLivePlayerError](188113#VeLivePlayerError) 。
      *
      */
+    
     onError?(player: VeLivePlayer, error: VeLivePlayerError): void;
     /** {zh}
      * @detail callback
@@ -22,6 +23,7 @@ export declare class VeLivePlayerObserver {
      *                     - false：重试后第一个视频帧。
      *
      */
+    
     onFirstVideoFrameRender?(player: VeLivePlayer, isFirstFrame: boolean): void;
     /** {zh}
      * @detail callback
@@ -33,6 +35,7 @@ export declare class VeLivePlayerObserver {
      *                     - false：重试后第一个音频帧。
      *
      */
+    
     onFirstAudioFrameRender?(player: VeLivePlayer, isFirstFrame: boolean): void;
     /** {zh}
      * @detail callback
@@ -41,6 +44,7 @@ export declare class VeLivePlayerObserver {
      * @param player 触发该事件回调的播放器对象。
      *
      */
+    
     onStallStart?(player: VeLivePlayer): void;
     /** {zh}
      * @detail callback
@@ -49,6 +53,7 @@ export declare class VeLivePlayerObserver {
      * @param player 触发该事件回调的播放器对象。
      *
      */
+    
     onStallEnd?(player: VeLivePlayer): void;
     /** {zh}
      * @detail callback
@@ -58,6 +63,7 @@ export declare class VeLivePlayerObserver {
      * @param stallTime 视频渲染卡顿时长，单位为 ms。
      *
      */
+    
     onVideoRenderStall?(player: VeLivePlayer, stallTime: long): void;
     /** {zh}
      * @detail callback
@@ -67,6 +73,7 @@ export declare class VeLivePlayerObserver {
      * @param stallTime 音频渲染卡顿时长，单位为 ms。
      *
      */
+    
     onAudioRenderStall?(player: VeLivePlayer, stallTime: long): void;
     /** {zh}
      * @detail callback
@@ -78,6 +85,7 @@ export declare class VeLivePlayerObserver {
      * @param reason 清晰度档位切换的原因，详情请参见 [VeLivePlayerResolutionSwitchReason](188115#VeLivePlayerResolutionSwitchReason) 。
      *
      */
+    
     onResolutionSwitch?(player: VeLivePlayer, resolution: VeLivePlayerResolution, error: VeLivePlayerError, reason: VeLivePlayerResolutionSwitchReason): void;
     /** {zh}
      * @detail callback
@@ -88,16 +96,28 @@ export declare class VeLivePlayerObserver {
      * @param height 变化后的视频高度，单位为 px。
      *
      */
+    
     onVideoSizeChanged?(player: VeLivePlayer, width: int, height: int): void;
     /** {zh}
      * @detail callback
-     * @brief SEI 信息回调。当播放器 SDK 接收到 SEI 信息时，触发回调。
+     * @brief 字符串 SEI 消息回调，当播放器 SDK 接收到 SEI 消息时，触发该回调。需要开启 VeLivePlayerConfiguration 中 enableSei 属性。当 enableBinarySei 属性开启时，字符串 SEI 消息将不再发送。
      * @order 10
      * @param player 触发该事件回调的播放器对象。
      * @param message SEI 信息。
      *
      */
+    
     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 主备流切换回调。
@@ -107,6 +127,7 @@ export declare class VeLivePlayerObserver {
      * @param error 触发主备流切换的原因，详情请参见 [VeLivePlayerError](188113#VeLivePlayerError) 。
      *
      */
+    
     onMainBackupSwitch?(player: VeLivePlayer, streamType: VeLivePlayerStreamType, error: VeLivePlayerError): void;
     /** {zh}
      * @detail callback
@@ -116,6 +137,7 @@ export declare class VeLivePlayerObserver {
      * @param status 当前播放器的状态，详情请参见 [VeLivePlayerStatus](188115#VeLivePlayerStatus) 。
      *
      */
+    
     onPlayerStatusUpdate?(player: VeLivePlayer, status: VeLivePlayerStatus): void;
     /** {zh}
      * @detail callback
@@ -125,6 +147,7 @@ export declare class VeLivePlayerObserver {
      * @param statistics 播放器周期性回调的统计信息，详情请参见 [VeLivePlayerStatistics](188115#VeLivePlayerStatistics) 。
      *
      */
+    
     onStatistics?(player: VeLivePlayer, statistics: VeLivePlayerStatistics): void;
     /** {zh}
      * @detail callback
@@ -134,6 +157,7 @@ export declare class VeLivePlayerObserver {
      * @param bitmap 截图的 Bitmap 对象。
      *
      */
+    
     onSnapshotComplete?(player: VeLivePlayer, bitmap: Bitmap): void;
     /** {zh}
      * @detail callback
@@ -145,6 +169,7 @@ export declare class VeLivePlayerObserver {
      * @param videoFrame 视频帧数据，包含像素格式、封装格式、视频宽高等信息，详情请参见 [VeLivePlayerVideoFrame](188115#VeLivePlayerVideoFrame) 。
      *
      */
+    
     onRenderVideoFrame?(player: VeLivePlayer, videoFrame: VeLivePlayerVideoFrame): void;
     /** {zh}
      * @detail callback
@@ -156,6 +181,7 @@ export declare class VeLivePlayerObserver {
      * @param audioFrame 音频数据，详情请参见 [VeLivePlayerAudioFrame](188115#VeLivePlayerAudioFrame) 。
      *
      */
+    
     onRenderAudioFrame?(player: VeLivePlayer, audioFrame: VeLivePlayerAudioFrame): void;
     /** {zh}
      * @detail callback
@@ -165,5 +191,16 @@ export declare class VeLivePlayerObserver {
      * @param error 超分开启失败原因，错误码请参见 [VeLivePlayerErrorCode](188113#VeLivePlayerError-VeLivePlayerErrorCode) 。
      *
      */
+    
     onStreamFailedOpenSuperResolution?(player: VeLivePlayer, error: VeLivePlayerError): void;
+    /** {zh}
+     * @detail callback
+     * @brief 锐化开启失败。调用 setEnableSharpen{@link #VeLivePlayer#setEnableSharpen} 开启锐化后，当播放器不支持超分开启或者超分处理出错时，会触发此回调。
+     * @param player 触发该事件回调的播放器对象。
+     * @param error 锐化开启失败原因。错误码请参见 [VeLivePlayerErrorCode](188113#VeLivePlayerErrorCode)。
+     * @order 18
+     *
+     */
+    
+    onStreamFailedOpenSharpen?(player: VeLivePlayer, error: VeLivePlayerError): void;
 }

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

@@ -1,122 +1,177 @@
 import { int, String } from './types';
 export declare class VeLivePlayerError {
-    constructor(errorCode: int, errorMsg: String);
-    constructor(errorCode: int);
+    constructor(errorCode: int, subCode: int, errorMsg: String);
     /** {zh}
      * @brief 直播播放错误码。
      *
      */
+    
     mErrorCode: int;
     /** {zh}
      * @brief 直播播放错误信息。
      *
      */
+    
     mErrorMsg: String;
+    /** {zh}
+     * @brief 直播播放子错误码。
+     *
+     */
+    
+    mSubCode: int;
 }
 export declare enum VeLivePlayerErrorCode {
     /** {zh}
      * @brief 没有错误。
      *
      */
+    
     VeLivePlayerNoError = 0,
     /** {zh}
      * @brief License 无效。可能 License 集成错误或 License 过期，请检查 License 集成方式和有效性。
      *
      */
+    
     VeLivePlayerInvalidLicense = -1,
     /** {zh}
      * @brief 调用时传入的参数不合法。请检查入参，并重新调用。
      *
      */
+    
     VeLivePlayerInvalidParameter = -2,
     /** {zh}
      * @brief 调用被拒绝。方法调用时机不合法，请检查调用时机。
      *
      */
+    
     VeLivePlayerErrorRefused = -3,
     /** {zh}
      * @brief 加载库文件失败。可能是 SDK 集成错误，请检查 SDK 集成方式。
      *
      */
+    
     VeLivePlayerErrorLibraryLoadFailed = -4,
     /** {zh}
      * @brief 播放地址不存在或无效。可能是播放地址为空、地址格式不合法或地址长度不合法，请检查播放地址。
      *
      */
+    
     VeLivePlayerErrorPlayUrl = -100,
     /** {zh}
      * @brief 无法获取流数据。可能是直播流不存在、直播流中断或直播已结束，请检查直播状态。
      *
      */
+    
     VeLivePlayerErrorNoStreamData = -101,
     /** {zh}
      * @brief 内部播放重试。可能由于播放器内部错误触发了重试。
      *
      */
+    
     VeLivePlayerErrorInternalRetryStart = -102,
     /** {zh}
      * @brief 内部重试失败。内部重试次数达到最大限制，播放器停止重试，您可以尝试重新播放。
      *
      */
+    
     VeLivePlayerErrorInternalRetryFailed = -103,
     /** {zh}
      * @brief DNS 解析失败。可能是播放地址异常或客户端网络异常，请您检查播放地址和网络情况，如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorDnsParseFailed = -200,
     /** {zh}
      * @brief 网络请求失败。请检查网络情况，如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorNetworkRequestFailed = -201,
     /** {zh}
      * @brief 直播格式解封装失败。可能是使用了不支持的直播流格式和协议，或音视频流错误；请检查流格式，如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorDemuxFailed = -300,
     /** {zh}
      * @brief 视频解码失败。可能使用了不支持的直播流音视频格式，或解码器出错；请检查音视频格式，如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorDecodeFailed = -301,
     /** {zh}
      * @brief 渲染失败。可能是音视频输出设备异常，请重试；如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorAVOutputFailed = -302,
     /** {zh}
      * @brief 该台设备不支持超分能力，不在超分机型白名单内；如果有疑问，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorSRDeviceUnsupported = -303,
     /** {zh}
      * @brief 当前分辨率高于超分开启限制的最大分辨率。如果有疑问，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorSRResolutionUnsupported = -304,
     /** {zh}
      * @brief 当前帧率高于超分开启限制的最大帧率。如果有疑问，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorSRFpsUnsupported = -305,
     /** {zh}
      * @brief 超分初始化失败。可能超分参数配置错误，或版本不兼容；如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorSRInitFail = -306,
     /** {zh}
      * @brief 超分执行失败，可能超分参数配置错误，或版本不兼容；如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorSRExecuteFail = -307,
     /** {zh}
-     * @brief 您使用的基础版 License 暂不支持 H.265 硬件解码，请登录火山引擎[视频直播控制台](https://console.volcengine.com/live/main/sdk)获取高级版 License。
+     * @brief 您使用的基础版 License 暂不支持 H.265 硬件解码。
      *
      */
+    
     VeLivePlayerLicenseUnsupportedH265 = -308,
+    /** {zh}
+     * @brief 该台设备系统版本不支持锐化能力；如果有疑问，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=owVvVTNjDkRmjctcsyNW)。
+     *
+     */
+    
+    VeLivePlayerErrorSharpenDeviceUnsupported = -309,
+    /** {zh}
+     * @hidden (Android)
+     * @brief 当前不支持离屏渲染；如果故障未排除，请联系火山引擎技术支持。
+     *
+     */
+    
+    VeLivePlayerErrorNotSupportTextureRender = -508,
+    /** {zh}
+     * @brief Effect 初始化失败；如果故障未排除，请联系火山引擎技术支持。
+     * @hidden (Android)
+     *
+     */
+    
+    VeLivePlayerErrorInitICEffectFail = -509,
+    /** {zh}
+     * @brief 分辨率档位切换不支持；如果故障未排除，请联系火山引擎技术支持。
+     * @hidden (Android)
+     *
+     */
+    
+    VeLivePlayerErrorNotSupportResolutionSwitch = -510,
     /** {zh}
      * @brief 内部错误。请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
      *
      */
+    
     VeLivePlayerErrorInternal = -999
 }