@volcengine/react-native-live-push 1.0.2 → 1.1.1-rc.0

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

@@ -12,6 +12,7 @@ export declare class VeLiveVideoFrameFilter {
      * @order 15
      * @param srcFrame 源视频帧，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
      * @param dstFrame 处理后的视频帧，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
+     *
      */
     onVideoProcess?(srcFrame: VeLiveVideoFrame, dstFrame: VeLiveVideoFrame): int;
 }
@@ -21,20 +22,23 @@ export declare class VeLiveVideoFrameListener {
      * @brief 设置当前 Listener 需要的视频帧来源。
      * @return 您所要订阅的视频数据的位置信息，详情请参见 [VeLiveVideoFrameSource](147521#VeLiveVideoFrameSource)。
      * @order 17
+     *
      */
     getObservedVideoFrameSource?(): VeLiveVideoFrameSource;
     /** {zh}
      * @detail callback
-     * @brief 采集视频帧回调。只有当您通过 {@link #VeLiveVideoFrameListener#getObservedVideoFrameSource getObservedVideoFrameSource} 返回 `VeLiveVideoFrameSourceCapture` 时，才会触发该回调。
+     * @brief 采集视频帧回调。只有当您通过 getObservedVideoFrameSource{@link #VeLiveVideoFrameListener#getObservedVideoFrameSource} 返回 `VeLiveVideoFrameSourceCapture` 时，才会触发该回调。
      * @order 18
      * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
+     *
      */
     onCaptureVideoFrame?(frame: VeLiveVideoFrame): void;
     /** {zh}
      * @detail callback
-     * @brief 编码前视频帧回调。只有当您通过 {@link #VeLiveVideoFrameListener#getObservedVideoFrameSource getObservedVideoFrameSource} 返回 `VeLiveVideoFrameSourcePreEncode` 时，才会触发该回调。
+     * @brief 编码前视频帧回调。只有当您通过 getObservedVideoFrameSource{@link #VeLiveVideoFrameListener#getObservedVideoFrameSource} 返回 `VeLiveVideoFrameSourcePreEncode` 时，才会触发该回调。
      * @order 19
      * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
+     *
      */
     onPreEncodeVideoFrame?(frame: VeLiveVideoFrame): void;
 }
@@ -44,6 +48,7 @@ export declare class VeLiveVideoEffectCallback {
      * @brief 视频特效处理结果回调。
      * @param result 处理结果
      * @param msg 消息
+     *
      */
     onResult?(result: int, msg: String): void;
 }
@@ -51,17 +56,20 @@ export declare class VeLiveMediaPlayerListener {
     /** {zh}
      * @detail callback
      * @brief 开始播放的回调。
+     *
      */
     onStart?(info: Bundle): void;
     /** {zh}
      * @detail callback
      * @brief 播放进度的回调，每 100ms 触发一次。
      * @param timeMs 播放进度，单位为 ms。
+     *
      */
     onProgress?(timeMs: long): void;
     /** {zh}
      * @detail callback
      * @brief 停止播放的回调。
+     *
      */
     onStop?(): void;
     /** {zh}
@@ -69,6 +77,7 @@ export declare class VeLiveMediaPlayerListener {
      * @brief 返错误状态的回调。
      * @param code 错误码，详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
      * @param msg 错误消息。
+     *
      */
     onError?(code: int, msg: String): void;
 }
@@ -78,20 +87,23 @@ export declare class VeLiveAudioFrameListener {
      * @brief 设置当前 Listener 需要的音频帧来源。
      * @return 订阅的音频帧位置信息，详情请参见 [VeLiveAudioFrameSource](147521#VeLiveAudioFrameSource)。
      * @order 20
+     *
      */
     getObservedAudioFrameSource?(): VeLiveAudioFrameSource;
     /** {zh}
      * @detail callback
-     * @brief 采集音频帧回调。只有当您通过 {@link #VeLiveAudioFrameListener#getObservedAudioFrameSource getObservedAudioFrameSource} 返回 `VeLiveAudioFrameSourceCapture` 时，才会触发该回调。
+     * @brief 采集音频帧回调。只有当您通过 getObservedAudioFrameSource{@link #VeLiveAudioFrameListener#getObservedAudioFrameSource} 返回 `VeLiveAudioFrameSourceCapture` 时，才会触发该回调。
      * @order 21
      * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
+     *
      */
     onCaptureAudioFrame?(frame: VeLiveAudioFrame): void;
     /** {zh}
      * @detail callback
-     * @brief 编码前音频帧回调。只有当您通过 {@link #VeLiveAudioFrameListener#getObservedAudioFrameSource getObservedAudioFrameSource} 返回 `VeLiveAudioFrameSourcePreEncode` 时，才会触发该回调。
+     * @brief 编码前音频帧回调。只有当您通过 getObservedAudioFrameSource{@link #VeLiveAudioFrameListener#getObservedAudioFrameSource} 返回 `VeLiveAudioFrameSourcePreEncode` 时，才会触发该回调。
      * @order 22
      * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
+     *
      */
     onPreEncodeAudioFrame?(frame: VeLiveAudioFrame): void;
 }
@@ -100,12 +112,14 @@ export declare class VeLiveMediaPlayerFrameListener {
      * @detail callback
      * @brief 播放器音频帧回调。
      * @param frame 音频帧，详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
+     *
      */
     onAudioFrame?(frame: VeLiveAudioFrame): void;
     /** {zh}
      * @detail callback
      * @brief 播放器视频帧回调。当完成一个新的视频帧的解码后，触发该回调。
      * @param frame 视频帧数据，包含了帧的时间戳和格式等信息，详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
+     *
      */
     onVideoFrame?(frame: VeLiveVideoFrame): void;
 }
@@ -114,9 +128,10 @@ export declare class VeLiveSnapshotListener {
      * @detail callback
      * @brief 截图成功回调。
      * @notes <br>
-     *    调用 {@link #VeLivePusher#snapshot snapshot} 截图成功后，会收到这个回调。
+     *    调用 snapshot{@link #VeLivePusher#snapshot} 截图成功后，会收到这个回调。
      * @order 15
      * @param image 视频的截图。
+     *
      */
     onSnapshotComplete?(image: Bitmap): void;
 }
@@ -129,6 +144,7 @@ export declare class VeLiveAudioFrameFilter {
      * @param dstFrame 处理后的音频帧，详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
      *        - 0：处理成功；
      *        - ≠0：处理失败，该帧会被 SDK 继续传递到编码器；
+     *
      */
     onAudioProcess?(srcFrame: VeLiveAudioFrame, dstFrame: VeLiveAudioFrame): int;
 }
@@ -140,6 +156,7 @@ export declare class VeLivePusherObserver {
      * @param code 错误码。详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
      * @param subCode 子错误码。
      * @param msg 错误信息。
+     *
      */
     onError?(code: int, subCode: int, msg: String): void;
     /** {zh}
@@ -147,6 +164,7 @@ export declare class VeLivePusherObserver {
      * @brief 推流状态变化回调。
      * @order 2
      * @param status 变化后的推流状态。详情请参见 [VeLivePusherStatus](147521#VeLivePusherStatus)。
+     *
      */
     onStatusChange?(status: VeLivePusherStatus): void;
     /** {zh}
@@ -155,6 +173,7 @@ export declare class VeLivePusherObserver {
      * @order 3
      * @param type 首帧的类型，详情请参见 [VeLiveFirstFrameType](147521#VeLiveFirstFrameType)。
      * @param timestampMs 时间戳，单位为 ms。
+     *
      */
     onFirstVideoFrame?(type: VeLiveFirstFrameType, timestampMs: long): void;
     /** {zh}
@@ -163,6 +182,7 @@ export declare class VeLivePusherObserver {
      * @order 4
      * @param type 首帧的类型，详情请参见 [VeLiveFirstFrameType](147521#VeLiveFirstFrameType)。
      * @param timestampMs 时间戳，单位为 ms。
+     *
      */
     onFirstAudioFrame?(type: VeLiveFirstFrameType, timestampMs: long): void;
     /** {zh}
@@ -172,6 +192,7 @@ export declare class VeLivePusherObserver {
      *      - true：摄像头开启；
      *      - false：摄像头关闭。
      * @order 5
+     *
      */
     onCameraOpened?(open: boolean): void;
     /** {zh}
@@ -181,6 +202,7 @@ export declare class VeLivePusherObserver {
      *      - true：麦克风开启；
      *      - false：麦克风关闭。
      * @order 6
+     *
      */
     onMicrophoneOpened?(open: boolean): void;
     /** {zh}
@@ -190,6 +212,7 @@ export declare class VeLivePusherObserver {
      *      - true：屏幕采集开启；
      *      - false：屏幕采集关闭。
      * @order 7
+     *
      */
     onScreenRecording?(open: boolean): void;
     /** {zh}
@@ -197,6 +220,7 @@ export declare class VeLivePusherObserver {
      * @brief 网络质量状态回调，当推流器检测到网络质量发生变化时，触发该回调。
      * @order 8
      * @param quality 变化后的网络质量。详情请参见 [VeLiveNetworkQuality](147521#VeLiveNetworkQuality)。
+     *
      */
     onNetworkQuality?(quality: VeLiveNetworkQuality): void;
     /** {zh}
@@ -212,6 +236,7 @@ export declare class VeLivePusherObserver {
      *        - 分贝数大于 30 小于等于 60，对应 VeLiveAudioPowerLevelNormal 级别
      *        - 分贝数大于 60 小于等于 85，对应 VeLiveAudioPowerLevelLoud
      *        - 分贝数大于 85，对应 VeLiveAudioPowerLevelNoisy 级别
+     *
      */
     onAudioPowerQuality?(level: VeLiveAudioPowerLevel, value: float): void;
 }
@@ -221,6 +246,7 @@ export declare class VeLivePusherStatisticsObserver {
      * @brief 推流周期性统计信息回调。
      * @order 10
      * @param statistics 周期性统计信息，默认每 5s 回调一次。详情请参见 [VeLivePusherStatistics](147521#VeLivePusherStatistics)。
+     *
      */
     onStatistics?(statistics: VeLivePusherStatistics): void;
     /** {zh}
@@ -228,6 +254,7 @@ export declare class VeLivePusherStatisticsObserver {
      * @brief 周期性日志信息回调。
      * @order 11
      * @param logInfo 周期性日志信息。
+     *
      */
     onLogMonitor?(logInfo: JSONObject): void;
 }
@@ -238,12 +265,14 @@ export declare class VeLiveFileRecordingListener {
      * @detail callback
      * @brief 直播录制开始回调。
      * @order 12
+     *
      */
     onFileRecordingStarted?(): void;
     /** {zh}
      * @detail callback
      * @brief 直播录制停止回调。
      * @order 13
+     *
      */
     onFileRecordingStopped?(): void;
     /** {zh}
@@ -252,6 +281,7 @@ export declare class VeLiveFileRecordingListener {
      * @order 14
      * @param errorCode 错误码，详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
      * @param message 错误信息。
+     *
      */
     onFileRecordingError?(errorCode: int, message: String): void;
 }
@@ -260,6 +290,7 @@ export declare class VeLiveVideoEffectHandleCallback {
      * @detail callback
      * @brief 视频特效对象回调，调用 [setAdvancedFeature](147517#VeLiveVideoEffectManager-setadvancedfeature) 接口时触发此回调，如需使用请联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
      * @param handle 视频特效对象。
+     *
      */
     onEffectHandle?(handle: Object): void;
 }

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

@@ -1,50 +1,62 @@
 export declare enum VeLivePusherErrorCode {
     /** {zh}
      * @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 其他错误类型，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
+     *
      */
     VeLivePusherError = 11
 }