@byteplus/react-native-live-pull 1.3.0-rc.9 → 1.3.2-rc.0

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

@@ -1,318 +0,0 @@
-import { String, SurfaceHolder, Surface, float, Map, List, int } from './types';
-import { VeLivePlayerLogLevel, VeLivePlayerConfiguration, VeLivePlayerFillMode, VeLivePlayerStreamData, VeLivePlayerResolution, VeLivePlayerPixelFormat, VeLivePlayerVideoBufferType, VeLivePlayerAudioBufferType, VeLivePlayerRotation, VeLivePlayerMirror } from './keytype';
-import { VeLivePlayerObserver } from './callback';
-import { ApplicationContext } from './external';
-export declare class VeLivePlayer {
-    
-    /** {en}
-     * @detail api
-     * @brief Gets the version number of the Player SDK.
-     * @return  <br>
-     *     The version number of the Player SDK.
-     * @order 4
-     *
-     */
-    static getVersion(): String;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets the level of the output log.
-     * @param logLevel The level of the output log. For details, see VeLivePlayerLogLevel{@link #VeLivePlayerLogLevel}.
-     * @order 5
-     *
-     */
-    static setLogLevel(logLevel: VeLivePlayerLogLevel): void;
-    constructor(context: ApplicationContext);
-    
-    /** {en}
-     * @detail api
-     * @brief  Initializes the player and configures whether to turn on SEI messaging, hardware decoding, local DNS prefetch, and other configurations.
-     * @notes <br>Call this method to initialize the player before calling [play](#VeLivePlayer-play) .
-     * @order 1
-     * @param config Player configurations. Refer to VeLivePlayerConfiguration{@link #VeLivePlayerConfiguration} for details.
-     *
-     */
-    setConfig(config: VeLivePlayerConfiguration): void;
-    
-    /** {en}
-     * @detail api
-     * @brief  Sets the player observer to listen to the live player's events, such as playback errors or status updates, rendering of the first audio and video frame, and resolution switching.
-     * @notes
-     *        Call this method before calling [play](#VeLivePlayer-play).
-     * @param observer The player observer. See VeLivePlayerObserver{@link #VeLivePlayerObserver} for details.
-     * @order 2
-     *
-     */
-    setObserver(observer: VeLivePlayerObserver): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets the fill mode of the player screen.
-     * @notes <br>
-     *        - Call this method before calling [play](#VeLivePlayer-play) to set the initial fill mode of the player.
-     *        - You can call this method during playback to dynamically adjust the fill mode.
-     * @order 3
-     * @param fillMode The fill mode of SurfaceView. The default value is `VeLivePlayerFillModeAspectFill`. For details, see VeLivePlayerFillMode{@link #VeLivePlayerFillMode}.
-     *
-     */
-    setRenderFillMode(fillMode: VeLivePlayerFillMode): Promise<void>;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets the `SurfaceHolder` object for video rendering and playback. Use this method if you use `SurfaceView` for playback.
-     * @notes
-     *        If you call both setSurfaceHolder and [setSurface](#VeLivePlayer-setsurface) to set the `Surface` object, the player will prioritize the configurations of `surfaceHolder`.
-     * @param surfaceHolder The `SurfaceHolder` object.
-     * @order 6
-     *
-     */
-    setSurfaceHolder(surfaceHolder: SurfaceHolder): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets the `Surface` object for video rendering and playback. Use this method if you use `SurfaceView` or `TextureView` for playback.
-     * @notes
-     *        If you call both [setSurfaceHolder](#VeLivePlayer-setsurfaceholder) and `setSurface` to set the `Surface` object, the player will prioritize the configurations of `surfaceHolder`.
-     * @param surface The `Surface` object.
-     * @order 7
-     *
-     */
-    setSurface(surface: Surface): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets a pull stream address.
-     * @notes <br>Call this method before calling play.
-     * @order 8
-     * @param url The pull stream address.
-     *
-     */
-    setPlayUrl(url: String): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets multiple live streams. Call this method if you need to enable features requiring multiple live streams, such as adaptive bitrate (ABR), manual resolution switching, and primary and backup streams.
-     * @notes <br>Call this method before calling play.
-     * @order 8
-     * @param streamData Configurations for multiple pull stream addresses. For details, see [VeLivePlayerStreamData](player-android-api-keytype#VeLivePlayerStreamData).
-     *
-     */
-    setPlayStreamData(streamData: VeLivePlayerStreamData): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Starts or resumes playback.
-     * @notes
-     *        After you call this method, the [onPlayerStatusUpdate](docs-player-android-api-callback#VeLivePlayerObserver-onplayerstatusupdate) callback is triggered both when the player finishes preparing for stream pulling and when the first frame is rendered.
-     * @order 8
-     *
-     */
-    play(): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Pauses playback.
-     * @notes
-     *        When playback is paused after you call this method, the [onPlayerStatusUpdate](docs-player-android-api-callback#VeLivePlayerObserver-onplayerstatusupdate) callback is triggered.
-     * @order 8
-     *
-     */
-    pause(): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Stops playback. This method does not destroy the player.
-     * @notes
-     *        When playback stops after you call this method, the [onPlayerStatusUpdate](docs-player-android-api-callback#VeLivePlayerObserver-onplayerstatusupdate) callback is triggered.
-     * @order 8
-     *
-     */
-    stop(): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Stops playback and destroys the player.
-     * @order 8
-     *
-     */
-    destroy(): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Changes the video resolution.
-     * @notes - Call [setPlayStreamData](#VeLivePlayer-setplaystreamdata) to set multiple resolutions before calling this method.
-     *        - Once the player switches to the new resolution after you call this method, the [onResolutionSwitch](docs-player-android-api-callback#VeLivePlayerObserver-onresolutionswitch) callback is triggered.
-     * @order 8
-     * @param resolution The video resolution. For details, refer to VeLivePlayerResolution
-     * @return <br>
-     *     - true: Success;
-     *     - false: Failure.
-     *
-     */
-    switchResolution(resolution: VeLivePlayerResolution): boolean;
-    
-    /** {en}
-     * @detail api
-     * @brief Checks whether the player is playing.
-     * @return Whether the player is playing. <br>
-     *       - true: The player is playing;
-     *       - false: The player is not playing.
-     * @order 8
-     *
-     */
-    isPlaying(): boolean;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets the player volume.
-     * @param volume The volume. The default value is `1.0`. The value range is [0.0, 1.0].
-     * @order 8
-     *
-     */
-    setPlayerVolume(volume: float): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets whether to mute playback.
-     * @param mute Whether to mute playback. The default value is `false`. <br>
-     *              - true: Mute;
-     *              - false: Do not mute.
-     * @order 9
-     *
-     */
-    setMute(mute: boolean): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Checks whether playback is muted.
-     * @return Whether playback is muted. <br>
-     *      - true: Muted;
-     *      - false: Not muted.
-     * @order 10
-     *
-     */
-    isMute(): boolean;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets the mapping of domain names to server IP addresses.
-     * @param hostIpMap The mapping of domain names to server IP addresses. The `Map` object uses the domain name as the key, and the corresponding value is a list of IP addresses for the servers associated with that domain. The value is of the `List` type.
-     * @order 11
-     * @notes - When using setUrlHostIP to map domain names and IP addresses, disable the DNS pre-resolution feature in the initial configuration by setting [enableLiveDNS](docs-player-android-api-keytype#VeLivePlayerConfiguration-enablelivedns) to false.
-     *        - Call this method to set the mapping of domain names and IP addresses before calling [play](#VeLivePlayer-play) to start playback.
-     *
-     */
-    setUrlHostIP(hostIpMap: Map<String, List<String>>): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Configures advanced settings for the player, including offscreen rendering, maximum buffer duration, and adaptive bitrate (ABR) algorithms. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if you need further information.
-     * @param key The parameter name of the advanced setting.
-     * @param value The parameter value of the advanced setting.
-     * @order 12
-     *
-     */
-    setProperty(key: String, value: Object): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Takes a screenshot of the video.
-     * @notes
-     *        - This method only takes effect during playback.
-     *        - When a screenshot is captured after you call this method, the [onSnapshotComplete](docs-player-android-api-callback#VeLivePlayerObserver-onsnapshotcomplete) callback is triggered containing the Bitmap object of the screenshot.
-     * @order 13
-     * @return
-     *         - 0: Screenshot capturing is allowed.
-     *         - [VeLivePlayerErrorRefused](docs-player-android-api-errorcode#VeLivePlayerErrorCode-veliveplayererrorrefused) : Screenshot capturing is not allowed.
-     *
-     */
-    snapshot(): int;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets the video frame observer.
-     * @param enable Whether to enable the video frame callback. The default value is `false`. <br>
-     *                - true: Enable;
-     *                - false: Disable.
-     * @param pixelFormat The pixel format of the video frame in the callback. See VeLivePlayerPixelFormat{@link #VeLivePlayerPixelFormat} for details.
-     * @param bufferType The encapsulation format of the video data in the callback. For details, see VeLivePlayerVideoBufferType{@link #VeLivePlayerVideoBufferType}.
-     * @notes
-     *        - You can call this method to subscribe to decoded video data for external rendering.
-     *        - After you call this method, the [onRenderVideoFrame](docs-player-android-api-callback#VeLivePlayerObserver-onrendervideoframe) callback is triggered once the SDK receives a video frame. The callback contains detailed information about the video frame.
-     *        - If you use external rendering, you need to make sure the video and audio are synchronized.
-     * @order 14
-     *
-     */
-    enableVideoFrameObserver(enable: boolean, pixelFormat: VeLivePlayerPixelFormat, bufferType: VeLivePlayerVideoBufferType): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets the audio frame observer.
-     * @notes
-     *        - You can call this method to subscribe to decoded audio data if you want to use external rendering.
-     *        - After you call this method, the [onRenderAudioFrame](docs-player-android-api-callback#VeLivePlayerObserver-onrenderaudioframe) callback is triggered once the SDK receives an audio frame. The callback contains detailed information about the audio frame.
-     *        - If you use external rendering, you need to make sure the video and audio are synchronized.
-     * @order 15
-     *
-     * @param enable Whether to enable the audio frame callback. The default value is `false`. <br>
-     *                - true: Enable;
-     *                - false: Disable.
-     * @param enableRendering Whether to enable player rendering. The default value is `false`. <br>
-     *                         - true: Enable;
-     *                         - false: Disable.
-     * @param bufferType Audio buffer type. For details, please refer to [VeLivePlayerAudioBufferType](docs-player-android-api-keytype#VeLivePlayerAudioBufferType).
-     *
-     */
-    enableAudioFrameObserver(enable: boolean, enableRendering: boolean, bufferType: VeLivePlayerAudioBufferType): void;
-    
-    /** {en}
-     * @detail api
-     * @brief Sets the clockwise rotation angle of the video.
-     * @param rotation The clockwise rotation angle of the video. Rotation is disabled by default. See VeLivePlayerRotation{@link #VeLivePlayerRotation} for details.
-     * @notes  <br>
-     *       - You can change the rotation angle before and during playback.
-     *       - Each time this method is called, the player rotates the video based on the original video.
-     *       - When you apply both rotation and mirroring to the video, the player will mirror the video and then rotate it.
-     * @order 16
-     *
-     */
-    setRenderRotation(rotation: VeLivePlayerRotation): Promise<void>;
-    
-    /** {en}
-     * @detail api
-     * @brief Configures mirroring settings.
-     * @param mirror Mirroring settings. Mirroring is disabled by default. See VeLivePlayerMirror{@link #VeLivePlayerMirror} for details.
-     * @notes  <br>
-     *       - You can change the mirroring settings before and during playback.
-     *       - Each time this method is called, the player applies the mirroring settings to the original video.
-     *       - When you apply both rotation and mirroring to the video, the player will mirror the video and then rotate it.
-     * @order 17
-     *
-     */
-    setRenderMirror(mirror: VeLivePlayerMirror): Promise<void>;
-    
-    /** {en}
-     * @detail api
-     * @brief Enables or disables super resolution. You must first contact BytePlus [technical support](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to activate the feature before using it.
-     * @param enable Whether to enable super resolution. The default value is false.
-     *        - true: enable;
-     *        - false: disable.
-     * @notes
-     *        - Call this method after receiving the [onFirstVideoFrameRender](docs-player-android-api-callback#VeLivePlayerObserver-onfirstvideoframerender) callback, or during playback.
-     *        - Support dynamically enabling and disabling super-resolution by calling this interface during playback.
-     *        - If the SDK fails to enable super resolution due to device model, video resolution or frame rate, you will receive the [onStreamFailedOpenSuperResolution](docs-player-android-api-callback#VeLivePlayerObserver-onstreamfailedopensuperresolution) callback.
-     * @order 18
-     *
-     */
-    setEnableSuperResolution(enable: boolean): void;
-    
-    /** {en}
-     * @brief Set whether to enable video sharpening.
-     * @param enable Set whether to enable video sharpening. The default value is `false`.
-     *        - true: Enable;
-     *        - false: Disable.
-     *
-     */
-    setEnableSharpen(enable: boolean): void;
-    addExtraHttpRequestHeadersByUser(headers: Map): void;
-}

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

@@ -1,206 +0,0 @@
-import { VeLivePlayer } from './api';
-import { VeLivePlayerError } from './errorcode';
-import { long, int, String, Bitmap } from './types';
-import { VeLivePlayerResolution, VeLivePlayerResolutionSwitchReason, VeLivePlayerStreamType, VeLivePlayerStatus, VeLivePlayerStatistics, VeLivePlayerVideoFrame, VeLivePlayerAudioFrame } from './keytype';
-export declare class 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: long): 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: long): 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](docs-player-android-api-keytype#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: int, height: int): void;
-    
-    /** {en}
-     * @detail callback
-     * @brief String SEI message callback. This callback is triggered when the player SDK receives an SEI message. It is necessary to enable the `enableSei` property in `VeLivePlayerConfiguration`. When the `enableBinarySei` property is enabled, the string SEI message will no longer be sent.
-     * @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 Binary SEI message callback. This callback is triggered when the player SDK receives an SEI message. It is necessary to enable the `enableBinarySei` property in `VeLivePlayerConfiguration`. When the `enableBinarySei` property is enabled, the string SEI message will no longer be sent.
-     * @param player The player object that triggers the callback function.
-     * @param message The SEI message.
-     * @order 10
-     *
-     */
-    onReceiveBinarySeiMessage?(player: VeLivePlayer, message: ArrayBuffer): 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 snapshot{@link #VeLivePlayer#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: Bitmap): void;
-    
-    /** {en}
-     * @detail callback
-     * @brief Occurs when the player decodes a video frame. Call [enableVideoFrameObserver](docs-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 enableAudioFrameObserver{@link #VeLivePlayer#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 setEnableSuperResolution{@link #VeLivePlayer#setEnableSuperResolution} is called.
-     * @order 17
-     * @param player The player object that triggers the callback function.
-     * @param error The reason of the failure. See [VeLivePlayerErrorCode](docs-player-android-api-errorcode#VeLivePlayerErrorCode) for details.
-     *
-     */
-    onStreamFailedOpenSuperResolution?(player: VeLivePlayer, error: VeLivePlayerError): void;
-    
-    /** {en}
-     * @detail callback
-     * @brief Occurs when the SDK fails to enable sharpen after [setEnableSuperResolution](docs-player-android-api-reference#VeLivePlayer-setenablesuperresolution) is called.
-     * @param player The player object that triggers the callback function.
-     * @param error The reason of the failure. See [VeLivePlayerErrorCode](docs-player-android-api-errorcode#VeLivePlayerErrorCode) for details.
-     * @order 18
-     *
-     */
-    onStreamFailedOpenSharpen?(player: VeLivePlayer, error: VeLivePlayerError): void;
-}