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

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

@@ -1,261 +1,749 @@
 import { int, String, List, long, float, ByteBuffer, EGLContext } from './types';
 export declare enum VeLivePlayerResolution {
     
-    VeLivePlayerResolutionOrigin = 0,
-    
-    VeLivePlayerResolutionUHD = 1,
-    
-    VeLivePlayerResolutionHD = 2,
-    
-    VeLivePlayerResolutionSD = 3,
-    
-    VeLivePlayerResolutionLD = 4
+    /** {en}
+     * @brief Original.
+     *
+     */
+    VeLivePlayerResolutionOrigin = "origin",
+    
+    /** {en}
+     * @brief Ultra high definition (UHD).
+     *
+     */
+    VeLivePlayerResolutionUHD = "uhd",
+    
+    /** {en}
+     * @brief High definition (HD).
+     *
+     */
+    VeLivePlayerResolutionHD = "hd",
+    
+    /** {en}
+     * @brief Standard definition (SD).
+     *
+     */
+    VeLivePlayerResolutionSD = "sd",
+    
+    /** {en}
+     * @brief Low definition (LD).
+     *
+     */
+    VeLivePlayerResolutionLD = "ld",
+    
+    /** {en}
+     * @brief AO pure audio stream.
+     * @hidden (Android)
+     *
+     */
+    VeLivePlayerResolutionAO = "ao"
 }
 export declare class VeLivePlayerConfiguration {
     
+    /** {en}
+     * @brief Whether to enable the parsing of string SEI messages. The default value is `false`.<br/>
+     *        - true: Enable;
+     *        - false: Disable.
+     *
+     */
     enableSei: boolean;
     
+    /** {en}
+     * @brief Whether to enable the parsing of binary SEI messages. The default value is `false`. <br>
+     *       - true: Enable;
+     *       - false: Disable.
+     * @notes After binary SEI is enabled, callbacks for string SEI will no longer be sent.
+     *
+     */
+    enableBinarySei: boolean;
+    
+    /** {en}
+     * @brief Whether to turn on hardware decoding. The default value is `true`. When hardware decoding is enabled, if the player fails to start hardware decoding or if hardware decoding fails, the player automatically switches to software decoding. <br>
+     *       - true: Enable;
+     *       - false: Disable.
+     *
+     */
     enableHardwareDecode: boolean;
     
+    /** {en}
+     * @brief Network timeout duration, in milliseconds. The default value is `5000`. Once the player sends a network request, if the player does not receive a response from the server after the timeout duration, the network request is considered failed.
+     *
+     */
     networkTimeoutMs: int;
     
+    /** {en}
+     * @brief The retry time interval, in milliseconds. The default value is `5000`. This variable takes effect only when there is no backup stream.<br>
+     *     - In the absence of a backup stream, if playback is interrupted due to network issues or other anomalies, the player will immediately initiate a retry. The player will make the first three retries immediately without any waiting time. However, for subsequent retries starting from the fourth attempt, the player will wait for the specified time interval between each attempt.
+     *     - In the presence of a backup stream, the time interval will not take effect because all retries will be executed immediately without any waiting time.
+     *
+     */
     retryIntervalTimeMs: int;
     
+    /** {en}
+     * @brief In the case of a network connection error, the maximum number of automatic retries of the player. The default value is `5`. If the value is `0`, the player will not automatically retry.<br>
+     *     - In the absence of a backup stream, each retry will count as one retry attempt.
+     *     - In the presence of a backup stream, each switch between the primary stream and the backup stream will count as a retry attempt.
+     *
+     */
     retryMaxCount: int;
     
+    /** {en}
+     * @brief Whether to enable local DNS prefetch. The default value is `false`. Enabling local DNS prefetch can reduce the time required to start playback. If an abnormality occurs with local DNS prefetch, the player may not function properly. <br>
+     *       - true: Enable;
+     *       - false: Disable.
+     *
+     */
     enableLiveDNS: boolean;
     
+    /** {en}
+     * @brief Whether to enable periodic callbacks for playback information. The default value is `false`. Refer to [VeLivePlayerStatistics](#VeLivePlayerStatistics) for more information on callback statistics. If `enableStatisticsCallback` is `true` and [statisticsCallbackInterval](#VeLivePlayerConfiguration-statisticscallbackinterval) is greater than `0`, the player will periodically report the player status information after the specified time interval.<br/>
+     *        - true: Enable;
+     *        - false: Disable.
+     *
+     */
     enableStatisticsCallback: boolean;
     
+    /** {en}
+     * @brief The time interval for periodic callbacks that provide playback information, in seconds. The default value is `5`. If [enableStatisticsCallback](#VeLivePlayerConfiguration-enablestatisticscallback) is `true` and `statisticsCallbackInterval` is greater than `0`, the player will periodically report the player status information after the specified time interval.
+     *
+     */
     statisticsCallbackInterval: int;
 }
 export declare enum VeLivePlayerFormat {
     
+    /** {en}
+     * @brief FLV.
+     *
+     */
     VeLivePlayerFormatFLV = 0,
     
+    /** {en}
+     * @brief HLS.
+     *
+     */
     VeLivePlayerFormatHLS = 1,
     
-    VeLivePlayerFormatRTM = 2
+    /** {en}
+     * @brief Real Time Media (RTM).
+     *
+     */
+    VeLivePlayerFormatRTM = 2,
+    
+    /** {en}
+     * @brief CMAF format
+     *
+     */
+    VeLivePlayerFormatCMAF = 3
 }
 export declare enum VeLivePlayerProtocol {
     
+    /** {en}
+     * @brief TCP.
+     *
+     */
     VeLivePlayerProtocolTCP = 0,
     
+    /** {en}
+     * @brief QUIC.
+     *
+     */
     VeLivePlayerProtocolQUIC = 1,
     
-    VeLivePlayerProtocolTLS = 2
+    /** {en}
+     * @brief TLS.
+     *
+     */
+    VeLivePlayerProtocolTLS = 2,
+    
+    /** {en}
+     * @brief HTTP2.0 protocol
+     *
+     */
+    VeLivePlayerProtocolHTTP2 = 3
 }
 export declare enum VeLivePlayerMirror {
     
+    /** {en}
+     * @brief No mirroring.
+     *
+     */
     VeLivePlayerMirrorNone = 0,
     
+    /** {en}
+     * @brief Horizontal mirroring.
+     *
+     */
     VeLivePlayerMirrorHorizontal = 1,
     
+    /** {en}
+     * @brief Vertical mirroring.
+     *
+     */
     VeLivePlayerMirrorVertical = 2
 }
 export declare enum VeLivePlayerVideoBufferType {
     
+    /** {en}
+     * @brief Unknown format.
+     *
+     */
     VeLivePlayerVideoBufferTypeUnknown = 0,
     
+    /** {en}
+     * @brief ByteBuffer.
+     *
+     */
     VeLivePlayerVideoBufferTypeByteBuffer = 1,
     
+    /** {en}
+     * @brief ByteArray.
+     *
+     */
     VeLivePlayerVideoBufferTypeByteArray = 2,
     
+    /** {en}
+     * @brief Texture.
+     *
+     */
     VeLivePlayerVideoBufferTypeTexture = 3
 }
 export declare enum VeLivePlayerStatus {
     
+    /** {en}
+     * @brief The playback is stopped.
+     *
+     */
     VeLivePlayerStatusStopped = 0,
     
+    /** {en}
+     * @brief The playback is paused.
+     *
+     */
     VeLivePlayerStatusPaused = 1,
     
+    /** {en}
+     * @brief The player finishes preparing and is waiting to render the video.
+     *
+     */
     VeLivePlayerStatusPrepared = 2,
     
+    /** {en}
+     * @brief Playback is currently in progress, meaning that the first frame has been rendered and no errors have occurred to the player.
+     *
+     */
     VeLivePlayerStatusPlaying = 3,
     
+    /** {en}
+     * @brief An error has occurred to the player.
+     *
+     */
     VeLivePlayerStatusError = 4
 }
 export declare class VeLivePlayerLogConfig {
     
+    /** {en}
+     * @brief The log file directory path. The default value is `/cache/Log`.
+     *
+     */
     logPath: String;
     
+    /** {en}
+     * @brief The maximum size of log files, in MB. The default value is `100`.
+     *
+     */
     maxLogSizeM: int;
     
+    /** {en}
+     * @brief The size of a single log file, in MB. The default value is `2`.
+     *
+     */
     singleLogSizeM: int;
     
+    /** {en}
+     * @brief  The log expiration time, in seconds. Once a log file expires, a new log file will be created and the existing file will be deleted. The default value is `604800`, or seven days.
+     *
+     */
     logExpireTimeS: int;
     
+    /** {en}
+     * @brief Whether to print log in the console. The default value is `true`.
+     *
+     */
     enableConsole: boolean;
     
+    /** {en}
+     * @brief Whether to save log to a file. The default value is `true`.
+     *
+     */
     enableLogFile: boolean;
     
+    /** {en}
+     * @brief The upload URL of the log file.
+     *
+     */
     queryUrl: String;
     
+    /** {en}
+     * @brief Whether to enable thread polling. <br>
+     *      - `true`: Enable
+     *      - `false`: Disable
+     *
+     */
     enableThreadLoop: boolean;
     
+    /** {en}
+     * @brief The polling interval, in milliseconds. The value should be greater than 0.
+     *
+     */
     intervalMS: int;
     
+    /** {en}
+     * @brief The timeout for an HTTP request. Value range: > 0.
+     *
+     */
     httpTimeoutMS: int;
     
+    /** {en}
+     * @brief The timeout for an HTTP request to upload a file. Value range: > 0.
+     *
+     */
     httpUploadFileTimeoutMS: int;
     
+    /** {en}
+     * @brief The output log level. The default value is `VeLivePlayerLogLevelDebug`. For details, see [VeLivePlayerLogLevel](#VeLivePlayerLogLevel).
+     *
+     */
     logLevel: VeLivePlayerLogLevel;
 }
 export declare class VeLivePlayerStreamData {
     
+    /** {en}
+     * @brief Whether to enable adaptive bitrate (ABR). The default value is `false`. <br>
+     *      - true: Enable;
+     *      - false: Disable.
+     *
+     */
     enableABR: boolean;
     
+    /** {en}
+     * @brief Whether to enable switching between primary and backup streams. The default value is `false`. <br>
+     *      - true: Enable;
+     *      - false: Disable.
+     *
+     */
     enableMainBackupSwitch: boolean;
     
+    /** {en}
+     * @brief The default resolution. The default value is `VeLivePlayerResolutionOrigin`, which indicates the original resolution. See [VeLivePlayerResolution](#VeLivePlayerResolution) for details.
+     *
+     */
     defaultResolution: VeLivePlayerResolution;
     
+    /** {en}
+     * @brief The default video format. The default value is `VeLivePlayerFormatFLV`. See [VeLivePlayerFormat](#VeLivePlayerFormat) for details.
+     *
+     */
     defaultFormat: VeLivePlayerFormat;
     
+    /** {en}
+     * @brief The default transmission protocol. The default value is `VeLivePlayerProtocolTCP`. See [VeLivePlayerProtocol](#VeLivePlayerProtocol) for details.
+     *
+     */
     defaultProtocol: VeLivePlayerProtocol;
     
+    /** {en}
+     * @brief A list of main stream addresses. See [VeLivePlayerStream](#VeLivePlayerStreamData-VeLivePlayerStream) for details.
+     *
+     */
     mainStreamList: List<VeLivePlayerStream>;
     
+    /** {en}
+     * @brief A list of backup stream addresses. See [VeLivePlayerStream](#VeLivePlayerStreamData-VeLivePlayerStream) for details.
+     *
+     */
     backupStreamList: List<VeLivePlayerStream>;
 }
 export declare enum VeLivePlayerResolutionSwitchReason {
     
+    /** {en}
+     * @brief The resolution is switched automatically through the adaptive bitrate (ABR) feature.
+     *
+     */
     VeLiveplayerResolutionSwitchByAuto = 0,
     
+    /** {en}
+     * @brief The resolution is changed after switchResolution{@link #VeLivePlayer#switchResolution} is called.
+     *
+     */
     VeLiveplayerResolutionSwitchByManual = 1
 }
 export declare class VeLivePlayerStream {
     constructor();
     
+    /** {en}
+     * @brief The pull stream address.
+     *
+     */
     url: String;
     
+    /** {en}
+     * @brief The playback resolution. For details, see [VeLivePlayerResolution](#VeLivePlayerResolution).
+     *
+     */
     resolution: VeLivePlayerResolution;
     
+    /** {en}
+     * @brief The playback bitrate, in Kbps.
+     *
+     */
     bitrate: long;
     
+    /** {en}
+     * @brief The format of the live stream. See [VeLivePlayerFormat](#VeLivePlayerFormat) for details.
+     *
+     */
     format: VeLivePlayerFormat;
     
+    /** {en}
+     * @brief Whether the stream is a main or backup stream. See [VeLivePlayerStreamType](#VeLivePlayerStreamType) for details.
+     *
+     */
     streamType: VeLivePlayerStreamType;
 }
 export declare enum VeLivePlayerFillMode {
     
+    /** {en}
+     * @brief Display the full video. The video is uniformly scaled until one dimension of the video hits the boundary of the screen. Any remaining space on the screen will be filled with black.
+     *
+     */
     VeLivePlayerFillModeAspectFit = 0,
     
+    /** {en}
+     * @brief Stretch the video to fill the screen. The aspect ratio of the video might change.
+     *
+     */
     VeLivePlayerFillModeFullFill = 1,
     
+    /** {en}
+     * @brief Uniformly scale the video until the screen is completely filled. Part of the video may be cropped.
+     *
+     */
     VeLivePlayerFillModeAspectFill = 2
 }
 export declare enum VeLivePlayerPixelFormat {
     
+    /** {en}
+     * @brief Unknown format.
+     *
+     */
     VeLivePlayerPixelFormatUnknown = 0,
     
+    /** {en}
+     * @brief RGBA8888.
+     *
+     */
     VeLivePlayerPixelFormatRGBA32 = 1,
     
+    /** {en}
+     * @brief Texture.
+     *
+     */
     VeLivePlayerPixelFormatTexture = 2
 }
 export declare class VeLivePlayerStatistics {
     constructor();
     
+    /** {en}
+     * @brief The current pull stream address.
+     *
+     */
     url: String;
     
+    /** {en}
+     * @brief Whether hardware decoding is used. <br>
+     *      - true: Hardware decoding is used;
+     *      - false: Hardware decoding is not used.
+     *
+     */
     isHardwareDecode: boolean;
     
+    /** {en}
+     * @brief The encoding format of the video.
+     *
+     */
     videoCodec: String;
     
+    /** {en}
+     * @brief The cumulative duration of stutters that occurred since the beginning of playback, in milliseconds.
+     *
+     */
     stallTimeMs: long;
     
+    /** {en}
+     * @brief Bandwidth estimation, unit is kbps.
+     *
+     */
     bandwidthEstimation: long;
     
+    /** {en}
+     * @brief The current playback latency, in milliseconds. The latency data is available only if you use the BytePlus MediaLive Broadcast SDK to push the live stream.
+     *
+     */
     delayMs: long;
     
+    /** {en}
+     * @brief The width of the video, in pixels.
+     *
+     */
     width: int;
     
+    /** {en}
+     * @brief The height of the video, in pixels.
+     *
+     */
     height: int;
     
+    /** {en}
+     * @brief The frame rate of the video, in fps.
+     *
+     */
     fps: float;
     
+    /** {en}
+     * @brief The downlink bitrate, in Kbps.
+     *
+     */
     bitrate: long;
     
+    /** {en}
+     * @brief The video buffer, in milliseconds.
+     *
+     */
     videoBufferMs: long;
     
+    /** {en}
+     * @brief The audio buffer, in milliseconds.
+     *
+     */
     audioBufferMs: long;
     
+    /** {en}
+     * @brief The video format.
+     *
+     */
     format: String;
     
+    /** {en}
+     * @brief The transmission protocol of the live stream.
+     *
+     */
     protocol: String;
 }
 export declare class VeLivePlayerVideoFrame {
     
+    /** {en}
+     * @brief The encapsulation format. See [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) for details.
+     *
+     */
     bufferType: VeLivePlayerVideoBufferType;
     
+    /** {en}
+     * @brief The pixel format. See [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) for details.
+     *
+     */
     pixelFormat: VeLivePlayerPixelFormat;
     
+    /** {en}
+     * @brief The video width, in pixels.
+     *
+     */
     width: int;
     
+    /** {en}
+     * @brief The video height, in pixels.
+     *
+     */
     height: int;
     
+    /** {en}
+     * @brief The timestamp indicating the time when the video frame is rendered, in milliseconds.
+     *
+     */
     pts: long;
     
+    /** {en}
+     * @brief The texture data for OpenGL rendering. The SDK returns this video data type if you set [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) to `VeLivePlayerPixelFormatTexture` and set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeTexture`. See [VeLivePlayerVideoTexture](#VeLivePlayerVideoTexture) for details.
+     *
+     */
     texture: VeLivePlayerVideoTexture;
     
+    /** {en}
+     * @brief The video data in ByteBuffer format. The SDK returns this video data type if you set [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) to `VeLivePlayerPixelFormatRGBA32` and set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeByteBuffer`.
+     *
+     */
     buffer: ByteBuffer;
     
+    /** {en}
+     * @brief The video data in ByteArray format. The SDK returns this video data type if you set [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) to `VeLivePlayerPixelFormatRGBA32` and set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeByteArray`.
+     *
+     */
     data: ArrayBuffer;
 }
 export declare class VeLivePlayerVideoTexture {
     
+    /** {en}
+     * @brief The video texture ID.
+     *
+     */
     texId: int;
     
+    /** {en}
+     * @brief OpenGL ES context for custom rendering. After you bind EGLContext to GLSurfaceView or TextureView, you can perform custom OpenGL ES rendering on the bound View.
+     *
+     */
     eglContext: EGLContext;
 }
 export declare enum VeLivePlayerStreamType {
     
+    /** {en}
+     * @brief The primary stream.
+     *
+     */
     VeLivePlayerStreamTypeMain = 0,
     
+    /** {en}
+     * @brief The backup stream.
+     *
+     */
     VeLivePlayerStreamTypeBackup = 1
 }
 export declare enum VeLivePlayerLogLevel {
     
+    /** {en}
+     * @brief Output logs at the VERBOSE, DEBUG, INFO, WARNING, and ERROR levels.
+     *
+     */
     VeLivePlayerLogLevelVerbose = 0,
     
+    /** {en}
+     * @brief Output logs at the DEBUG, INFO, WARNING, and ERROR levels.
+     *
+     */
     VeLivePlayerLogLevelDebug = 1,
     
+    /** {en}
+     * @brief Output logs at the INFO, WARNING, and ERROR levels.
+     *
+     */
     VeLivePlayerLogLevelInfo = 2,
     
+    /** {en}
+     * @brief Output logs at the WARNING and ERROR levels.
+     *
+     */
     VeLivePlayerLogLevelWarn = 3,
     
+    /** {en}
+     * @brief Output logs at the ERROR level.
+     *
+     */
     VeLivePlayerLogLevelError = 4,
     
+    /** {en}
+     * @brief Disable log printing.
+     *
+     */
     VeLivePlayerLogLevelNone = 5
 }
 export declare class VeLivePlayerAudioFrame {
     
+    /** {en}
+     * @brief The encapsulation format of the audio data. See [VeLivePlayerAudioBufferType](#VeLivePlayerAudioBufferType) for details.
+     *
+     */
     bufferType: VeLivePlayerAudioBufferType;
     
+    /** {en}
+     * @brief The audio sample rate, in Hz.
+     *
+     */
     sampleRate: int;
     
+    /** {en}
+     * @brief The number of audio channels. <br>
+     *      - 1: Mono;
+     *      - 2: Stereo.
+     *
+     */
     channels: int;
     
+    /** {en}
+     * @brief The audio bit depth.
+     *
+     */
     bitDepth: int;
     
+    /** {en}
+     * @brief The timestamp indicating the time when the audio is rendered, in milliseconds.
+     *
+     */
     pts: long;
     
-    buffer: ArrayBuffer;
-    
+    /** {en}
+     * @brief The PCM audio data. byte[] type.
+     *
+     */
+    bufferArray: ArrayBuffer;
+    
+    /** {en}
+     * @brief The PCM audio data. ByteBuffer[] type.
+     *
+     */
+    buffer: Array<ByteBuffer>;
+    
+    /** {en}
+     * @brief The number of audio samples.
+     *
+     */
     samples: int;
 }
 export declare enum VeLivePlayerAudioBufferType {
     
+    /** {en}
+     * @brief Unknown format.
+     *
+     */
     VeLivePlayerAudioBufferTypeUnknown = 0,
     
+    /** {en}
+     * @brief ByteArray.
+     *
+     */
     VeLivePlayerAudioBufferTypeByteArray = 1
 }
 export declare enum VeLivePlayerRotation {
     
+    /** {en}
+     * @brief No rotation.
+     *
+     */
     VeLivePlayerRotation0 = 0,
     
+    /** {en}
+     * @brief Rotate 90 degrees clockwise.
+     *
+     */
     VeLivePlayerRotation90 = 1,
     
+    /** {en}
+     * @brief Rotate 180 degrees clockwise.
+     *
+     */
     VeLivePlayerRotation180 = 2,
     
+    /** {en}
+     * @brief Rotate 270 degrees clockwise.
+     *
+     */
     VeLivePlayerRotation270 = 3
 }