iOS

iOS API文档

基本功能方法

基本功能事件方法可点击 CCLiveEngine查看。

初始化

方法 描述
initEngineWithAppId:andAppKey: SDK初始化方法
destroy SDK销毁方法

房间管理

方法 描述
loginRoom:userId:role:andDelegate: 登陆房间
logoutRoom 退出房间

推流功能

方法 描述
setLocalView:videoRenderMode: 设置本端推流视图,videoRenderMode详情看CCVideoRenderMode
publishStream:withStreamConfig: 开始推本端视频流,参数configutation详情看CCStreamConfig
stopPublishStream 停止推本端视频流
switchCamera: 前后摄像头切换
setMicMute: 设置麦克风是否静音
注意:调用推流接口:publishStream:withStreamConfig:,如果推流的同时开启rtmp推流,则需要给推流接口的StreamConfig中的RtmpAddress传rtmp地址,不开启则地址传空

播流功能

方法 描述
playStream:withPlayView:andRendMode: 开始播远端视频流,参数userInfo详情看CCStreamInfo
stopPlayStream: 停止播远端视频流,参数userInfo请查看CCStreamInfo

进阶功能【可选】

混流功能

适用于多人互动直播场景,需要将多路视频流混成一路流然后转推出去。

方法 描述
startStreamMixWithConfig: 开始混流,参数mixConfig详情看CCStreamMixConfig
stopStreamMix 停止混流
updateStreamMixWithConfig: 更新混流布局方法,混流期间房间流变化需更新混流布局
注意:调用上面混流接口:startStreamMixWithConfig:,如果混流后转推rtmp,则需要给混流接口的mixStreams传混流的rtmp地址,不开启则地址传空

发送流附加消息

方法 描述
sendStreamAttachMessage: 发送推流附加消息

跨房间播流

方法 描述
playStreamWithRoomId:streamId:andPlayView:andRendMode: 开始跨房间播流
stopPlayWithRoomId:andStreamId: 停止跨房间播流

基本事件回调方法

主要回调方法

设置遵循协议CCLiveEngineDelegate的自定义类为CCLiveEngine代理(delegate)后,会收到回调方法。以下为所有的回调方法:

方法 描述
onLoginRoomCallBack: 登陆房间回调方法
onLiveStreamsAddedCallBack: 新加入房间的流信息回调(除自己外的推流),更新播流比较重要的方法
onLiveStreamsRemovedCallBack: 离开房间的流信息回调(除自己外的推流),更新播流比较重要的方法
onLogoutRoomCallBack 退出房间回调方法
onPublishDidStartCallBack 开始推流回调方法
onPublishDidStopCallBack: 停止推流回调方法
onPlayDidStartCallBack: 开始播流回调方法
onPlayDidStopCallBackWithCode:andStreamName: 停止播流回调方法
onInitMicrophoneFaildCallBack 麦克风初始化失败回调方法
onMicrophoneVolumeLevelChangedCallBack: 麦克风声量变化回调方法
onPublishStreamStatusCallback: 当前推流状态变化回调方法
onPlayStreamStatusCallBack: 当前播流状态变化回调
onMixStreamCallBack: 混流结果回调
onReceiveStreamAttachMessage:andStreamId:timestampOffset:: 收到流附加消息回调
onPlayStreamStatusCallBack: 本地网络类型发生变化回调,netWorkType详情看CCNetworkType

接口链接: