@volcengine/react-native-live-push 1.1.3-rc.0 → 1.2.0-rc.0

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

@@ -1,45 +1,47 @@
-import { VeLiveVideoFrame, VeLiveAudioFrame } from './api';
+import { VeLiveVideoFrame, VeLiveVideoFrameSource, VeLiveAudioFrameSource, VeLiveAudioFrame, VeLivePusherStatus, VeLiveFirstFrameType, VeLiveNetworkQuality, VeLiveAudioPowerLevel, VeLivePusherStatistics } from './keytype';
 import { int, String, Bundle, long, Bitmap, float, JSONObject } from './types';
-import { VeLiveVideoFrameSource, VeLiveAudioFrameSource, VeLivePusherStatus, VeLiveFirstFrameType, VeLiveNetworkQuality, VeLiveAudioPowerLevel, VeLivePusherStatistics } from './keytype';
 export declare class VeLiveVideoFrameFilter {
     /** {zh}
      * @detail callback
      * @brief 自定义的视频处理方法。
-     * @return <br>
-     *      - 0：处理成功；
-     *      - <0：处理失败，该帧会被 SDK 丢弃；
-     *      - \\\\>0：处理失败，该帧会被 SDK 继续传递到编码器。
-     * @order 15
-     * @param srcFrame 源视频帧，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
-     * @param dstFrame 处理后的视频帧，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
+     * @order 20
+     * @param srcFrame 源视频帧，详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
+     * @param dstFrame 处理后的视频帧，详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
+     * @return - 0：处理成功；
+     *         - <0：处理失败，该帧会被 SDK 丢弃；
+     *         - >0：处理失败，该帧会被 SDK 继续传递到编码器。
      *
      */
+    
     onVideoProcess?(srcFrame: VeLiveVideoFrame, dstFrame: VeLiveVideoFrame): int;
 }
 export declare class VeLiveVideoFrameListener {
     /** {zh}
      * @detail callback
      * @brief 设置当前 Listener 需要的视频帧来源。
-     * @return 您所要订阅的视频数据的位置信息，详情请参见 [VeLiveVideoFrameSource](147521#VeLiveVideoFrameSource)。
-     * @order 17
+     * @order 30
+     * @return 您所要订阅的视频数据的位置信息，详情请参见 [VeLiveVideoFrameSource](147521#VeLivePusherDef-VeLiveVideoFrameSource)。
      *
      */
+    
     getObservedVideoFrameSource?(): VeLiveVideoFrameSource;
     /** {zh}
      * @detail callback
-     * @brief 采集视频帧回调。只有当您通过 getObservedVideoFrameSource{@link #VeLiveVideoFrameListener#getObservedVideoFrameSource} 返回 `VeLiveVideoFrameSourceCapture` 时，才会触发该回调。
-     * @order 18
-     * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
+     * @brief 采集视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourceCapture` 时，才会触发该回调。
+     * @order 26
+     * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](#VeLivePusherDef-VeLiveVideoFrameFilter)。
      *
      */
+    
     onCaptureVideoFrame?(frame: VeLiveVideoFrame): void;
     /** {zh}
      * @detail callback
-     * @brief 编码前视频帧回调。只有当您通过 getObservedVideoFrameSource{@link #VeLiveVideoFrameListener#getObservedVideoFrameSource} 返回 `VeLiveVideoFrameSourcePreEncode` 时，才会触发该回调。
-     * @order 19
-     * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
+     * @brief 编码前视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourcePreEncode` 时，才会触发该回调。
+     * @order 27
+     * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
      *
      */
+    
     onPreEncodeVideoFrame?(frame: VeLiveVideoFrame): void;
 }
 export declare class VeLiveVideoEffectCallback {
@@ -48,79 +50,96 @@ export declare class VeLiveVideoEffectCallback {
      * @brief 视频特效处理结果回调。
      * @param result 处理结果
      * @param msg 消息
+     * @order 6
      *
      */
+    
     onResult?(result: int, msg: String): void;
 }
 export declare class VeLiveMediaPlayerListener {
     /** {zh}
      * @detail callback
      * @brief 开始播放的回调。
+     * @order 7
      *
      */
+    
     onStart?(info: Bundle): void;
     /** {zh}
      * @detail callback
      * @brief 播放进度的回调，每 100ms 触发一次。
      * @param timeMs 播放进度，单位为 ms。
+     * @order 8
      *
      */
+    
     onProgress?(timeMs: long): void;
     /** {zh}
      * @detail callback
      * @brief 停止播放的回调。
+     * @order 9
      *
      */
+    
     onStop?(): void;
     /** {zh}
      * @detail callback
      * @brief 返错误状态的回调。
      * @param code 错误码，详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
      * @param msg 错误消息。
+     * @order 10
      *
      */
+    
     onError?(code: int, msg: String): void;
 }
 export declare class VeLiveAudioFrameListener {
     /** {zh}
      * @detail callback
      * @brief 设置当前 Listener 需要的音频帧来源。
-     * @return 订阅的音频帧位置信息，详情请参见 [VeLiveAudioFrameSource](147521#VeLiveAudioFrameSource)。
-     * @order 20
+     * @order 31
+     * @return 订阅的音频帧位置信息，详情请参见 [VeLiveAudioFrameSource](147521#VeLivePusherDef-VeLiveAudioFrameSource)。
      *
      */
+    
     getObservedAudioFrameSource?(): VeLiveAudioFrameSource;
     /** {zh}
      * @detail callback
-     * @brief 采集音频帧回调。只有当您通过 getObservedAudioFrameSource{@link #VeLiveAudioFrameListener#getObservedAudioFrameSource} 返回 `VeLiveAudioFrameSourceCapture` 时，才会触发该回调。
-     * @order 21
-     * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
+     * @brief 采集音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourceCapture` 时，才会触发该回调。
+     * @order 28
+     * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
      *
      */
+    
     onCaptureAudioFrame?(frame: VeLiveAudioFrame): void;
     /** {zh}
      * @detail callback
-     * @brief 编码前音频帧回调。只有当您通过 getObservedAudioFrameSource{@link #VeLiveAudioFrameListener#getObservedAudioFrameSource} 返回 `VeLiveAudioFrameSourcePreEncode` 时，才会触发该回调。
-     * @order 22
-     * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
+     * @brief 编码前音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourcePreEncode` 时，才会触发该回调。
+     * @order 29
+     * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
      *
      */
+    
     onPreEncodeAudioFrame?(frame: VeLiveAudioFrame): void;
 }
 export declare class VeLiveMediaPlayerFrameListener {
     /** {zh}
      * @detail callback
      * @brief 播放器音频帧回调。
-     * @param frame 音频帧，详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
+     * @param frame 音频帧，详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
+     * @order 11
      *
      */
+    
     onAudioFrame?(frame: VeLiveAudioFrame): void;
     /** {zh}
      * @detail callback
      * @brief 播放器视频帧回调。当完成一个新的视频帧的解码后，触发该回调。
-     * @param frame 视频帧数据，包含了帧的时间戳和格式等信息，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
+     * @param frame 视频帧数据，包含了帧的时间戳和格式等信息，详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
+     * @order 12
      *
      */
+    
     onVideoFrame?(frame: VeLiveVideoFrame): void;
 }
 export declare class VeLiveSnapshotListener {
@@ -129,23 +148,25 @@ export declare class VeLiveSnapshotListener {
      * @brief 截图成功回调。
      * @notes <br>
      *    调用 snapshot{@link #VeLivePusher#snapshot} 截图成功后，会收到这个回调。
-     * @order 15
+     * @order 19
      * @param image 视频的截图。
      *
      */
+    
     onSnapshotComplete?(image: Bitmap): void;
 }
 export declare class VeLiveAudioFrameFilter {
     /** {zh}
      * @detail callback
      * @brief 自定义的音频处理方法。
-     * @order 16
-     * @param srcFrame 源音频帧，详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
-     * @param dstFrame 处理后的音频帧，详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
+     * @order 21
+     * @param srcFrame 源音频帧，详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
+     * @param dstFrame 处理后的音频帧，详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
      *        - 0：处理成功；
      *        - ≠0：处理失败，该帧会被 SDK 继续传递到编码器；
      *
      */
+    
     onAudioProcess?(srcFrame: VeLiveAudioFrame, dstFrame: VeLiveAudioFrame): int;
 }
 export declare class VeLivePusherObserver {
@@ -158,32 +179,36 @@ export declare class VeLivePusherObserver {
      * @param msg 错误信息。
      *
      */
+    
     onError?(code: int, subCode: int, msg: String): void;
     /** {zh}
      * @detail callback
      * @brief 推流状态变化回调。
-     * @order 2
+     * @order 16
      * @param status 变化后的推流状态。详情请参见 [VeLivePusherStatus](147521#VeLivePusherStatus)。
      *
      */
+    
     onStatusChange?(status: VeLivePusherStatus): void;
     /** {zh}
      * @detail callback
      * @brief 首帧视频回调，当推流器发送出第一帧视频时，触发该回调。
-     * @order 3
+     * @order 2
      * @param type 首帧的类型，详情请参见 [VeLiveFirstFrameType](147521#VeLiveFirstFrameType)。
      * @param timestampMs 时间戳，单位为 ms。
      *
      */
+    
     onFirstVideoFrame?(type: VeLiveFirstFrameType, timestampMs: long): void;
     /** {zh}
      * @detail callback
      * @brief 首帧音频回调，当推流器发送出第一帧音频时，触发该回调。
-     * @order 4
+     * @order 3
      * @param type 首帧的类型，详情请参见 [VeLiveFirstFrameType](147521#VeLiveFirstFrameType)。
      * @param timestampMs 时间戳，单位为 ms。
      *
      */
+    
     onFirstAudioFrame?(type: VeLiveFirstFrameType, timestampMs: long): void;
     /** {zh}
      * @detail callback
@@ -191,9 +216,10 @@ export declare class VeLivePusherObserver {
      * @param open 摄像头的新状态是否为开启。<br>
      *      - true：摄像头开启；
      *      - false：摄像头关闭。
-     * @order 5
+     * @order 4
      *
      */
+    
     onCameraOpened?(open: boolean): void;
     /** {zh}
      * @detail callback
@@ -201,9 +227,10 @@ export declare class VeLivePusherObserver {
      * @param open 麦克风的新状态是否为开启。<br>
      *      - true：麦克风开启；
      *      - false：麦克风关闭。
-     * @order 6
+     * @order 5
      *
      */
+    
     onMicrophoneOpened?(open: boolean): void;
     /** {zh}
      * @detail callback
@@ -211,25 +238,27 @@ export declare class VeLivePusherObserver {
      * @param open 屏幕采集的新状态是否为开启。<br>
      *      - true：屏幕采集开启；
      *      - false：屏幕采集关闭。
-     * @order 7
+     * @order 14
      *
      */
+    
     onScreenRecording?(open: boolean): void;
     /** {zh}
      * @detail callback
      * @brief 网络质量状态回调，当推流器检测到网络质量发生变化时，触发该回调。
-     * @order 8
+     * @order 17
      * @param quality 变化后的网络质量。详情请参见 [VeLiveNetworkQuality](147521#VeLiveNetworkQuality)。
      *
      */
+    
     onNetworkQuality?(quality: VeLiveNetworkQuality): void;
     /** {zh}
      * @detail callback
      * @brief 音量等级回调，当推流器的音频音量等级发生变化时，触发该回调。
-     * @order 9
+     * @order 15
      * @param level 变化后的音量等级。详情请参见 [VeLiveAudioPowerLevel](147521#VeLiveAudioPowerLevel)。
-     * @param value 当前音量的分贝值（dB）。
-     *        - \\\\-1 表示当前没有获取到对应的音量分贝值。
+     * @param value 当前音量的分贝值（dB）。<br/>
+     *        - \\-1 表示当前没有获取到对应的音量分贝值。
      *        - 分贝数小于 1，对应 VeLiveAudioPowerLevelSilent 级别
      *        - 分贝数大于 1 小于等于 15，对应 VeLiveAudioPowerLevelQuiet 级别
      *        - 分贝数大于 15 小于等于 30，对应 VeLiveAudioPowerLevelLight 级别
@@ -238,24 +267,27 @@ export declare class VeLivePusherObserver {
      *        - 分贝数大于 85，对应 VeLiveAudioPowerLevelNoisy 级别
      *
      */
+    
     onAudioPowerQuality?(level: VeLiveAudioPowerLevel, value: float): void;
 }
 export declare class VeLivePusherStatisticsObserver {
     /** {zh}
      * @detail callback
-     * @brief 推流周期性统计信息回调。
-     * @order 10
-     * @param statistics 周期性统计信息，默认每 5s 回调一次。详情请参见 [VeLivePusherStatistics](147521#VeLivePusherStatistics)。
+     * @brief 推流周期性统计信息回调，每 5s 回调一次，您可以调用 [setStatisticsObserver](147517#VeLivePusher-setstatisticsobserver) 修改回调时间间隔。
+     * @order 18
+     * @param statistics 周期性统计信息，详情请参见 [VeLivePusherStatistics](147521#VeLivePusherDef-VeLivePusherStatistics)。
      *
      */
+    
     onStatistics?(statistics: VeLivePusherStatistics): void;
     /** {zh}
      * @detail callback
      * @brief 周期性日志信息回调。
-     * @order 11
+     * @order 25
      * @param logInfo 周期性日志信息。
      *
      */
+    
     onLogMonitor?(logInfo: JSONObject): void;
 }
 export declare class VeLivePusherDef {
@@ -264,25 +296,28 @@ export declare class VeLiveFileRecordingListener {
     /** {zh}
      * @detail callback
      * @brief 直播录制开始回调。
-     * @order 12
+     * @order 22
      *
      */
+    
     onFileRecordingStarted?(): void;
     /** {zh}
      * @detail callback
      * @brief 直播录制停止回调。
-     * @order 13
+     * @order 23
      *
      */
+    
     onFileRecordingStopped?(): void;
     /** {zh}
      * @detail callback
      * @brief 直播录制错误回调。
-     * @order 14
+     * @order 24
      * @param errorCode 错误码，详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
      * @param message 错误信息。
      *
      */
+    
     onFileRecordingError?(errorCode: int, message: String): void;
 }
 export declare class VeLiveVideoEffectHandleCallback {
@@ -290,7 +325,9 @@ export declare class VeLiveVideoEffectHandleCallback {
      * @detail callback
      * @brief 视频特效对象回调，调用 [setAdvancedFeature](147517#VeLiveVideoEffectManager-setadvancedfeature) 接口时触发此回调，如需使用请联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
      * @param handle 视频特效对象。
+     * @order 13
      *
      */
+    
     onEffectHandle?(handle: Object): void;
 }

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

@@ -3,60 +3,90 @@ export declare enum VeLivePusherErrorCode {
      * @brief 无错误。
      *
      */
+    
     VeLivePusherSuccess = 0,
     /** {zh}
      * @brief License 错误，可能 License 集成错误或 License 过期，请检查 License 集成方式和有效性。
      *
      */
+    
     VeLivePusherInvalidLicense = -1,
     /** {zh}
      * @brief 参数错误，请检查入参，并重新调用。
      *
      */
+    
     VeLivePusherInvalidParameter = -2,
     /** {zh}
      * @brief 视频采集错误，可能未开启设备视频采集权限，请检查权限是否获取。
      *
      */
+    
     VeLivePusherVideoCaptureError = -3,
     /** {zh}
      * @brief 音频采集错误，可能未开启设备麦克风采集权限，请检查权限是否获取。
      *
      */
+    
     VeLivePusherAudioCaptureError = -4,
     /** {zh}
      * @brief 视频编码错误，可能配置了当前设备不支持的视频编码方式，请检查编码参数，并重新调用。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
      *
      */
+    
     VeLivePusherVideoEncoderError = -5,
     /** {zh}
      * @brief 音频编码错误，可能配置了当前设备不支持的音频编码方式，请检查编码参数，并重新调用。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
      *
      */
+    
     VeLivePusherAudioEncoderError = -6,
     /** {zh}
      * @brief 网络发送错误，可能当前网络链路不通，或者开启了代理和关闭了网络权限，请检查网络后重新调用。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
      *
      */
+    
     VeLivePusherTransportError = -7,
     /** {zh}
      * @brief 视频特效错误，请检查视频特效 SDK 是否已经集成并且初试化成功。检查特效资源路径是否配置正确。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
      *
      */
+    
     VeLivePusherVideoEffectError = -8,
     /** {zh}
      * @brief 音频模块错误，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
      *
      */
+    
     VeLivePusherAudioDeviceError = -9,
     /** {zh}
      * @brief 您使用的基础版 License 暂不支持 H.265 硬件编码，请登录火山引擎控制台获取高级版 License。
      *
      */
+    
     VeLivePusherLicenseUnsupportedH265 = -10,
+    /** {zh}
+     * @brief 当前系统版本不支持屏幕采集功能
+     *
+     */
+    
+    VeLivePusherScreenCaptureNotSupportError = -11,
+    /** {zh}
+     * @brief 屏幕采集权限的获取被用户拒绝
+     *
+     */
+    
+    VeLivePusherScreenCaptureStartError = -12,
+    /** {zh}
+     * @brief 屏幕采集被系统中断，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
+     *
+     */
+    
+    VeLivePusherScreenCaptureInterruptedError = -13,
     /** {zh}
      * @brief 其他错误类型，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
      *
      */
+    
     VeLivePusherError = -100
 }