My Project
Instance Methods | Class Methods | List of all members
CCStreamer Class Reference
Inheritance diagram for CCStreamer:

Instance Methods

(void) - onStreamStatsListener:
 
(BOOL) - setServerDomain:area:
 
(BOOL) - setCameraType:
 
(void) - startPreview:
 
(BOOL) - stopPreview
 
(BOOL) - loginWithRoomID:userID:role:password:nickName:config:videoOri:areaCode:completion:
 
(BOOL) - joinRoom:
 
(BOOL) - leaveRoom:
 
(BOOL) - startPublish:
 
(BOOL) - startPublishWithRecord:completion:
 
(BOOL) - stopPublish:
 
(BOOL) - publish:
 
(BOOL) - unPublish:
 
(BOOL) - kickUserFromRoom:
 
(BOOL) - stopLive:
 
(BOOL) - releaseAnnouncement:completion:
 
(BOOL) - removeAnnouncement:
 
(BOOL) - gagUser:
 
(BOOL) - recoveGagUser:
 
(BOOL) - authUserDraw:
 
(BOOL) - cancleAuthUserDraw:
 
(BOOL) - authUserAssistant:
 
(BOOL) - cancleAuthUserAssistant:
 
(BOOL) - getAudienceChatStatus:
 
(BOOL) - handup
 
(BOOL) - cancleHandup
 
(BOOL) - startNamed:
 
(NSDictionary *) - getNamedInfo
 
(NSArray *) - getStudentNamedList
 
(BOOL) - studentNamed
 
(BOOL) - requestLianMai:
 
(BOOL) - cancleLianMai:
 
(BOOL) - stopLianMai:
 
(NSInteger) - getLianMaiNum
 
(BOOL) - kickUserFromLianmai:completion:
 
(BOOL) - inviteUserLianMai:completion:
 
(BOOL) - cancleInviteUserLianMai:completion:
 
(BOOL) - certainHandup:completion:
 
(BOOL) - refuseTeacherInvite:
 
(BOOL) - acceptTeacherInvite:
 
(BOOL) - getDocHistory:
 
(BOOL) - getRoomServerWithUserID:completion:
 
(BOOL) - getRelatedRoomDocs:userID:docID:docName:pageNumber:pageSize:completion:
 
(BOOL) - unReleatedDoc:roomID:userID:completion:
 
(BOOL) - docPageChange:
 
(BOOL) - addExternalOutput:completion:
 
(BOOL) - removeExternalOutput:completion:
 
(BOOL) - setVideoOpened:userID:
 
(BOOL) - setAudioOpened:userID:
 
(BOOL) - subcribeStream:role:qualityLevel:completion:
 
(BOOL) - unsubscribeStream:completion:
 
(NSArray *) - getAllEnableSubStreamIDs
 
(BOOL) - setRegion:completion:
 
(BOOL) - getRoomDescWithRoonID:completion:
 
(BOOL) - changeRoomClassType:completion:
 
(BOOL) - changeRoomVideoMode:completion:
 
(BOOL) - changeRoomName:completion:
 
(BOOL) - changeRoomDetail:completion:
 
(BOOL) - changeRoomTemplateMode:completion:
 
(BOOL) - changeRoomTeacherBitrate:completion:
 
(BOOL) - changeRoomStudentBitrate:completion:
 
(BOOL) - changeMainStreamInSigleTemplate:completion:
 
(BOOL) - changeRoomAudioState:completion:
 
(BOOL) - changeRoomRotate:time:completion:
 
(BOOL) - rotateLockUser:completion:
 
(BOOL) - rotateUnLockUser:completion:
 
(BOOL) - gagAll:
 
(BOOL) - changeRoomAllKickDownMai:
 
(BOOL) - recoverGagAll:
 
(BOOL) - sendMsg:
 
(void) - sendDrawData:
 
(BOOL) - sendAnimationChange:
 
(BOOL) - updateUserCount
 
(CCRoom *) - getRoomInfo
 
(BOOL) - sendVoteSelected:singleAns:voteID:publisherID:
 
(BOOL) - sendBrainReply:title:text:
 
