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

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

@@ -2,79 +2,241 @@ import { VeLivePusherStatistics, VeLiveVideoFrame, VeLiveAudioFrame, VeLivePushS
 import { NSDictionary, int, NSString, long, NSError, UIImage, int64_t, BOOL, float } from './types';
 export declare class VeLivePusherStatisticsObserver {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs periodically to report streaming statistics. By default, the callback is triggered every 5 seconds.
+     * @param statistics The streaming statistics. See [VeLivePusherStatistics](broadcast-sdk-for-ios-type-definition#VeLivePusherStatistics) for details.
+     * @order 8
+     */
     onStatistics?(statistics: VeLivePusherStatistics): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs periodically to return log information.
+     * @param logInfo The log information.
+     * @order 9
+     */
     onLogMonitor?(logInfo: NSDictionary): void;
 }
 export declare class VeLiveMediaPlayerFrameListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the media player decodes a video frame.
+     * @param videoFrame The video frame data, including the timestamp, pixel format, and other information. See [VeLiveVideoFrame](broadcast-sdk-for-ios-type-definition#VeLiveVideoFrame) for details.
+     */
     onVideoFrame?(videoFrame: VeLiveVideoFrame): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the media player decodes an audio frame.
+     * @param audioFrame The audio frame data. See [VeLiveAudioFrame](broadcast-sdk-for-ios-type-definition#VeLiveAudioFrame) for details.
+     */
     onAudioFrame?(audioFrame: VeLiveAudioFrame): void;
 }
 export declare class VeLiveFileRecordingListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when recording starts.
+     * @order 10
+     */
     onFileRecordingStarted?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when recording stops.
+     * @order 11
+     */
     onFileRecordingStopped?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when an error occurs during recording.
+     * @param errorCode The error code. See [VeLivePusherCode](broadcast-sdk-for-ios-api-error-code#VeLivePusherCode) for details.
+     * @param msg The error message.
+     * @order 12
+     */
     onFileRecordingError$message?(errorCode: int, msg: NSString): void;
 }
 export declare class VeLiveScreenCaptureStatusObserver {
     
+    /** {en}
+     * @detail callback
+     * @brief Triggered when screen streaming starts. This callback is triggered once the `[RPBroadcastSampleHandler startBroadcast]` callback is triggered.
+     */
     broadcastStarted?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Triggered when screen streaming pauses. This callback is triggered once the `[RPBroadcastSampleHandler pauseBroadcast]` callback is triggered.
+     */
     broadcastPaused?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Triggered when screen streaming resumes. This callback is triggered once the `[RPBroadcastSampleHandler resumeBroadcast]` callback is triggered.
+     */
     broadcastResumed?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Triggered when screen streaming stops. This callback is triggered once the `[RPBroadcastSampleHandler finishBroadcast]` callback is triggered.
+     */
     broadcastFinished?(): void;
 }
 export declare class VeLiveVideoFrameFilter {
 }
 export declare class VeLiveVideoFrameListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a video frame is captured. This callback will be triggered only if you return `VeLiveVideoFrameSourceCapture` when implementing the [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) callback method.
+     * @param frame The captured video frame. See VeLiveVideoFrame{@link #VeLiveVideoFrame} for details.
+     */
     onCaptureVideoFrame?(frame: VeLiveVideoFrame): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a video frame is to be encoded. This callback will be triggered only if you return `VeLiveVideoFrameSourcePreEncode` when implementing the [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) callback method.
+     * @param frame The video frame prior to encoding. See [VeLiveVideoFrame](broadcast-sdk-for-ios-type-definition#VeLiveVideoFrame) for details.
+     */
     onPreEncodeVideoFrame?(frame: VeLiveVideoFrame): void;
 }
 export declare class VeLiveAudioFrameListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when an audio frame is captured. This callback will be triggered only if you return `VeLiveAudioFrameSourceCapture` when implementing the [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) callback method.
+     * @param frame The captured audio frame data. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     */
     onCaptureAudioFrame?(frame: VeLiveAudioFrame): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when an audio frame is to be encoded. This callback will be triggered only if you return `VeLiveAudioFrameSourcePreEncode` when implementing the [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) callback method.
+     * @param frame The audio frame prior to encoding. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
+     */
     onPreEncodeAudioFrame?(frame: VeLiveAudioFrame): void;
 }
 export declare class VeLiveMediaPlayerListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the playback starts.
+     */
     onStart?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs every 100 ms to report the playback progress.
+     * @param timeMS The playback progress, in milliseconds.
+     */
     onProgress?(timeMS: long): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the playback stops.
+     */
     onStop?(): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when an error occurs in the media player.
+     * @param error The error message.
+     */
     onError?(error: NSError): void;
 }
 export declare class VeLiveAudioFrameFilter {
 }
 export declare class VeLiveSnapshotListener {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a screenshot is successfully taken after snapshot:{@link #VeLivePusher#snapshot} is called.
+     * @param image The screenshot image.
+     */
     onSnapshotComplete?(image: UIImage): void;
 }
 export declare class VeLivePusherObserver {
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when a streaming error occurs.
+     * @param code The error code. See [VeLivePusherCode](broadcast-sdk-for-ios-api-error-code#VeLivePusherCode) for details.
+     * @param subcode The subcode. See [VeLivePusherErrorCode](broadcast-sdk-for-ios-api-error-code#VeLivePusherErrorCode) for details.
+     * @param msg The error message.
+     * @order 0
+     */
     onError$subcode$message?(code: int, subcode: int, msg: NSString): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the streaming status changes.
+     * @param status The updated streaming status. See [VeLivePushStatus](broadcast-sdk-for-ios-type-definition#VeLivePushStatus) for details.
+     * @order 1
+     */
     onStatusChange?(status: VeLivePushStatus): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the live pusher sends the first video frame.
+     * @param type The type of the first frame. See [VeLiveFirstFrameType](broadcast-sdk-for-ios-type-definition#VeLiveFirstFrameType) for details.
+     * @param timestampMs The timestamp, in milliseconds.
+     * @order 2
+     */
     onFirstVideoFrame$timestampMs?(type: VeLiveFirstFrameType, timestampMs: int64_t): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the live pusher sends the first audio frame.
+     * @param type The type of the first audio frame. See [VeLiveFirstFrameType](broadcast-sdk-for-ios-type-definition#VeLiveFirstFrameType) for details.
+     * @param timestampMs The timestamp, in milliseconds.
+     * @order 3
+     */
     onFirstAudioFrame$timestampMs?(type: VeLiveFirstFrameType, timestampMs: int64_t): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the camera is turned on or turned off.
+     * @param open Whether the updated status of the camera is on. <br>
+     *       - YES: On;
+     *       - NO: Off.
+     * @order 4
+     */
     onCameraOpened?(open: BOOL): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the microphone is turned on or turned off.
+     * @param open Whether the updated status of the microphone is on. <br>
+     *      - YES：On;
+     *      - NO：Off.
+     * @order 5
+     */
     onMicrophoneOpened?(open: BOOL): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the network quality changes.
+     * @param quality The updated network quality. See [VeLiveNetworkQuality](broadcast-sdk-for-ios-type-definition#VeLiveNetworkQuality) for details.
+     * @order 6
+     */
     onNetworkQuality?(quality: VeLiveNetworkQuality): void;
     
+    /** {en}
+     * @detail callback
+     * @brief Occurs when the audio volume level changes.
+     * @order 7
+     * @param level The updated volume level. See [VeLiveAudioPowerLevel](broadcast-sdk-for-ios-type-definition#VeLiveAudioPowerLevel) for details.
+     * @param value The current volume measured in decibel value (dB).
+     *        - A value of -1 indicates that the corresponding volume decibel value is not available.
+     *        - Decibel values less than 1 correspond to the VeLiveAudioPowerLevelSilent level.
+     *        - Decibel values greater than 1 and less than or equal to 15 correspond to the VeLiveAudioPowerLevelQuiet level.
+     *        - Decibel values greater than 15 and less than or equal to 30 correspond to the VeLiveAudioPowerLevelLight level.
+     *        - Decibel values greater than 30 and less than or equal to 60 correspond to the VeLiveAudioPowerLevelNormal level.
+     *        - Decibel values greater than 60 and less than or equal to 85 correspond to the VeLiveAudioPowerLevelLoud level.
+     *        - Decibel values greater than 85 correspond to the VeLiveAudioPowerLevelNoisy level.
+     */
     onAudioPowerQuality$value?(level: VeLiveAudioPowerLevel, value: float): void;
 }

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

@@ -1,54 +1,154 @@
 export declare enum VeLivePusherErrorCode {
     
+    /** {en}
+     * @brief SDK license error, possibly caused by an invalid or expired certificate.
+     *
+     */
     VeLivePusherInvalidLicenseSubErrorCode = -100,
     
+    /** {en}
+     * @brief The current SDK license does not support H.265.
+     *
+     */
     VeLivePusherInvalidLicenseUnsupportH265 = -101,
     
+    /** {en}
+     * @brief Parameter error, possibly caused by an invalid parameter value or parameter type.
+     *
+     */
     VeLivePusherInvalidParameterSubErrorCode = -200,
     
+    /** {en}
+     * @brief Parameter error, screen capture AppGroupIdentifier parameter error.
+     *
+     */
     VeLivePusherInvalidParameterScreenCaptureAppGroupIdentifierSubErrorCode = -201,
     
+    /** {en}
+     * @brief Video capture type error, possibly caused by an unsupported video capture type or capture device.
+     *
+     */
     VeLivePusherVideoCaptureTypeError = -301,
     
+    /** {en}
+     * @brief Video capture permission error, possibly caused by the lack of access to the video device.
+     *
+     */
     VeLivePusherVideoCapturePermissionError = -302,
     
+    /** {en}
+     * @brief Audio capture type error, possibly caused by an unsupported audio capture type or capture device.
+     *
+     */
     VeLivePusherAudioCaptureTypeError = -401,
     
+    /** {en}
+     * @brief Audio capture permission error, possibly caused by the lack of access to the audio device.
+     *
+     */
     VeLivePusherAudioCapturePermissionError = -402,
     
+    /** {en}
+     * @brief Video encoding error, possibly caused by a configuration issue with the video encoder or an error during encoding.
+     *
+     */
     VeLivePusherVideoEncoderSubErrorCode = -500,
     
+    /** {en}
+     * @brief Audio encoding error, possibly caused by a configuration issue with the audio encoder or an error during encoding.
+     *
+     */
     VeLivePusherAudioEncoderSubErrorCode = -600,
     
+    /** {en}
+     * @brief Network error, which might be caused by network connection issues such as network instability or high latency.
+     *
+     */
     VeLivePusherTransportSubErrorCode = -700,
     
+    /** {en}
+     * @brief Special effects error, possibly caused by issues with video processing.
+     *
+     */
     VeLivePusherVideoEffectSubErrorCode = -800,
     
+    /** {en}
+     * @brief Audio device error.
+     *
+     */
     VeLivePusherAudioDeviceSubErrorCode = -900,
     
-    VeLivePusherInternalError = -1001
+    /** {en}
+     * @brief Internal error. You can [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact the BytePlus technical support for help.
+     *
+     */
+    VeLivePusherInternalError = -10001
 }
 export declare enum VeLivePusherCode {
     
+    /** {en}
+     * @brief No error.
+     *
+     */
     VeLivePusherSuccess = 0,
     
+    /** {en}
+     * @brief SDK license error.
+     *
+     */
     VeLivePusherInvalidLicense = -1,
     
+    /** {en}
+     * @brief Parameter error.
+     *
+     */
     VeLivePusherInvalidParameter = -2,
     
+    /** {en}
+     * @brief Video capture error.
+     *
+     */
     VeLivePusherVideoCaptureError = -3,
     
+    /** {en}
+     * @brief Audio capture error.
+     *
+     */
     VeLivePusherAudioCaptureError = -4,
     
+    /** {en}
+     * @brief Video encoding error.
+     *
+     */
     VeLivePusherVideoEncoderError = -5,
     
+    /** {en}
+     * @brief Audio encoding error.
+     *
+     */
     VeLivePusherAudioEncoderError = -6,
     
+    /** {en}
+     * @brief Network transmission error.
+     *
+     */
     VeLivePusherTransportError = -7,
     
+    /** {en}
+     * @brief Special effects error.
+     *
+     */
     VeLivePusherVideoEffectError = -8,
     
+    /** {en}
+     * @brief Audio error.
+     *
+     */
     VeLivePusherAudioDeviceError = -9,
     
+    /** {en}
+     * @brief Other error.
+     *
+     */
     VeLivePusherError = -100
 }