@volcengine/react-native-live-push 1.1.3-rc.1 → 1.2.0-rc.0

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

@@ -0,0 +1,242 @@
+import { VeLivePusherStatistics, VeLiveVideoFrame, VeLiveAudioFrame, VeLivePushStatus, VeLiveFirstFrameType, VeLiveNetworkQuality, VeLiveAudioPowerLevel } from './keytype';
+import { NSDictionary, int, NSString, long, NSError, UIImage, int64_t, BOOL, float } from './types';
+export declare class VeLivePusherStatisticsObserver {
+    /** {zh}
+     * @detail callback
+     * @brief 推流周期性统计信息回调。
+     * @order 8
+     * @param statistics 周期性统计信息，默认每 5s 回调一次，详情请参见 [VeLivePusherStatistics](155321#VeLivePusherStatistics)。
+     */
+    
+    onStatistics?(statistics: VeLivePusherStatistics): void;
+    /** {zh}
+     * @detail callback
+     * @brief 周期性日志信息回调。
+     * @order 9
+     * @param logInfo 周期性日志信息。
+     */
+    
+    onLogMonitor?(logInfo: NSDictionary): void;
+}
+export declare class VeLiveMediaPlayerFrameListener {
+    /** {zh}
+     * @detail callback
+     * @brief 播放器视频帧回调。当完成一个新的视频帧的解码后，触发该回调。
+     * @param videoFrame 视频帧数据，包含了帧的时间戳和格式等信息，详情请参见 [VeLiveVideoFrame](155321#VeLiveVideoFrame)。
+     */
+    
+    onVideoFrame?(videoFrame: VeLiveVideoFrame): void;
+    /** {zh}
+     * @detail callback
+     * @brief 播放器音频帧回调。
+     * @param audioFrame 音频帧，详情请参见 [VeLiveAudioFrame](155321#VeLiveAudioFrame)。
+     */
+    
+    onAudioFrame?(audioFrame: VeLiveAudioFrame): void;
+}
+export declare class VeLiveFileRecordingListener {
+    /** {zh}
+     * @detail callback
+     * @brief 直播录制开始回调。
+     * @order 10
+     */
+    
+    onFileRecordingStarted?(): void;
+    /** {zh}
+     * @detail callback
+     * @brief 直播录制停止回调。
+     * @order 11
+     */
+    
+    onFileRecordingStopped?(): void;
+    /** {zh}
+     * @detail callback
+     * @brief 直播录制错误回调。
+     * @order 12
+     * @param errorCode 错误码，详情请参见 [VeLivePusherCode](155320#VeLivePusherCode)。
+     * @param msg 错误信息。
+     */
+    
+    onFileRecordingError$message?(errorCode: int, msg: NSString): void;
+}
+export declare class VeLiveScreenCaptureStatusObserver {
+    /** {zh}
+     * @detail callback
+     * @brief 录屏推流开始的回调。当 `[RPBroadcastSampleHandler startBroadcast]` 回调被触发时，会同时触发该回调。
+     */
+    
+    broadcastStarted?(): void;
+    /** {zh}
+     * @detail callback
+     * @brief 屏幕推流暂停的回调。当 `[RPBroadcastSampleHandler pauseBroadcast]` 回调被触发时，会同时触发该回调。
+     */
+    
+    broadcastPaused?(): void;
+    /** {zh}
+     * @detail callback
+     * @brief 屏幕推流恢复的回调。当 `[RPBroadcastSampleHandler resumeBroadcast]` 回调被触发时，会同时触发该回调。
+     */
+    
+    broadcastResumed?(): void;
+    /** {zh}
+     * @detail callback
+     * @brief 屏幕推流结束的回调。当 `[RPBroadcastSampleHandler finishBroadcast]` 回调被触发时，会同时触发该回调。
+     */
+    
+    broadcastFinished?(): void;
+}
+export declare class VeLiveVideoFrameFilter {
+}
+export declare class VeLiveVideoFrameListener {
+    /** {zh}
+     * @detail callback
+     * @brief 采集视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourceCapture` 时，才会触发该回调。
+     * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](155321#VeLiveVideoFrame)。
+     */
+    
+    onCaptureVideoFrame?(frame: VeLiveVideoFrame): void;
+    /** {zh}
+     * @detail callback
+     * @brief 编码前视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourcePreEncode` 时，才会触发该回调。
+     * @param frame 视频帧数据，详情请参见 [VeLiveVideoFrame](155321#VeLiveVideoFrame)。
+     */
+    
+    onPreEncodeVideoFrame?(frame: VeLiveVideoFrame): void;
+}
+export declare class VeLiveAudioFrameListener {
+    /** {zh}
+     * @detail callback
+     * @brief 采集音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourceCapture` 时，才会触发该回调。
+     * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](155321#VeLiveAudioFrame)。
+     */
+    
+    onCaptureAudioFrame?(frame: VeLiveAudioFrame): void;
+    /** {zh}
+     * @detail callback
+     * @brief 编码前音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourcePreEncode` 时，才会触发该回调。
+     * @param frame 音频帧数据，详情请参见 [VeLiveAudioFrame](155321#VeLiveAudioFrame)。
+     */
+    
+    onPreEncodeAudioFrame?(frame: VeLiveAudioFrame): void;
+}
+export declare class VeLiveMediaPlayerListener {
+    /** {zh}
+     * @detail callback
+     * @brief 开始播放的回调。
+     */
+    
+    onStart?(): void;
+    /** {zh}
+     * @detail callback
+     * @brief 播放进度的回调，每 100ms 触发一次。
+     * @param timeMS 播放进度，单位为 ms。
+     */
+    
+    onProgress?(timeMS: long): void;
+    /** {zh}
+     * @detail callback
+     * @brief 停止播放的回调。
+     */
+    
+    onStop?(): void;
+    /** {zh}
+     * @detail callback
+     * @brief 返错误状态的回调。
+     * @param error 错误消息。
+     */
+    
+    onError?(error: NSError): void;
+}
+export declare class VeLiveAudioFrameFilter {
+}
+export declare class VeLiveSnapshotListener {
+    /** {zh}
+     * @detail callback
+     * @brief 截图成功回调。调用 [snapshot:](155318#VeLivePusher-snapshot) 截图成功后，会收到这个回调。
+     * @param image 视频的截图。
+     */
+    
+    onSnapshotComplete?(image: UIImage): void;
+}
+export declare class VeLivePusherObserver {
+    /** {zh}
+     * @detail callback
+     * @brief 推流错误回调。
+     * @order 0
+     * @param code 错误码，详情请参见 [VeLivePusherCode](155320#VeLivePusherCode)。
+     * @param subcode 子错误码，详情请参见 [VeLivePusherErrorCode](155320#VeLivePusherErrorCode)。
+     * @param msg 错误信息。
+     */
+    
+    onError$subcode$message?(code: int, subcode: int, msg: NSString): void;
+    /** {zh}
+     * @detail callback
+     * @brief 推流状态变化回调。
+     * @order 1
+     * @param status 变化后的推流状态，详情请参见 [VeLivePushStatus](155321#VeLivePushStatus)。
+     */
+    
+    onStatusChange?(status: VeLivePushStatus): void;
+    /** {zh}
+     * @detail callback
+     * @brief 首帧视频回调，当推流器发送出第一帧视频时，触发该回调。
+     * @order 2
+     * @param type 首帧的类型，详情请参见 [VeLiveFirstFrameType](155321#VeLiveFirstFrameType)。
+     * @param timestampMs 时间戳，单位为 ms。
+     */
+    
+    onFirstVideoFrame$timestampMs?(type: VeLiveFirstFrameType, timestampMs: int64_t): void;
+    /** {zh}
+     * @detail callback
+     * @brief 首帧音频回调，当推流器发送出第一帧音频时，触发该回调。
+     * @order 3
+     * @param type 首帧的类型，详情请参见 [VeLiveFirstFrameType](155321#VeLiveFirstFrameType)。
+     * @param timestampMs 时间戳，单位为 ms。
+     */
+    
+    onFirstAudioFrame$timestampMs?(type: VeLiveFirstFrameType, timestampMs: int64_t): void;
+    /** {zh}
+     * @detail callback
+     * @brief 摄像头开启/关闭回调，当推流器的摄像头开启或关闭时，触发该回调。
+     * @param open 摄像头的新状态是否为开启。<br>
+     *      - YES：摄像头开启；
+     *      - NO：摄像头关闭。
+     * @order 4
+     */
+    
+    onCameraOpened?(open: BOOL): void;
+    /** {zh}
+     * @detail callback
+     * @brief 麦克风开启/关闭回调，当推流器的麦克风开启或关闭时，触发该回调。
+     * @param open 麦克风的新状态是否为开启。<br>
+     *      - YES：麦克风开启；
+     *      - NO：麦克风关闭。
+     * @order 5
+     */
+    
+    onMicrophoneOpened?(open: BOOL): void;
+    /** {zh}
+     * @detail callback
+     * @brief 网络质量状态回调，当推流器检测到网络质量发生变化时，触发该回调。
+     * @order 6
+     * @param quality 变化后的网络质量。详情请参见 [VeLiveNetworkQuality](155321#VeLiveNetworkQuality)。
+     */
+    
+    onNetworkQuality?(quality: VeLiveNetworkQuality): void;
+    /** {zh}
+     * @detail callback
+     * @brief 音量等级回调，当推流器采集的音频音量等级发生变化时，触发该回调。
+     * @order 7
+     * @param level 变化后的音量等级。详情请参见 [VeLiveAudioPowerLevel](155321#VeLiveAudioPowerLevel)。
+     * @param value 当前音量的分贝值（dB）。
+     *        - -1 表示当前没有获取到对应的音量分贝值；
+     *        - 分贝数小于 1，对应 VeLiveAudioPowerLevelSilent 级别；
+     *        - 分贝数大于 1 小于等于 15，对应 VeLiveAudioPowerLevelQuiet 级别；
+     *        - 分贝数大于 15 小于等于 30，对应 VeLiveAudioPowerLevelLight 级别；
+     *        - 分贝数大于 30 小于等于 60，对应 VeLiveAudioPowerLevelNormal 级别；
+     *        - 分贝数大于 60 小于等于 85，对应 VeLiveAudioPowerLevelLoud 级别；
+     *        - 分贝数大于 85，对应 VeLiveAudioPowerLevelNoisy 级别。
+     */
+    
+    onAudioPowerQuality$value?(level: VeLiveAudioPowerLevel, value: float): void;
+}

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

