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

package/lib/commonjs/typescript/codegen/ios/api.d.ts

@@ -4,219 +4,1109 @@ import { VeLiveMediaPlayerListener, VeLiveMediaPlayerFrameListener, VeLivePusher
 import { UIView } from './external';
 export declare class VeLiveFileRecorderManager {
     
+    /** {en}
+     * @detail api
+     * @brief Start live recording.
+     * @notes - Please call [startPush:](#VeLivePusher-startpush) After the stream is successfully pushed, call this method, and the audio & video data during the live broadcast will be saved locally;
+     *          - This method is an asynchronous operation;
+     *          - After starting recording, [onFileRecordingStarted](#docs-broadcast-sdk-for-ios-callbackVeLiveFileRecordingListener-onfilerecordingstarted) callback message;
+     *          - An error in recording will trigger [onFileRecordingError:message:](#docs-broadcast-sdk-for-ios-callbackVeLiveFileRecordingListener-onfilerecordingerror-message) callback message.
+     * @param path The recording file save path cannot be configured for empty
+     * @param config live recording. For details, see [VeLiveFileRecorderConfiguration](docs-broadcast-sdk-for-ios-type-definition#VeLiveFileRecorderConfiguration).
+     * @order 43
+     */
     startRecord(path: NSString, config: VeLiveFileRecorderConfiguration): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stop local live recording.
+     * @notes - Please call this method after calling [startRecord:config:](#VeLiveFileRecorderManager-startrecord-config) successfully starts recording;
+     *          - This method is an asynchronous operation;
+     *          - Stop recording, which will trigger [onFileRecordingStopped](#docs-broadcast-sdk-for-ios-callbackVeLiveFileRecordingListener-onfilerecordingstopped) callback message;
+     *          - An error occurs in the recording, which will trigger [onFileRecordingError:message:](#docs-broadcast-sdk-for-ios-callbackVeLiveFileRecordingListener-onfilerecordingerror-message) callback message.
+     * @order 45
+     */
     stopRecord(): void;
     init(): this;
 }
 export declare class VeLiveCameraDevice {
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether flashlight is supported.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 49
+     * @return - YES: Supported;
+     *         - NO: Not supported.
+     */
     isTorchSupported(): BOOL;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables the flashlight.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 51
+     * @param enable Whether to enable the flashlight.<br>
+     *         - YES: Enable
+     *         - NO: (Default) Disable.
+     * @return - = 0: Success;
+     *         - ≠ 0: Failure.
+     */
     enableTorch(enable: BOOL): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the zoom factor of the camera.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 52
+     * @param ratio The zoom factor. The SDK uses the original size by default. The range of the zoom factor is [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio), [getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)].
+     * @return - = 0: Success;
+     *         - ≠ 0: Failure.
+     */
     setZoomRatio(ratio: float): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the current zoom factor of the camera.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 53
+     * @return - ≤0: The camera does not support zooming;
+     *         - >0: The zoom factor.
+     */
     getCurrentZoomRatio(): float;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the maximum zoom factor of the camera.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 54
+     * @return - ≤0: The camera does not support zooming;
+     *         - >0: The maximum zoom factor.
+     */
     getMaxZoomRatio(): float;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the minimum zoom factor of the camera.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 55
+     * @return - ≤0: The camera does not support zooming;
+     *         - >0: The minimum zoom factor.
+     */
     getMinZoomRatio(): float;
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether autofocus is supported.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 56
+     * @return - YES: Supported;
+     *         - NO: Not supported.
+     */
     isAutoFocusEnabled(): BOOL;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables autofocus.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 57
+     * @param enable Whether to enable autofocus.
+     *      - YES: (Default) Enable;
+     *      - NO: Disable.
+     * @return - =0: Success;
+     *         - ≠0: Failure.
+     */
     enableAutoFocus(enable: BOOL): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the focus position of the camera.
+     * @notes
+     *        Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 58
+     * @param position The coordinate of the focus point from the upper left corner of the current view.
+     * @return - =0: Success;
+     *         - ≠0: Failure.
+     */
     setFocusPosition(position: CGPoint): int;
     
+    /** {en}
+     * @detail api
+     * @brief Checks if manual exposure setting is available for the currently used camera.
+     * @notes You must call [startVideoCapture:](#VeLivePusher-startvideocapture) to start SDK internal video capturing before calling this API.
+     * @order 59
+     * @return - YES: Available.
+     *         - NO: Unavailable.
+     */
     isExposurePositionSupported(): BOOL;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the manual exposure position for the currently used camera.
+     * @param position The position of the exposure point. Setting the upper-left corner of the canvas as the origin, the `x` in `position` means the x-coordinate of the exposure point in range of [0, 1], and the `y` in `position` means the y-coordinate of the exposure point in range of [0, 1].
+     * @notes - You must call [startVideoCapture:](#VeLivePusher-startvideocapture) to start SDK internal video capturing, and use SDK internal rendering before calling this API.
+     *        - When you set the exposure point at the center of the canvas, the exposure point setting will be canceled.
+     *        - The camera exposure point setting will be invalid after calling [stopVideoCapture:](#VeLivePusher-stopvideocapture) to stop internal capturing.
+     * @order 60
+     * @return - =0: Success.
+     *         - ≠0: Failure.
+     */
     setExposurePosition(position: CGPoint): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the exposure compensation for the currently used camera.
+     * @param value The range of the exposure compensation is [[getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation), [getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation)]. Default to 0, which means no exposure compensation.
+     * @notes - You must call [startVideoCapture:](#VeLivePusher-startvideocapture) to start SDK internal video capturing, and use SDK internal rendering before calling this API.
+     *        - The camera exposure compensation setting will be invalid after calling [stopVideoCapture:](#VeLivePusher-stopvideocapture) to stop internal capturing.
+     * @order 61
+     * @return - =0: Success.
+     *         - ≠0: Failure.
+     */
     setExposureCompensation(value: float): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the minimum exposure compensation of the camera.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 62
+     * @return - ≤0: The camera does not support exposure;
+     *         - >0: The minimum exposure compensation.
+     */
     getMinExposureCompensation(): float;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the maximum exposure compensation of the camera.
+     * @notes
+     *        Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 63
+     * @return - ≤0: The camera does not support exposure;
+     *         - >0: The maximum exposure compensation.
+     */
     getMaxExposureCompensation(): float;
     
+    /** {en}
+     * @detail api
+     * @brief Sets camera parameters.
+     * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 64
+     * @param parameter The parameter name (key) and the corresponding value.
+     */
     setParameter(parameter: NSDictionary): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets camera parameters.
+     * @notes
+     *        Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
+     * @order 65
+     * @param key The parameter name.
+     * @return The value of the camera parameter. The data type is determined by the parameter name you set when calling the method.
+     */
     getParameter(key: NSString): id;
     init(): this;
 }
 export declare class VeLiveMediaPlayer {
     
+    /** {en}
+     * @detail api
+     * @brief Sets the file path. Supported file formats include MP3, AAC, M4A, and WAV.
+     * @param url The file path.
+     * @order 1
+     * @return - 0: Success;
+     *         - ≠ 0: Failure.
+     */
     prepare(url: NSString): int;
     
+    /** {en}
+     * @detail api
+     * @brief Destroys the media player instance.
+     * @order 3
+     */
     destroy(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the observer for playback statuses.
+     * @param listener The observer that listens for playback statuses. For details, see [VeLiveMediaPlayerListener](broadcast-sdk-for-ios-callback#VeLiveMediaPlayerListener).
+     * @notes If you make multiple calls to this method, only the last call takes effect.
+     * @order 4
+     */
     setListener(listener: id<VeLiveMediaPlayerListener>): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the observer for audio and video frames.
+     * @param listener The observer that listens for audio and video frames. For details, see [VeLiveMediaPlayerFrameListener](broadcast-sdk-for-ios-callback#VeLiveMediaPlayerFrameListener).
+     * @notes  <br>
+     *      If you make multiple calls to this method, only the last call takes effect.
+     * @order 5
+     */
     setFrameListener(listener: id<VeLiveMediaPlayerFrameListener>): void;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables mixing the audio to the live stream.
+     * @param enable Whether to enable or disable mixing the audio to the live stream. <br>
+     *         - YES: Enable;
+     *         - NO: (Default) Disable.
+     * @order 6
+     */
     enableMixer(enable: BOOL): void;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables automatic volume equalization.
+     * @param sourceLufs The source volume.
+     * @param target The target volume.
+     * @order 7
+     * @param targetLufs The target volume.
+     */
     enableAutoEq(sourceLufs: float, targetLufs: float): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the view for rendering the video. Supports MP4 format.
+     * @param view The view used by the media player to render video.
+     * @order 93
+     */
     setRenderView(view: UIView): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets whether to loop the media file.
+     * @param enable Whether to loop the media file. <br>
+     *                - YES: Loop.
+     *                - NO: (Default) Do not loop.
+     * @order 8
+     */
     enableBGMLoop(enable: BOOL): void;
     
+    /** {en}
+     * @detail api
+     * @brief Starts playback.
+     * @notes
+     *        - This method must be called after you call [prepare:](#VeLiveMediaPlayer-prepare) to set the file path.
+     *        - This method is an asynchronous operation. The media player starts playback when the [onStart](docs-broadcast-sdk-for-ios-callback#VeLiveMediaPlayerListener-onstart) callback is triggered.
+     * @order 9
+     * @return  <br>
+     *         - 0: Success;
+     *         - ≠ 0: Failure.
+     */
     start(): Promise<int>;
     
+    /** {en}
+     * @detail api
+     * @brief Stops playback.
+     * @notes
+     *        This method must be called after you call [start](#VeLiveMediaPlayer-start) to start playback.
+     * @order 10
+     * @return  <br>
+     *         - 0: Success;
+     *         - ≠ 0: Failure.
+     */
     stop(): Promise<int>;
     
+    /** {en}
+     * @detail api
+     * @brief Pauses playback.
+     * @notes
+     *        This method must be called after you call [start](#VeLiveMediaPlayer-start) to start playback.
+     * @order 11
+     */
     pause(): Promise<void>;
     
+    /** {en}
+     * @detail api
+     * @brief Resumes playback.
+     * @notes
+     *        This method must be called after you call [pause](#VeLiveMediaPlayer-pause) to pause playback.
+     * @order 12
+     */
     resume(): Promise<void>;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the playback progress.
+     * @param pos The playback progress, in milliseconds.
+     * @order 13
+     * @return  <br>
+     *         - 0: Success;
+     *         - ≠ 0: Failure.
+     */
     seek(pos: long): int;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the duration of the media file.
+     * @notes
+     *        This method must be called after you call [start](#VeLiveMediaPlayer-start) to start playback.
+     * @order 2
+     * @return  <br>
+     *      - > 0: The duration of the media file, in milliseconds.
+     *      - ≤ 0: Failure.
+     */
     getDuration(): long;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the playback volume.
+     * @param volume The playback volume. The value range is [0.0, 4.0].
+     * @order 14
+     */
     setBGMVolume(volume: float): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the audio capture volume.
+     * @param volume The audio capture volume. The value range is [0.0, 4.0].
+     * @notes
+     *        This method must be called after you call [start](#VeLiveMediaPlayer-start) to start playing background music.
+     * @order 15
+     */
     setVoiceVolume(volume: float): void;
     init(): this;
 }
 export declare class VeLiveAudioDevice {
     
+    /** {en}
+     * @detail api
+     * @brief Sets the volume.
+     * @param level The volume. The value range is [0.0,4.0].
+     * @order 60
+     */
     setVoiceLoudness(level: float): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the current volume.
+     * @order 61
+     * @return  <br>
+     *      The current volume.
+     */
     getVoiceLoudness(): float;
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether in-ear monitoring is supported.
+     * @return  <br>
+     *      - YES: Supported;
+     *      - NO: Not supported.
+     * @order 62
+     */
     isSupportHardwareEcho(): BOOL;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables in-ear monitoring.
+     * @param enable Whether to enable in-ear monitoring. <br>
+     *       - YES: Enable;
+     *       - NO: (Default) Disable.
+     * @notes
+     *        Call this method after calling [startAudioCapture:](#VeLivePusher-startaudiocapture) to start audio capture.
+     * @order 64
+     */
     enableEcho(enable: BOOL): void;
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether in-ear monitoring is enabled.
+     * @notes
+     *        Call this method after calling [startAudioCapture:](#VeLivePusher-startaudiocapture) to start audio capture.
+     * @order 65
+     * @return  <br>
+     *      - YES: Enabled;
+     *      - NO: Disabled.
+     */
     isEnableEcho(): BOOL;
     init(): this;
 }
 export declare class VeLivePusher {
     
+    /** {en}
+     * @detail api
+     * @brief Sets the log level sent to the console.
+     * @param level The log level. See [VeLivePusherLogLevel](broadcast-sdk-for-ios-type-definition#VeLivePusherLogLevel) for details. The default value is 'VeLivePusherLogLevelNone', which means turning off logging.
+     * @order 50
+     */
     static setLogLevel(level: VeLivePusherLogLevel): void;
     
+    /** {en}
+     * @detail api
+     * @param applicationGroupIdentifier iOS app group identifier.
+     * @brief Starts screen capturing.
+     * @order 20
+     */
     startScreenCapture(applicationGroupIdentifier: NSString): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stops the screen capturing process.
+     * @notes  <br>
+     *      This method completely terminates the current screen capture flow and releases associated resources. After calling this method, `pauseScreenCapture` and `resumeScreenCapture` will no longer be effective.
+     * @order 21
+     */
     stopScreenCapture(): void;
+    
+    /** {en}
+     * @detail api
+     * @brief Pauses the screen capturing process.
+     * @notes  <br>
+     *      This method pauses the screen capture without releasing underlying resources.  You can call `resumeScreenCapture` later to resume capturing. If the capture is already stopped or has not been started, calling this method has no effect.
+     * @order 22
+     */
+    pauseScreenCapture(): void;
+    
+    /** {en}
+     * @detail api
+     * @brief Resumes the screen capturing process.
+     * @notes  <br>
+     *      After calling `pauseScreenCapture`, use this method to resume screen capture output. If the capture has already been stopped or never started, calling this method has no effect.
+     * @order 23
+     */
+    resumeScreenCapture(): void;
     init(): this;
     
+    /** {en}
+     * @detail api
+     * @brief Initializes the live pusher.
+     * @param config The pusher configurations. See [VeLivePusherConfiguration](docs-broadcast-sdk-for-ios-type-definition#VeLivePusherConfiguration) for details.
+     * @order 0
+     */
     initWithConfig(config: VeLivePusherConfiguration): this;
     
+    /** {en}
+     * @detail api
+     * @brief Stops capturing and pushing streams and destroys the live pusher. Call this method after [stopPush](#VeLivePusher-stoppush) is called.
+     * @order 2
+     */
     destroy(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets an observer to listen for live pusher events, including errors, statuses, network quality, device information, and first frame rendering.
+     * @param observer The observer. Refer to VeLivePusherObserver {@link #VeLivePusherObserver} for details.
+     * @notes  <br>
+     *      - This method must be called after the live pusher is created;
+     *      - If you make multiple calls to this method, only the last call takes effect.
+     * @order 4
+     */
     setObserver(observer: id<VeLivePusherObserver>): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets an observer to periodically report push-stream statistics.
+     * @param observer The observer. Refer to VeLivePusherStatisticsObserver {@link #VeLivePusherStatisticsObserver} for details.
+     * @param interval The time interval between two callbacks, in seconds. The default value is `5`.
+     * @notes  <br>
+     *      - This method must be called after the live pusher is created;
+     *      - If you make multiple calls to this method, only the last call takes effect.
+     * @order 6
+     */
     setStatisticsObserver(observer: id<VeLivePusherStatisticsObserver>, interval: int): void;
     
+    /** {en}
+     * @detail api
+     * @brief Adds a video frame listener.
+     * @param listener The listener. See VeLiveVideoFrameListener {@link #VeLiveVideoFrameListener} for details.
+     * @order 51
+     * @return  <br>
+     *       - 0: Success;
+     *       - ≠ 0: Failure.
+     */
     addVideoFrameListener(listener: id<VeLiveVideoFrameListener>): int;
     
+    /** {en}
+     * @detail api
+     * @brief Removes the video frame listener.
+     * @param listener The listener. See [VeLiveVideoFrameListener](broadcast-sdk-for-ios-callback#VeLiveVideoFrameListener) for details.
+     * @notes  <br>
+     *    Calling this method will return a failure if the listener has not been added or has been removed.
+     * @order 52
+     * @return  <br>
+     *       - 0: Success;
+     *       - <0: Failure.
+     */
     removeVideoFrameListener(listener: id<VeLiveVideoFrameListener>): int;
     
+    /** {en}
+     * @detail api
+     * @brief Adds an audio frame listener.
+     * @order 53
+     * @param listener The listener. See [VeLiveAudioFrameListener](docs-broadcast-sdk-for-ios-callback#VeLiveAudioFrameListener)for details.
+     * @return  <br>
+     *       - 0: Success;
+     *       - <0: Failure.
+     */
     addAudioFrameListener(listener: id<VeLiveAudioFrameListener>): int;
     
+    /** {en}
+     * @detail api
+     * @brief Removes the audio frame listener.
+     * @notes  <br>
+     *    Calling this method will return a failure if the listener has not been added or has been removed.
+     * @order 54
+     * @param listener The listener. See [VeLiveAudioFrameListener](docs-broadcast-sdk-for-ios-callback#VeLiveAudioFrameListener) for details.
+     * @return  <br>
+     *       - 0: Success;
+     *       - <0: Failure.
+     */
     removeAudioFrameListener(listener: id<VeLiveAudioFrameListener>): int;
     
+    /** {en}
+     * @brief Sets the observer for screen capturing events.
+     * @notes Calling this method will return a failure if the listener has not been added or has been removed.
+     * @param observer The observer for screen capturing events. For details, refer to [VeLiveScreenCaptureStatusObserver](docs-broadcast-sdk-for-ios-callback#VeLiveScreenCaptureStatusObserver).
+     * @order 5
+     * @return - 0: Success;
+     *         - <0: Failure.
+     */
     setScreenCaptureObserver(observer: id<VeLiveScreenCaptureStatusObserver>): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the preview for the local camera. If beauty AR is applied to the captured video or if it undergoes any other processing, the preview will display the processed video.
+     * @param view The preview view.
+     * @order 7
+     */
     setRenderView(view: UIView): Promise<void>;
     
+    /** {en}
+     * @detail api
+     * @order 10
+     * @brief Sets the fill mode of the local preview.
+     * @param fillMode The fill mode. See VeLivePusherRenderMode {@link #VeLivePusherRenderMode} for details.
+     */
     setRenderFillMode(fillMode: VeLivePusherRenderMode): void;
     
+    /** {en}
+     * @detail api
+     * @brief Enables or disables mirroring for the local preview and the streamed video.
+     * @order 8
+     * @param type Mirror mode. See [VeLiveVideoMirrorType](broadcast-sdk-for-ios-type-definition#VeLiveVideoMirrorType) for details.
+     * @param enable Whether to enable mirroring.<br>
+     *        - YES: Enable;
+     *        - NO: Disable.
+     */
     setVideoMirror(type: VeLiveVideoMirrorType, enable: BOOL): void;
     
+    /** {en}
+     * @detail api
+     * @brief Starts streaming.
+     * @param url The push stream address.
+     * @order 24
+     */
     startPush(url: NSString): void;
     
+    /** {en}
+     * @detail api
+     * @brief Starts streaming with one or more push stream addresses.
+     * @param urls A list of push stream addresses.
+     * @notes  <br>
+     *    When the first push stream address in the array is unavailable, the SDK will automatically switch to the subsequent addresses.
+     * @order 25
+     */
     startPushWithUrls(urls: NSArray<NSString>): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stops streaming.
+     * @notes
+     *        After you have stopped streaming, you can restart streaming by calling [startPush:](#VeLivePusher-startpush) or [startPushWithUrls:](#VeLivePusher-startpushwithurls).
+     * @order 26
+     */
     stopPush(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether the streaming is currently ongoing. You can use this method to query the status of the live pusher.
+     * @order 27
+     * @return  <br>
+     *      Whether the streaming is currently ongoing.<br>
+     *          - YES: The streaming is currently ongoing;
+     *          - NO: The streaming has stopped.
+     */
     isPushing(): BOOL;
     
+    /** {en}
+     * @detail api
+     * @brief Starts video capture.
+     * @param type The video capture type. See VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} for details.
+     * @notes
+     *        After calling this method, you can stop video capture by calling [stopVideoCapture](#VeLivePusher-stopvideocapture).
+     * @order 11
+     */
     startVideoCapture(type: VeLiveVideoCaptureType): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stops video capture.
+     * @notes
+     *         After calling this method, you can start video capture by calling [startVideoCapture:](#VeLivePusher-startvideocapture).
+     * @order 12
+     */
     stopVideoCapture(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Switches the video capture type.
+     * @notes
+     *        This method must be called after [startVideoCapture:](#VeLivePusher-startvideocapture) is called.
+     * @order 13
+     * @param type The video capture type. See VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} for details.
+     */
     switchVideoCapture(type: VeLiveVideoCaptureType): void;
     
+    /** {en}
+     * @detail api
+     * @brief Starts audio capture.
+     * @param type The audio capture type. See VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} for details.
+     * @notes
+     *        After calling this method, you can stop audio capture by calling [stopAudioCapture](#VeLivePusher-stopaudiocapture).
+     * @order 15
+     */
     startAudioCapture(type: VeLiveAudioCaptureType): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stops audio capture.
+     * @notes
+     *        After calling this method, you can start audio capture by calling [startAudioCapture:](#VeLivePusher-startaudiocapture).
+     * @order 16
+     */
     stopAudioCapture(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Switches audio capture type.
+     * @param type The audio capture type. See VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} for details.
+     * @notes
+     *        This method must be called after [startAudioCapture:](#VeLivePusher-startaudiocapture) is called.
+     * @order 17
+     */
     switchAudioCapture(type: VeLiveAudioCaptureType): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the current video capture type.
+     * @order 14
+     * @return
+     *         The video capture type. See [VeLiveVideoCaptureType](docs-broadcast-sdk-for-ios-type-definition#VeLiveVideoCaptureType) for details.
+     */
     getCurrentVideoCaptureType(): VeLiveVideoCaptureType;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the current audio capture type.
+     * @order 18
+     * @return
+     *         The audio capture type. See [VeLiveAudioCaptureType](docs-broadcast-sdk-for-ios-type-definition#VeLiveAudioCaptureType) for details.
+     */
     getCurrentAudioCaptureType(): VeLiveAudioCaptureType;
     
+    /** {en}
+     * @detail api
+     * @brief Sets a static image to push. When using this method, you must call [startVideoCapture:](#VeLivePusher-startvideocapture) and set [VeLiveVideoCaptureType](docs-broadcast-sdk-for-ios-type-definition#VeLiveVideoCaptureType) to `VeLiveVideoCaptureCustomImage`.
+     * @order 19
+     * @param image The static image to push.
+     */
     updateCustomImage(image: UIImage): Promise<void>;
     
+    /** {en}
+     * @detail api
+     * @brief Sets whether to mute the stream.
+     * @param mute Whether to mute the stream.<br>
+     *              - YES: Mute;
+     *              - NO: (Default) Do not mute.
+     * @order 22
+     */
     setMute(mute: BOOL): void;
     
+    /** {en}
+     * @detail api
+     * @brief Checks whether the stream is muted.
+     * @order 23
+     * @return  <br>
+     *      - YES: The stream is muted.
+     *      - NO: The stream is not muted.
+     */
     isMute(): BOOL;
     
+    /** {en}
+     * @detail api
+     * @brief Sets video encoding parameters for the pushed stream.
+     * @param config The video encoding parameters, including the video resolution, encoding format, target bitrate, and GOP size. For details, see VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration}.
+     * @notes  <br>
+     *    This method can be called before or after live streaming starts.
+     * @order 29
+     */
     setVideoEncoderConfiguration(config: VeLiveVideoEncoderConfiguration): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets audio encoding parameters for the pushed stream.
+     * @param config The audio encoding parameters. See VeLiveAudioEncoderConfiguration {@link #VeLiveAudioEncoderConfiguration} for details.
+     * @notes
+     *        This method must be called before calling [startPush:](#VeLivePusher-startpush) or [startPushWithUrls:](#VeLivePusher-startpushwithurls).
+     * @order 28
+     */
     setAudioEncoderConfiguration(config: VeLiveAudioEncoderConfiguration): void;
     
+    /** {en}
+     * @detail api
+     * @brief Starts local recording.
+     * @param path The directory for saving the recording file. You cannot leave this parameter empty.
+     * @param config The recording configurations. See VeLiveFileRecorderConfiguration {@link #VeLiveFileRecorderConfiguration} for details.
+     * @param listener The listener for recording events. See VeLiveFileRecordingListener {@link #VeLiveFileRecordingListener} for details.
+     * @order 44
+     */
     startFileRecording(path: NSString, config: VeLiveFileRecorderConfiguration, listener: id<VeLiveFileRecordingListener>): void;
     
+    /** {en}
+     * @detail api
+     * @brief Stops local recording.
+     * @notes
+     *        This method must be called after calling [startFileRecording](#VeLivePusher-startfilerecording-config-listener).
+     * @order 46
+     */
     stopFileRecording(): void;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the camera manager. With the camera manager, you can do the following:
+     *         - Control the flashlight
+     *         - Set the camera zoom
+     *         - Set autofocus
+     * @notes
+     *        To use this method, you must first call [startVideoCapture:](#VeLivePusher-startvideocapture) and set [VeLiveVideoCaptureType](docs-broadcast-sdk-for-ios-type-definition#VeLiveVideoCaptureType) to `VeLiveVideoCaptureFrontCamera` or `VeLiveVideoCaptureBackCamera`.
+     * @order 32
+     * @return
+     *          The camera manager. See [VeLiveCameraDevice](#VeLiveCameraDevice) for details.
+     */
     getCameraDevice(): VeLiveCameraDevice;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the audio device manager.
+     * @notes
+     *        To use this method, you must first call [startAudioCapture:](#VeLivePusher-startaudiocapture) and set [VeLiveAudioCaptureType](docs-broadcast-sdk-for-ios-type-definition#VeLiveAudioCaptureType) to `VeLiveAudioCaptureMicrophone`.
+     * @order 33
+     * @return
+     *         The audio device manager. See [VeLiveAudioDevice](#VeLiveAudioDevice) for details.
+     */
     getAudioDevice(): VeLiveAudioDevice;
     
+    /** {en}
+     * @detail api
+     * @brief Gets the special effects manager. With the special effects manager, you can do the following:
+     *         - Set beauty AR
+     *         - Set special effects
+     *         - Set materials
+     *         - Set stickers
+     *         - Set filters
+     * @notes  <br>
+     *    You must first integrate the BytePlus Effects SDK before calling this method.
+     * @order 31
+     * @return
+     *         The special effects manager. See [VeLiveVideoEffectManager](#VeLiveVideoEffectManager) for details.
+     */
     getVideoEffectManager(): VeLiveVideoEffectManager;
     
+    /** {en}
+     * @detail api
+     * @brief Creates the media player.
+     * @order 3
+     * @return
+     *         The media player. See [VeLiveMediaPlayer](#VeLiveMediaPlayer) for details.
+     */
     createPlayer(): VeLiveMediaPlayer;
     
+    /** {en}
+     * @detail api
+     * @brief Sets a protocol for custom video processing.
+     * @param filter The protocol for custom video processing. See VeLiveVideoFrameFilter {@link #VeLiveVideoFrameFilter} for details.
+     * @order 36
+     */
     setVideoFrameFilter(filter: id<VeLiveVideoFrameFilter>): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets custom audio processing.
+     * @param filter The audio filter. See VeLiveAudioFrameFilter {@link #VeLiveAudioFrameFilter} for details.
+     * @order 40
+     */
     setAudioFrameFilter(filter: id<VeLiveAudioFrameFilter>): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the orientation of the pushed video frame. The default orientation is portrait.
+     * @param orientation The orientation of the pushed video frame.
+     * @order 9
+     */
     setOrientation(orientation: UIInterfaceOrientation): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets a watermark for the pushed stream.
+     * @param image The watermark image. Setting it to null means disabling watermarking.
+     * @param x The horizontal offset of the watermark, which represents the ratio of the distance between the left edge of the watermark and the left edge of the video to the width of the video. The value range is [0.0,1.0].
+     * @param y The vertical offset of the watermark, which represents the ratio of the distance between the top edge of the watermark and the top edge of the video to the height of the video. The value range is [0.0,1.0].
+     * @param scale The uniform scaling of the watermark. The value range is [0.0,1.0].
+     * @order 35
+     * @return  <br>
+     *     - 0: Success;
+     *     - <0: Failure.
+     */
     setWatermark(image: UIImage, x: float, y: float, scale: float): Promise<int>;
     
+    /** {en}
+     * @detail api
+     * @brief Takes a screenshot.
+     * @param listener The listener for the screenshot. See VeLiveSnapshotListener {@link #VeLiveSnapshotListener} for details.
+     * @order 34
+     */
     snapshot(listener: id<VeLiveSnapshotListener>): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sends an SEI message through the video frame. The SEI messages are strings in JSON format.
+     * @param key The JSON key.
+     * @param value The JSON value.
+     * @param repeat The number of times the message is sent. For example, if you set `repeat` to `20` and set `isKeyFrame` to `YES`, the SDK will add the SEI message to 20 consecutive key frames starting from the time the method is called.
+     * @param isKeyFrame Whether to add the SEI message to key frames only. <br>
+     *         - YES: Add the SEI message to key frames only.
+     *         - NO: Add the SEI message to all types of frames.
+     * @param allowsCovered Whether to allow overwriting. <br>
+     *         - YES: Allow overwriting.
+     *         - NO: Do not allow overwriting.
+     * @notes
+     *        This method must be called after calling [startPush:](#VeLivePusher-startpush) or [startPushWithUrls:](#VeLivePusher-startpushwithurls).
+     * @order 41
+     * @return  <br>
+     *      - 0: Success;
+     *      - <0: Failure.
+     */
     sendSeiMessage(key: NSString, value: id, repeat: int, isKeyFrame: BOOL, allowsCovered: BOOL): int;
     
+    /** {en}
+     * @detail api
+     * @brief Pushes an external video frame.
+     * @notes
+     *        Before calling this method, you must first call [startVideoCapture:](#VeLivePusher-startvideocapture) and set [VeLiveVideoCaptureType](docs-broadcast-sdk-for-ios-type-definition#VeLiveVideoCaptureType) to `VeLiveVideoCaptureExternal`.
+     * @order 37
+     * @param frame The external video frame. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
+     * @return  <br>
+     *      - 0: Success;
+     *      - <0: Failure.
+     */
     pushExternalVideoFrame(frame: VeLiveVideoFrame): int;
     
+    /** {en}
+     * @detail api
+     * @brief Pushes an external encoded video frame.
+     * @notes
+     *        Before calling this method, you must first call [startVideoCapture:](#VeLivePusher-startvideocapture) and set [VeLiveVideoCaptureType](docs-broadcast-sdk-for-ios-type-definition#VeLiveVideoCaptureType) to `VeLiveVideoCaptureFrontCamera` or `VeLiveVideoCaptureExternal`.
+     * @order 38
+     * @param encodeFrame The external encoded video frame. See VeLiveVideoEncodeFrame {@link #VeLiveVideoEncodeFrame} for details.
+     * @return  <br>
+     *      - 0: Success;
+     *      - <0: Failure.
+     */
     pushExternalVideoEncodeFrame(encodeFrame: VeLiveVideoEncodeFrame): int;
     
+    /** {en}
+     * @detail api
+     * @brief Pushes an external audio frame.
+     * @param frame The external audio frame. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     * @notes
+     *        To use this method, you must first call [startAudioCapture:](#VeLivePusher-startaudiocapture) and set [VeLiveAudioCaptureType](docs-broadcast-sdk-for-ios-type-definition#VeLiveAudioCaptureType) to `VeLiveAudioCaptureExternal`.
+     * @order 39
+     * @return  <br>
+     *       - 0: Success;
+     *       - <0: Failure.
+     */
     pushExternalAudioFrame(frame: VeLiveAudioFrame): int;
     
+    /** {en}
+     * @detail api
+     * @brief Set advanced configurations. You can [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for more information about how to use this method.
+     * @param key The JSON key.
+     * @param value The JSON value. We recommend that you set it to an NSDictionary or NSString object.
+     * @order 42
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     */
     setProperty(key: NSString, value: id): int;
     
+    /** {en}
+     * @detail api
+     * @brief Request to encode a new IDR frame.
+     * @notes
+     *        This method must be called after calling [startPush:](#VeLivePusher-startpush) or [startPushWithUrls:](#VeLivePusher-startpushwithurls).
+     * @order 49
+     */
     requestIDRFrame(): void;
 }
 export declare class VeLiveVideoEffectManager {
     
+    /** {en}
+     * @detail api
+     * @brief Initializes the special effects manager.
+     * @param config The special effects configurations. See VeLiveVideoEffectLicenseConfiguration {@link #VeLiveVideoEffectLicenseConfiguration} for details.
+     * @order 76
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     */
     setupWithConfig(config: VeLiveVideoEffectLicenseConfiguration): int;
     
+    /** {en}
+     * @detail api
+     * @brief Updates the special effects license after the existing license expires. This method is effective only if you authenticate the license online.
+     * @param completion The result callback.
+     * @notes
+     *        - Call this method after you set the video effects license by calling [setupWithConfig:](#VeLiveVideoEffectManager-setupwithconfig);
+     *        - This method is an asynchronous operation.
+     * @order 76
+     */
     updateLicense(completion: (result: number, message: string) => void): void;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the path to the algorithm models of the special effects.
+     * @param path The path to the algorithm models of the special effects.
+     * @notes
+     *        Call this method after you set the special effects license by calling [setupWithConfig:](#VeLiveVideoEffectManager-setupwithconfig).
+     * @order 77
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     */
     setAlgoModelPath(path: NSString): int;
     
+    /** {en}
+     * @detail api
+     * @brief Creates or destroys the special effects engine.
+     * @notes
+     *        - Call this method after calling [setupWithConfig:](#VeLiveVideoEffectManager-setupwithconfig) and [setAlgoModelPath:](#VeLiveVideoEffectManager-setalgomodelpath).
+     *        - This method does not enable or disable video special effects. Call [setComposeNodes:](#VeLiveVideoEffectManager-setcomposenodes) after calling this method to enable video special effects.
+     *        - In most cases, the special effects engine will be destroyed when the effects manager is destroyed. However, if you have high performance requirements, you can call this method to manually destroy the special effects engine when you are not using special effects-related features.
+     *        - Creating or destroying the special effects engine repeatedly can result in increased processing time.
+     * @order 78
+     * @param enable Whether to create or destroy the special effects engine. <br>
+     *                - YES: Create.
+     *                - NO: (Default) Destroy.
+     * @return  <br>
+     *      - 0: Success;
+     *      - -1: Failure.
+     */
     setEnable(enable: BOOL): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the special effects you want to apply to the video. You can choose effects from ComposeMakeup.bundle.
+     * @notes
+     *        - Call this method after calling [setEnable:](#VeLiveVideoEffectManager-setenable).
+     *        - If you make multiple calls to this method, only the last call takes effect.
+     *        - To add more effects to the existing effects settings, call [appendComposeNodes:](#VeLiveVideoEffectManager-appendcomposenodes).
+     * @order 79
+     * @param nodes The paths to the special effects resources.
+     * @return  <br>
+     *      - 0: Success.
+     *      - -1: Failure.
+     */
     setComposeNodes(nodes: NSArray<NSString>): int;
     
+    /** {en}
+     * @detail api
+     * @brief Adds one or more effects to the existing effects settings that you have configured with [setComposeNodes:](#VeLiveVideoEffectManager-setcomposenodes).
+     * @notes Call this method after calling [setEnable:](#VeLiveVideoEffectManager-setenable).
+     * @order 80
+     * @param nodes The paths to the special effects resources.
+     * @return  <br>
+     *      - 0: Success.
+     *      - -1: Failure.
+     */
     appendComposeNodes(nodes: NSArray<NSString>): int;
     
+    /** {en}
+     * @detail api
+     * @brief Removes one or more special effects resources set by the [setComposeNodes:](#VeLiveVideoEffectManager-setcomposenodes) or [ppendComposeNodes:](#VeLiveVideoEffectManager-appendcomposenodes) methods.
+     * @notes Call this method after calling [setEnable:](#VeLiveVideoEffectManager-setenable).
+     * @order 81
+     * @param nodes The paths to the special effects resources.
+     * @return  <br>
+     *      - 0: Success.
+     *      - -1: Failure.
+     */
     removeComposeNodes(nodes: NSArray<NSString>): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the intensity of a special effect.
+     * @notes
+     *        - Call this method after calling [setComposeNodes:](#VeLiveVideoEffectManager-setcomposenodes) or [appendComposeNodes:](#VeLiveVideoEffectManager-appendcomposenodes).
+     *        - This method is only applicable to special effects that contain the three parameters mentioned above. For effects that do not have the intensity parameter, such as stickers, the method does not have any effect.
+     * @order 82
+     * @param node The path to the special effects resource.
+     * @param key The key of the resource.
+     * @param intensity The intensity of the effect. The value range is [0.0, 1.0]
+     * @return  <br>
+     *      - 0: Success.
+     *      - -1: Failure.
+     */
     updateComposerNodeIntensity(node: NSString, key: NSString, intensity: float): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the color filter.
+     * @notes
+     *        Call this method after calling [setEnable:](#VeLiveVideoEffectManager-setenable).
+     * @order 83
+     * @param path The absolute path to the filter resource.
+     * @return  <br>
+     *      - 0: Success.
+     *      - -1: Failure.
+     */
     setFilter(path: NSString): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the intensity of the color filter.
+     * @param intensity The intensity. The value range is [0.0, 1.0].
+     * @notes
+     *        Call this method after calling [setFilter:](#VeLiveVideoEffectManager-setfilter).
+     * @order 84
+     * @return  <br>
+     *      - 0: Success.
+     *      - -1: Failure.
+     */
     updateFilterIntensity(intensity: float): int;
     
+    /** {en}
+     * @detail api
+     * @brief Sets the sticker.
+     * @param path The absolute path to the sticker resource.
+     * @notes
+     *        Call this method after calling [setEnable:](#VeLiveVideoEffectManager-setenable).
+     * @order 85
+     * @return  <br>
+     *      - 0: Success.
+     *      - -1: Failure.
+     */
     setSticker(path: NSString): int;
     
+    /** {en}
+     * @detail api
+     * @brief Advanced settings for special effects.
+     * @notes
+     *        Call the method after calling [setEnable:](#VeLiveVideoEffectManager-setenable). Do not perform frequent synchronization operations in the main thread.
+     * @param callback A callback function that takes a handle as an argument.
+     * @param isGLThread Whether the callback is called in the GL thread.
+     * @param isAsync Whether the callback is executed synchronously.
+     */
     setAdvancedFeature(callback: (handle: void) => void, isGLThread: BOOL, isAsync: BOOL): void;
     init(): this;
 }