@byteplus/react-native-live-pull 1.0.0

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

@@ -0,0 +1,217 @@
+import { VeLivePlayer } from './api';
+import { VeLivePlayerError } from './errorcode';
+import { VeLivePlayerResolution, VeLivePlayerResolutionSwitchReason, VeLivePlayerStreamType, VeLivePlayerStatus, VeLivePlayerStatistics, VeLivePlayerVideoFrame, VeLivePlayerAudioFrame } from './keytype';
+import * as $p_a from '../android/index';
+import * as $p_i from '../ios/index';
+
+/** {en}
+ * @detail callback
+ * @brief The live player observer.
+ */
+export interface VeLivePlayerObserver {
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a player error occurs.
+     * @param player The player object that triggers the callback function.
+     * @param error The error message. Refer to VeLivePlayerError {@link #VeLivePlayerError} for details.
+     * @order 1
+     */
+    onError?(player: VeLivePlayer, error: VeLivePlayerError): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the first video frame is rendered at the beginning of playback or after a retry during playback.
+     * @param player The player object that triggers the callback function.
+     * @param isFirstFrame Whether the video frame is the first video frame rendered at the beginning of playback. <br>
+     *                      - true: The video frame is the first video frame rendered at the beginning of playback;
+     *                      - false: The video frame is the first video frame rendered after a retry during playback.
+     * @order 2
+     */
+    onFirstVideoFrameRender?(player: VeLivePlayer, isFirstFrame: boolean): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the first audio frame is rendered at the beginning of playback or after a retry during playback.
+     * @param player The player object that triggers the callback function.
+     * @param isFirstFrame Whether the audio frame is the first audio frame rendered at the beginning of playback. <br>
+     *                      - true: The audio frame is the first audio frame rendered at the beginning of playback;
+     *                      - false: The audio frame is the first audio frame rendered after a retry during playback.
+     * @order 3
+     */
+    onFirstAudioFrameRender?(player: VeLivePlayer, isFirstFrame: boolean): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a playback stutter starts.
+     * @param player The player object that triggers the callback function.
+     * @order 4
+     */
+    onStallStart?(player: VeLivePlayer): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a playback stutter stops, that is, when playback resumes after there is enough audio buffer.
+     * @param player The player object that triggers the callback function.
+     * @order 5
+     */
+    onStallEnd?(player: VeLivePlayer): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when video rendering stutters.
+     * @param player The player object that triggers the callback function.
+     * @param stallTime The stutter duration, in milliseconds.
+     * @order 6
+     */
+    onVideoRenderStall?(player: VeLivePlayer, stallTime: number): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when audio rendering stutters.
+     * @param player The player object that triggers the callback function.
+     * @param stallTime The stutter duration, in milliseconds.
+     * @order 7
+     */
+    onAudioRenderStall?(player: VeLivePlayer, stallTime: number): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the video resolution changes.
+     * @param player The player object that triggers the callback function.
+     * @param resolution The updated resolution. See VeLivePlayerResolution {@link #VeLivePlayerResolution} for details.
+     * @param error Whether an error occurred during resolution switching. See VeLivePlayerError {@link #VeLivePlayerError} for details.
+     * @param reason The reason for resolution switching. See VeLivePlayerResolutionSwitchReason {@link #VeLivePlayerResolutionSwitchReason} for details.
+     * @order 8
+     */
+    onResolutionSwitch?(player: VeLivePlayer, resolution: VeLivePlayerResolution, error: VeLivePlayerError, reason: VeLivePlayerResolutionSwitchReason): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the video size changes.
+     * @param player The player object that triggers the callback function.
+     * @param width The updated width of the video, in pixels.
+     * @param height The updated height of the video, in pixels.
+     * @order 9
+     */
+    onVideoSizeChanged?(player: VeLivePlayer, width: number, height: number): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the Player SDK receives an SEI message.
+     * @param player The player object that triggers the callback function.
+     * @param message The SEI message.
+     * @order 10
+     */
+    onReceiveSeiMessage?(player: VeLivePlayer, message: string): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the player switches between the primary stream and the backup stream.
+     * @param player The player object that triggers the callback function.
+     * @param streamType The type of the updated stream. For details, see VeLivePlayerStreamType {@link #VeLivePlayerStreamType}.
+     * @param error The reason for the switch. For details, see VeLivePlayerError {@link #VeLivePlayerError}.
+     * @order 11
+     */
+    onMainBackupSwitch?(player: VeLivePlayer, streamType: VeLivePlayerStreamType, error: VeLivePlayerError): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the playback status changes.
+     * @param player The player object that triggers the callback function.
+     * @param status The updated status of the player. See VeLivePlayerStatus {@link #VeLivePlayerStatus} for details.
+     * @order 12
+     */
+    onPlayerStatusUpdate?(player: VeLivePlayer, status: VeLivePlayerStatus): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs periodically to report information such as the current pull stream address, bitrate, and frame rate.
+     * @param player The player object that triggers the callback function.
+     * @param statistics The playback statistics. For details, see VeLivePlayerStatistics {@link #VeLivePlayerStatistics}.
+     * @order 13
+     */
+    onStatistics?(player: VeLivePlayer, statistics: VeLivePlayerStatistics): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a screenshot is taken after {@link #VeLivePlayer#snapshot snapshot} is called.
+     * @param player The player object that triggers the callback function.
+     * @param bitmap The Bitmap object of the screenshot.
+     * @order 14
+     */
+    onSnapshotComplete?(player: VeLivePlayer, bitmap: any): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the player decodes a video frame. Call [enableVideoFrameObserver](player-android-api-reference#VeLivePlayer-enablevideoframeobserver) to enable video frame callback.
+     * @notes  <br>
+     *       If you use the texture format for external rendering, we recommend that you render the video in the callback thread.
+     * @order 15
+     * @param player The player object that triggers the callback function.
+     * @param videoFrame The video frame, including the pixel format, encapsulation format, width and height of the video, and other information. See VeLivePlayerVideoFrame {@link #VeLivePlayerVideoFrame} for details.
+     */
+    onRenderVideoFrame?(player: VeLivePlayer, videoFrame: VeLivePlayerVideoFrame): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the player decodes an audio frame. Call {@link #VeLivePlayer#enableAudioFrameObserver enableAudioFrameObserver} to enable audio frame callback.
+     * @param player The player object that triggers the callback function.
+     * @param audioFrame The audio frame. See VeLivePlayerAudioFrame {@link #VeLivePlayerAudioFrame} for details.
+     * @notes  <br>
+     *      The audio data returned by the callback is of type Float32 and in big-endian byte order.
+     * @order 16
+     */
+    onRenderAudioFrame?(player: VeLivePlayer, audioFrame: VeLivePlayerAudioFrame): void;
+    
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the SDK fails to enable super resolution after {@link #VeLivePlayer#setEnableSuperResolution setEnableSuperResolution} is called.
+     * @order 17
+     * @param player The player object that triggers the callback function.
+     * @param error The reason of the failure. See [VeLivePlayerErrorCode](player-android-api-errorcode#VeLivePlayerError-VeLivePlayerErrorCode) for details.
+     */
+    onStreamFailedOpenSuperResolution?(player: VeLivePlayer, error: VeLivePlayerError): void;
+}
+export declare class android_VeLivePlayerObserver extends $p_a.VeLivePlayerObserver {
+    protected _instance: VeLivePlayerObserver;
+    constructor(_instance: VeLivePlayerObserver);
+    onError(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.VeLivePlayerError): void;
+    onFirstVideoFrameRender(arg_0: $p_a.VeLivePlayer, arg_1: boolean): void;
+    onFirstAudioFrameRender(arg_0: $p_a.VeLivePlayer, arg_1: boolean): void;
+    onStallStart(arg_0: $p_a.VeLivePlayer): void;
+    onStallEnd(arg_0: $p_a.VeLivePlayer): void;
+    onVideoRenderStall(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.long): void;
+    onAudioRenderStall(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.long): void;
+    onResolutionSwitch(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.VeLivePlayerResolution, arg_2: $p_a.VeLivePlayerError, arg_3: $p_a.VeLivePlayerResolutionSwitchReason): void;
+    onVideoSizeChanged(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.int, arg_2: $p_a.int): void;
+    onReceiveSeiMessage(arg_0: $p_a.VeLivePlayer, arg_1: string): void;
+    onMainBackupSwitch(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.VeLivePlayerStreamType, arg_2: $p_a.VeLivePlayerError): void;
+    onPlayerStatusUpdate(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.VeLivePlayerStatus): void;
+    onStatistics(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.VeLivePlayerStatistics): void;
+    onSnapshotComplete(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.Bitmap): void;
+    onRenderVideoFrame(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.VeLivePlayerVideoFrame): void;
+    onRenderAudioFrame(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.VeLivePlayerAudioFrame): void;
+    onStreamFailedOpenSuperResolution(arg_0: $p_a.VeLivePlayer, arg_1: $p_a.VeLivePlayerError): void;
+}
+export declare class ios_VeLivePlayerObserver extends $p_i.VeLivePlayerObserver {
+    protected _instance: VeLivePlayerObserver;
+    constructor(_instance: VeLivePlayerObserver);
+    onError(arg_0: $p_i.TVLManager, arg_1: $p_i.VeLivePlayerError): void;
+    onFirstVideoFrameRender(arg_0: $p_i.TVLManager, arg_1: $p_i.BOOL): void;
+    onFirstAudioFrameRender(arg_0: $p_i.TVLManager, arg_1: $p_i.BOOL): void;
+    onStallStart(arg_0: $p_i.TVLManager): void;
+    onStallEnd(arg_0: $p_i.TVLManager): void;
+    onVideoRenderStall(arg_0: $p_i.TVLManager, arg_1: $p_i.int64_t): void;
+    onAudioRenderStall(arg_0: $p_i.TVLManager, arg_1: $p_i.int64_t): void;
+    onResolutionSwitch(arg_0: $p_i.TVLManager, arg_1: $p_i.VeLivePlayerResolution, arg_2: $p_i.VeLivePlayerError, arg_3: $p_i.VeLivePlayerResolutionSwitchReason): void;
+    onVideoSizeChanged(arg_0: $p_i.TVLManager, arg_1: $p_i.int, arg_2: $p_i.int): void;
+    onReceiveSeiMessage(arg_0: $p_i.TVLManager, arg_1: $p_i.NSString): void;
+    onMainBackupSwitch(arg_0: $p_i.TVLManager, arg_1: $p_i.VeLivePlayerStreamType, arg_2: $p_i.VeLivePlayerError): void;
+    onPlayerStatusUpdate(arg_0: $p_i.TVLManager, arg_1: $p_i.VeLivePlayerStatus): void;
+    onStatistics(arg_0: $p_i.TVLManager, arg_1: $p_i.VeLivePlayerStatistics): void;
+    onSnapshotComplete(arg_0: $p_i.TVLManager, arg_1: $p_i.UIImage): void;
+    onRenderVideoFrame(arg_0: $p_i.TVLManager, arg_1: $p_i.VeLivePlayerVideoFrame): void;
+    onRenderAudioFrame(arg_0: $p_i.TVLManager, arg_1: $p_i.VeLivePlayerAudioFrame): void;
+    onStreamFailedOpenSuperResolution(arg_0: $p_i.TVLManager, arg_1: $p_i.VeLivePlayerError): void;
+}

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

@@ -0,0 +1,150 @@
+import * as $p_a from '../android/index';
+import * as $p_i from '../ios/index';
+
+/** {en}
+ * @detail errorcode
+ * @brief The playback error.
+ */
+export declare class VeLivePlayerError {
+    protected _instance: any;
+    protected __init(...args: any[]): void;
+    protected __new_instance(...args: any[]): $p_a.VeLivePlayerError | $p_i.VeLivePlayerError;
+    
+    /** {en}
+     * @brief The error code.
+     */
+    get errorCode(): number;
+    
+    /** {en}
+     * @brief The error message.
+     */
+    get errorMsg(): string;
+}
+
+/** {en}
+ * @detail errorcode
+ * @brief The playback error code.
+ */
+export declare enum VeLivePlayerErrorCode {
+    
+    /** {en}
+     * @brief No error.
+     */
+    VeLivePlayerNoError = 0,
+    
+    /** {en}
+     * @brief The SDK license is invalid. This error may occur due to incorrect integration of the license or if the license has expired. Review how the license was integrated and ensure that it is still valid.
+     */
+    VeLivePlayerInvalidLicense = -1,
+    
+    /** {en}
+     * @brief Invalid parameters. Check the input parameter and call the method again.
+     */
+    VeLivePlayerInvalidParameter = -2,
+    
+    /** {en}
+     * @brief The method call has been rejected. This error occurs when the method is called at an incorrect time.
+     */
+    VeLivePlayerErrorRefused = -3,
+    
+    /** {en}
+     * @brief Failed to load the library file. This error may occur due to incorrect integration of the SDK.
+     */
+    VeLivePlayerErrorLibraryLoadFailed = -4,
+    
+    /** {en}
+     * @brief The pull stream address does not exist or is invalid. This error may occur if the pull stream address is empty, or if the format or length of the address is invalid.
+     */
+    VeLivePlayerErrorPlayUrl = -100,
+    
+    /** {en}
+     * @brief Unable to get the stream data. This error may occur if the live stream does not exist, is interrupted, or has ended. Please check the status of the live stream.
+     */
+    VeLivePlayerErrorNoStreamData = -101,
+    
+    /** {en}
+     * @brief An internal retry to play the live stream, which might happen due to an internal player error.
+     */
+    VeLivePlayerErrorInternalRetryStart = -102,
+    
+    /** {en}
+     * @brief An internal retry failed and the maximum number of internal retries is reached. The player has stopped retrying. You may attempt a manual retry.
+     */
+    VeLivePlayerErrorInternalRetryFailed = -103,
+    
+    /** {en}
+     * @brief DNS parsing failed. This error may occur due to an error in the pull stream address or the client's network conditions. If the error persists after you verify the pull stream address and network conditions, contact BytePlus technical support for assistance.
+     */
+    VeLivePlayerErrorDnsParseFailed = -200,
+    
+    /** {en}
+     * @brief The network request failed. Check the network conditions. If the error persists, contact BytePlus technical support for assistance.
+     */
+    VeLivePlayerErrorNetworkRequestFailed = -201,
+    
+    /** {en}
+     * @brief Video decapsulation failed. This error may occur if the live stream uses an unsupported format or protocol, or if there is an audio or video error. If the error persists, contact BytePlus technical support for assistance.
+     */
+    VeLivePlayerErrorDemuxFailed = -300,
+    
+    /** {en}
+     * @brief Decoding failed. This error may occur if the live stream uses an unsupported audio or video format. If the error persists, contact BytePlus technical support for assistance.
+     */
+    VeLivePlayerErrorDecodeFailed = -301,
+    
+    /** {en}
+     * @brief Rendering failed. This error may occur if there is an issue with the audio or video output devices. If the error persists, contact BytePlus technical support for assistance.
+     */
+    VeLivePlayerErrorAVOutputFailed = -302,
+    
+    /** {en}
+     * @brief The device model does not support super resolution. Contact BytePlus technical support for any assistance you may need.
+     */
+    VeLivePlayerErrorSRDeviceUnsupported = -303,
+    
+    /** {en}
+     * @brief The current resolution exceeds the upper limit allowed for super resolution. Contact BytePlus technical support for any assistance you may need.
+     */
+    VeLivePlayerErrorSRResolutionUnsupported = -304,
+    
+    /** {en}
+     * @brief The current frame rate exceeds the upper limit allowed for super resolution. Contact BytePlus technical support for any assistance you may need.
+     */
+    VeLivePlayerErrorSRFpsUnsupported = -305,
+    
+    /** {en}
+     * @brief Fails to initialize super resolution. Contact BytePlus technical support if the error persists.
+     */
+    VeLivePlayerErrorSRInitFail = -306,
+    
+    /** {en}
+     * @brief Fails to apply super resolution to the video. Contact BytePlus technical support if the error persists.
+     */
+    VeLivePlayerErrorSRExecuteFail = -307,
+    
+    /** {en}
+     * @brief The current SDK license does not provide support for the H.265 feature.
+     */
+    VeLivePlayerLicenseUnsupportedH265 = -308,
+    
+    /** {en}
+     * @brief DRM authentication fails
+     */
+    VeLivePlayerDRMFetchCKCFailed = -400,
+    
+    /** {en}
+     * @brief Fails to generate Server Playback Context (SPC)
+     */
+    VeLivePlayerDRMFetchSPCFailed = -401,
+    
+    /** {en}
+     * @brief Internal error. Please contact BytePlus technical support for assistance.
+     */
+    VeLivePlayerErrorInternal = -999
+}
+export declare class t_VeLivePlayerErrorCode {
+    static ts_to_android(value: VeLivePlayerErrorCode): $p_a.VeLivePlayerErrorCode;
+    static android_to_ts(value: $p_a.VeLivePlayerErrorCode): VeLivePlayerErrorCode;
+    static ts_to_ios(value: VeLivePlayerErrorCode): $p_i.VeLivePlayerErrorCode;
+    static ios_to_ts(value: $p_i.VeLivePlayerErrorCode): VeLivePlayerErrorCode;
+}

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

@@ -0,0 +1,5 @@
+export * from './api';
+export * from './callback';
+export * from './errorcode';
+export * from './keytype';
+export * from './types';