(BOOL) - sendVoteTickedReply:title:choice:
 
(BOOL) - rewardUid:uName:type:sender:
 
(BOOL) - getPicUploadToken:
 
(BOOL) - sendPic:
 
(AVCaptureSession *) - getCaptureSession
 
(void) - stopSession
 
(void) - startSession
 
(CCUser *) - getUSerInfoWithUserID:
 
(BOOL) - getConnectionStats:completion:
 
(BOOL) - getLiveStatus:
 
(void) - realsesAllStream
 
(void) - assistLM:completion:
 
(void) - assistDM:completion:
 
(void) - presentDM:byUser:completion:
 
(void) - rolePreLM:completion:
 

Class Methods

(instancetype) + sharedStreamer
 
(void) + setLogState:
 

Method Documentation

◆ acceptTeacherInvite:()

- (BOOL) acceptTeacherInvite: (CCComletionBlock)  completion

同意老师的上麦邀请

Parameters
completion结果
Returns
操作结果

◆ addExternalOutput:completion:()

- (BOOL) addExternalOutput: (NSString *)  url
completion: (CCComletionBlock)  completion 

设置第三方推流地址

Parameters
url第三方推流地址(rtmp地址)
completion结果
Returns
操作结果

◆ assistDM:completion:()

- (void) assistDM: (CCUser *)  user
completion: (CCComletionBlock)  completion 

助教下麦–助教下麦,状态变更为0

Parameters
completion回调

◆ assistLM:completion:()

- (void) assistLM: (BOOL)  published
completion: (CCComletionBlock)  completion 

助教上麦–助教推流后调用,更新状态为3

Parameters
completion回调

◆ authUserAssistant:()

- (BOOL) authUserAssistant: (NSString *)  userID

对某个学生设为讲师

Parameters
userID学生ID
Returns
操作结果

◆ authUserDraw:()

- (BOOL) authUserDraw: (NSString *)  userID

对某个学生授权标注

Parameters
userID学生ID
Returns
操作结果

◆ cancleAuthUserAssistant:()

- (BOOL) cancleAuthUserAssistant: (NSString *)  userID

取消对某个学生的设为讲师

Parameters
userID学生ID
Returns
操作结果

◆ cancleAuthUserDraw:()

- (BOOL) cancleAuthUserDraw: (NSString *)  userID

取消对某个学生的标注功能

Parameters
userID学生ID
Returns
操作结果

◆ cancleHandup()

- (BOOL) cancleHandup

学生取消举手

Returns
状态

◆ cancleInviteUserLianMai:completion:()

- (BOOL) cancleInviteUserLianMai: (NSString *)  userID
completion: (CCComletionBlock)  completion 

老师取消对学生的上麦邀请

Parameters
userID学生ID
completion结果
Returns
操作结果

◆ cancleLianMai:()

- (BOOL) cancleLianMai: (CCComletionBlock)  completion

取消排麦

Returns
操作结果

◆ certainHandup:completion:()

- (BOOL) certainHandup: (NSString *)  userID
completion: (CCComletionBlock)  completion 

同意举手学生连麦

Parameters
userID学生ID
completion结果
Returns
操作结果

◆ changeMainStreamInSigleTemplate:completion:()

- (BOOL) changeMainStreamInSigleTemplate: (NSString *)  userID
completion: (CCComletionBlock)  completion 

主视频模式跟随,老师切换视频(userID 为空表示关闭)

Parameters
userID切换到大屏的学生ID
Returns
操作结果

◆ changeRoomAllKickDownMai:()

- (BOOL) changeRoomAllKickDownMai: (CCComletionBlock)  completion

切换房间上麦状态(全部踢下麦)

Parameters
completion回调
Returns
操作结果

◆ changeRoomAudioState:completion:()

- (BOOL) changeRoomAudioState: (BOOL)  audioState
completion: (CCComletionBlock)  completion 

切换房间麦克风状态

Parameters
audioState麦克风状态
completion回调
Returns
操作结果

◆ changeRoomClassType:completion:()

- (BOOL) changeRoomClassType: (CCClassType)  type
completion: (CCComletionBlock)  completion 