@@ -0,0 +1,154 @@
+export declare enum VeLivePusherErrorCode {
+    /** {zh}
+     * @brief License 验证错误，可能是由于 License 无效或过期。
+     *
+     */
+    
+    VeLivePusherInvalidLicenseSubErrorCode = -100,
+    /** {zh}
+     * @brief 您使用的基础版 License 暂不支持 H.265 硬件编码，请登录火山引擎控制台获取高级版 License。
+     *
+     */
+    
+    VeLivePusherInvalidLicenseUnsupportH265 = -101,
+    /** {zh}
+     * @brief 参数错误，可能是由于传入的参数类型或值不符合预期。
+     *
+     */
+    
+    VeLivePusherInvalidParameterSubErrorCode = -200,
+    /** {zh}
+     * @brief 参数错误，屏幕推流传入的 AppGroupIdentifier 错误。
+     *
+     */
+    
+    VeLivePusherInvalidParameterScreenCaptureAppGroupIdentifierSubErrorCode = -201,
+    /** {zh}
+     * @brief 视频采集类型错误，可能是由于不支持的视频采集类型或者设备不兼容。
+     *
+     */
+    
+    VeLivePusherVideoCaptureTypeError = -301,
+    /** {zh}
+     * @brief 视频采集权限错误，可能是由于应用没有获取到视频设备的访问权限。
+     *
+     */
+    
+    VeLivePusherVideoCapturePermissionError = -302,
+    /** {zh}
+     * @brief 音频采集类型错误，可能是由于不支持的音频采集类型或者设备不兼容。
+     *
+     */
+    
+    VeLivePusherAudioCaptureTypeError = -401,
+    /** {zh}
+     * @brief 音频采集权限错误，可能是由于应用没有获取到音频设备的访问权限。
+     *
+     */
+    
+    VeLivePusherAudioCapturePermissionError = -402,
+    /** {zh}
+     * @brief 视频编码错误，可能是由于视频编码器的配置问题或者编码过程中出现错误。
+     *
+     */
+    
+    VeLivePusherVideoEncoderSubErrorCode = -500,
+    /** {zh}
+     * @brief 音频编码错误，可能是由于音频编码器的配置问题或者编码过程中出现错误。
+     *
+     */
+    
+    VeLivePusherAudioEncoderSubErrorCode = -600,
+    /** {zh}
+     * @brief 网络错误，可能是由于网络连接的问题，如网络不稳定、网络延迟过高等。
+     *
+     */
+    
+    VeLivePusherTransportSubErrorCode = -700,
+    /** {zh}
+     * @brief 视频特效错误，可能是由于视频特效处理中出现的问题。
+     *
+     */
+    
+    VeLivePusherVideoEffectSubErrorCode = -800,
+    /** {zh}
+     * @brief 音频模块错误，可能是由于音频模块处理过程中出现的问题。
+     *
+     */
+    
+    VeLivePusherAudioDeviceSubErrorCode = -900,
+    /** {zh}
+     * @brief 内部错误，请通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)，获取帮助。
+     *
+     */
+    
+    VeLivePusherInternalError = -10001
+}
+export declare enum VeLivePusherCode {
+    /** {zh}
+     * @brief 无错误。
+     *
+     */
+    
+    VeLivePusherSuccess = 0,
+    /** {zh}
+     * @brief License 错误，可能 License 集成错误或 License 过期，请检查 License 集成方式和有效性。
+     *
+     */
+    
+    VeLivePusherInvalidLicense = -1,
+    /** {zh}
+     * @brief 参数错误，请检查入参，并重新调用。
+     *
+     */
+    
+    VeLivePusherInvalidParameter = -2,
+    /** {zh}
+     * @brief 视频采集错误，可能未开启设备视频采集权限，请检查权限是否获取。
+     *
+     */
+    
+    VeLivePusherVideoCaptureError = -3,
+    /** {zh}
+     * @brief 音频采集错误，可能未开启设备麦克风采集权限，请检查权限是否获取。
+     *
+     */
+    
+    VeLivePusherAudioCaptureError = -4,
+    /** {zh}
+     * @brief 视频编码错误，可能配置了当前设备不支持的视频编码方式，请检查编码参数，并重新调用。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
+     *
+     */
+    
+    VeLivePusherVideoEncoderError = -5,
+    /** {zh}
+     * @brief 音频编码错误，可能配置了当前设备不支持的音频编码方式，请检查编码参数，并重新调用。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
+     *
+     */
+    
+    VeLivePusherAudioEncoderError = -6,
+    /** {zh}
+     * @brief 网络发送错误，可能当前网络链路不通，或者开启了代理和关闭了网络权限，请检查网络后重新调用。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
+     *
+     */
+    
+    VeLivePusherTransportError = -7,
+    /** {zh}
+     * @brief 视频特效错误，请检查视频特效 SDK 是否已经集成并且初试化成功。检查特效资源路径是否配置正确。如果故障未排除，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
+     *
+     */
+    
+    VeLivePusherVideoEffectError = -8,
+    /** {zh}
+     * @brief 音频模块错误，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
+     *
+     */
+    
+    VeLivePusherAudioDeviceError = -9,
+    /** {zh}
+     * @brief 其他错误类型，请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
+     *
+     */
+    
+    VeLivePusherError = -100
+}

package/lib/module/typescript/codegen/ios/external.d.ts

@@ -0,0 +1 @@
+export { UIView } from '../../platforms/ios/extends';

package/lib/module/typescript/codegen/ios/index.d.ts

@@ -0,0 +1,6 @@
+export * from './api';
+export * from './callback';
+export * from './errorcode';
+export * from './keytype';
+export * from './external';
+export * from './types';