ChuangLiveEngine Class Reference

Inherits from	NSObject
Declared in	ChuangLiveEngine.h

`micVolume`

设置麦克风音量增益，0.0 ～ 3.0 之间，默认 1.0

@property (nonatomic, assign) float micVolume

Declared In

ChuangLiveEngine.h

`+ initEngine:andAppKey:delegate:`

初始化

+ (nullable instancetype)initEngine:(NSString *)appId andAppKey:(NSString *)appKey delegate:(nullable id<ChuangLiveEngineDelegate>)delegate

Parameters

`appId`	【必传】当前 App申请被分配到的 AppID，从官网管理后台获取
`appKey`	【必传】当前APP注册后与app ID一起获取的APP验证标示，也是从官网管理后台获取
`delegate`	回调对象，代理方法详见：ChuangLiveEngineDelegate

Return Value

返回 ChuangLiveEngine 对象

Declared In

ChuangLiveEngine.h

`delegate`	回调对象，代理方法详见：ChuangLiveEngineDelegate

该方法主要用于释放 SDK 使用的所有对象资源。帮助 App 在无需使用SDK时释放资源。一旦 App 调用了 uninitEngine 接口销毁创建的ChuangLiveEngine实例，将无法调用 SDK 内的任何方法也不再会有任何回调产生。如需使用SDK，请调用初始化方法 initSDKWithAppId:andAppKey:delegate: 创建一个新的 ChuangLiveEngine 实例。

注意：不得在 SDK 生成的回调中调用该方法，不然 SDK只能等候该回调返回才能重新获取相应的对象资源造成死锁。

+ (void)uninitEngine

Declared In

ChuangLiveEngine.h

`+ sharedEngine`

获取引擎对象

+ (ChuangLiveEngine *)sharedEngine

Return Value

返回 ChuangLiveEngine 对象

Declared In

ChuangLiveEngine.h

`+ getSDKVersion`

获取sdk版本号

+ (NSString *)getSDKVersion

Declared In

ChuangLiveEngine.h

`+ setLogLevel:`

设置日志级别。

+ (void)setLogLevel:(ChuangLogLevel)level

Parameters

`level`	日志级别。详见：ChuangLogLevel

Declared In

ChuangLiveEngine.h

`+ setLogFileSize:`

设置日志文件大小。

+ (void)setLogFileSize:(NSInteger)fileSize

Parameters

`fileSize`	单位KB, 取值范围为 [0, 10240], 当设置值为0时，sdk会关闭日志记录功能，默认为1024KB。

Declared In

ChuangLiveEngine.h

`+ setLogFilePath:`

设置日志文件路径

+ (void)setLogFilePath:(NSString *)filePath

Parameters

`filePath`	日志文件保存的绝对路径, 请确保sdk对该路径具有写权限。

Declared In

ChuangLiveEngine.h

`– loginRoom:userId:role:`

登录房间，初始化后需要先登录房间，登录成功后才可以推流或播流、混流

- (int)loginRoom:(NSString *)roomId userId:(NSString *)userId role:(ChuangUserRole)userRole

Parameters

`roomId`	要登录的房间号
`userId`	当前用户的 UID，用户的唯一标识，保证传入的是应用唯一的，不可重复
`userRole`	用户的角色，详情见：ChuangUserRole

Return Value

返回 0 表示成功发送登录请求，其他值均为发送失败

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– getRoomConnectState`

获取当前房间连接状态

- (ChuangRoomState)getRoomConnectState

Return Value

返回房间连接状态 ChuangRoomState

Declared In

ChuangLiveEngine.h

`– logoutRoom`

退出房间

- (void)logoutRoom

Declared In

ChuangLiveEngine.h

`– setPreview:`

设置本地视频预览视图

该方法设置本地用户视频显示信息，只影响本地用户看到的视频画面，不影响本地发布视频。调用该方法绑定本地视频流的显示视窗(view)，并设置本地用户视图的渲染模式和镜像模式。在 App开发中开发中，通常在调用该方法进行本地视频设置，然后再登录房间。登出房间后，绑定仍然有效，如果需要解除绑定，可以指定空 (nil) view 调用本方法。该方法在登录房间前后都能调用。

- (int)setPreview:(ChuangVideoCanvas *)videoCanvas

Parameters

`videoCanvas`	本地视图对象，详情参照ChuangVideoCanvas

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– startPreview`

