◆ acceptTeacherInvite:()
- (BOOL) acceptTeacherInvite: |
|
(CCComletionBlock) |
completion |
|
同意老师的上麦邀请
- Parameters
-
- 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
-
◆ assistLM:completion:()
- (void) assistLM: |
|
(BOOL) |
published |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
助教上麦–助教推流后调用,更新状态为3
- Parameters
-
◆ authUserAssistant:()
- (BOOL) authUserAssistant: |
|
(NSString *) |
userID |
|
对某个学生设为讲师
- Parameters
-
- Returns
- 操作结果
◆ authUserDraw:()
- (BOOL) authUserDraw: |
|
(NSString *) |
userID |
|
对某个学生授权标注
- Parameters
-
- Returns
- 操作结果
◆ cancleAuthUserAssistant:()
- (BOOL) cancleAuthUserAssistant: |
|
(NSString *) |
userID |
|
取消对某个学生的设为讲师
- Parameters
-
- Returns
- 操作结果
◆ cancleAuthUserDraw:()
- (BOOL) cancleAuthUserDraw: |
|
(NSString *) |
userID |
|
取消对某个学生的标注功能
- Parameters
-
- Returns
- 操作结果
◆ cancleHandup()
◆ cancleInviteUserLianMai:completion:()
- (BOOL) cancleInviteUserLianMai: |
|
(NSString *) |
userID |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
老师取消对学生的上麦邀请
- Parameters
-
- Returns
- 操作结果
◆ cancleLianMai:()
- (BOOL) cancleLianMai: |
|
(CCComletionBlock) |
completion |
|
◆ certainHandup:completion:()
- (BOOL) certainHandup: |
|
(NSString *) |
userID |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
同意举手学生连麦
- Parameters
-
- Returns
- 操作结果
◆ changeMainStreamInSigleTemplate:completion:()
- (BOOL) changeMainStreamInSigleTemplate: |
|
(NSString *) |
userID |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
主视频模式跟随,老师切换视频(userID 为空表示关闭)
- Parameters
-
- Returns
- 操作结果
◆ changeRoomAllKickDownMai:()
- (BOOL) changeRoomAllKickDownMai: |
|
(CCComletionBlock) |
completion |
|
切换房间上麦状态(全部踢下麦)
- Parameters
-
- Returns
- 操作结果
◆ changeRoomAudioState:completion:()
- (BOOL) changeRoomAudioState: |
|
(BOOL) |
audioState |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
切换房间麦克风状态
- Parameters
-
audioState | 麦克风状态 |
completion | 回调 |
- Returns
- 操作结果
◆ changeRoomClassType:completion:()
- (BOOL) changeRoomClassType: |
|
(CCClassType) |
type |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
切换连麦模式
- Parameters
-
- Returns
- 操作结果
◆ changeRoomDetail:completion:()
- (BOOL) changeRoomDetail: |
|
(NSString *) |
detail |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
设置直播间介绍
- Parameters
-
- Returns
- 操作结果
◆ changeRoomName:completion:()
- (BOOL) changeRoomName: |
|
(NSString *) |
name |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
设置直播间名字
- Parameters
-
- 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
-
- Returns
- 操作结果
◆ changeRoomTeacherBitrate:completion:()
- (BOOL) changeRoomTeacherBitrate: |
|
(CCUserBitrate) |
bitrate |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
修改房间老师推流码率
- Parameters
-
- Returns
- 操作结果
◆ changeRoomTemplateMode:completion:()
- (BOOL) changeRoomTemplateMode: |
|
(CCRoomTemplate) |
tem |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
改变房间模板
- Parameters
-
- Returns
- 操作结果
◆ changeRoomVideoMode:completion:()
- (BOOL) changeRoomVideoMode: |
|
(CCVideoMode) |
videoMode |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
改变连麦音视频权限
- Parameters
-
- Returns
- 操作结果
◆ docPageChange:()
- (BOOL) docPageChange: |
|
(NSDictionary *) |
info |
|
老师单文档翻页
- Parameters
-
- Returns
- 操作结果
◆ gagAll:()
- (BOOL) gagAll: |
|
(CCComletionBlock) |
completion |
|
全体禁言
- Parameters
-
- Returns
- 操作结果
◆ gagUser:()
- (BOOL) gagUser: |
|
(NSString *) |
userID |
|
对某个学生禁言
- Parameters
-
- Returns
- 操作结果
◆ getAllEnableSubStreamIDs()
- (NSArray *) getAllEnableSubStreamIDs |
|
|
|
◆ getAudienceChatStatus:()
- (BOOL) getAudienceChatStatus: |
|
(NSString *) |
userID |
|
获取旁听的禁言状态(YES表示禁言中)
- Parameters
-
- Returns
- 状态
◆ getCaptureSession()
- (AVCaptureSession *) getCaptureSession |
|
|
|
◆ getConnectionStats:completion:()
- (BOOL) getConnectionStats: |
|
(NSString *) |
stream |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
获取流状态
- Parameters
-
- Returns
- 操作结果
◆ getDocHistory:()
- (BOOL) getDocHistory: |
|
(CCComletionBlock) |
completion |
|
◆ getLianMaiNum()
- (NSInteger) getLianMaiNum |
|
|
|
◆ getLiveStatus:()
- (BOOL) getLiveStatus: |
|
(CCComletionBlock) |
completion |
|
◆ getNamedInfo()
- (NSDictionary *) getNamedInfo |
|
|
|
获取老师点名的信息(老师端有效)
- Returns
- 信息
◆ getPicUploadToken:()
- (BOOL) getPicUploadToken: |
|
(CCComletionBlock) |
completion |
|
获取上传图片token(这里也可以使用自己的存储上传图片)
- Parameters
-
- 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
-
- Returns
- 操作结果
◆ getRoomInfo()
◆ getRoomServerWithUserID:completion:()
- (BOOL) getRoomServerWithUserID: |
|
(NSString *) |
userId |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
获取节点列表
- Parameters
-
- Returns
- 操作结果
◆ getStudentNamedList()
- (NSArray *) getStudentNamedList |
|
|
|
◆ getUSerInfoWithUserID:()
- (CCUser *) getUSerInfoWithUserID: |
|
(NSString *) |
userID |
|
获取用户
- Parameters
-
- Returns
- 用户
◆ handup()
◆ inviteUserLianMai:completion:()
- (BOOL) inviteUserLianMai: |
|
(NSString *) |
userID |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
老师邀请没有举手学生连麦(只对老师有效)
- Parameters
-
- Returns
- 操作结果
◆ joinRoom:()
- (BOOL) joinRoom: |
|
(CCComletionBlock) |
completion |
|
加入房间
- Parameters
-
- Returns
- 操作结果
◆ kickUserFromLianmai:completion:()
- (BOOL) kickUserFromLianmai: |
|
(NSString *) |
userID |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
将连麦者踢下麦
- Parameters
-
- Returns
- 操作结果
◆ kickUserFromRoom:()
- (BOOL) kickUserFromRoom: |
|
(NSString *) |
userID |
|
踢出房间
- Parameters
-
- Returns
- 操作结果
◆ leaveRoom:()
- (BOOL) leaveRoom: |
|
(CCComletionBlock) |
completion |
|
◆ 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 |
|
◆ realsesAllStream()
- (void) realsesAllStream |
|
|
|
◆ recoveGagUser:()
- (BOOL) recoveGagUser: |
|
(NSString *) |
userID |
|
取消对某个学生禁言
- Parameters
-
- Returns
- 操作结果
◆ recoverGagAll:()
- (BOOL) recoverGagAll: |
|
(CCComletionBlock) |
completion |
|
取消全体禁言
- Parameters
-
- Returns
- 操作结果
◆ refuseTeacherInvite:()
- (BOOL) refuseTeacherInvite: |
|
(CCComletionBlock) |
completion |
|
拒绝老师的连麦邀请
- Parameters
-
- Returns
- 操作结果
◆ releaseAnnouncement:completion:()
- (BOOL) releaseAnnouncement: |
|
(NSString *) |
message |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
发布公告
- Parameters
-
- Returns
- 操作结果
◆ removeAnnouncement:()
- (BOOL) removeAnnouncement: |
|
(CCComletionBlock) |
completion |
|
清除公告
- Parameters
-
- Returns
- 操作结果
◆ removeExternalOutput:completion:()
- (BOOL) removeExternalOutput: |
|
(NSString *) |
url |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
清除第三方推流地址
- Parameters
-
- Returns
- 操作结果
◆ requestLianMai:()
- (BOOL) requestLianMai: |
|
(CCComletionBlock) |
completion |
|
◆ 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
-
◆ 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 |
|
◆ sendBrainReply:title:text:()
- (BOOL) sendBrainReply: |
|
(NSString *) |
Id |
title: |
|
(NSString *) |
title |
text: |
|
(NSString *) |
content |
|
|
| |
发送头脑风暴答案
- Parameters
-
Id | 问题id |
title | 问题title |
content | 问题回答 |
◆ sendDrawData:()
- (void) sendDrawData: |
|
(NSDictionary *) |
info |
|
◆ sendMsg:()
- (BOOL) sendMsg: |
|
(NSString *) |
message |
|
◆ sendPic:()
- (BOOL) sendPic: |
|
(NSString *) |
url |
|
发送聊天图片
- Parameters
-
- 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
-
- Returns
- 操作结果
◆ setLogState:()
+ (void) setLogState: |
|
(BOOL) |
state |
|
设置日志是否开启(默认开启)
- Parameters
-
◆ setRegion:completion:()
- (BOOL) setRegion: |
|
(NSString *) |
streamID |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
◆ 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 |
|
|
|
◆ startNamed:()
- (BOOL) startNamed: |
|
(NSTimeInterval) |
duration |
|
老师开始点名
- Parameters
-
- Returns
- 操作结果
◆ startPreview:()
- (void) startPreview: |
|
(CCComletionBlock) |
completion |
|
开始预览 开启摄像头开启预览,在login之后开始推流之前调用
- Parameters
-
◆ startPublish:()
- (BOOL) startPublish: |
|
(CCComletionBlock) |
completion |
|
◆ startPublishWithRecord:completion:()
- (BOOL) startPublishWithRecord: |
|
(BOOL) |
record |
completion: |
|
(CCComletionBlock) |
completion |
|
|
| |
开始直播
- Parameters
-
- Returns
- 操作结果
◆ startSession()
◆ stopLianMai:()
- (BOOL) stopLianMai: |
|
(CCComletionBlock) |
completion |
|
◆ stopLive:()
- (BOOL) stopLive: |
|
(CCComletionBlock) |
completion |
|
停止直播(login返回直播状态是直播中,假如开始新的直播需要调用该接口,继续直播则不需要)
- Parameters
-
- Returns
- 操作结果
◆ stopPreview()
停止预览(login out 包含该操作)
- Returns
- 操作结果
◆ stopPublish:()
- (BOOL) stopPublish: |
|
(CCComletionBlock) |
completion |
|
◆ stopSession()
◆ studentNamed()
◆ 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 |
|
◆ 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
-
- Returns
- 操作结果
◆ updateUserCount()
The documentation for this class was generated from the following file: