@byteplus/react-native-live-push 1.0.0

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

@@ -0,0 +1,542 @@
+import { VeLiveVideoFrame, VeLiveAudioFrame } from './api';
+import * as $p_a from '../android/index';
+import * as $p_i from '../ios/index';
+import { VeLivePusherStatus, VeLiveFirstFrameType, VeLiveNetworkQuality, VeLiveAudioPowerLevel, VeLivePusherStatistics } from './keytype';
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief A custom video processing callback.
+ */
+export interface VeLiveVideoFrameFilter {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @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 {@link #VeLiveVideoFrame} for details.
+     * @param dstFrame The processed video frame. See VeLiveVideoFrame {@link #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): number;
+}
+export declare class android_VeLiveVideoFrameFilter extends $p_a.VeLiveVideoFrameFilter {
+    protected _instance: VeLiveVideoFrameFilter;
+    constructor(_instance: VeLiveVideoFrameFilter);
+    onVideoProcess(arg_0: $p_a.VeLiveVideoFrame, arg_1: $p_a.VeLiveVideoFrame): number;
+}
+export declare class ios_VeLiveVideoFrameFilter extends $p_i.VeLiveVideoFrameFilter {
+    protected _instance: VeLiveVideoFrameFilter;
+    constructor(_instance: VeLiveVideoFrameFilter);
+    onVideoProcess(arg_0: $p_i.VeLiveVideoFrame, arg_1: $p_i.VeLiveVideoFrame): number;
+}
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief The listener for video frames.
+ */
+export interface VeLiveVideoFrameListener {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when a video frame is captured. This callback will be triggered only if you return `VeLiveVideoFrameSourceCapture` when implementing the {@link #VeLiveVideoFrameListener#getObservedVideoFrameSource getObservedVideoFrameSource} callback method.
+     * @param frame The captured video frame. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     * @order 18
+     */
+    onCaptureVideoFrame?(frame: VeLiveVideoFrame): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when a video frame is to be encoded. This callback will be triggered only if you return `VeLiveVideoFrameSourcePreEncode` when implementing the {@link #VeLiveVideoFrameListener#getObservedVideoFrameSource getObservedVideoFrameSource} callback method.
+     * @param frame The video frame to be encoded. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     * @order 19
+     */
+    onPreEncodeVideoFrame?(frame: VeLiveVideoFrame): void;
+}
+export declare class android_VeLiveVideoFrameListener extends $p_a.VeLiveVideoFrameListener {
+    protected _instance: VeLiveVideoFrameListener;
+    constructor(_instance: VeLiveVideoFrameListener);
+    onCaptureVideoFrame(arg_0: $p_a.VeLiveVideoFrame): void;
+    onPreEncodeVideoFrame(arg_0: $p_a.VeLiveVideoFrame): void;
+}
+export declare class ios_VeLiveVideoFrameListener extends $p_i.VeLiveVideoFrameListener {
+    protected _instance: VeLiveVideoFrameListener;
+    constructor(_instance: VeLiveVideoFrameListener);
+    onCaptureVideoFrame(arg_0: $p_i.VeLiveVideoFrame): void;
+    onPreEncodeVideoFrame(arg_0: $p_i.VeLiveVideoFrame): void;
+}
+
+/** {en}
+ * @platform android
+ * @detail callback
+ * @list overview
+ * @brief The listener for special effect events.
+ */
+export interface VeLiveVideoEffectCallback {
+    
+    /** {en}
+     * @platform android
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when special effects are processed.
+     * @param result The result.
+     * @param msg The message.
+     */
+    android_onResult?(result: number, msg: string): void;
+}
+export declare class android_VeLiveVideoEffectCallback extends $p_a.VeLiveVideoEffectCallback {
+    protected _instance: VeLiveVideoEffectCallback;
+    constructor(_instance: VeLiveVideoEffectCallback);
+    onResult(arg_0: $p_a.int, arg_1: string): void;
+}
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief Observer that listens for playback-related events of the media player.
+ */
+export interface VeLiveMediaPlayerListener {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when the playback starts.
+     * @param info \-
+     * @order 1
+     */
+    onStart?(info: $p_a.Bundle): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs every 100 ms to report the playback progress.
+     * @param timeMs The playback progress, in milliseconds.
+     */
+    onProgress?(timeMs: number): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when the playback stops.
+     */
+    onStop?(): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when an error occurs in the media player.
+     * @param code The error code. See VeLivePusherErrorCode {@link #VeLivePusherErrorCode} for details.
+     * @param msg The error message.
+     */
+    onError?(code: number, msg: string): void;
+}
+export declare class android_VeLiveMediaPlayerListener extends $p_a.VeLiveMediaPlayerListener {
+    protected _instance: VeLiveMediaPlayerListener;
+    constructor(_instance: VeLiveMediaPlayerListener);
+    onStart(arg_0: $p_a.Bundle): void;
+    onProgress(arg_0: $p_a.long): void;
+    onStop(): void;
+    onError(arg_0: $p_a.int, arg_1: string): void;
+}
+export declare class ios_VeLiveMediaPlayerListener extends $p_i.VeLiveMediaPlayerListener {
+    protected _instance: VeLiveMediaPlayerListener;
+    constructor(_instance: VeLiveMediaPlayerListener);
+    onStart(): void;
+    onProgress(arg_0: $p_i.long): void;
+    onStop(): void;
+    onError(arg_0: $p_i.NSError): void;
+}
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief The listener for audio frames.
+ */
+export interface VeLiveAudioFrameListener {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when an audio frame is captured. This callback will be triggered only if you return `VeLiveAudioFrameSourceCapture` when implementing the {@link #VeLiveAudioFrameListener#getObservedAudioFrameSource getObservedAudioFrameSource} callback method.
+     * @param frame The captured audio frame data. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     * @order 21
+     */
+    onCaptureAudioFrame?(frame: VeLiveAudioFrame): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when an audio frame is to be encoded. This callback will be triggered only if you return `VeLiveAudioFrameSourcePreEncode` when implementing the {@link #VeLiveAudioFrameListener#getObservedAudioFrameSource getObservedAudioFrameSource} callback method.
+     * @param frame The audio frame to be encoded. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     * @order 22
+     */
+    onPreEncodeAudioFrame?(frame: VeLiveAudioFrame): void;
+}
+export declare class android_VeLiveAudioFrameListener extends $p_a.VeLiveAudioFrameListener {
+    protected _instance: VeLiveAudioFrameListener;
+    constructor(_instance: VeLiveAudioFrameListener);
+    onCaptureAudioFrame(arg_0: $p_a.VeLiveAudioFrame): void;
+    onPreEncodeAudioFrame(arg_0: $p_a.VeLiveAudioFrame): void;
+}
+export declare class ios_VeLiveAudioFrameListener extends $p_i.VeLiveAudioFrameListener {
+    protected _instance: VeLiveAudioFrameListener;
+    constructor(_instance: VeLiveAudioFrameListener);
+    onCaptureAudioFrame(arg_0: $p_i.VeLiveAudioFrame): void;
+    onPreEncodeAudioFrame(arg_0: $p_i.VeLiveAudioFrame): void;
+}
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief Observer that listens for audio and video frames of the media player.
+ */
+export interface VeLiveMediaPlayerFrameListener {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when the media player decodes an audio frame.
+     * @param frame The audio frame. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     */
+    onAudioFrame?(frame: VeLiveAudioFrame): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @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.
+     */
+    onVideoFrame?(frame: VeLiveVideoFrame): void;
+}
+export declare class android_VeLiveMediaPlayerFrameListener extends $p_a.VeLiveMediaPlayerFrameListener {
+    protected _instance: VeLiveMediaPlayerFrameListener;
+    constructor(_instance: VeLiveMediaPlayerFrameListener);
+    onAudioFrame(arg_0: $p_a.VeLiveAudioFrame): void;
+    onVideoFrame(arg_0: $p_a.VeLiveVideoFrame): void;
+}
+export declare class ios_VeLiveMediaPlayerFrameListener extends $p_i.VeLiveMediaPlayerFrameListener {
+    protected _instance: VeLiveMediaPlayerFrameListener;
+    constructor(_instance: VeLiveMediaPlayerFrameListener);
+    onAudioFrame(arg_0: $p_i.VeLiveAudioFrame): void;
+    onVideoFrame(arg_0: $p_i.VeLiveVideoFrame): void;
+}
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief The listener for screenshot capturing events.
+ */
+export interface VeLiveSnapshotListener {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when a screenshot is successfully taken after snapshot {@link #VeLivePusher#snapshot} is called.
+     * @param image The screenshot image.
+     * @order 15
+     */
+    onSnapshotComplete?(image: any): void;
+}
+export declare class android_VeLiveSnapshotListener extends $p_a.VeLiveSnapshotListener {
+    protected _instance: VeLiveSnapshotListener;
+    constructor(_instance: VeLiveSnapshotListener);
+    onSnapshotComplete(arg_0: $p_a.Bitmap): void;
+}
+export declare class ios_VeLiveSnapshotListener extends $p_i.VeLiveSnapshotListener {
+    protected _instance: VeLiveSnapshotListener;
+    constructor(_instance: VeLiveSnapshotListener);
+    onSnapshotComplete(arg_0: $p_i.UIImage): void;
+}
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief A custom audio processing callback.
+ */
+export interface VeLiveAudioFrameFilter {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @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 {@link #VeLiveAudioFrame} for details.
+     * @param dstFrame The processed audio frame. See VeLiveAudioFrame {@link #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): number;
+}
+export declare class android_VeLiveAudioFrameFilter extends $p_a.VeLiveAudioFrameFilter {
+    protected _instance: VeLiveAudioFrameFilter;
+    constructor(_instance: VeLiveAudioFrameFilter);
+    onAudioProcess(arg_0: $p_a.VeLiveAudioFrame, arg_1: $p_a.VeLiveAudioFrame): number;
+}
+export declare class ios_VeLiveAudioFrameFilter extends $p_i.VeLiveAudioFrameFilter {
+    protected _instance: VeLiveAudioFrameFilter;
+    constructor(_instance: VeLiveAudioFrameFilter);
+    onAudioProcess(arg_0: $p_i.VeLiveAudioFrame, arg_1: $p_i.VeLiveAudioFrame): number;
+}
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief The observer for live pusher events, including errors, statuses, network quality, device information, and first frame rendering.
+ */
+export interface VeLivePusherObserver {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when a streaming error occurs.
+     * @param code The error code. See VeLivePusherErrorCode {@link #VeLivePusherErrorCode} for details.
+     * @param subCode The subcode.
+     * @param msg The error message.
+     * @order 1
+     */
+    onError?(code: number, subCode: number, msg: string): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when the streaming status changes.
+     * @param status The updated streaming status. See VeLivePusherStatus {@link #VeLivePusherStatus} for details.
+     * @order 2
+     */
+    onStatusChange?(status: VeLivePusherStatus): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @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 timestampMs  The timestamp, in milliseconds.
+     * @order 3
+     */
+    onFirstVideoFrame?(type: VeLiveFirstFrameType, timestampMs: number): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @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 timestampMs  The timestamp, in milliseconds.
+     * @order 4
+     */
+    onFirstAudioFrame?(type: VeLiveFirstFrameType, timestampMs: number): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @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
+     * @group 回调
+     * @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}
+     * @platform android
+     * @detail callback
+     * @group 回调
+     * @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
+     */
+    android_onScreenRecording?(open: boolean): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when the network quality changes.
+     * @param quality The updated network quality. See VeLiveNetworkQuality {@link #VeLiveNetworkQuality} for details.
+     * @order 8
+     */
+    onNetworkQuality?(quality: VeLiveNetworkQuality): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @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: number): void;
+}
+export declare class android_VeLivePusherObserver extends $p_a.VeLivePusherObserver {
+    protected _instance: VeLivePusherObserver;
+    constructor(_instance: VeLivePusherObserver);
+    onError(arg_0: $p_a.int, arg_1: $p_a.int, arg_2: string): void;
+    onStatusChange(arg_0: $p_a.VeLivePusherStatus): void;
+    onFirstVideoFrame(arg_0: $p_a.VeLiveFirstFrameType, arg_1: $p_a.long): void;
+    onFirstAudioFrame(arg_0: $p_a.VeLiveFirstFrameType, arg_1: $p_a.long): void;
+    onCameraOpened(arg_0: boolean): void;
+    onMicrophoneOpened(arg_0: boolean): void;
+    onScreenRecording(arg_0: boolean): void;
+    onNetworkQuality(arg_0: $p_a.VeLiveNetworkQuality): void;
+    onAudioPowerQuality(arg_0: $p_a.VeLiveAudioPowerLevel, arg_1: $p_a.float): void;
+}
+export declare class ios_VeLivePusherObserver extends $p_i.VeLivePusherObserver {
+    protected _instance: VeLivePusherObserver;
+    constructor(_instance: VeLivePusherObserver);
+    onError(arg_0: $p_i.int, arg_1: $p_i.int, arg_2: $p_i.NSString): void;
+    onStatusChange(arg_0: $p_i.VeLivePushStatus): void;
+    onFirstVideoFrame(arg_0: $p_i.VeLiveFirstFrameType, arg_1: $p_i.int64_t): void;
+    onFirstAudioFrame(arg_0: $p_i.VeLiveFirstFrameType, arg_1: $p_i.int64_t): void;
+    onCameraOpened(arg_0: $p_i.BOOL): void;
+    onMicrophoneOpened(arg_0: $p_i.BOOL): void;
+    onNetworkQuality(arg_0: $p_i.VeLiveNetworkQuality): void;
+    onAudioPowerQuality(arg_0: $p_i.VeLiveAudioPowerLevel, arg_1: $p_i.float): void;
+}
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief The observer that periodically reports streaming statistics.
+ */
+export interface VeLivePusherStatisticsObserver {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs periodically to report streaming statistics. By default, the callback is triggered every 5 seconds.
+     * @order 10
+     * @param statistics The streaming statistics. See VeLivePusherStatistics for details.
+     */
+    onStatistics?(statistics: VeLivePusherStatistics): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs periodically to return log information.
+     * @param logInfo The log information.
+     * @order 11
+     */
+    onLogMonitor?(logInfo: object): void;
+}
+export declare class android_VeLivePusherStatisticsObserver extends $p_a.VeLivePusherStatisticsObserver {
+    protected _instance: VeLivePusherStatisticsObserver;
+    constructor(_instance: VeLivePusherStatisticsObserver);
+    onStatistics(arg_0: $p_a.VeLivePusherStatistics): void;
+    onLogMonitor(arg_0: $p_a.JSONObject): void;
+}
+export declare class ios_VeLivePusherStatisticsObserver extends $p_i.VeLivePusherStatisticsObserver {
+    protected _instance: VeLivePusherStatisticsObserver;
+    constructor(_instance: VeLivePusherStatisticsObserver);
+    onStatistics(arg_0: $p_i.VeLivePusherStatistics): void;
+    onLogMonitor(arg_0: $p_i.NSDictionary): void;
+}
+export declare class VeLivePusherDef extends $p_a.VeLivePusherDef {
+}
+
+/** {en}
+ * @detail callback
+ * @list overview
+ * @brief The observer for recording events.
+ */
+export interface VeLiveFileRecordingListener {
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when recording starts.
+     * @order 12
+     */
+    onFileRecordingStarted?(): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when recording stops.
+     * @order 13
+     */
+    onFileRecordingStopped?(): void;
+    
+    /** {en}
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when an error occurs during recording.
+     * @param errorCode The error code. See VeLivePusherErrorCode {@link #VeLivePusherErrorCode} for details.
+     * @param message The error message.
+     * @order 14
+     */
+    onFileRecordingError?(errorCode: number, message: string): void;
+}
+export declare class android_VeLiveFileRecordingListener extends $p_a.VeLiveFileRecordingListener {
+    protected _instance: VeLiveFileRecordingListener;
+    constructor(_instance: VeLiveFileRecordingListener);
+    onFileRecordingStarted(): void;
+    onFileRecordingStopped(): void;
+    onFileRecordingError(arg_0: $p_a.int, arg_1: string): void;
+}
+export declare class ios_VeLiveFileRecordingListener extends $p_i.VeLiveFileRecordingListener {
+    protected _instance: VeLiveFileRecordingListener;
+    constructor(_instance: VeLiveFileRecordingListener);
+    onFileRecordingStarted(): void;
+    onFileRecordingStopped(): void;
+    onFileRecordingError(arg_0: $p_i.int, arg_1: $p_i.NSString): void;
+}
+
+/** {en}
+ * @platform android
+ * @detail callback
+ * @list overview
+ * @brief A video effects callback.
+ */
+export interface VeLiveVideoEffectHandleCallback {
+    
+    /** {en}
+     * @platform android
+     * @detail callback
+     * @group 回调
+     * @brief Occurs when the setAdvancedFeature {@link #VeLiveVideoEffectManager #setAdvancedFeature} method is called. Please contact BytePlus technical support for assistance when using this callback method.
+     * @param handle The video effect object.
+     */
+    android_onEffectHandle?(handle: Object): void;
+}
+export declare class android_VeLiveVideoEffectHandleCallback extends $p_a.VeLiveVideoEffectHandleCallback {
+    protected _instance: VeLiveVideoEffectHandleCallback;
+    constructor(_instance: VeLiveVideoEffectHandleCallback);
+    onEffectHandle(arg_0: object): void;
+}
+
+/** {en}
+ * @platform ios
+ * @list overview
+ * @detail callback
+ */
+export interface VeLiveScreenCaptureStatusObserver {
+}
+export declare class ios_VeLiveScreenCaptureStatusObserver extends $p_i.VeLiveScreenCaptureStatusObserver {
+    protected _instance: VeLiveScreenCaptureStatusObserver;
+    constructor(_instance: VeLiveScreenCaptureStatusObserver);
+}