开始预览本地视图，需要在setPreview后调用有效。

- (int)startPreview

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– stopPreview`

停止预览本地视图

- (void)stopPreview

Declared In

ChuangLiveEngine.h

`– setVideoMirrorMode:`

设置镜像模式

- (void)setVideoMirrorMode:(ChuangVideoMirrorMode)mirrorMode

Parameters

`mirrorMode`	预览或者推流的镜像模式，详情参照：ChuangVideoMirrorMode ，默认：本地预览镜像推流不镜像。注意：预览镜像只对前置摄像头有效，后置无效。

Declared In

ChuangLiveEngine.h

`– switchCamera:`

前/后置摄像头切换

- (BOOL)switchCamera:(ChuangCameraType)cameraType

Parameters

`cameraType`	摄像头类型，详情参照：ChuangCameraType 0:前置摄像像头 1：后置摄像头，默认前置摄像头

Declared In

ChuangLiveEngine.h

`– setVideoConfig:`

设置视频推流配置

- (int)setVideoConfig:(ChuangVideoConfig *)videoConfig

Parameters

`videoConfig`	视频推流配置，详见ChuangVideoConfig

Return Value

返回 0 表示成功调用接口成功调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– getVideoConfig`

获取视频推流配置，详见ChuangVideoConfig

- (ChuangVideoConfig *)getVideoConfig

Return Value

返回当前流视频配置

Declared In

ChuangLiveEngine.h

`– setAudioConfig:`

设置音频配置

- (int)setAudioConfig:(ChuangAudioConfig *)audioConfig

Parameters

`audioConfig`	音频配置，详见ChuangAudioConfig

Return Value

返回 0 表示成功调用接口成功，调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– enablePublishDirectToCDN:`

是否推流至CDN,开始推流前设置有效，推流后设置对当前推流无效（不经过RTC服务！）

直推CDN适用于对延迟要求不高的大规模直播场景，如果需要使用超低延迟音视频服务，请使用RTC推流服务

- (void)enablePublishDirectToCDN:(BOOL)enable

Parameters

`enable`	是否直推CDN YES：直推CDN ，NO：不直推CDN ，默认NO，

Declared In

ChuangLiveEngine.h

`– startPublishStream:`

开始推流

- (int)startPublishStream:(ChuangStreamConfig *)streamConfig

Parameters

`streamConfig`	推流配置参数对象，详情查看ChuangStreamConfig

Return Value

调用结果 0：成功，非0：失败，返回 0 表示推流请求成功，其他值均为失败

Declared In

ChuangLiveEngine.h

`– stopPublishStream`

停止推流

- (void)stopPublishStream

Declared In

ChuangLiveEngine.h

`– sendStreamAttachedMessage:`

发送推流附加消息。推流成功后可调用此函数，所有通过SDK播放此流者会收到此消息。此消息为不可靠消息，每秒最大发送带宽 8192字节。

- (int)sendStreamAttachedMessage:(NSString *)message

Parameters

`message`	消息内容

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– enableTrafficControl:property:`

开始或停止推流流量控制

- (void)enableTrafficControl:(BOOL)enable property:(ChuangTrafficControlProperty)property

Parameters

`enable`	是否使用流量控制。YES 表示开启流控，NO 表示关闭流控。默认为 YES。
`property`	流量控制的属性，位掩码格式。具体可设置为 [ChuangTrafficControlProperty] 的属性的一个或多个枚举组合。

Discussion

Note: 在推流 [startPublishStream] 之前调用生效，最后一次调用会覆盖前面的调用。

Declared In

ChuangLiveEngine.h

`– enableCustomAudioCapture:config:`

是否启用自定义采集音频

- (int)enableCustomAudioCapture:(BOOL)enable config:(ChuangCustomAudioCaptureConfig *)config

Parameters

`enable`	YES：启用自定义采集 NO：不启用自定义采集。(默认：NO 不启用自定义采集)
`config`	自定义采集音频配置，详见ChuangCustomAudioCaptureConfig

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– sendCustomAudioCapturePCMData:`

自定义采集的音频pcm数据

- (int)sendCustomAudioCapturePCMData:(NSData *)data

Parameters

`data`	pcm数据

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– enableCustomVideoCapture:config:`

是否启用自定义采集视频

- (int)enableCustomVideoCapture:(BOOL)enable config:(ChuangCustomVideoCaptureConfig *)config

Parameters

`enable`	YES：启用自定义采集 NO：不启用自定义采集。(默认：NO 不启用自定义采集)
`config`	自定义采集视频配置，详见ChuangCustomVideoCaptureConfig

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– setCustomVideoCaptureHandler:`

设置自定义采集视频回调

- (int)setCustomVideoCaptureHandler:(id<ChuangVideoCustomCaptureDelegate>)delegate

Parameters

`delegate`	自定义采集视频回调代理，代理方法见ChuangVideoCustomCaptureDelegate

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– sendCustomVideoCapturePixelBuffer:videoRoration:timeStamp:`

传入自定义视频帧 (CVPixelBufferRef类型)

- (int)sendCustomVideoCapturePixelBuffer:(CVPixelBufferRef)pixelBuffer videoRoration:(ChuangStreamRotation)rotation timeStamp:(uint64_t)timeStamp

Parameters

`pixelBuffer`	视频帧
`rotation`	屏幕方向。详见ChuangStreamRotation
`timeStamp`	时间戳

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– sendCustomVideoCaptureRawData:param:timeStamp:`

传入自定义视频帧 (rawData裸数据)

- (int)sendCustomVideoCaptureRawData:(NSData *)rawData param:(ChuangVideoRawDataFrameParam *)videFrame timeStamp:(uint64_t)timeStamp

Parameters

`rawData`	raw data ，要向 SDK 发送的视频帧数据
`videFrame`	视频帧参数，详见ChuangVideoRawDataFrameParam
`timeStamp`	时间戳

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– sendCustomVideoCaptureEncodedData:param:timestamp:`

发送自定义采集的视频帧编码后的数据(默认支持H.264编码)

- (int)sendCustomVideoCaptureEncodedData:(NSData *)data param:(ChuangEncodedFrameParam *)param timestamp:(uint64_t)timestamp

Parameters

`data`	发送的编码后的视频帧数据
`param`	视频帧的参数，详见ChuangEncodedFrameParam
`timestamp`	视频帧的索引时间

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– takePublishStreamSnapshot:`

获取推流视频截图

- (int)takePublishStreamSnapshot:(ChuangTakeSnapshotCallback)imageCallback

Parameters

`imageCallback`	截图回调详情见ChuangTakeSnapshotCallback

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– takePlayStreamSnapshot:imgCallBack:`

获取播流视频截图

- (int)takePlayStreamSnapshot:(NSString *)streamId imgCallBack:(ChuangTakeSnapshotCallback)imageCallback

Parameters

`streamId`	流ID
`imageCallback`	截图回调详情见ChuangTakeSnapshotCallback

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– takePlayStreamSnapshotWithRoomId:streamId:imgCallBack:`

获取跨房间播流视频截图

- (int)takePlayStreamSnapshotWithRoomId:(NSString *)roomId streamId:(NSString *)streamId imgCallBack:(ChuangTakeSnapshotCallback)imageCallback

Parameters

`roomId`	房间ID
`streamId`	流ID
`imageCallback`	截图回调详情见ChuangTakeSnapshotCallback

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– enableAEC:`

开/关回声消除

- (void)enableAEC:(BOOL)enable

Parameters

`enable`	是否开启回声消除，YES：开启回声消除 NO:关闭回声消除，默认YES 开启回声消除，会对SDK采集到的音频数据进行过滤以降低音频中的回音成分，使声音更干净

enable

是否开启回声消除，YES：开启回声消除 NO:关闭回声消除，默认YES

开启回声消除，会对SDK采集到的音频数据进行过滤以降低音频中的回音成分，使声音更干净

Declared In

ChuangLiveEngine.h

`– enableAGC:`

开/关自动增益

- (void)enableAGC:(BOOL)enable

Parameters

`enable`	是否开启自动增益 YES：开启自动增益 NO:关闭自动增益默认YES 开启自动增益后声音会被放大，但会一定程度上影响音质

enable

是否开启自动增益 YES：开启自动增益 NO:关闭自动增益默认YES

