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

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

@@ -4,9 +4,19 @@ import { VeLivePlayerResolution, VeLivePlayerResolutionSwitchReason, VeLivePlaye
 import { VeLivePlayer } from './api';
 import { VeLivePlayerError } from './errorcode';
 import { Bitmap, int, BOOL, NSString } from './types';
-
+/** {zh}
+ * @detail callback
+ * @brief 播放器事件回调。
+ */
 export interface VeLivePlayerObserver {
-    
+    /** {zh}
+     * @detail callback
+     * @brief 播放器错误信息回调，播放器出现错误时，触发回调。
+     * @order 1
+     * @param player 触发该事件回调的播放器对象。
+     * @param error 错误信息，详情请参见 [VeLivePlayerError](188113#VeLivePlayerError) 。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when a player error occurs.
@@ -16,7 +26,16 @@ export interface VeLivePlayerObserver {
      *
      */
     onError?(player: VeLivePlayer, error: VeLivePlayerError): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 视频首帧渲染事件回调。视频首帧渲染成功，或播放过程中发生重试，重试后的第一个视频帧渲染成功，均会触发此回调。
+     * @order 2
+     * @param player 触发该事件回调的播放器对象。
+     * @param isFirstFrame 渲染成功的是否为视频首帧。<br>
+     *                     - true：视频首帧；
+     *                     - false：重试后第一个视频帧。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the first video frame is rendered at the beginning of playback or after a retry during playback.
@@ -28,7 +47,16 @@ export interface VeLivePlayerObserver {
      *
      */
     onFirstVideoFrameRender?(player: VeLivePlayer, isFirstFrame: boolean): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 音频首帧渲染事件回调。音频首帧渲染成功，或播放过程中发生重试，重试后的第一个音频帧渲染成功，均会触发此回调。
+     * @order 3
+     * @param player 触发该事件回调的播放器对象。
+     * @param isFirstFrame 渲染成功的是否为音频首帧。<br>
+     *                     - true：音频首帧；
+     *                     - false：重试后第一个音频帧。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the first audio frame is rendered at the beginning of playback or after a retry during playback.
@@ -40,7 +68,13 @@ export interface VeLivePlayerObserver {
      *
      */
     onFirstAudioFrameRender?(player: VeLivePlayer, isFirstFrame: boolean): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 播放卡顿开始回调。
+     * @order 4
+     * @param player 触发该事件回调的播放器对象。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when a playback stutter starts.
@@ -49,7 +83,13 @@ export interface VeLivePlayerObserver {
      *
      */
     onStallStart?(player: VeLivePlayer): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 播放卡顿结束回调。音频缓冲区达到起播条件且开始播放后，触发此回调。
+     * @order 5
+     * @param player 触发该事件回调的播放器对象。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when a playback stutter stops, that is, when playback resumes after there is enough audio buffer.
@@ -58,7 +98,14 @@ export interface VeLivePlayerObserver {
      *
      */
     onStallEnd?(player: VeLivePlayer): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 视频渲染卡顿回调。视频渲染发生卡顿时，触发此回调。
+     * @order 6
+     * @param player 触发该事件回调的播放器对象。
+     * @param stallTime 视频渲染卡顿时长，单位为 ms。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when video rendering stutters.
@@ -68,7 +115,14 @@ export interface VeLivePlayerObserver {
      *
      */
     onVideoRenderStall?(player: VeLivePlayer, stallTime: number): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 音频渲染卡顿回调。音频渲染发生卡顿时，触发此回调。
+     * @order 7
+     * @param player 触发该事件回调的播放器对象。
+     * @param stallTime 音频渲染卡顿时长，单位为 ms。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when audio rendering stutters.
@@ -78,7 +132,16 @@ export interface VeLivePlayerObserver {
      *
      */
     onAudioRenderStall?(player: VeLivePlayer, stallTime: number): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 清晰度档位变化回调。
+     * @order 8
+     * @param player 触发该事件回调的播放器对象。
+     * @param resolution 切换后的清晰度档位，详情请参见 [VeLivePlayerResolution](188115#VeLivePlayerResolution) 。
+     * @param error 切换清晰度档位时，是否发生错误，详情请参见 [VeLivePlayerError](188113#VeLivePlayerError) 。
+     * @param reason 清晰度档位切换的原因，详情请参见 [VeLivePlayerResolutionSwitchReason](188115#VeLivePlayerResolutionSwitchReason) 。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the video resolution changes.
@@ -90,7 +153,15 @@ export interface VeLivePlayerObserver {
      *
      */
     onResolutionSwitch?(player: VeLivePlayer, resolution: VeLivePlayerResolution, error: VeLivePlayerError, reason: VeLivePlayerResolutionSwitchReason): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 视频分辨率变化回调。视频大小发生变化时，触发回调。
+     * @order 9
+     * @param player 触发该事件回调的播放器对象。
+     * @param width 变化后的视频宽度，单位为 px。
+     * @param height 变化后的视频高度，单位为 px。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the video size changes.
@@ -101,7 +172,14 @@ export interface VeLivePlayerObserver {
      *
      */
     onVideoSizeChanged?(player: VeLivePlayer, width: number, height: number): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 字符串 SEI 消息回调，当播放器 SDK 接收到 SEI 消息时，触发该回调。需要开启 VeLivePlayerConfiguration 中 enableSei 属性。当 enableBinarySei 属性开启时，字符串 SEI 消息将不再发送。
+     * @order 10
+     * @param player 触发该事件回调的播放器对象。
+     * @param message SEI 信息。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief String SEI message callback. This callback is triggered when the player SDK receives an SEI message. It is necessary to enable the `enableSei` property in `VeLivePlayerConfiguration`. When the `enableBinarySei` property is enabled, the string SEI message will no longer be sent.
@@ -111,7 +189,14 @@ 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 信息。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Binary SEI message callback. This callback is triggered when the player SDK receives an SEI message. It is necessary to enable the `enableBinarySei` property in `VeLivePlayerConfiguration`. When the `enableBinarySei` property is enabled, the string SEI message will no longer be sent.
@@ -121,7 +206,15 @@ export interface VeLivePlayerObserver {
      *
      */
     onReceiveBinarySeiMessage?(player: VeLivePlayer, message: ArrayBuffer): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 主备流切换回调。
+     * @order 11
+     * @param player 触发该事件回调的播放器对象。
+     * @param streamType 切换后的流类型为主路流或备路流，详情请参见 [VeLivePlayerStreamType](188115#VeLivePlayerStreamType) 。
+     * @param error 触发主备流切换的原因，详情请参见 [VeLivePlayerError](188113#VeLivePlayerError) 。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the player switches between the primary stream and the backup stream.
@@ -132,7 +225,14 @@ export interface VeLivePlayerObserver {
      *
      */
     onMainBackupSwitch?(player: VeLivePlayer, streamType: VeLivePlayerStreamType, error: VeLivePlayerError): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 播放状态发生变化时，触发回调。
+     * @order 12
+     * @param player 触发该事件回调的播放器对象。
+     * @param status 当前播放器的状态，详情请参见 [VeLivePlayerStatus](188115#VeLivePlayerStatus) 。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the playback status changes.
@@ -142,7 +242,14 @@ export interface VeLivePlayerObserver {
      *
      */
     onPlayerStatusUpdate?(player: VeLivePlayer, status: VeLivePlayerStatus): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 播放信息周期性回调。播放器 SDK 会周期性地回调本方法，您可以通过本方法获取当前播放器的播放地址、码率和帧率等信息。
+     * @order 13
+     * @param player 触发该事件回调的播放器对象。
+     * @param statistics 播放器周期性回调的统计信息，详情请参见 [VeLivePlayerStatistics](188115#VeLivePlayerStatistics) 。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs periodically to report information such as the current pull stream address, bitrate, and frame rate.
@@ -152,7 +259,14 @@ export interface VeLivePlayerObserver {
      *
      */
     onStatistics?(player: VeLivePlayer, statistics: VeLivePlayerStatistics): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 截图成功回调。当播放器调用 snapshot{@link #VeLivePlayer#snapshot} 截图成功后，会触发此回调。
+     * @order 14
+     * @param player 触发该事件回调的播放器对象。
+     * @param bitmap 截图的 Bitmap 对象。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when a screenshot is taken after snapshot{@link #VeLivePlayer#snapshot} is called.
@@ -162,7 +276,16 @@ export interface VeLivePlayerObserver {
      *
      */
     onSnapshotComplete?(player: VeLivePlayer, bitmap: Bitmap): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 视频帧回调。调用 enableVideoFrameObserver{@link #VeLivePlayer#enableVideoFrameObserver} 开启视频帧解析回调后，当播放器成功解码视频帧时，会触发此回调。
+     * @notes <br>
+     *       如果自定义渲染使用纹理格式，建议在视频帧回调线程中执行渲染操作。
+     * @order 15
+     * @param player 触发该事件回调的播放器对象。
+     * @param videoFrame 视频帧数据，包含像素格式、封装格式、视频宽高等信息，详情请参见 [VeLivePlayerVideoFrame](188115#VeLivePlayerVideoFrame) 。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the player decodes a video frame. Call [enableVideoFrameObserver](docs-player-android-api-reference#VeLivePlayer-enablevideoframeobserver) to enable video frame callback.
@@ -174,7 +297,16 @@ export interface VeLivePlayerObserver {
      *
      */
     onRenderVideoFrame?(player: VeLivePlayer, videoFrame: VeLivePlayerVideoFrame): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 音频帧回调。调用 enableAudioFrameObserver{@link #VeLivePlayer#enableAudioFrameObserver} 开启音频帧解析回调后，当播放器成功解码音频帧时，会触发此回调。
+     * @notes <br>
+     *      回调的音频帧数据为 float32 格式，大端字节序存储。
+     * @order 16
+     * @param player 触发该事件回调的播放器对象。
+     * @param audioFrame 音频数据，详情请参见 [VeLivePlayerAudioFrame](188115#VeLivePlayerAudioFrame) 。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the player decodes an audio frame. Call enableAudioFrameObserver{@link #VeLivePlayer#enableAudioFrameObserver} to enable audio frame callback.
@@ -186,7 +318,14 @@ export interface VeLivePlayerObserver {
      *
      */
     onRenderAudioFrame?(player: VeLivePlayer, audioFrame: VeLivePlayerAudioFrame): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 超分开启失败。调用 setEnableSuperResolution{@link #VeLivePlayer#setEnableSuperResolution} 开启超分后，当播放器不支持超分开启或者超分处理出错时，会触发此回调。
+     * @order 17
+     * @param player 触发该事件回调的播放器对象。
+     * @param error 超分开启失败原因，错误码请参见 [VeLivePlayerErrorCode](188113#VeLivePlayerError-VeLivePlayerErrorCode) 。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the SDK fails to enable super resolution after setEnableSuperResolution{@link #VeLivePlayer#setEnableSuperResolution} is called.
@@ -196,7 +335,15 @@ 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
+     *
+     */
     /** {en}
      * @platform android
      * @detail callback

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

@@ -1,177 +1,273 @@
 import * as $p_a from '../android/index';
 import * as $p_i from '../ios/index';
-
+/** {zh}
+ * @detail errorcode
+ * @brief 直播播放错误码。
+ *
+ */
 export declare enum VeLivePlayerErrorCode {
-    
+    /** {zh}
+     * @brief 没有错误。
+     *
+     */
     /** {en}
      * @brief No error.
      *
      */
     VeLivePlayerNoError = 0,
-    
+    /** {zh}
+     * @brief License 无效。可能 License 集成错误或 License 过期，请检查 License 集成方式和有效性。
+     *
+     */
     /** {en}
      * @brief The SDK license is invalid. This error may occur due to incorrect integration of the license or if the license has expired. Review how the license was integrated and ensure that it is still valid.
      *
      */
     VeLivePlayerInvalidLicense = -1,
-    
+    /** {zh}
+     * @brief 调用时传入的参数不合法。请检查入参，并重新调用。
+     *
+     */
     /** {en}
      * @brief Invalid parameters. Check the input parameter and call the method again.
      *
      */
     VeLivePlayerInvalidParameter = -2,
-    
+    /** {zh}
+     * @brief 调用被拒绝。方法调用时机不合法，请检查调用时机。
+     *
+     */
     /** {en}
      * @brief The method call has been rejected. This error occurs when the method is called at an incorrect time.
      *
      */
     VeLivePlayerErrorRefused = -3,
-    
+    /** {zh}
+     * @brief 加载库文件失败。可能是 SDK 集成错误，请检查 SDK 集成方式。
+     *
+     */
     /** {en}
      * @brief Failed to load the library file. This error may occur due to incorrect integration of the SDK.
      *
      */
     VeLivePlayerErrorLibraryLoadFailed = -4,
-    
+    /** {zh}
+     * @brief 播放地址不存在或无效。可能是播放地址为空、地址格式不合法或地址长度不合法，请检查播放地址。
+     *
+     */
     /** {en}
      * @brief The pull stream address does not exist or is invalid. This error may occur if the pull stream address is empty, or if the format or length of the address is invalid.
      *
      */
     VeLivePlayerErrorPlayUrl = -100,
-    
+    /** {zh}
+     * @brief 无法获取流数据。可能是直播流不存在、直播流中断或直播已结束，请检查直播状态。
+     *
+     */
     /** {en}
      * @brief Unable to get the stream data. This error may occur if the live stream does not exist, is interrupted, or has ended. Please check the status of the live stream.
      *
      */
     VeLivePlayerErrorNoStreamData = -101,
-    
+    /** {zh}
+     * @brief 内部播放重试。可能由于播放器内部错误触发了重试。
+     *
+     */
     /** {en}
      * @brief An internal retry to play the live stream, which might happen due to an internal player error.
      *
      */
     VeLivePlayerErrorInternalRetryStart = -102,
-    
+    /** {zh}
+     * @brief 内部重试失败。内部重试次数达到最大限制，播放器停止重试，您可以尝试重新播放。
+     *
+     */
     /** {en}
      * @brief An internal retry failed and the maximum number of internal retries is reached. The player has stopped retrying. You may attempt a manual retry.
      *
      */
     VeLivePlayerErrorInternalRetryFailed = -103,
-    
+    /** {zh}
+     * @brief DNS 解析失败。可能是播放地址异常或客户端网络异常，请您检查播放地址和网络情况，如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief DNS parsing failed. This error may occur due to an error in the pull stream address or the client's network conditions. If the error persists after you verify the pull stream address and network conditions, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
      *
      */
     VeLivePlayerErrorDnsParseFailed = -200,
-    
+    /** {zh}
+     * @brief 网络请求失败。请检查网络情况，如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief The network request failed. Check the network conditions. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
      *
      */
     VeLivePlayerErrorNetworkRequestFailed = -201,
-    
+    /** {zh}
+     * @brief 直播格式解封装失败。可能是使用了不支持的直播流格式和协议，或音视频流错误；请检查流格式，如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Video decapsulation failed. This error may occur if the live stream uses an unsupported format or protocol, or if there is an audio or video error. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
      *
      */
     VeLivePlayerErrorDemuxFailed = -300,
-    
+    /** {zh}
+     * @brief 视频解码失败。可能使用了不支持的直播流音视频格式，或解码器出错；请检查音视频格式，如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Decoding failed. This error may occur if the live stream uses an unsupported audio or video format. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
      *
      */
     VeLivePlayerErrorDecodeFailed = -301,
-    
+    /** {zh}
+     * @brief 渲染失败。可能是音视频输出设备异常，请重试；如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Rendering failed. This error may occur if there is an issue with the audio or video output devices. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
      *
      */
     VeLivePlayerErrorAVOutputFailed = -302,
-    
+    /** {zh}
+     * @brief 该台设备不支持超分能力，不在超分机型白名单内；如果有疑问，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief The device model does not support super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
      *
      */
     VeLivePlayerErrorSRDeviceUnsupported = -303,
-    
+    /** {zh}
+     * @brief 当前分辨率高于超分开启限制的最大分辨率。如果有疑问，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief The current resolution exceeds the upper limit allowed for super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
      *
      */
     VeLivePlayerErrorSRResolutionUnsupported = -304,
-    
+    /** {zh}
+     * @brief 当前帧率高于超分开启限制的最大帧率。如果有疑问，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief The current frame rate exceeds the upper limit allowed for super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
      *
      */
     VeLivePlayerErrorSRFpsUnsupported = -305,
-    
+    /** {zh}
+     * @brief 超分初始化失败。可能超分参数配置错误，或版本不兼容；如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Fails to initialize super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if the error persists.
      *
      */
     VeLivePlayerErrorSRInitFail = -306,
-    
+    /** {zh}
+     * @brief 超分执行失败，可能超分参数配置错误，或版本不兼容；如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Fails to apply super resolution to the video. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if the error persists.
      *
      */
     VeLivePlayerErrorSRExecuteFail = -307,
-    
+    /** {zh}
+     * @brief 您使用的基础版 License 暂不支持 H.265 硬件解码。
+     *
+     */
     /** {en}
      * @brief The current SDK license does not provide support for the H.265 feature.
      *
      */
     VeLivePlayerLicenseUnsupportedH265 = -308,
-    
+    /** {zh}
+     * @platform android
+     * @brief 该台设备系统版本不支持锐化能力；如果有疑问，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=owVvVTNjDkRmjctcsyNW)。
+     *
+     */
     /** {en}
      * @platform android
      * @brief The device model does not support sharpen. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
      *
      */
     VeLivePlayerErrorSharpenDeviceUnsupported = -309,
-    
+    /** {zh}
+     * @brief 分辨率档位切换不支持；如果故障未排除，请联系火山引擎技术支持。
+     * @hidden (Android)
+     *
+     */
     /** {en}
      * @hidden (Android)
      *
      */
     VeLivePlayerErrorNotSupportResolutionSwitch = -310,
-    
+    /** {zh}
+     * @platform ios
+     * @brief DRM 鉴权失败。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief DRM authentication fails
      *
      */
     VeLivePlayerDRMFetchCKCFailed = -400,
-    
+    /** {zh}
+     * @platform ios
+     * @brief 服务器播放上下文（SPC）生成失败。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief Fails to generate Server Playback Context (SPC)
      *
      */
     VeLivePlayerDRMFetchSPCFailed = -401,
-    
+    /** {zh}
+     * @brief 内部错误。请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Internal error. Please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
      *
      */
     VeLivePlayerErrorInternal = -999
 }
-
+/** {zh}
+ * @detail errorcode
+ * @brief 直播播放错误。
+ */
 export declare class VeLivePlayerError {
     protected _instance: any;
-    
+    /** {zh}
+     * @brief 直播播放错误码。
+     *
+     */
     /** {en}
      * @brief The error code.
      *
      */
     get errorCode(): number;
-    
+    /** {zh}
+     * @brief 直播播放错误信息。
+     *
+     */
     /** {en}
      * @brief The error message.
      *
      */
     get errorMsg(): string;
-    
+    /** {zh}
+     * @platform android
+     * @brief 直播播放子错误码。
+     *
+     */
     /** {en}
      * @platform android
      * @brief The sub error code.