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

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

@@ -1,241 +1,695 @@
 import { BOOL, NSInteger, NSString, int, CMTime, NSData, int64_t, CVPixelBufferRef, CMSampleBufferRef, NSArray, NSURL, long, float } from './types';
 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:](docs-player-sdk-for-ios-api#TVLManager(VeLivePlayer)-switchresolution) is called.
+     *
+     */
     VeLivePlayerResolutionSwitchByManual = 1
 }
 export declare class VeLivePlayerConfiguration {
     
+    /** {en}
+     * @brief Whether to enable the parsing of string SEI messages. The default value is `NO`.<br/>
+     *        - YES: Enable;
+     *        - NO: Disable.
+     */
     enableSei: BOOL;
     
+    /** {en}
+     * @brief Whether to enable the parsing of binary SEI messages. The default value is `NO`.<br/>
+     *        - YES: Enable;
+     *        - NO: Disable.
+     * @notes After binary SEI is enabled, callbacks for string SEI will no longer be sent.
+     */
+    enableBinarySei: BOOL;
+    
+    /** {en}
+     * @brief Whether to turn on hardware decoding. The default value is `YES`. 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>
+     *       - YES: Enable;
+     *       - NO: Disable.
+     */
     enableHardwareDecode: BOOL;
     
+    /** {en}
+     * @brief Whether to enable local DNS prefetch. The default value is `NO`. 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>
+     *       - YES: Enable;
+     *       - NO: Disable.
+     */
     enableLiveDNS: BOOL;
     
+    /** {en}
+     * @brief Whether to enable periodic callbacks for playback information. The default value is `NO`. Refer to [VeLivePlayerStatistics](#VeLivePlayerStatistics) for more information on callback statistics. If `enableStatisticsCallback` is `YES` and [statisticsCallbackInterval](#VeLivePlayerConfiguration-statisticscallbackinterval) is greater than `0`, the player will periodically report the player status information after the specified time interval.<br/>
+     *        - YES: Enable;
+     *        - NO: Disable.
+     */
     enableStatisticsCallback: BOOL;
     
+    /** {en}
+     * @brief The time interval for periodic callbacks that provide playback information, in seconds. The default value is `5`. If enableStatisticsCallback is `YES` and [enableStatisticsCallback](#VeLivePlayerConfiguration-enablestatisticscallback) is greater than `0`, the player will periodically report the player status information after the specified time interval.
+     */
     statisticsCallbackInterval: NSInteger;
     
+    /** {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 to have failed.
+     */
     networkTimeoutMs: NSInteger;
     
+    /** {en}
+     * @brief Retry interval, in ms. The default value is 5000 and it is only effective when there is no backup stream.
+     *        - In scenarios without a backup stream, if playback is interrupted due to issues such as network anomalies, the player will immediately retry. The first three retries are executed immediately, and the fourth and subsequent retries will be executed according to the set retry interval.
+     *        - In scenarios with a backup stream, the retry interval will not take effect and all retries will be executed immediately.
+     */
     retryIntervalTimeMs: NSInteger;
     
+    /** {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 a scenario without backup streams, each retry consumes one retry attempt.
+     *        - In a scenario with backup streams, each primary-backup stream switch consumes one retry attempt.
+     */
     retryMaxCount: NSInteger;
     
+    /** {en}
+     * @brief Initializes the configurations.
+     */
     init(): this;
 }
 export declare class VeLivePlayerStream {
     
+    /** {en}
+     * @brief The pull stream address.
+     */
     url: NSString;
     
+    /** {en}
+     * @brief The resolution. See [VeLivePlayerResolution](#VeLivePlayerResolution) for details.
+     */
     resolution: VeLivePlayerResolution;
     
+    /** {en}
+     * @brief The playback bitrate, in bps.
+     */
     bitrate: int;
     
+    /** {en}
+     * @brief The transmission protocol. See [VeLivePlayerProtocol](#VeLivePlayerProtocol) for details.
+     */
     protocol: VeLivePlayerProtocol;
     
+    /** {en}
+     * @brief The video format. See [VeLivePlayerFormat](#VeLivePlayerFormat) for details.
+     */
     format: VeLivePlayerFormat;
     
+    /** {en}
+     * @brief Whether the stream is a primary or a backup stream. See [VeLivePlayerStreamType](#VeLivePlayerStreamType) for details.
+     */
     type: VeLivePlayerStreamType;
     
+    /** {en}
+     * @brief Initializes a pull stream address.
+     */
     init(): this;
 }
 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: CMTime;
     
+    /** {en}
+     * @brief The PCM audio data.
+     */
     data: NSData;
     
+    /** {en}
+     * @brief The number of audio samples.
+     */
     samples: int;
     init(): this;
 }
 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: NSInteger;
     
+    /** {en}
+     * @brief The video height, in pixels.
+     */
     height: NSInteger;
     
+    /** {en}
+     * @brief The timestamp indicating the time when the video frame is rendered, in milliseconds.
+     */
     pts: int64_t;
     
+    /** {en}
+     * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypePixelBuffer`.
+     */
     pixelBuffer: CVPixelBufferRef;
     
+    /** {en}
+     * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeSampleBuffer`.
+     */
     sampleBuffer: CMSampleBufferRef;
     
+    /** {en}
+     * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeNSData`.
+     */
     data: NSData;
     init(): this;
 }
+export declare enum VeLivePlayerSupportResolutionSwitchError {
+    
+    /** {en}
+     * @brief The corresponding resolution gear is not found.
+     *
+     */
+    VeLivePlayerErrorResNotFound = -1,
+    
+    /** {en}
+     * @brief The same as the current resolution level.
+     *
+     */
+    VeLivePlayerErrorSameRes = -2,
+    
+    /** {en}
+     * @brief The player status is not in the prepare state.
+     *
+     */
+    VeLivePlayerErrorStatusInvalid = -3,
+    
+    /** {en}
+     * @brief Resolution level error.
+     *
+     */
+    VeLivePlayerErrorInvalidRes = -4,
+    
+    /** {en}
+     * @brief Configuration not supported.
+     *
+     */
+    VeLivePlayerErrorConfigNotSupport = -5,
+    
+    /** {en}
+     * @brief Format not supported.
+     *
+     */
+    VeLivePlayerErrorFormatNotSupport = -6
+}
 export declare class VeLivePlayerStreamData {
     
+    /** {en}
+     * @brief Whether to enable adaptive bitrate (ABR). The default value is `NO`. <br>
+     *      - YES: Enable;
+     *      - NO: Disable.
+     */
     enableABR: BOOL;
     
+    /** {en}
+     * @brief Whether to enable switching between the primary and the backup stream. The default value is `NO`. <br>
+     *      - YES: Enable;
+     *      - NO: Disable.
+     */
     enableMainBackupSwitch: BOOL;
     
+    /** {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](#VeLivePlayerStream) for details.
+     */
     mainStream: NSArray<VeLivePlayerStream>;
     
+    /** {en}
+     * @brief A list of backup stream addresses. See [VeLivePlayerStream](#VeLivePlayerStream) for details.
+     */
     backupStream: NSArray<VeLivePlayerStream>;
     init(): this;
 }
 export declare enum VeLivePlayerAudioBufferType {
     
+    /** {en}
+     * @brief Unknown format.
+     *
+     */
     VeLivePlayerAudioBufferUnknown = 0,
     
+    /** {en}
+     * @brief CVSampleBufferRef. The audio data is processed and rendered as sample buffers.
+     *
+     */
     VeLivePlayerAudioBufferTypeSampleBuffer = 1,
     
+    /** {en}
+     * @brief NSData. The audio data is processed and rendered as NSData objects.
+     *
+     */
     VeLivePlayerAudioBufferTypeNSData = 2
 }
 export declare enum VeLivePlayerVideoBufferType {
     
+    /** {en}
+     * @brief Unknown format.
+     *
+     */
     VeLivePlayerVideoBufferTypeUnknown = 0,
     
+    /** {en}
+     * @brief CVPixelBufferRef.
+     *
+     */
     VeLivePlayerVideoBufferTypePixelBuffer = 1,
     
+    /** {en}
+     * @brief CVSampleBufferRef.
+     *
+     */
     VeLivePlayerVideoBufferTypeSampleBuffer = 2,
     
+    /** {en}
+     * @brief NSData.
+     *
+     */
     VeLivePlayerVideoBufferTypeNSData = 3
 }
 export declare enum VeLivePlayerProtocol {
     
+    /** {en}
+     * @brief TCP.
+     *
+     */
     VeLivePlayerProtocolTCP = 0,
     
+    /** {en}
+     * @brief QUIC.
+     *
+     */
     VeLivePlayerProtocolQUIC = 1,
     
-    VeLivePlayerProtocolTLS = 2
+    /** {en}
+     * @brief TLS.
+     *
+     */
+    VeLivePlayerProtocolTLS = 2,
+    
+    /** {en}
+     * @brief HTTP。
+     *
+     */
+    VeLivePlayerProtocolHTTP2 = 3
 }
 export declare enum VeLivePlayerFillMode {
     
+    /** {en}
+     * @brief Uniformly scale the video until the screen is completely filled. Part of the video may be cropped.
+     *
+     */
     VeLivePlayerFillModeAspectFill = 0,
     
+    /** {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 = 1,
     
+    /** {en}
+     * @brief Stretch the video to fill the screen. The aspect ratio of the video might change.
+     *
+     */
     VeLivePlayerFillModeFullFill = 2
 }
 export declare enum VeLivePlayerRotation {
     
+    /** {en}
+     * @brief No rotation.
+     *
+     */
     VeLivePlayerRotation0 = 0,
     
+    /** {en}
+     * @brief Rotate 90 degrees clockwise.
+     *
+     */
     VeLivePlayerRotation90 = 90,
     
+    /** {en}
+     * @brief Rotate 180 degrees clockwise.
+     *
+     */
     VeLivePlayerRotation180 = 180,
     
+    /** {en}
+     * @brief Rotate 270 degrees clockwise.
+     *
+     */
     VeLivePlayerRotation270 = 270
 }
 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 VeLivePlayerPixelFormat {
     
+    /** {en}
+     * @brief Unknown format.
+     *
+     */
     VeLivePlayerPixelFormatUnknown = 0,
     
+    /** {en}
+     * @brief NV12.
+     *
+     */
     VeLivePlayerPixelFormatNV12 = 1,
     
+    /** {en}
+     * @brief YUVI420.
+     *
+     */
     VeLivePlayerPixelFormatI420 = 2,
     
+    /** {en}
+     * @brief BGRA.
+     *
+     */
     VeLivePlayerPixelFormatBGRA32 = 3
 }
 export declare enum VeLivePlayerStatus {
     
+    /** {en}
+     * @brief The player finishes preparing and is waiting to render the video.
+     *
+     */
     VeLivePlayerStatusPrepared = 0,
     
+    /** {en}
+     * @brief Playback is currently in progress, meaning that the first frame has been rendered and no errors have occurred to the player.
+     *
+     */
     VeLivePlayerStatusPlaying = 1,
     
+    /** {en}
+     * @brief The playback is paused.
+     *
+     */
     VeLivePlayerStatusPaused = 2,
     
+    /** {en}
+     * @brief The playback is stopped.
+     *
+     */
     VeLivePlayerStatusStopped = 3,
     
+    /** {en}
+     * @brief An error has occurred to the player.
+     *
+     */
     VeLivePlayerStatusError = 4
 }
 export declare class VeLivePlayerStatistics {
     
+    /** {en}
+     * @brief The current pull stream address.
+     */
     url: NSURL;
     
+    /** {en}
+     * @brief Whether hardware decoding is used. <br>
+     *      - YES: Hardware decoding is used;
+     *      - NO: Hardware decoding is not used.
+     */
     isHardWareDecode: BOOL;
     
+    /** {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: int;
     
+    /** {en}
+     * @brief The cumulative duration of stutters that occurred since the beginning of playback, in milliseconds.
+     */
     stallTimeMs: int;
     
+    /** {en}
+     * @brief The estimated bandwidth, in kbps.
+     */
     bandwidthEstimation: long;
     
+    /** {en}
+     * @brief The encoding format of the video.
+     */
     videoCodec: NSString;
     
+    /** {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: VeLivePlayerFormat;
     
+    /** {en}
+     * @brief The transmission protocol of the live stream.
+     */
     protocol: VeLivePlayerProtocol;
     init(): this;
 }
+export declare enum VeLivePlayerType {
+    
+    /** {en}
+     * @brief Custom player.
+     *
+     */
+    VeLivePlayerTypeOwn = 0,
+    
+    /** {en}
+     * @brief System player.
+     *
+     */
+    VeLivePlayerTypeSystem = 1
+}
 export declare enum VeLivePlayerStreamType {
     
+    /** {en}
+     * @brief The primary stream.
+     *
+     */
     VeLivePlayerStreamTypeMain = 0,
     
+    /** {en}
+     * @brief The backup stream.
+     *
+     */
     VeLivePlayerStreamTypeBackup = 1
 }
 export declare enum VeLivePlayerFormat {
     
+    /** {en}
+     * @brief FLV.
+     *
+     */
     VeLivePlayerFormatFLV = 0,
     
+    /** {en}
+     * @brief HLS.
+     *
+     */
     VeLivePlayerFormatHLS = 1,
     
+    /** {en}
+     * @brief Real Time Media (RTM).
+     *
+     */
     VeLivePlayerFormatRTM = 2
 }
 export declare enum VeLivePlayerResolution {
     
+    /** {en}
+     * @brief Original.
+     *
+     */
     VeLivePlayerResolutionOrigin = 0,
     
+    /** {en}
+     * @brief Ultra high definition (UHD).
+     *
+     */
     VeLivePlayerResolutionUHD = 1,
     
-    VeLivePlayerResolutionHD = 2,
-    
-    VeLivePlayerResolutionSD = 3,
-    
-    VeLivePlayerResolutionLD = 4
+    /** {en}
+     * @brief Full High definition (FHD).
+     *
+     */
+    VeLivePlayerResolutionFHD = 2,
+    
+    /** {en}
+     * @brief High definition (HD).
+     *
+     */
+    VeLivePlayerResolutionHD = 3,
+    
+    /** {en}
+     * @brief Standard definition (SD).
+     *
+     */
+    VeLivePlayerResolutionSD = 4,
+    
+    /** {en}
+     * @brief Low definition (LD).
+     *
+     */
+    VeLivePlayerResolutionLD = 5,
+    
+    /** {en}
+     * @hidden (iOS)
+     *
+     */
+    VeLivePlayerResolutionMD = 6,
+    
+    /** {en}
+     * @hidden (iOS)
+     *
+     */
+    VeLivePlayerResolutionAO = 7,
+    
+    /** {en}
+     * @brief Auto.
+     *
+     */
+    VeLivePlayerResolutionAUTO = 8
 }