开启自动增益后声音会被放大，但会一定程度上影响音质

Declared In

ChuangLiveEngine.h

`– enableANS:`

开/关噪声抑制

- (void)enableANS:(BOOL)enable

Parameters

`enable`	是否开启噪声抑制 YES：开启噪声抑制 NO:关闭噪声抑制默认YES 开启噪声抑制可以使人声更加清晰

enable

是否开启噪声抑制 YES：开启噪声抑制 NO:关闭噪声抑制默认YES

开启噪声抑制可以使人声更加清晰

Declared In

ChuangLiveEngine.h

`– enableAudioMixing:`

是否启用混音

- (int)enableAudioMixing:(BOOL)enable

Parameters

`enable`	是否开启混音，YES：开启混音，NO：不开启混音，默认NO.

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– setAudioMixingHandler:`

设置混音回调

- (int)setAudioMixingHandler:(nullable id<ChuangAudioMixingDelegate>)delegate

Parameters

`delegate`	自定义混音回调代理，详细代理方法见ChuangAudioMixingDelegate

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– startPlayStream:withCanvas:`

开始播放指定流(所在房间内的流)

- (int)startPlayStream:(NSString *)streamId withCanvas:(ChuangVideoCanvas *)videoCanvas

Parameters

`streamId`	流ID
`videoCanvas`	视频显示信息，修改videoCanvas属性值后再次调用该方法可以实现修改播流填充模式、镜像模式等，详见ChuangVideoCanvas

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– stopPlayStream:`

停止播放指定用户

- (void)stopPlayStream:(NSString *)streamId

Parameters

`streamId`	需要停止播放的流ID

Declared In

ChuangLiveEngine.h

`– startPlayStreamWithRoomId:streamId:withCanvas:`

开始跨房间播流

- (int)startPlayStreamWithRoomId:(NSString *)roomId streamId:(NSString *)streamId withCanvas:(ChuangVideoCanvas *)videoCanvas

Parameters

`roomId`	要播的流所在的房间ID
`streamId`	流ID
`videoCanvas`	视频显示信息，详见ChuangVideoCanvas

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– stopPlayStreamWithRoomId:andStreamId:`

停止跨房间播流

- (void)stopPlayStreamWithRoomId:(NSString *)roomId andStreamId:(NSString *)streamId

Parameters

`roomId`	房间名
`streamId`	流ID

Declared In

ChuangLiveEngine.h

`– enableCustomAudioRender:config:`

是否启用自定义渲染音频

- (int)enableCustomAudioRender:(BOOL)enable config:(ChuangCustomAudioRenderConfig *)config

Parameters

`enable`	YES：启用自定义渲染 NO：不启用自定义渲染。(默认：NO 不启用自定义渲染)
`config`	自定义渲染音频配置，详见ChuangCustomAudioRenderConfig

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– fetchCustomAudioRenderPCMData:dataLength:streamId:`

获取自定义渲染音频播放数据

- (int)fetchCustomAudioRenderPCMData:(int16_t *)data dataLength:(uint32_t)dataLength streamId:(NSString *)streamId

Parameters

`data`	数据
`dataLength`	数据长度（单位字节）
`streamId`	播流ID

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– enableCustomRemoteVideoRender:config:`

是否启用远端视频自定义渲染

- (int)enableCustomRemoteVideoRender:(BOOL)enable config:(ChuangCustomVideoRenderConfig *)config

Parameters

`enable`	YES：启用自定义渲染 NO：不启用自定义渲染。(默认：NO 不启用自定义渲染)
`config`	自定义渲染视频配置 , 详见ChuangCustomVideoRenderConfig

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– enableCustomLocalVideoRender:config:`

是否启用本地视频自定义渲染

- (int)enableCustomLocalVideoRender:(BOOL)enable config:(ChuangCustomVideoRenderConfig *)config

Parameters

`enable`	YES：启用自定义渲染 NO：不启用自定义渲染。(默认：NO 不启用自定义渲染)
`config`	自定义渲染视频配置 , 详见ChuangCustomVideoRenderConfig

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– setCustomVideoRenderHandler:`

设置自定义渲染视频回调

- (void)setCustomVideoRenderHandler:(id<ChuangVideoCustomRenderDelegate>)delegate