切换连麦模式

Parameters
type模式
Returns
操作结果

◆ changeRoomDetail:completion:()

- (BOOL) changeRoomDetail: (NSString *)  detail
completion: (CCComletionBlock)  completion 

设置直播间介绍

Parameters
detail介绍
completion回调结果
Returns
操作结果

◆ changeRoomName:completion:()

- (BOOL) changeRoomName: (NSString *)  name
completion: (CCComletionBlock)  completion 

设置直播间名字

Parameters
name名字
completion回调结果
Returns
操作结果

◆ changeRoomRotate:time:completion:()

- (BOOL) changeRoomRotate: (CCRotateType)  type
time: (float)  time
completion: (CCComletionBlock)  completion 

开启、关闭、变更轮播

Parameters
type操作类型
time轮播时间(开启或者变更的时候需要该参数,关闭不需要)
completion回调闭包
Returns
操作结果

◆ changeRoomStudentBitrate:completion:()

- (BOOL) changeRoomStudentBitrate: (CCUserBitrate)  bitrate
completion: (CCComletionBlock)  completion 

修改房间学生推流码率

Parameters
bitrate码率
completion回调
Returns
操作结果

◆ changeRoomTeacherBitrate:completion:()

- (BOOL) changeRoomTeacherBitrate: (CCUserBitrate)  bitrate
completion: (CCComletionBlock)  completion 

修改房间老师推流码率

Parameters
bitrate码率
completion会滴
Returns
操作结果

◆ changeRoomTemplateMode:completion:()

- (BOOL) changeRoomTemplateMode: (CCRoomTemplate)  tem
completion: (CCComletionBlock)  completion 

改变房间模板

Parameters
tem模板
Returns
操作结果

◆ changeRoomVideoMode:completion:()

- (BOOL) changeRoomVideoMode: (CCVideoMode)  videoMode
completion: (CCComletionBlock)  completion 

改变连麦音视频权限

Parameters
videoMode连麦音视频权限
Returns
操作结果

◆ docPageChange:()

- (BOOL) docPageChange: (NSDictionary *)  info

老师单文档翻页

Parameters
info数据信息
Returns
操作结果

◆ gagAll:()

- (BOOL) gagAll: (CCComletionBlock)  completion

全体禁言

Parameters
completion回调闭包
Returns
操作结果

◆ gagUser:()

- (BOOL) gagUser: (NSString *)  userID

对某个学生禁言

Parameters
userID学生ID
Returns
操作结果

◆ getAllEnableSubStreamIDs()

- (NSArray *) getAllEnableSubStreamIDs

获取所有可以订阅的流ID

Returns
流ID

◆ getAudienceChatStatus:()

- (BOOL) getAudienceChatStatus: (NSString *)  userID

获取旁听的禁言状态(YES表示禁言中)

Parameters
userID旁听的ID
Returns
状态

◆ getCaptureSession()

- (AVCaptureSession *) getCaptureSession

获取相机对象

Returns
相机对象

◆ getConnectionStats:completion:()

- (BOOL) getConnectionStats: (NSString *)  stream
completion: (CCComletionBlock)  completion 

获取流状态

Parameters
stream
completion回调闭包
Returns
操作结果

◆ getDocHistory:()

- (BOOL) getDocHistory: (CCComletionBlock)  completion

获取文档历史信息

Returns
操作结果

◆ getLianMaiNum()

- (NSInteger) getLianMaiNum

获取麦序

Returns
麦序

◆ getLiveStatus:()

- (BOOL) getLiveStatus: (CCComletionBlock)  completion

获取直播间状态

◆ getNamedInfo()

- (NSDictionary *) getNamedInfo

获取老师点名的信息(老师端有效)

Returns
信息

◆ getPicUploadToken:()

- (BOOL) getPicUploadToken: (CCComletionBlock)  completion

获取上传图片token(这里也可以使用自己的存储上传图片)

Parameters
completiontoken
Returns
操作结果

◆ getRelatedRoomDocs:userID:docID:docName:pageNumber:pageSize:completion:()

- (BOOL) getRelatedRoomDocs: (NSString *)  roomID
userID: (NSString *)  userID
docID: (NSString *)  docID
docName: (NSString *)  docName
pageNumber: (int)  page
pageSize: (int)  size
completion: (CCComletionBlock)  completion 

获取房间机构文档

Parameters
roomID房间ID(缺省为当前登录的房间ID)
userID房间ID(缺省为当前登录的房间userID)
docID文档ID(可选)
docName文档名字(可选)
page请求页码(获取指定页,默认返回第一页< 可选>="">)
size请求每页条目数(每页的数据条数,默认每页50< 可选>="">)
completion回调
Returns
操作结果

◆ getRoomDescWithRoonID:completion:()

- (BOOL) getRoomDescWithRoonID: (NSString *)  roomID
completion: (CCComletionBlock)  completion 

获取直播间简介

Parameters
roomID房间ID
completion回调
Returns
操作结果

◆ getRoomInfo()

- (CCRoom *) getRoomInfo

获取当前CCRoom

Returns
当前房间信息

◆ getRoomServerWithUserID:completion:()

- (BOOL) getRoomServerWithUserID: (NSString *)  userId
completion: (CCComletionBlock)  completion 

获取节点列表

Parameters
userId用户id
Returns
操作结果

◆ getStudentNamedList()

- (NSArray *) getStudentNamedList

获取答到的学生列表

Returns
列表

◆ getUSerInfoWithUserID:()

- (CCUser *) getUSerInfoWithUserID: (NSString *)  userID

获取用户

Parameters
userID用户ID
Returns
用户

◆ handup()

- (BOOL) handup

学生举手

Returns
状态

◆ inviteUserLianMai:completion:()

- (BOOL) inviteUserLianMai: (NSString *)  userID
completion: (CCComletionBlock)  completion 

老师邀请没有举手学生连麦(只对老师有效)

Parameters
userID学生ID
Returns
操作结果

◆ joinRoom:()

- (BOOL) joinRoom: (CCComletionBlock)  completion

加入房间

Parameters
completion结果
Returns
操作结果

◆ kickUserFromLianmai:completion:()

- (BOOL) kickUserFromLianmai: (NSString *)  userID
completion: (CCComletionBlock)  completion 

将连麦者踢下麦

Parameters
userID连麦者userID
Returns
操作结果

◆ kickUserFromRoom:()

- (BOOL) kickUserFromRoom: (NSString *)  userID

踢出房间

Parameters
userID用户ID
Returns
操作结果

◆ leaveRoom:()

- (BOOL) leaveRoom: (CCComletionBlock)  completion

退出

Returns
操作结果

◆ loginWithRoomID:userID:role:password:nickName:config:videoOri:areaCode:completion:()

- (BOOL) loginWithRoomID: (NSString *)  roomID
userID: (NSString *)  userID
role: (CCRole)  role
password: (NSString *)  password
nickName: (NSString *)  name
config: (CCEncodeConfig *)  config
videoOri: (CCVideoOriMode)  isLandSpace
areaCode: (NSString *)  areaCode
completion: (CCComletionBlock)  completion 

登录接口

Parameters
roomID房间ID
userID用户ID
role角色
password密码
name昵称
areaCode节点
Returns
操作结果

◆ onStreamStatsListener:()

- (void) onStreamStatsListener: (CCComletionBlock)  completion

黑流检测监听事件

◆ presentDM:byUser:completion:()

- (void) presentDM: (CCUser *)  user
byUser: (NSString *)  userId
completion: (CCComletionBlock)  completion 

老师下麦–老师下麦,状态变更为0

Parameters
user被下麦用户,如果为nil,默认当前g用户
userId被谁下麦 | nil 自己下麦
completion回调

◆ publish:()

- (BOOL) publish: (CCComletionBlock)  completion

结束推流

Returns
操作结果

◆ realsesAllStream()

- (void) realsesAllStream

释放所有已订阅的流(学生退出超时调用)

◆ recoveGagUser:()

- (BOOL) recoveGagUser: (NSString *)  userID

取消对某个学生禁言

Parameters
userID学生ID
Returns
操作结果

◆ recoverGagAll:()

- (BOOL) recoverGagAll: (CCComletionBlock)  completion

取消全体禁言

Parameters
completion回调闭包
Returns
操作结果

◆ refuseTeacherInvite:()

- (BOOL) refuseTeacherInvite: (CCComletionBlock)  completion

拒绝老师的连麦邀请

Parameters
completion结果
Returns
操作结果

◆ releaseAnnouncement:completion:()

- (BOOL) releaseAnnouncement: (NSString *)  message
completion: (CCComletionBlock)  completion 

发布公告

Parameters
message公告内容
completion结果
Returns
操作结果

◆ removeAnnouncement:()

- (BOOL) removeAnnouncement: (CCComletionBlock)  completion

清除公告

Parameters
completion回调结果
Returns
操作结果

◆ removeExternalOutput:completion:()

- (BOOL) removeExternalOutput: (NSString *)  url
completion: (CCComletionBlock)  completion 

清除第三方推流地址

Parameters
url地址
completion回调闭包
Returns
操作结果

◆ requestLianMai:()

- (BOOL) requestLianMai: (CCComletionBlock)  completion

开始连麦(改为排麦中)

Returns
操作结果

◆ rewardUid:uName:type:sender:()

- (BOOL) rewardUid: (NSString *)  uid
uName: (NSString *)  uName
type: (NSString *)  actionType
sender: (NSString *)  sid 

奖杯、鲜花

Parameters
uid用户id
uName用户名称
actionType操作类型 | flower 鲜花 cup 奖杯
sid发送者id

◆ rolePreLM:completion:()

- (void) rolePreLM: (CCUser *)  user
completion: (CCComletionBlock)  completion 

讲师\助教 – 状态变更为5

Parameters
user预上麦人员
completion回调

◆ rotateLockUser:completion:()

- (BOOL) rotateLockUser: (NSString *)  userID
completion: (CCComletionBlock)  completion 

轮播模式锁定用户

Parameters
userID用户ID
completion回调闭包
Returns
操作结果

◆ rotateUnLockUser:completion:()

- (BOOL) rotateUnLockUser: (NSString *)  userID
completion: (CCComletionBlock)  completion 

轮播模式解锁用户

Parameters
userID用户ID
completion回调闭包
Returns
操作结果

◆ sendAnimationChange:()

- (BOOL) sendAnimationChange: (NSDictionary *)  info

发送文档动画数据

Parameters
info数据

◆ sendBrainReply:title:text:()

- (BOOL) sendBrainReply: (NSString *)  Id
title: (NSString *)  title
text: (NSString *)  content 

发送头脑风暴答案

Parameters
Id问题id
title问题title
content问题回答

◆ sendDrawData:()

- (void) sendDrawData: (NSDictionary *)  info

发送画笔数据

Parameters
info画笔数据

◆ sendMsg:()

- (BOOL) sendMsg: (NSString *)  message

发送公聊信息

◆ sendPic:()

- (BOOL) sendPic: (NSString *)  url

发送聊天图片

Parameters
url图片地址
Returns
操作结果

◆ sendVoteSelected:singleAns:voteID:publisherID:()

- (BOOL) sendVoteSelected: (NSArray *)  multAns
singleAns: (NSInteger)  singleAns
voteID: (NSString *)  voteID
publisherID: (NSString *)  publisherID 

发送答题答案

Parameters
multAns多选的答案
singleAns单选答案
voteID答题ID
publisherID答题发起者ID

◆ sendVoteTickedReply:title:choice:()

- (BOOL) sendVoteTickedReply: (NSString *)  Id
title: (NSString *)  title
choice: (NSArray *)  choices 

发送投票答案

Parameters
Id投票id
title投票title
choices投票回答

◆ setAudioOpened:userID:()

- (BOOL) setAudioOpened: (BOOL)  opened
userID: (NSString *)  userID 

设置音频状态(开始直播之后才生效)

Parameters
opened音频状态
userID学生ID(为空表示操作自己的音频)
Returns
操作结果

◆ setCameraType:()

- (BOOL) setCameraType: (AVCaptureDevicePosition)  pos

设置摄像头 切换摄像头(在login之后调用)

Parameters
pos摄像头位置
Returns
操作结果

◆ setLogState:()

+ (void) setLogState: (BOOL)  state

设置日志是否开启(默认开启)

Parameters
state状态

◆ setRegion:completion:()

- (BOOL) setRegion: (NSString *)  streamID
completion: (CCComletionBlock)  completion 

修改合流的主视频流

Parameters
streamID流ID

◆ setServerDomain:area:()

- (BOOL) setServerDomain: (NSString *)  domain
area: (NSString *)  area 

设置访问域名 设置访问域名

Parameters
domain课堂域名
area区域参数 |- 国内:HB、HD、HN | 亚洲:DNY | 美国:MD、MX | 欧洲:OZD、OZX -|
Returns
操作结果

◆ setVideoOpened:userID:()

- (BOOL) setVideoOpened: (BOOL)  opened
userID: (NSString *)  userID 

设置视频状态(开始直播之后生效)

Parameters
opened视频状态
userID学生ID(为空表示操作自己的视频)
Returns
操作结果

◆ sharedStreamer()

+ (instancetype) sharedStreamer

单例 单例

Returns
streamer

◆ startNamed:()

- (BOOL) startNamed: (NSTimeInterval)  duration

老师开始点名

Parameters
duration点名有效期
Returns
操作结果

◆ startPreview:()

- (void) startPreview: (CCComletionBlock)  completion

开始预览 开启摄像头开启预览,在login之后开始推流之前调用

Parameters
completion回调

◆ startPublish:()

- (BOOL) startPublish: (CCComletionBlock)  completion

开始直播

Returns
操作结果

◆ startPublishWithRecord:completion:()

- (BOOL) startPublishWithRecord: (BOOL)  record
completion: (CCComletionBlock)  completion 

开始直播

Parameters
record是否开启直播录制
Returns
操作结果

◆ startSession()

- (void) startSession

开启相机session

◆ stopLianMai:()

- (BOOL) stopLianMai: (CCComletionBlock)  completion

结束连麦

Returns
操作结果

◆ stopLive:()

- (BOOL) stopLive: (CCComletionBlock)  completion

停止直播(login返回直播状态是直播中,假如开始新的直播需要调用该接口,继续直播则不需要)

Parameters
completion停止结果
Returns
操作结果

◆ stopPreview()

- (BOOL) stopPreview

停止预览(login out 包含该操作)

Returns
操作结果

◆ stopPublish:()

- (BOOL) stopPublish: (CCComletionBlock)  completion

结束直播

Returns
操作结果

◆ stopSession()

- (void) stopSession

停止相机session

◆ studentNamed()

- (BOOL) studentNamed

学生答到

Returns
操作结果

◆ subcribeStream:role:qualityLevel:completion:()

- (BOOL) subcribeStream: (NSString *)  streamID
role: (CCRole)  role
qualityLevel: (int)  level
completion: (CCComletionBlock)  completion 

订阅某人画面(不需要观看的时候要取消订阅)

Parameters
streamID流id
role角色
level画面质量(0:BestQuality,1:BetterQuality, 2:Standard, 3:BetterSpeed, 4:BestSpeed)
Returns
操作结果

◆ unPublish:()

- (BOOL) unPublish: (CCComletionBlock)  completion

结束推流

Returns
操作结果

◆ unReleatedDoc:roomID:userID:completion:()

- (BOOL) unReleatedDoc: (NSString *)  docID
roomID: (NSString *)  roomID
userID: (NSString *)  userID
completion: (CCComletionBlock)  completion 

删除机构文档

Parameters
docID文档ID
roomID房间ID(缺省为当前登录的房间ID)
userID房间ID(缺省为当前登录的房间userID)
completion回调
Returns
操作结果

◆ unsubscribeStream:completion:()

- (BOOL) unsubscribeStream: (NSString *)  streamID
completion: (CCComletionBlock)  completion 

取消订阅某人画面

Parameters
streamID流ID
Returns
操作结果

◆ updateUserCount()

- (BOOL) updateUserCount

更新房间在线人数


The documentation for this class was generated from the following file: