@byteplus/react-native-live-push 1.0.1 → 1.0.3-rc.0

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

@@ -1,41 +1,183 @@
 import { int, double, String, ArrayList, float, long } from './types';
 export declare class VeLiveVideoEncoderConfiguration {
     
+    /** {en}
+     * @detail api
+     * @brief Gets the video resolution.
+     * @return  <br>
+     *      The video resolution. See VeLiveVideoResolution {@link #VeLiveVideoResolution} for details.
+     *
+     */
     getResolution(): VeLiveVideoResolution;
     
-    setResolution(resolution: VeLiveVideoResolution): VeLiveVideoEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the video resolution.
+     * @param resolution The video resolution. The default value is `VeLiveVideoResolution720P`. See VeLiveVideoResolution {@link #VeLiveVideoResolution} for details.
+     * @return  <br>
+     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     *
+     */
+    setResolution(resolution: VeLiveVideoResolution): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the video codec.
+     * @return  <br>
+     *      The video codec. See VeLiveVideoCodec {@link #VeLiveVideoCodec} for details.
+     *
+     */
     getCodec(): VeLiveVideoCodec;
     
-    setCodec(codec: VeLiveVideoCodec): VeLiveVideoEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the video codec.
+     * @return The video encoding configurations. See [VeLiveVideoEncoderConfiguration](broadcast-sdk-for-android-type-definition#VeLiveVideoEncoderConfiguration) for details.
+     * @param codec <br>The video codec. See [VeLiveVideoCodec](broadcast-sdk-for-android-type-definition#VeLiveVideoCodec) for details.
+     *
+     */
+    setCodec(codec: VeLiveVideoCodec): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Get the encoded video bitrate.
+     * @return  <br>
+     *      The encoded video bitrate.
+     *
+     */
     getBitrate(): int;
     
-    setBitrate(bitrate: int): VeLiveVideoEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the encoded video bitrate.
+     * @param bitrate The encoded video bitrate, in Kbps. The default value depends on the value of the `resolution` parameter.
+     * @return  <br>
+     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     *
+     */
+    setBitrate(bitrate: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the minimum encoded video bitrate.
+     * @return  <br>
+     *      The minimum encoded video bitrate.
+     *
+     */
     getMinBitrate(): int;
     
-    setMinBitrate(minBitrate: int): VeLiveVideoEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the minimum encoded video bitrate.
+     * @param minBitrate The minimum encoded video bitrate, in Kbps, when the adaptive bitrate (ABR) feature is enabled. The default value depends on the value of the `resolution` parameter.
+     * @return  <br>
+     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     *
+     */
+    setMinBitrate(minBitrate: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the maximum encoded video bitrate.
+     * @return  <br>
+     *      The maximum encoded video bitrate.
+     *
+     */
     getMaxBitrate(): int;
     
-    setMaxBitrate(maxBitrate: int): VeLiveVideoEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the maximum encoded video bitrate.
+     * @param maxBitrate The maximum video encoding bitrate, in Kbps, when the adaptive bitrate (ABR) feature is enabled. The default value depends on the value of the `resolution` parameter.
+     * @return  <br>
+     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     *
+     */
+    setMaxBitrate(maxBitrate: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the encoded video GOP size.
+     * @return  <br>
+     *      The encoded video GOP size.
+     *
+     */
     getGopSize(): int;
     
-    setGopSize(gopSize: int): VeLiveVideoEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the encoded video GOP size.
+     * @param gopSize The encoded video GOP size, in seconds. The default value is `2`.
+     * @return  <br>
+     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     *
+     */
+    setGopSize(gopSize: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the encoded frame rate.
+     * @return  <br>
+     *      The encoded frame rate.
+     *
+     */
     getFps(): int;
     
-    setFps(fps: int): VeLiveVideoEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the encoded frame rate.
+     * @param fps The encoded frame rate, in fps. The default value is `15`.
+     * @return  <br>
+     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     *
+     */
+    setFps(fps: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief  Gets whether to enable B frames.
+     * @return  <br>
+     *      Whether to enable B frames. <br>
+     *          - true: Enable;
+     *          - false: Disable.
+     *
+     */
     isEnableBFrame(): boolean;
     
-    setEnableBFrame(enableBFrame: boolean): VeLiveVideoEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets whether to enable B frames.
+     * @param enableBFrame Whether to enable B frames. <br>
+     *                - true: Enable;
+     *                - false: (Default) Disable.
+     * @return  <br>
+     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     *
+     */
+    setEnableBFrame(enableBFrame: boolean): this;
+    
+    /** {en}
+     * @detail api
+     * @brief  Gets whether to enable hardware encoding.
+     * @return  <br>
+     *      Whether to enable hardware encoding. <br>
+     *          - true: Enable;
+     *          - false: Disable.
+     *
+     */
     isEnableAccelerate(): boolean;
     
-    setEnableAccelerate(enableAccelerate: boolean): VeLiveVideoEncoderConfiguration;
+    /** {en}
+     * @detail api
+     * @brief Enables hardware encoding.
+     * @param enableAccelerate Whether to enable hardware encoding. <br>
+     *                - true: (Default) Enable;
+     *                - false: Disable.
+     * @return  <br>
+     *      The video encoding configurations. See VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} for details.
+     *
+     */
+    setEnableAccelerate(enableAccelerate: boolean): this;
 }
 export declare enum VeLiveAudioCodec {
     
@@ -107,9 +249,9 @@ export declare enum VeLiveAudioBufferType {
 }
 export declare enum VeLiveAudioChannel {
     
-    VeLiveAudioChannelMono = 0,
+    VeLiveAudioChannelMono = 1,
     
-    VeLiveAudioChannelStereo = 1
+    VeLiveAudioChannelStereo = 2
 }
 export declare enum VeLiveFirstFrameType {
     
@@ -121,14 +263,6 @@ export declare enum VeLiveFirstFrameType {
     
     VeLiveFirstSendFrame = 3
 }
-export declare enum VeLiveVideoFluencyLevel {
-    
-    VeLiveVideoFluencyLevelSmooth = 0,
-    
-    VeLiveVideoFluencyLevelSluggish = 1,
-    
-    VeLiveVideoFluencyLevelBlocked = 2
-}
 export declare enum VeLiveVideoCaptureType {
     
     VeLiveVideoCaptureFrontCamera = 0,
@@ -163,11 +297,11 @@ export declare enum VeLiveVideoRotation {
     
     VeLiveVideoRotation0 = 0,
     
-    VeLiveVideoRotation90 = 1,
+    VeLiveVideoRotation90 = 90,
     
-    VeLiveVideoRotation180 = 2,
+    VeLiveVideoRotation180 = 180,
     
-    VeLiveVideoRotation270 = 3
+    VeLiveVideoRotation270 = 270
 }
 export declare enum VeLiveVideoFrameSource {
     
@@ -195,13 +329,41 @@ export declare enum VeLiveVideoBufferType {
 }
 export declare class VeLiveAudioCaptureConfiguration {
     
+    /** {en}
+     * @detail api
+     * @brief Gets the sample rate.
+     * @return  <br>
+     *      The sample rate. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
+     *
+     */
     getSampleRate(): VeLiveAudioSampleRate;
     
-    setSampleRate(sampleRate: VeLiveAudioSampleRate): VeLiveAudioCaptureConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the sample rate.
+     * @return <br>The audio capture configurations. See VeLiveAudioCaptureConfiguration for details.
+     * @param sampleRate The sample rate. The default value is `VeLiveAudioSampleRate44100`. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
+     *
+     */
+    setSampleRate(sampleRate: VeLiveAudioSampleRate): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the number of audio channels.
+     * @return  <br>
+     *      The number of audio channels. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
+     *
+     */
     getChannel(): VeLiveAudioChannel;
     
-    setChannel(channel: VeLiveAudioChannel): VeLiveAudioCaptureConfiguration;
+    /** {en}
+     * @detail api
+     * @brief Sets the number of audio channels.
+     * @return <br>The audio capture configurations. See VeLiveAudioCaptureConfiguration for details.
+     * @param channel The number of audio channels. The default value is `VeLiveAudioChannelStereo`. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
+     *
+     */
+    setChannel(channel: VeLiveAudioChannel): this;
 }
 export declare class VeLiveStreamMixDescription {
     
@@ -213,15 +375,15 @@ export declare class VeLiveStreamMixDescription {
 }
 export declare enum VeLiveAudioSampleRate {
     
-    VeLiveAudioSampleRate8000 = 0,
+    VeLiveAudioSampleRate8000 = 8000,
     
-    VeLiveAudioSampleRate16000 = 1,
+    VeLiveAudioSampleRate16000 = 16000,
     
-    VeLiveAudioSampleRate32000 = 2,
+    VeLiveAudioSampleRate32000 = 32000,
     
-    VeLiveAudioSampleRate44100 = 3,
+    VeLiveAudioSampleRate44100 = 44100,
     
-    VeLiveAudioSampleRate48000 = 4
+    VeLiveAudioSampleRate48000 = 48000
 }
 export declare enum VeLiveAudioPowerLevel {
     
@@ -239,17 +401,59 @@ export declare enum VeLiveAudioPowerLevel {
 }
 export declare class VeLiveVideoCaptureConfiguration {
     
+    /** {en}
+     * @detail api
+     * @brief Gets the width of the captured video.
+     * @return  <br>
+     *      The width of the captured video.
+     *
+     */
     getWidth(): int;
     
-    setWidth(width: int): VeLiveVideoCaptureConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the width of the captured video.
+     * @return <br>The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
+     * @param width The width of the captured video. The default value is `720`.
+     *
+     */
+    setWidth(width: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the height of the captured video.
+     * @return  <br>
+     *      The height of the captured video.
+     *
+     */
     getHeight(): int;
     
-    setHeight(height: int): VeLiveVideoCaptureConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the height of the captured video.
+     * @return <br>The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
+     * @param height The height of the captured video. The default value is `1280`.
+     *
+     */
+    setHeight(height: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the captured frame rate.
+     * @return  <br>
+     *      The captured frame rate.
+     *
+     */
     getFps(): int;
     
-    setFps(fps: int): VeLiveVideoCaptureConfiguration;
+    /** {en}
+     * @detail api
+     * @brief Sets the captured frame rate.
+     * @return <br>The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
+     * @param fps The captured frame rate. The default value is `15`.
+     *
+     */
+    setFps(fps: int): this;
 }
 export declare enum VeLivePixelFormat {
     
@@ -319,7 +523,7 @@ export declare enum VeLivePusherLogLevel {
 }
 export declare enum VeLiveAudioBitDepth {
     
-    VeLiveAudioBitDepth16 = 0
+    VeLiveAudioBitDepth16 = 16
 }
 export declare class VeLiveMixAudioLayout {
     
@@ -327,6 +531,12 @@ export declare class VeLiveMixAudioLayout {
     
     volume: float;
     
+    /** {en}
+     * @detail api
+     * @brief Updates audio mixing configurations.
+     * @param other New audio mixing configurations. See VeLiveMixAudioLayout for details.
+     *
+     */
     update(other: VeLiveMixAudioLayout): void;
 }
 export declare enum VeLiveOrientation {
@@ -373,21 +583,77 @@ export declare class VeLivePusherLogConfig {
 }
 export declare class VeLiveFileRecorderConfiguration {
     
+    /** {en}
+     * @detail api
+     * @brief Gets the width of the recorded video.
+     * @return  <br>
+     *      The width of the recorded video.
+     *
+     */
     getWidth(): int;
     
-    setWidth(width: int): VeLiveFileRecorderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the width of the recorded video.
+     * @return <br>The local recording configurations. See VeLiveFileRecorderConfiguration for details.
+     * @param width The width of the recorded video. The default value is `360`.
+     *
+     */
+    setWidth(width: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the height of the recorded video.
+     * @return  <br>
+     *      The height of the recorded video.
+     *
+     */
     getHeight(): int;
     
-    setHeight(height: int): VeLiveFileRecorderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the height of the recorded video.
+     * @return <br>The local recording configurations. See VeLiveFileRecorderConfiguration for details.
+     * @param height The height of the recorded video, the default value is `640`.
+     *
+     */
+    setHeight(height: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the frame rate of the recorded video.
+     * @return  <br>
+     *      The frame rate of the recorded video.
+     *
+     */
     getFps(): int;
     
-    setFps(fps: int): VeLiveFileRecorderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the frame rate of the recorded video.
+     * @return <br>The local recording configurations. See VeLiveFileRecorderConfiguration for details.
+     * @param fps The frame rate of the recorded video. The default value is `15`.
+     *
+     */
+    setFps(fps: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the bitrate of the recorded video.
+     * @return  <br>
+     *      The bitrate of the recorded video.
+     *
+     */
     getBitrate(): int;
     
-    setBitrate(bitrate: int): VeLiveFileRecorderConfiguration;
+    /** {en}
+     * @detail api
+     * @brief Sets the bitrate of the recorded video.
+     * @return <br>The local recording configurations. See VeLiveFileRecorderConfiguration for details.
+     * @param bitrate The bitrate of the recorded video, in Kbps. The default value is `2000`.
+     *
+     */
+    setBitrate(bitrate: int): this;
 }
 export declare class VeLiveMixVideoLayout {
     
@@ -407,22 +673,77 @@ export declare class VeLiveMixVideoLayout {
     
     renderMode: VeLivePusherRenderMode;
     
+    /** {en}
+     * @detail api
+     * @brief Updates video mixing configurations.
+     * @param other New video mixing configurations. See VeLiveMixVideoLayout {@link #VeLiveMixVideoLayout} for details.
+     *
+     */
     update(other: VeLiveMixVideoLayout): void;
 }
 export declare class VeLiveVideoEffectLicenseConfiguration {
     
-    static create_String(path: String): VeLiveVideoEffectLicenseConfiguration;
-    
-    static create_String$String$String(key: String, secret: String, url: String): VeLiveVideoEffectLicenseConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Initializes the license configurations in local authentication mode.
+     * @return <br>A VeLiveVideoEffectLicenseConfiguration object that uses the specified local path for license authentication.
+     * @param path The local cache path for the video effects license. You can get the path through the getPath {@link #getPath} property.
+     *
+     */
+    static create(path: String): VeLiveVideoEffectLicenseConfiguration;
+    
+    /** {en}
+     * @detail api
+     * @brief Initializes the license configurations in local authentication mode.
+     * @return <br>A VeLiveVideoEffectLicenseConfiguration object that uses the specified local path for license authentication.
+     * @param path The local cache path for the video effects license. You can get the path through the getPath {@link #getPath} property.
+     *
+     */
+    static create_key$secret$url(key: String, secret: String, url: String): VeLiveVideoEffectLicenseConfiguration;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the special effects license type.
+     * @return  <br>
+     *      The special effects license type. See VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} for details..
+     *
+     */
     getType(): VeLiveVideoEffectLicenseType;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the local path to the video effects license.
+     * @return  <br>
+     *     The local path to the video effects license, when VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} is `VeLiveVideoEffectLicenseTypeOffLine`.
+     *
+     */
     getPath(): String;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the online authentication key for the video effects licenses.
+     * @return  <br>
+     *     The online authentication key for the video effects license, when VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} is `VeLiveVideoEffectLicenseTypeOnLine`.
+     *
+     */
     getKey(): String;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the online authentication secret for the video effects license.
+     * @return  <br>
+     *     The online authentication secret for the video effects license, when VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} is `VeLiveVideoEffectLicenseTypeOnLine`.
+     *
+     */
     getSecret(): String;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the online authentication address for the video effects license.
+     * @return  <br>
+     *     The online authentication address for the video effects license, when VeLiveVideoEffectLicenseType {@link #VeLiveVideoEffectLicenseType} is `VeLiveVideoEffectLicenseTypeOnLine`.
+     *
+     */
     getUrl(): String;
 }
 export declare enum VeLiveAudioFrameSource {
@@ -433,21 +754,77 @@ export declare enum VeLiveAudioFrameSource {
 }
 export declare class VeLiveAudioEncoderConfiguration {
     
+    /** {en}
+     * @detail api
+     * @brief Gets the audio encoding bitrate.
+     * @return  <br>
+     *      The audio encoding bitrate.
+     *
+     */
     getBitrate(): int;
     
-    setBitrate(bitrate: int): VeLiveAudioEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the audio encoding bitrate.
+     * @return <br>The audio encoding configurations. See VeLiveAudioEncoderConfiguration for details.
+     * @param bitrate The audio encoding bitrate, in Kbps. The default value is `64`.
+     *
+     */
+    setBitrate(bitrate: int): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the encoding sample rate.
+     * @return  <br>
+     *      The encoding sample rate. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
+     *
+     */
     getSampleRate(): VeLiveAudioSampleRate;
     
-    setSampleRate(sampleRate: VeLiveAudioSampleRate): VeLiveAudioEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the encoding sample rate.
+     * @return <br>The audio encoding configurations. See VeLiveAudioEncoderConfiguration for details.
+     * @param sampleRate The encoding sample rate. The default value is `VeLiveAudioSampleRate44100`. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
+     *
+     */
+    setSampleRate(sampleRate: VeLiveAudioSampleRate): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the number of audio channels for streaming.
+     * @return  <br>
+     *      The number of audio channels for streaming. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
+     *
+     */
     getChannel(): VeLiveAudioChannel;
     
-    setChannel(channel: VeLiveAudioChannel): VeLiveAudioEncoderConfiguration;
-    
+    /** {en}
+     * @detail api
+     * @brief Sets the number of audio channels for streaming.
+     * @return <br>The audio encoding configurations. See VeLiveAudioEncoderConfiguration for details.
+     * @param channel The number of audio channels for streaming. The default value is `VeLiveAudioChannelStereo`. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
+     *
+     */
+    setChannel(channel: VeLiveAudioChannel): this;
+    
+    /** {en}
+     * @detail api
+     * @brief Gets the audio encoding format.
+     * @return  <br>
+     *      The audio encoding format. See VeLiveAudioProfile {@link #VeLiveAudioProfile} for details.
+     *
+     */
     getProfile(): VeLiveAudioProfile;
     
-    setProfile(profile: VeLiveAudioProfile): VeLiveAudioEncoderConfiguration;
+    /** {en}
+     * @detail api
+     * @brief Sets the audio encoding format.
+     * @return <br>The audio encoding configurations. See VeLiveAudioEncoderConfiguration for details.
+     * @param profile The audio encoding format. The default value is `VeLiveAudioAACProfileLC`. See VeLiveAudioProfile {@link #VeLiveAudioProfile} for details.
+     *
+     */
+    setProfile(profile: VeLiveAudioProfile): this;
 }
 export declare enum VeLiveAudioMixType {
     

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

@@ -7,11 +7,13 @@ export type double = number;
 export type long = number;
 export type Integer = number;
 export type Double = number;
-export type List<T> = Array<T>;
-export type list<T> = Array<T>;
-export type ArrayList<T> = Array<T>;
-export type Map<K extends keyof any, V> = Record<K, V>;
-export type set<T> = Set<T>;
+export type List<T = any> = Array<T>;
+export type list<T = any> = Array<T>;
+export type ArrayList<T = any> = Array<T>;
+export type Map<K extends keyof any = any, V = any> = Record<K, V>;
+export type HashMap<K extends keyof any = any, V = any> = Record<K, V>;
+export type Pair<K extends keyof any = any, V = any> = Record<K, V>;
+export type set<T = any> = Set<T>;
 export type map = Object;
 export type struct = Object;
 export type Bitmap = unknown;
@@ -26,7 +28,6 @@ export type View = unknown;
 export type Intent = unknown;
 export type Context = unknown;
 export type Bundle = any;
-export type Error = any;
 export type JSONObject = any;
 export type LiveSdkSetting = unknown;
 export type NativeImageResource = unknown;