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

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

@@ -2,12 +2,26 @@ import * as $p_a from '../android/index';
 import * as $p_i from '../ios/index';
 import { VeLiveVideoFrame, VeLiveAudioFrame, VeLivePusherStatus, VeLiveFirstFrameType, VeLiveNetworkQuality, VeLiveAudioPowerLevel, VeLivePusherStatistics } from './keytype';
 import { int, Bitmap, NSString, BOOL, JSONObject, NSDictionary } from './types';
-
+/** {zh}
+ * @detail callback
+ * @brief 自定义的视频处理回调。
+ *
+ */
 export interface VeLiveVideoFrameFilter {
 }
-
+/** {zh}
+ * @detail callback
+ * @brief 视频帧订阅回调。
+ *
+ */
 export interface VeLiveVideoFrameListener {
-    
+    /** {zh}
+     * @detail callback
+     * @brief 采集视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourceCapture` 时，才会触发该回调。
+     * @order 26
+     * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](#VeLivePusherDef-VeLiveVideoFrameFilter)。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when a video frame is captured. This callback will be triggered only if you return `VeLiveVideoFrameSourceCapture` when implementing the [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) callback method.
@@ -16,7 +30,13 @@ export interface VeLiveVideoFrameListener {
      *
      */
     onCaptureVideoFrame?(frame: VeLiveVideoFrame): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 编码前视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourcePreEncode` 时，才会触发该回调。
+     * @order 27
+     * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when a video frame is to be encoded. This callback will be triggered only if you return `VeLiveVideoFrameSourcePreEncode` when implementing the [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) callback method.
@@ -26,16 +46,31 @@ export interface VeLiveVideoFrameListener {
      */
     onPreEncodeVideoFrame?(frame: VeLiveVideoFrame): void;
 }
-
+/** {zh}
+ * @detail callback
+ * @brief 播放器播放回调。通过该回调，您可以获取与播放相关的事件和通知。
+ *
+ */
 export interface VeLiveMediaPlayerListener {
-    
+    /** {zh}
+     * @detail callback
+     * @brief 开始播放的回调。
+     * @order 7
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the playback starts.
      *
      */
     onStart?(): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 播放进度的回调，每 100ms 触发一次。
+     * @param timeMs 播放进度，单位为 ms。
+     * @order 8
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs every 100 ms to report the playback progress.
@@ -43,14 +78,26 @@ export interface VeLiveMediaPlayerListener {
      *
      */
     onProgress?(timeMs: number): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 停止播放的回调。
+     * @order 9
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the playback stops.
      *
      */
     onStop?(): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 返错误状态的回调。
+     * @param code 错误码，详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
+     * @param msg 错误消息。
+     * @order 10
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when an error occurs in the media player.
@@ -60,9 +107,19 @@ export interface VeLiveMediaPlayerListener {
      */
     onError?(error: number): void;
 }
-
+/** {zh}
+ * @detail callback
+ * @brief 音频帧订阅回调。
+ *
+ */
 export interface VeLiveAudioFrameListener {
-    
+    /** {zh}
+     * @detail callback
+     * @brief 采集音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourceCapture` 时，才会触发该回调。
+     * @order 28
+     * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when an audio frame is captured. This callback will be triggered only if you return `VeLiveAudioFrameSourceCapture` when implementing the [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) callback method.
@@ -71,7 +128,13 @@ export interface VeLiveAudioFrameListener {
      *
      */
     onCaptureAudioFrame?(frame: VeLiveAudioFrame): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 编码前音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourcePreEncode` 时，才会触发该回调。
+     * @order 29
+     * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when an audio frame is to be encoded. This callback will be triggered only if you return `VeLiveAudioFrameSourcePreEncode` when implementing the [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) callback method.
@@ -81,9 +144,19 @@ export interface VeLiveAudioFrameListener {
      */
     onPreEncodeAudioFrame?(frame: VeLiveAudioFrame): void;
 }
-
+/** {zh}
+ * @detail callback
+ * @brief 播放器音视频帧回调。通过该回调，您可以获取音频和视频帧的数据。
+ *
+ */
 export interface VeLiveMediaPlayerFrameListener {
-    
+    /** {zh}
+     * @detail callback
+     * @brief 播放器音频帧回调。
+     * @param frame 音频帧，详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
+     * @order 11
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the media player decodes an audio frame.
@@ -91,7 +164,13 @@ export interface VeLiveMediaPlayerFrameListener {
      *
      */
     onAudioFrame?(frame: VeLiveAudioFrame): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 播放器视频帧回调。当完成一个新的视频帧的解码后，触发该回调。
+     * @param frame 视频帧数据，包含了帧的时间戳和格式等信息，详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
+     * @order 12
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the media player decodes a video frame.
@@ -100,9 +179,21 @@ export interface VeLiveMediaPlayerFrameListener {
      */
     onVideoFrame?(frame: VeLiveVideoFrame): void;
 }
-
+/** {zh}
+ * @detail callback
+ * @brief 直播截图回调。
+ *
+ */
 export interface VeLiveSnapshotListener {
-    
+    /** {zh}
+     * @detail callback
+     * @brief 截图成功回调。
+     * @notes <br>
+     *    调用 snapshot{@link #VeLivePusher#snapshot} 截图成功后，会收到这个回调。
+     * @order 19
+     * @param image 视频的截图。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Screenshot success callback.
@@ -112,12 +203,27 @@ export interface VeLiveSnapshotListener {
      */
     onSnapshotComplete?(image: Bitmap): void;
 }
-
+/** {zh}
+ * @detail callback
+ * @brief 自定义的音频处理回调。
+ *
+ */
 export interface VeLiveAudioFrameFilter {
 }
-
+/** {zh}
+ * @detail callback
+ * @brief 回调协议，用于监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件等。
+ */
 export interface VeLivePusherObserver {
-    
+    /** {zh}
+     * @detail callback
+     * @brief 推流错误回调。
+     * @order 1
+     * @param code 错误码。详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
+     * @param subCode 子错误码。
+     * @param msg 错误信息。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when a streaming error occurs.
@@ -128,7 +234,13 @@ export interface VeLivePusherObserver {
      *
      */
     onError?(code: number, subCode: number, msg: string): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 推流状态变化回调。
+     * @order 16
+     * @param status 变化后的推流状态。详情请参见 [VeLivePusherStatus](147521#VeLivePusherStatus)。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the streaming status changes.
@@ -137,7 +249,14 @@ export interface VeLivePusherObserver {
      *
      */
     onStatusChange?(status: VeLivePusherStatus): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 首帧视频回调，当推流器发送出第一帧视频时，触发该回调。
+     * @order 2
+     * @param type 首帧的类型，详情请参见 [VeLiveFirstFrameType](147521#VeLiveFirstFrameType)。
+     * @param timestampMs 时间戳，单位为 ms。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the live pusher sends the first video frame.
@@ -147,7 +266,14 @@ export interface VeLivePusherObserver {
      *
      */
     onFirstVideoFrame?(type: VeLiveFirstFrameType, timestampMs: number): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 首帧音频回调，当推流器发送出第一帧音频时，触发该回调。
+     * @order 3
+     * @param type 首帧的类型，详情请参见 [VeLiveFirstFrameType](147521#VeLiveFirstFrameType)。
+     * @param timestampMs 时间戳，单位为 ms。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the live pusher sends the first audio frame.
@@ -157,7 +283,15 @@ export interface VeLivePusherObserver {
      *
      */
     onFirstAudioFrame?(type: VeLiveFirstFrameType, timestampMs: number): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 摄像头开启/关闭回调，当推流器的摄像头开启或关闭时，触发该回调。
+     * @param open 摄像头的新状态是否为开启。<br>
+     *      - true：摄像头开启；
+     *      - false：摄像头关闭。
+     * @order 4
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the camera is turned on or turned off.
@@ -168,7 +302,15 @@ export interface VeLivePusherObserver {
      *
      */
     onCameraOpened?(open: boolean): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 麦克风开启/关闭回调，当推流器的麦克风开启或关闭时，触发该回调。
+     * @param open 麦克风的新状态是否为开启。<br>
+     *      - true：麦克风开启；
+     *      - false：麦克风关闭。
+     * @order 5
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the microphone is turned on or turned off.
@@ -179,7 +321,16 @@ export interface VeLivePusherObserver {
      *
      */
     onMicrophoneOpened?(open: boolean): void;
-    
+    /** {zh}
+     * @platform android
+     * @detail callback
+     * @brief 屏幕采集开启/关闭回调，当推流器的屏幕采集开启或关闭时，触发该回调。
+     * @param open 屏幕采集的新状态是否为开启。<br>
+     *      - true：屏幕采集开启；
+     *      - false：屏幕采集关闭。
+     * @order 14
+     *
+     */
     /** {en}
      * @platform android
      * @detail callback
@@ -191,7 +342,13 @@ export interface VeLivePusherObserver {
      *
      */
     onScreenRecording?(): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 网络质量状态回调，当推流器检测到网络质量发生变化时，触发该回调。
+     * @order 17
+     * @param quality 变化后的网络质量。详情请参见 [VeLiveNetworkQuality](147521#VeLiveNetworkQuality)。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the network quality changes.
@@ -200,7 +357,21 @@ export interface VeLivePusherObserver {
      *
      */
     onNetworkQuality?(quality: VeLiveNetworkQuality): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 音量等级回调，当推流器的音频音量等级发生变化时，触发该回调。
+     * @order 15
+     * @param level 变化后的音量等级。详情请参见 [VeLiveAudioPowerLevel](147521#VeLiveAudioPowerLevel)。
+     * @param value 当前音量的分贝值（dB）。<br/>
+     *        - \\-1 表示当前没有获取到对应的音量分贝值。
+     *        - 分贝数小于 1，对应 VeLiveAudioPowerLevelSilent 级别
+     *        - 分贝数大于 1 小于等于 15，对应 VeLiveAudioPowerLevelQuiet 级别
+     *        - 分贝数大于 15 小于等于 30，对应 VeLiveAudioPowerLevelLight 级别
+     *        - 分贝数大于 30 小于等于 60，对应 VeLiveAudioPowerLevelNormal 级别
+     *        - 分贝数大于 60 小于等于 85，对应 VeLiveAudioPowerLevelLoud
+     *        - 分贝数大于 85，对应 VeLiveAudioPowerLevelNoisy 级别
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when the audio volume level changes.
@@ -218,9 +389,19 @@ export interface VeLivePusherObserver {
      */
     onAudioPowerQuality?(level: VeLiveAudioPowerLevel, value: number): void;
 }
-
+/** {zh}
+ * @detail callback
+ * @brief 推流器周期性回调。
+ *
+ */
 export interface VeLivePusherStatisticsObserver {
-    
+    /** {zh}
+     * @detail callback
+     * @brief 推流周期性统计信息回调，每 5s 回调一次，您可以调用 [setStatisticsObserver](147517#VeLivePusher-setstatisticsobserver) 修改回调时间间隔。
+     * @order 18
+     * @param statistics 周期性统计信息，详情请参见 [VeLivePusherStatistics](147521#VeLivePusherDef-VeLivePusherStatistics)。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs periodically to report streaming statistics. By default, the callback is triggered every 5 seconds. You can call [setStatisticsObserver](docs-broadcast-sdk-for-android-api#VeLivePusher-setstatisticsobserver) to modify the callback time interval.
@@ -229,7 +410,13 @@ export interface VeLivePusherStatisticsObserver {
      *
      */
     onStatistics?(statistics: VeLivePusherStatistics): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 周期性日志信息回调。
+     * @order 25
+     * @param logInfo 周期性日志信息。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs periodically to return log information.
@@ -239,9 +426,18 @@ export interface VeLivePusherStatisticsObserver {
      */
     onLogMonitor?(logInfo: JSONObject): void;
 }
-
+/** {zh}
+ * @detail callback
+ * @brief 直播录制回调。
+ *
+ */
 export interface VeLiveFileRecordingListener {
-    
+    /** {zh}
+     * @detail callback
+     * @brief 直播录制开始回调。
+     * @order 22
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when recording starts.
@@ -249,7 +445,12 @@ export interface VeLiveFileRecordingListener {
      *
      */
     onFileRecordingStarted?(): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 直播录制停止回调。
+     * @order 23
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when recording stops.
@@ -257,7 +458,14 @@ export interface VeLiveFileRecordingListener {
      *
      */
     onFileRecordingStopped?(): void;
-    
+    /** {zh}
+     * @detail callback
+     * @brief 直播录制错误回调。
+     * @order 24
+     * @param errorCode 错误码，详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
+     * @param message 错误信息。
+     *
+     */
     /** {en}
      * @detail callback
      * @brief Occurs when an error occurs during recording.

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

@@ -1,95 +1,148 @@
 import * as $p_a from '../android/index';
 import * as $p_i from '../ios/index';
-
+/** {zh}
+ * @detail errorcode
+ * @brief 推流过程错误码定义。
+ *
+ */
 export declare enum VeLivePusherErrorCode {
-    
+    /** {zh}
+     * @brief 无错误。
+     *
+     */
     /** {en}
      * @brief No error.
      *
      */
     VeLivePusherSuccess = 0,
-    
+    /** {zh}
+     * @brief License 错误，可能 License 集成错误或 License 过期，请检查 License 集成方式和有效性。
+     *
+     */
     /** {en}
      * @brief SDK license error, possibly caused by an invalid or expired certificate.
      *
      */
     VeLivePusherInvalidLicense = -1,
-    
+    /** {zh}
+     * @brief 参数错误，请检查入参，并重新调用。
+     *
+     */
     /** {en}
      * @brief Parameter error, possibly caused by an invalid parameter value or parameter type.
      *
      */
     VeLivePusherInvalidParameter = -2,
-    
+    /** {zh}
+     * @brief 视频采集错误，可能未开启设备视频采集权限，请检查权限是否获取。
+     *
+     */
     /** {en}
      * @brief Video capture error, possibly caused by the lack of access to the video device.
      *
      */
     VeLivePusherVideoCaptureError = -3,
-    
+    /** {zh}
+     * @brief 音频采集错误，可能未开启设备麦克风采集权限，请检查权限是否获取。
+     *
+     */
     /** {en}
      * @brief Audio capture error, possibly caused by the lack of access to the audio device.
      *
      */
     VeLivePusherAudioCaptureError = -4,
-    
+    /** {zh}
+     * @brief 视频编码错误，可能配置了当前设备不支持的视频编码方式，请检查编码参数，并重新调用。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Video encoding error, possibly caused by a configuration issue with the video encoder. If the error is not eliminated, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
      *
      */
     VeLivePusherVideoEncoderError = -5,
-    
+    /** {zh}
+     * @brief 音频编码错误，可能配置了当前设备不支持的音频编码方式，请检查编码参数，并重新调用。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Audio encoding error, possibly caused by a configuration issue with the audio encoder. If the error is not eliminated, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
      *
      */
     VeLivePusherAudioEncoderError = -6,
-    
+    /** {zh}
+     * @brief 网络发送错误，可能当前网络链路不通，或者开启了代理和关闭了网络权限，请检查网络后重新调用。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Network error, which might be caused by network connection issues such as network instability or high latency. If the error is not eliminated, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
      *
      */
     VeLivePusherTransportError = -7,
-    
+    /** {zh}
+     * @brief 视频特效错误，请检查视频特效 SDK 是否已经集成并且初试化成功。检查特效资源路径是否配置正确。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Special effects error. Please check if the Effects SDK has been integrated and initialized, and if the path of the effects resources is correctly set. If the error is not eliminated, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
      *
      */
     VeLivePusherVideoEffectError = -8,
-    
+    /** {zh}
+     * @brief 音频模块错误，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @brief Audio device error. Please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
      *
      */
     VeLivePusherAudioDeviceError = -9,
-    
+    /** {zh}
+     * @platform android
+     * @brief 您使用的基础版 License 暂不支持 H.265 硬件编码，请登录火山引擎控制台获取高级版 License。
+     *
+     */
     /** {en}
      * @platform android
      * @brief The license does not support H265.
      *
      */
     VeLivePusherLicenseUnsupportedH265 = -10,
-    
+    /** {zh}
+     * @brief 其他错误类型，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&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 when using this callback method.
      *
      */
     VeLivePusherError = -100,
-    
+    /** {zh}
+     * @platform android
+     * @brief 当前系统版本不支持屏幕采集功能
+     *
+     */
     /** {en}
      * @platform android
      * @brief
      *
      */
     VeLivePusherScreenCaptureNotSupportError = -99,
-    
+    /** {zh}
+     * @platform android
+     * @brief 屏幕采集权限的获取被用户拒绝
+     *
+     */
     /** {en}
      * @platform android
      * @brief
      *
      */
     VeLivePusherScreenCaptureStartError = -98,
-    
+    /** {zh}
+     * @platform android
+     * @brief 屏幕采集被系统中断，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
+     *
+     */
     /** {en}
      * @platform android
      * @brief