Parameters

`delegate`	自定义渲染视频回调代理，代理方法详见ChuangVideoCustomRenderDelegate

Declared In

ChuangLiveEngine.h

`– startSoundLevelMonitor`

开启音量监听

- (void)startSoundLevelMonitor

Declared In

ChuangLiveEngine.h

`– stopSoundLevelMonitor`

停止音量监听

- (void)stopSoundLevelMonitor

Declared In

ChuangLiveEngine.h

`– setSoundLevelMonitorInterval:`

设置音量回调间隔

- (int)setSoundLevelMonitorInterval:(int)intervalMs

Parameters

`intervalMs`	间隔，单位毫秒，10-5000, 默认200

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– muteLocalAudio:mute:`

静音本地指定流的音频

- (int)muteLocalAudio:(NSString *)streamId mute:(BOOL)mute

Parameters

`streamId`	流ID
`mute`	是否静音 YES:静音 NO:取消静音

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– muteRemoteAudio:mute:`

静音远端指定流的音频

- (int)muteRemoteAudio:(NSString *)streamId mute:(BOOL)mute

Parameters

`streamId`	流ID
`mute`	是否静音 YES:静音 NO:取消静音

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– muteLocalVideo:mute:`

关闭展示本地指定流的视频

- (int)muteLocalVideo:(NSString *)streamId mute:(BOOL)mute

Parameters

`streamId`	流ID
`mute`	是否关闭展示 YES:关闭 NO:取消关闭

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– muteRemoteVideo:mute:`

关闭展示远端指定流的视频

- (int)muteRemoteVideo:(NSString *)streamId mute:(BOOL)mute

Parameters

`streamId`	流ID
`mute`	是否关闭展示 YES:关闭 NO:取消关闭

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– setDummyCaptureImagePath:`

设置关闭摄像头时所推静态图路径

- (int)setDummyCaptureImagePath:(NSString *)imagePath

Parameters

`imagePath`	图片路径。如果是完整路径则添加file：前缀，如：@“file:绝对路径/image.png” ;资产则添加asset:前缀，如：@“asset:placeholderImg”

Return Value

调用结果,0:设置成功，非0设置失败。

Declared In

ChuangLiveEngine.h

`– startMixStream:`

开始混流

- (int)startMixStream:(ChuangMixStreamConfig *)mixConfig

Parameters

`mixConfig`	混流配置，详情查看ChuangMixStreamConfig

Return Value

返回 0 代表混流请求发送成功

Declared In

ChuangLiveEngine.h

`– stopMixStream`

停止混流

- (void)stopMixStream

Declared In

ChuangLiveEngine.h

`– startNetworkSpeedTest:`

开始网络测速

- (int)startNetworkSpeedTest:(ChuangNetworkSpeedTestConfig *)config

Parameters

`config`	测速配置，详见ChuangNetworkSpeedTestConfig

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– stopNetworkSpeedTest`

停止网络测速

- (void)stopNetworkSpeedTest

Declared In

ChuangLiveEngine.h

`– setAppOrientation:`

设置摄像头采集方向，默认是竖屏采集，不调用会默认竖屏,orientation传值参照ChuangAppOrientation

- (void)setAppOrientation:(ChuangAppOrientation)orientation

Parameters

`orientation`	详情参照ChuangAppOrientation，内部默认竖屏采集，当需要指定横屏采集的时候，如果需要横屏采集需要在开始预览和推流前设置

Declared In

ChuangLiveEngine.h

`– setRecordLocalDataEventHandler:`

设置录制本地推流音视频回调代理

- (void)setRecordLocalDataEventHandler:(id<ChuangLocalDataRecordDelegate>)handler

Parameters

`handler`	代理

Declared In

ChuangLiveEngine.h

`– startRecordLocalDataWithConfig:channelIndex:`

开始录制本地推流音视频(必须在发起推流，后调用)

- (void)startRecordLocalDataWithConfig:(ChuangDataRecordConfig *)config channelIndex:(int)channelIndex

Parameters

`config`	配置
`channelIndex`	推流通道

Declared In

ChuangLiveEngine.h

`– stopRecordLocalDataWithChannelIndex:`

停止录制本地推流音视频

