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

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

@@ -1,8 +1,7 @@
 import * as $p_a from '../android/index';
 import * as $p_i from '../ios/index';
-import { VeLiveVideoFrame, VeLiveAudioFrame } from './api';
-import { Bitmap, JSONObject } from './types';
-import { VeLivePusherStatus, VeLiveFirstFrameType, VeLiveNetworkQuality, VeLiveAudioPowerLevel, VeLivePusherStatistics } from './keytype';
+import { VeLiveVideoFrame, VeLiveAudioFrame, VeLivePusherStatus, VeLiveFirstFrameType, VeLiveNetworkQuality, VeLiveAudioPowerLevel, VeLivePusherStatistics } from './keytype';
+import { int, Bitmap, NSString, BOOL, JSONObject, NSDictionary } from './types';
 
 export interface VeLiveVideoFrameFilter {
 }
@@ -11,8 +10,8 @@ export interface VeLiveVideoFrameListener {
     
     /** {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{@link #VeLiveVideoFrameListener#getObservedVideoFrameSource} callback method.
-     * @param frame The captured video frame. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     * @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.
+     * @param frame The captured video frame. See [VeLiveVideoFrame](#VeLivePusherDef-VeLiveVideoFrameFilter) for details.
      * @order 18
      *
      */
@@ -20,8 +19,8 @@ export interface VeLiveVideoFrameListener {
     
     /** {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{@link #VeLiveVideoFrameListener#getObservedVideoFrameSource} callback method.
-     * @param frame The video frame to be encoded. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     * @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.
+     * @param frame The video frame to be encoded. See [VeLiveVideoFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoFrame) for details.
      * @order 19
      *
      */
@@ -55,7 +54,7 @@ export interface VeLiveMediaPlayerListener {
     /** {en}
      * @detail callback
      * @brief Occurs when an error occurs in the media player.
-     * @param code The error code. See VeLivePusherErrorCode {@link #VeLivePusherErrorCode} for details.
+     * @param code The error code. See [VeLivePusherErrorCode](broadcast-sdk-for-android-api-error-code#VeLivePusherErrorCode) for details.
      * @param msg The error message.
      *
      */
@@ -66,8 +65,8 @@ export interface VeLiveAudioFrameListener {
     
     /** {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{@link #VeLiveAudioFrameListener#getObservedAudioFrameSource} callback method.
-     * @param frame The captured audio frame data. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     * @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.
+     * @param frame The captured audio frame data. See [VeLiveAudioFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioFrame).
      * @order 21
      *
      */
@@ -75,8 +74,8 @@ export interface VeLiveAudioFrameListener {
     
     /** {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{@link #VeLiveAudioFrameListener#getObservedAudioFrameSource} callback method.
-     * @param frame The audio frame to be encoded. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     * @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.
+     * @param frame The audio frame to be encoded. See [VeLiveAudioFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioFrame) for details.
      * @order 22
      *
      */
@@ -88,7 +87,7 @@ export interface VeLiveMediaPlayerFrameListener {
     /** {en}
      * @detail callback
      * @brief Occurs when the media player decodes an audio frame.
-     * @param frame The audio frame. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     * @param frame The audio frame. See [VeLiveAudioFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioFrame) for details.
      *
      */
     onAudioFrame?(frame: VeLiveAudioFrame): void;
@@ -96,7 +95,7 @@ export interface VeLiveMediaPlayerFrameListener {
     /** {en}
      * @detail callback
      * @brief Occurs when the media player decodes a video frame.
-     * @param frame The video frame, including the timestamp, pixel format, and other information. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     * @param frame The video frame, including the timestamp, pixel format, and other information. See [VeLiveVideoFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoFrame) for details.
      *
      */
     onVideoFrame?(frame: VeLiveVideoFrame): void;
@@ -106,7 +105,7 @@ export interface VeLiveSnapshotListener {
     
     /** {en}
      * @detail callback
-     * @brief Occurs when a screenshot is successfully taken after snapshot {@link #VeLivePusher#snapshot} is called.
+     * @brief Screenshot success callback.
      * @param image The screenshot image.
      * @order 15
      *
@@ -122,7 +121,7 @@ export interface VeLivePusherObserver {
     /** {en}
      * @detail callback
      * @brief Occurs when a streaming error occurs.
-     * @param code The error code. See VeLivePusherErrorCode {@link #VeLivePusherErrorCode} for details.
+     * @param code The error code. See [VeLivePusherErrorCode](broadcast-sdk-for-android-api-error-code#VeLivePusherErrorCode) for details.
      * @param subCode The subcode.
      * @param msg The error message.
      * @order 1
@@ -133,7 +132,7 @@ export interface VeLivePusherObserver {
     /** {en}
      * @detail callback
      * @brief Occurs when the streaming status changes.
-     * @param status The updated streaming status. See VeLivePusherStatus {@link #VeLivePusherStatus} for details.
+     * @param status The updated streaming status. See [VeLivePusherStatus](broadcast-sdk-for-android-type-definition#VeLivePusherStatus) for details.
      * @order 2
      *
      */
@@ -142,7 +141,7 @@ export interface VeLivePusherObserver {
     /** {en}
      * @detail callback
      * @brief Occurs when the live pusher sends the first video frame.
-     * @param type The type of the first frame. See VeLiveFirstFrameType {@link #VeLiveFirstFrameType} for details.
+     * @param type The type of the first frame. See [VeLiveFirstFrameType](broadcast-sdk-for-android-type-definition#VeLiveFirstFrameType) for details.
      * @param timestampMs  The timestamp, in milliseconds.
      * @order 3
      *
@@ -152,7 +151,7 @@ export interface VeLivePusherObserver {
     /** {en}
      * @detail callback
      * @brief Occurs when the live pusher sends the first audio frame.
-     * @param type The type of the first audio frame. See VeLiveFirstFrameType {@link #VeLiveFirstFrameType} for details.
+     * @param type The type of the first audio frame. See [VeLiveFirstFrameType](broadcast-sdk-for-android-type-definition#VeLiveFirstFrameType) for details.
      * @param timestampMs  The timestamp, in milliseconds.
      * @order 4
      *
@@ -191,12 +190,12 @@ export interface VeLivePusherObserver {
      * @order 7
      *
      */
-    android_onScreenRecording?(open: boolean): void;
+    onScreenRecording?(): void;
     
     /** {en}
      * @detail callback
      * @brief Occurs when the network quality changes.
-     * @param quality The updated network quality. See VeLiveNetworkQuality {@link #VeLiveNetworkQuality} for details.
+     * @param quality The updated network quality. See [VeLiveNetworkQuality](broadcast-sdk-for-android-type-definition#VeLiveNetworkQuality) for details.
      * @order 8
      *
      */
@@ -206,7 +205,7 @@ export interface VeLivePusherObserver {
      * @detail callback
      * @brief Occurs when the audio volume level changes.
      * @order 9
-     * @param level The updated volume level. See [VeLiveAudioPowerLevel](broadcast-sdk-for-android-type-definition\\#VeLiveAudioPowerLevel) for details.
+     * @param level The updated volume level. See [VeLiveAudioPowerLevel](broadcast-sdk-for-android-type-definition#VeLiveAudioPowerLevel) for details.
      * @param value The current volume measured in decibel value (dB).
      *        - A value of -1 indicates that the corresponding volume decibel value is not available.
      *        - Decibel values less than 1 correspond to the VeLiveAudioPowerLevelSilent level.
@@ -224,9 +223,9 @@ export interface VeLivePusherStatisticsObserver {
     
     /** {en}
      * @detail callback
-     * @brief Occurs periodically to report streaming statistics. By default, the callback is triggered every 5 seconds.
+     * @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.
      * @order 10
-     * @param statistics The streaming statistics. See VeLivePusherStatistics for details.
+     * @param statistics The streaming statistics. See [VeLivePusherStatistics](docs-broadcast-sdk-for-android-type-definition#VeLivePusherDef-VeLivePusherStatistics) for details.
      *
      */
     onStatistics?(statistics: VeLivePusherStatistics): void;
@@ -262,7 +261,7 @@ export interface VeLiveFileRecordingListener {
     /** {en}
      * @detail callback
      * @brief Occurs when an error occurs during recording.
-     * @param errorCode The error code. See VeLivePusherErrorCode {@link #VeLivePusherErrorCode} for details.
+     * @param errorCode The error code. See [VeLivePusherErrorCode](broadcast-sdk-for-android-api-error-code#VeLivePusherErrorCode) for details.
      * @param message The error message.
      * @order 14
      *
@@ -293,15 +292,15 @@ export declare class android_VeLiveMediaPlayerListener extends $p_a.VeLiveMediaP
     protected _instance: VeLiveMediaPlayerListener;
     constructor(_instance: VeLiveMediaPlayerListener);
     onStart(info: $p_a.Bundle): void;
-    onProgress(timeMs: $p_a.long): void;
+    onProgress(timeMs: int): void;
     onStop(): void;
-    onError(code: $p_a.int, msg: string): void;
+    onError(code: int, msg: string): void;
 }
 export declare class ios_VeLiveMediaPlayerListener extends $p_i.VeLiveMediaPlayerListener {
     protected _instance: VeLiveMediaPlayerListener;
     constructor(_instance: VeLiveMediaPlayerListener);
     onStart(): void;
-    onProgress(timeMS: $p_i.long): void;
+    onProgress(timeMS: int): void;
     onStop(): void;
     onError(error: $p_i.NSError): void;
 }
@@ -350,10 +349,10 @@ export declare class ios_VeLiveAudioFrameFilter extends $p_i.VeLiveAudioFrameFil
 export declare class android_VeLivePusherObserver extends $p_a.VeLivePusherObserver {
     protected _instance: VeLivePusherObserver;
     constructor(_instance: VeLivePusherObserver);
-    onError(code: $p_a.int, subCode: $p_a.int, msg: string): void;
+    onError(code: int, subCode: int, msg: string): void;
     onStatusChange(status: $p_a.VeLivePusherStatus): void;
-    onFirstVideoFrame(type: $p_a.VeLiveFirstFrameType, timestampMs: $p_a.long): void;
-    onFirstAudioFrame(type: $p_a.VeLiveFirstFrameType, timestampMs: $p_a.long): void;
+    onFirstVideoFrame(type: $p_a.VeLiveFirstFrameType, timestampMs: int): void;
+    onFirstAudioFrame(type: $p_a.VeLiveFirstFrameType, timestampMs: int): void;
     onCameraOpened(open: boolean): void;
     onMicrophoneOpened(open: boolean): void;
     onScreenRecording(open: boolean): void;
@@ -363,12 +362,12 @@ export declare class android_VeLivePusherObserver extends $p_a.VeLivePusherObser
 export declare class ios_VeLivePusherObserver extends $p_i.VeLivePusherObserver {
     protected _instance: VeLivePusherObserver;
     constructor(_instance: VeLivePusherObserver);
-    onError$subcode$message(code: $p_i.int, subcode: $p_i.int, msg: $p_i.NSString): void;
+    onError$subcode$message(code: int, subcode: int, msg: NSString): void;
     onStatusChange(status: $p_i.VeLivePushStatus): void;
     onFirstVideoFrame$timestampMs(type: $p_i.VeLiveFirstFrameType, timestampMs: $p_i.int64_t): void;
     onFirstAudioFrame$timestampMs(type: $p_i.VeLiveFirstFrameType, timestampMs: $p_i.int64_t): void;
-    onCameraOpened(open: $p_i.BOOL): void;
-    onMicrophoneOpened(open: $p_i.BOOL): void;
+    onCameraOpened(open: BOOL): void;
+    onMicrophoneOpened(open: BOOL): void;
     onNetworkQuality(quality: $p_i.VeLiveNetworkQuality): void;
     onAudioPowerQuality$value(level: $p_i.VeLiveAudioPowerLevel, value: $p_i.float): void;
 }
@@ -376,25 +375,25 @@ export declare class android_VeLivePusherStatisticsObserver extends $p_a.VeLiveP
     protected _instance: VeLivePusherStatisticsObserver;
     constructor(_instance: VeLivePusherStatisticsObserver);
     onStatistics(statistics: $p_a.VeLivePusherStatistics): void;
-    onLogMonitor(logInfo: $p_a.JSONObject): void;
+    onLogMonitor(logInfo: JSONObject): void;
 }
 export declare class ios_VeLivePusherStatisticsObserver extends $p_i.VeLivePusherStatisticsObserver {
     protected _instance: VeLivePusherStatisticsObserver;
     constructor(_instance: VeLivePusherStatisticsObserver);
     onStatistics(statistics: $p_i.VeLivePusherStatistics): void;
-    onLogMonitor(logInfo: $p_i.NSDictionary): void;
+    onLogMonitor(logInfo: NSDictionary): void;
 }
 export declare class android_VeLiveFileRecordingListener extends $p_a.VeLiveFileRecordingListener {
     protected _instance: VeLiveFileRecordingListener;
     constructor(_instance: VeLiveFileRecordingListener);
     onFileRecordingStarted(): void;
     onFileRecordingStopped(): void;
-    onFileRecordingError(errorCode: $p_a.int, message: string): void;
+    onFileRecordingError(errorCode: int, message: string): void;
 }
 export declare class ios_VeLiveFileRecordingListener extends $p_i.VeLiveFileRecordingListener {
     protected _instance: VeLiveFileRecordingListener;
     constructor(_instance: VeLiveFileRecordingListener);
     onFileRecordingStarted(): void;
     onFileRecordingStopped(): void;
-    onFileRecordingError$message(errorCode: $p_i.int, msg: $p_i.NSString): void;
+    onFileRecordingError$message(errorCode: int, msg: NSString): void;
 }

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

@@ -3,33 +3,103 @@ import * as $p_i from '../ios/index';
 
 export declare enum VeLivePusherErrorCode {
     
+    /** {en}
+     * @brief No error.
+     *
+     */
     VeLivePusherSuccess = 0,
     
+    /** {en}
+     * @brief SDK license error, possibly caused by an invalid or expired certificate.
+     *
+     */
     VeLivePusherInvalidLicense = -1,
     
+    /** {en}
+     * @brief Parameter error, possibly caused by an invalid parameter value or parameter type.
+     *
+     */
     VeLivePusherInvalidParameter = -2,
     
+    /** {en}
+     * @brief Video capture error, possibly caused by the lack of access to the video device.
+     *
+     */
     VeLivePusherVideoCaptureError = -3,
     
+    /** {en}
+     * @brief Audio capture error, possibly caused by the lack of access to the audio device.
+     *
+     */
     VeLivePusherAudioCaptureError = -4,
     
+    /** {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,
     
+    /** {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,
     
+    /** {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,
     
+    /** {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,
     
+    /** {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,
     
+    /** {en}
+     * @platform android
+     * @brief The license does not support H265.
+     *
+     */
     VeLivePusherLicenseUnsupportedH265 = -10,
     
-    VeLivePusherError = -100
+    /** {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,
+    
+    /** {en}
+     * @platform android
+     * @brief
+     *
+     */
+    VeLivePusherScreenCaptureNotSupportError = -99,
+    
+    /** {en}
+     * @platform android
+     * @brief
+     *
+     */
+    VeLivePusherScreenCaptureStartError = -98,
+    
+    /** {en}
+     * @platform android
+     * @brief
+     *
+     */
+    VeLivePusherScreenCaptureInterruptedError = -97
 }
 export declare class t_VeLivePusherErrorCode {
-    static ts_to_android(value: VeLivePusherErrorCode): $p_a.VeLivePusherErrorCode;
-    static android_to_ts(value: $p_a.VeLivePusherErrorCode): VeLivePusherErrorCode;
-    static ts_to_ios(value: VeLivePusherErrorCode): $p_i.VeLivePusherCode;
-    static ios_to_ts(value: $p_i.VeLivePusherCode): VeLivePusherErrorCode;
+    static code_to_android(value: VeLivePusherErrorCode): $p_a.VeLivePusherErrorCode;
+    static android_to_code(value: $p_a.VeLivePusherErrorCode): VeLivePusherErrorCode;
+    static code_to_ios(value: VeLivePusherErrorCode): $p_i.VeLivePusherCode;
+    static ios_to_code(value: $p_i.VeLivePusherCode): VeLivePusherErrorCode;
 }