@byteplus/react-native-live-push 1.1.3-rc.4 → 1.3.0-rc.0

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

@@ -1,91 +1,323 @@
-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 {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the SDK captures a video frame. You can use the callback to process the frame in a custom way.
+     * @param srcFrame The source video frame. See [VeLiveVideoFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoFrame) for details.
+     * @param dstFrame The processed video frame. See [VeLiveVideoFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoFrame) for details.
+     * @order 15
+     * @return - 0: The video frame is successfully processed;
+     *         - < 0: The processing has failed. The frame will be discarded by the SDK;
+     *         - > 0: The processing has failed. The frame will be passed to the encoder by the SDK.
+     *
+     */
     onVideoProcess?(srcFrame: VeLiveVideoFrame, dstFrame: VeLiveVideoFrame): int;
 }
 export declare class VeLiveVideoFrameListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Sets the source of the video frame that the listener needs.
+     * @order 17
+     * @return The source type of the video frame you want to subscribe to. See [VeLiveVideoFrameSource](docs-broadcast-sdk-for-android-type-definition#VeLivePusherDef-VeLiveVideoFrameSource) for details.
+     *
+     */
     getObservedVideoFrameSource?(): VeLiveVideoFrameSource;
     
+    /** {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.
+     * @param frame The captured video frame. See [VeLiveVideoFrame](#VeLivePusherDef-VeLiveVideoFrameFilter) for details.
+     * @order 18
+     *
+     */
     onCaptureVideoFrame?(frame: VeLiveVideoFrame): void;
     
+    /** {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.
+     * @param frame The video frame to be encoded. See [VeLiveVideoFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoFrame) for details.
+     * @order 19
+     *
+     */
     onPreEncodeVideoFrame?(frame: VeLiveVideoFrame): void;
 }
 export declare class VeLiveVideoEffectCallback {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when special effects are processed.
+     * @param result The result.
+     * @param msg The message.
+     *
+     */
     onResult?(result: int, msg: String): void;
 }
 export declare class VeLiveMediaPlayerListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the playback starts.
+     *
+     */
     onStart?(info: Bundle): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs every 100 ms to report the playback progress.
+     * @param timeMs The playback progress, in milliseconds.
+     *
+     */
     onProgress?(timeMs: long): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the playback stops.
+     *
+     */
     onStop?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when an error occurs in the media player.
+     * @param code The error code. See [VeLivePusherErrorCode](broadcast-sdk-for-android-api-error-code#VeLivePusherErrorCode) for details.
+     * @param msg The error message.
+     *
+     */
     onError?(code: int, msg: String): void;
 }
 export declare class VeLiveAudioFrameListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Sets the source of the audio frame that the listener needs.
+     * @order 20
+     * @return The source type of the audio frame. See [VeLiveAudioFrameSource](docs-broadcast-sdk-for-android-type-definition#VeLivePusherDef-VeLiveAudioFrameSource) for details.
+     *
+     */
     getObservedAudioFrameSource?(): VeLiveAudioFrameSource;
     
+    /** {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.
+     * @param frame The captured audio frame data. See [VeLiveAudioFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioFrame).
+     * @order 21
+     *
+     */
     onCaptureAudioFrame?(frame: VeLiveAudioFrame): void;
     
+    /** {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.
+     * @param frame The audio frame to be encoded. See [VeLiveAudioFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioFrame) for details.
+     * @order 22
+     *
+     */
     onPreEncodeAudioFrame?(frame: VeLiveAudioFrame): void;
 }
 export declare class VeLiveMediaPlayerFrameListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the media player decodes an audio frame.
+     * @param frame The audio frame. See [VeLiveAudioFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioFrame) for details.
+     *
+     */
     onAudioFrame?(frame: VeLiveAudioFrame): void;
     
+    /** {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](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoFrame) for details.
+     *
+     */
     onVideoFrame?(frame: VeLiveVideoFrame): void;
 }
 export declare class VeLiveSnapshotListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Screenshot success callback.
+     * @param image The screenshot image.
+     * @order 15
+     *
+     */
     onSnapshotComplete?(image: Bitmap): void;
 }
 export declare class VeLiveAudioFrameFilter {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the SDK captures an audio frame. You can use the callback to process the frame in a custom way.
+     * @param srcFrame The source audio frame. See [VeLiveAudioFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioFrame) for details.
+     * @param dstFrame The processed audio frame. See [VeLiveAudioFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioFrame) for details.
+     *        - 0: Success;
+     *        - ≠ 0: Failure. The frame will be passed to the encoder by the SDK.
+     * @order 16
+     *
+     */
     onAudioProcess?(srcFrame: VeLiveAudioFrame, dstFrame: VeLiveAudioFrame): int;
 }
 export declare class VeLivePusherObserver {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a streaming error occurs.
+     * @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
+     *
+     */
     onError?(code: int, subCode: int, msg: String): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the streaming status changes.
+     * @param status The updated streaming status. See [VeLivePusherStatus](broadcast-sdk-for-android-type-definition#VeLivePusherStatus) for details.
+     * @order 2
+     *
+     */
     onStatusChange?(status: VeLivePusherStatus): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the live pusher sends the first video frame.
+     * @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
+     *
+     */
     onFirstVideoFrame?(type: VeLiveFirstFrameType, timestampMs: long): void;
     
+    /** {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](broadcast-sdk-for-android-type-definition#VeLiveFirstFrameType) for details.
+     * @param timestampMs  The timestamp, in milliseconds.
+     * @order 4
+     *
+     */
     onFirstAudioFrame?(type: VeLiveFirstFrameType, timestampMs: long): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the camera is turned on or turned off.
+     * @param open Whether the updated status of the camera is on. <br>
+     *       - true: On;
+     *       - false: Off.
+     * @order 5
+     *
+     */
     onCameraOpened?(open: boolean): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the microphone is turned on or turned off.
+     * @param open Whether the updated status of the microphone is on. <br>
+     *       - true: On;
+     *       - false: Off.
+     * @order 6
+     *
+     */
     onMicrophoneOpened?(open: boolean): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when screen capture is turned on or turned off.
+     * @param open Whether the updated status of screen capture is on. <br>
+     *       - true: On;
+     *       - false: Off.
+     * @order 7
+     *
+     */
     onScreenRecording?(open: boolean): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the network quality changes.
+     * @param quality The updated network quality. See [VeLiveNetworkQuality](broadcast-sdk-for-android-type-definition#VeLiveNetworkQuality) for details.
+     * @order 8
+     *
+     */
     onNetworkQuality?(quality: VeLiveNetworkQuality): void;
     
+    /** {en}
+     * @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 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.
+     *        - Decibel values greater than 1 and less than or equal to 15 correspond to the VeLiveAudioPowerLevelQuiet level.
+     *        - Decibel values greater than 15 and less than or equal to 30 correspond to the VeLiveAudioPowerLevelLight level.
+     *        - Decibel values greater than 30 and less than or equal to 60 correspond to the VeLiveAudioPowerLevelNormal level.
+     *        - Decibel values greater than 60 and less than or equal to 85 correspond to the VeLiveAudioPowerLevelLoud level.
+     *        - Decibel values greater than 85 correspond to the VeLiveAudioPowerLevelNoisy level.
+     *
+     */
     onAudioPowerQuality?(level: VeLiveAudioPowerLevel, value: float): void;
 }
 export declare class VeLivePusherStatisticsObserver {
     
+    /** {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.
+     * @order 10
+     * @param statistics The streaming statistics. See [VeLivePusherStatistics](docs-broadcast-sdk-for-android-type-definition#VeLivePusherDef-VeLivePusherStatistics) for details.
+     *
+     */
     onStatistics?(statistics: VeLivePusherStatistics): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs periodically to return log information.
+     * @param logInfo The log information.
+     * @order 11
+     *
+     */
     onLogMonitor?(logInfo: JSONObject): void;
 }
 export declare class VeLivePusherDef {
 }
 export declare class VeLiveFileRecordingListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when recording starts.
+     * @order 12
+     *
+     */
     onFileRecordingStarted?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when recording stops.
+     * @order 13
+     *
+     */
     onFileRecordingStopped?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when an error occurs during recording.
+     * @param errorCode The error code. See [VeLivePusherErrorCode](broadcast-sdk-for-android-api-error-code#VeLivePusherErrorCode) for details.
+     * @param message The error message.
+     * @order 14
+     *
+     */
     onFileRecordingError?(errorCode: int, message: String): void;
 }
 export declare class VeLiveVideoEffectHandleCallback {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the [setAdvancedFeature](docs-broadcast-sdk-for-android-api#VeLiveVideoEffectManager-setadvancedfeature) method is called. 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.
+     * @param handle The video effect object.
+     *
+     */
     onEffectHandle?(handle: Object): void;
 }

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

@@ -1,26 +1,92 @@
 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}
+     * @brief The license does not support H265.
+     *
+     */
     VeLivePusherLicenseUnsupportedH265 = -10,
     
+    /** {en}
+     * @brief
+     *
+     */
+    VeLivePusherScreenCaptureNotSupportError = -11,
+    
+    /** {en}
+     * @brief
+     *
+     */
+    VeLivePusherScreenCaptureStartError = -12,
+    
+    /** {en}
+     * @brief
+     *
+     */
+    VeLivePusherScreenCaptureInterruptedError = -13,
+    
+    /** {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
 }