- (void)stopRecordLocalDataWithChannelIndex:(NSInteger)channelIndex

Parameters

`channelIndex`	推流通道

Declared In

ChuangLiveEngine.h

`– setRecordRemoteDataEventHandler:`

设置录制远端音视频回调代理

- (void)setRecordRemoteDataEventHandler:(id<ChuangRemoteDataRecordDelegate>)handler

Parameters

`handler`	代理

Declared In

ChuangLiveEngine.h

`– startRecordRemoteDataWithConfig:streamId:`

开始录制远端音视频(必须在发起播流，后调用)

- (void)startRecordRemoteDataWithConfig:(ChuangDataRecordConfig *)config streamId:(NSString *)streamId

Parameters

`config`	配置
`streamId`	远端流ID

Declared In

ChuangLiveEngine.h

`– stopRecordRemoteDataWithStreamId:`

停止录制远端音视频

- (void)stopRecordRemoteDataWithStreamId:(NSString *)streamId

Parameters

`streamId`	远端流ID

Declared In

ChuangLiveEngine.h

`– setAudioConfig:channelIndex:`

设置音频配置

- (int)setAudioConfig:(ChuangAudioConfig *)audioConfig channelIndex:(int)channelIndex

Parameters

`audioConfig`	音频配置，详见ChuangAudioConfig
`channelIndex`	推流通道

Return Value

返回 0 表示成功调用接口成功

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– setVideoConfig:channelIndex:`

设置视频推流配置

- (int)setVideoConfig:(ChuangVideoConfig *)videoConfig channelIndex:(int)channelIndex

Parameters

`videoConfig`	视频推流配置，详见ChuangVideoConfig
`channelIndex`	推流通道

Return Value

返回 0 表示成功调用接口成功

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– getVideoConfigWithChannelIndex:`

获取指定通道的视频推流配置，详见ChuangVideoConfig

- (ChuangVideoConfig *)getVideoConfigWithChannelIndex:(int)channelIndex

Parameters

`channelIndex`	推流通道

Return Value

返回指定通道的流视频配置

Declared In

ChuangLiveEngine.h

`– startPublishStream:channelIndex:`

开始指定通道的推流

- (int)startPublishStream:(ChuangStreamConfig *)streamConfig channelIndex:(int)channelIndex

Parameters

`streamConfig`	推流配置参数对象，详情查看ChuangStreamConfig
`channelIndex`	推流通道

Return Value

调用结果 0：成功，非0：失败，返回 0 表示推流请求成功，其他值均为失败

Declared In

ChuangLiveEngine.h

`– stopPublishStreamWithChannelIndex:`

停止指定通道的推流

- (void)stopPublishStreamWithChannelIndex:(int)channelIndex

Parameters

`channelIndex`	推流通道

Declared In

ChuangLiveEngine.h

`– enableCustomAudioCapture:config:channelIndex:`

是否启用指定通道的自定义采集音频

- (int)enableCustomAudioCapture:(BOOL)enable config:(ChuangCustomAudioCaptureConfig *)config channelIndex:(int)channelIndex

Parameters

`enable`	YES：启用自定义采集 NO：不启用自定义采集。(默认：NO 不启用自定义采集)
`config`	自定义采集音频配置，详见ChuangCustomAudioCaptureConfig
`channelIndex`	推流通道

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– enableCustomVideoCapture:config:channelIndex:`

开始或停止自定义采集视频,支持设置其他通道的推流

- (int)enableCustomVideoCapture:(BOOL)enable config:(ChuangCustomVideoCaptureConfig *)config channelIndex:(int)channelIndex

Parameters

`enable`	YES：启用自定义采集 NO：不启用自定义采集。(默认：NO 不启用自定义采集)
`config`	自定义采集视频配置，详见ChuangCustomVideoCaptureConfig
`channelIndex`	推流通道

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– sendCustomVideoCapturePixelBuffer:videoRoration:timeStamp:channelIndex:`

传入指定通道自定义视频帧 (CVPixelBufferRef类型)

- (int)sendCustomVideoCapturePixelBuffer:(CVPixelBufferRef)pixelBuffer videoRoration:(ChuangStreamRotation)rotation timeStamp:(uint64_t)timeStamp channelIndex:(int)channelIndex

Parameters

`pixelBuffer`	视频帧
`rotation`	屏幕方向。详见ChuangStreamRotation
`timeStamp`	时间戳
`channelIndex`	推流通道

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– sendCustomVideoCaptureRawData:param:timeStamp:channelIndex:`

传入指定通道自定义视频帧 (rawData裸数据)

- (int)sendCustomVideoCaptureRawData:(NSData *)rawData param:(ChuangVideoRawDataFrameParam *)videFrame timeStamp:(uint64_t)timeStamp channelIndex:(int)channelIndex

Parameters

`rawData`	raw data ，要向 SDK 发送的视频帧数据
`videFrame`	视频帧参数，详见ChuangVideoRawDataFrameParam
`timeStamp`	时间戳
`channelIndex`	推流通道

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– sendCustomVideoCaptureEncodedData:param:timestamp:channelIndex:`

发送指定通道自定义采集的视频帧编码后的数据(默认支持H.264编码)

- (int)sendCustomVideoCaptureEncodedData:(NSData *)data param:(ChuangEncodedFrameParam *)param timestamp:(uint64_t)timestamp channelIndex:(int)channelIndex

Parameters

`data`	发送的编码后的视频帧数据
`param`	视频帧的参数，详见ChuangEncodedFrameParam
`timestamp`	视频帧的索引时间
`channelIndex`	推流通道

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– enableAudioMixing:channelIndex:`

是否指定通道启用混音

- (int)enableAudioMixing:(BOOL)enable channelIndex:(int)channelIndex

Parameters

`enable`	是否开启混音，YES：开启混音，NO：不开启混音，默认NO.
`channelIndex`	推流通道

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h

`– enableTrafficControl:property:channelIndex:`

开始或停止指定通道的推流流量控制

- (void)enableTrafficControl:(BOOL)enable property:(ChuangTrafficControlProperty)property channelIndex:(int)channelIndex

Parameters

`enable`	是否使用流量控制。YES 表示开启流控，NO 表示关闭流控。默认为 YES。
`property`	流量控制的属性，位掩码格式。具体可设置为 [ChuangTrafficControlProperty] 的属性的一个或多个枚举组合。
`channelIndex`	推流通道

Discussion

Note: 在推流 [startPublishStream] 之前调用生效，最后一次调用会覆盖前面的调用。

Declared In

ChuangLiveEngine.h

`– setDummyCaptureImagePath:channelIndex:`

设置指定通道的关闭摄像头时所推静态图路径

- (int)setDummyCaptureImagePath:(NSString *)imagePath channelIndex:(int)channelIndex

Parameters

`imagePath`	图片路径。如果是完整路径则添加file：前缀，如：@“file:绝对路径/image.png” ;资产则添加asset:前缀，如：@“asset:placeholderImg”
`channelIndex`	推流通道

Return Value

调用结果,0:设置成功，非0设置失败。

Declared In

ChuangLiveEngine.h

`– sendCustomAudioCapturePCMData:channelIndex:`

向指定通道发送自定义采集的音频pcm数据

- (int)sendCustomAudioCapturePCMData:(NSData *)data channelIndex:(int)channelIndex

Parameters

`data`	pcm数据
`channelIndex`	推流通道

Return Value

调用结果

Declared In

ChuangLiveEngine.h

`– setVideoMirrorMode:channelIndex:`

设置指定通道的镜像模式

- (void)setVideoMirrorMode:(ChuangVideoMirrorMode)mirrorMode channelIndex:(int)channelIndex

Parameters

`mirrorMode`	预览或者推流的镜像模式，详情参照：ChuangVideoMirrorMode ，默认：本地预览镜像推流不镜像。注意：预览镜像只对前置摄像头有效，后置无效。
`channelIndex`	推流通道

Declared In

ChuangLiveEngine.h

`– takePublishStreamSnapshot:channelIndex:`

获取指定流的推流视频截图

- (int)takePublishStreamSnapshot:(ChuangTakeSnapshotCallback)imageCallback channelIndex:(int)channelIndex

Parameters

`imageCallback`	截图回调详情见ChuangTakeSnapshotCallback
`channelIndex`	推流通道

Return Value

调用结果 0：成功，非0：失败

Declared In

ChuangLiveEngine.h