Skip to content

GitLab

排麦组件 · Changes

Page history
Updated 排麦组件 (markdown) authored by liguanpei's avatar liguanpei
Hide whitespace changes
Inline Side-by-side
Showing with 30 additions and 48 deletions
排麦组件.md
View page @ 4b2a79d9
......@@ -8,18 +8,26 @@
## 1.1 举手连麦
### 1.1.1 学生可举手申请连麦,需老师确认才可连麦
### 1.1.1 学生可点击连麦申请连麦,需老师确认才可连麦
### 1.1.2 老师可以邀请学生连麦,需学生同意才可连麦
### 1.1.3 学生可以点击下麦，老师也可以踢学生下麦
## 1.2 自由连麦
### 1.2.1 学生可自由连麦,无需老师确认
### 1.2.2 学生可以点击下麦，老师也可以踢学生下麦
## 1.3 自动连麦
### 1.3.1 学生进入房间后自动连麦
### 1.3.2 学生不可以点击下麦，老师可以踢学生下麦
### 1.3.3 学生可以发起举手消息，这个举手跟连麦没有关系
# 2. 排麦事件
## 2.0 请求排麦/举手
......@@ -29,7 +37,7 @@
应用模式：举手连麦，自由连麦，自动连麦。
```javascript
public void requestLianMai(final CCBarLeyCallBack<Void> callBack) {
public void handsup(final CCBarLeyCallBack<Void> callBack) {
```
object 参数说明：
......@@ -39,14 +47,14 @@ object 参数说明：
| onSuccess| CCBarLeyCallBack | 成功回调 | 可选 |
| onFailure| CCBarLeyCallBack | 失败回调 | 可选 |
## 2.1 学生举手
## 2.1 学生举手（自动连麦才可以设置）
举手状态由互动者端发起，通知老师端，老师端可以同意或者不同意。
举手状态由互动者端发起，通知老师端。
应用模式：举手连麦，自由连麦，自动连麦。
应用模式：自动连麦。
```javascript
public void handup(boolean flag, final CCBarLeyCallBack<Void> callBack) {
public void Studenthandup(boolean flag, final CCBarLeyCallBack<Void> callBack) {
```
object 参数说明：
......@@ -65,7 +73,7 @@ object 参数说明：
应用模式：举手连麦，自由连麦，自动连麦。
```javascript
public void cancleLianMai(final CCBarLeyCallBack<Void> callBack) {
public void handsUpCancel(final CCBarLeyCallBack<Void> callBack) {
```
object 参数说明：
......@@ -83,7 +91,7 @@ object 参数说明：
```javascript
public void cancleInviteUserLianMai(String userId, CCBarLeyCallBack<Void> callBack) {
public void cancleInviteUserSpeak(String userId, CCBarLeyCallBack<Void> callBack) {
```
object 参数说明：
......@@ -120,7 +128,7 @@ object 参数说明：
应用模式：举手连麦，自由连麦，自动连麦。
```javascript
public void kickUserFromLianmai(@NonNull String userId, CCBarLeyCallBack<Void> callBack) {
public void kickUserFromSpeak(@NonNull String userId, CCBarLeyCallBack<Void> callBack) {
```
object 参数说明：
......@@ -138,7 +146,7 @@ object 参数说明：
应用模式：举手连麦，自由连麦。
```javascript
public void stopLianMai(CCBarLeyCallBack<Void> callBack) {
public void handsDown(CCBarLeyCallBack<Void> callBack) {
```
object 参数说明：
......@@ -193,7 +201,7 @@ object 参数说明：
应用模式：举手连麦
```javascript
public void inviteUserLianMai(String userId, final CCBarLeyCallBack<Void> callBack) {
public void inviteUserSpeak(String userId, final CCBarLeyCallBack<Void> callBack) {
```
object 参数说明：
......@@ -204,32 +212,6 @@ object 参数说明：
| onSuccess | CCBarLeyCallBack | 成功回调（含参数） | 可选 |
| onFailure | CCBarLeyCallBack | 失败回调（含参数） | 可选 |
## 3.0 上麦更新
上麦更新是在两种情况下执行
​ 1.推流成功之后为更新自己上麦状态，通知其他人订阅，需调用。
​ 2.学生不能创建本地流或者推流失败，需将其麦序让出。
应用模式：举手连麦，自由连麦，自动连麦。
```
mBarleyService.updateLianmaiStatus(mInteractSession.getInteractBean().getUserId(),
mInteractSession.getRoomId(),"1",mInteractSession.getLocalStreamId(),
new EasyCallback(){
```
object 参数说明：
| 参数名称 | 参数类型 | 说明 | 是否必须 |
| -------- | -------- | ------------------ | -------- |
| uid | string | 用户id | 必选 |
| uid | string | 房间id | 必选 |
| pid | number | 上麦结果更新status | 必选 |
| stid | string | streamid | 必选 |
| success | EasyCallback | 成功回调（含参数） | 可选 |
| fail | EasyCallback | 失败回调（含参数） | 可选 |
## 3.1 设置连麦模式（可设置举手连麦，自由连麦，自动连麦，仅只有老师端）
......@@ -238,7 +220,7 @@ object 参数说明：
应用模式：举手连麦，自由连麦，自动连麦。
```
public boolean setLianmaiMode(@CCAtlasClient.LianmaiMode int lianmaiMode, CCBarLeyCallBack<Void> callBack) {
public boolean setSpeakMode(@CCAtlasClient.LianmaiMode int lianmaiMode, CCBarLeyCallBack<Void> callBack) {
```
object 参数说明：
......@@ -340,29 +322,29 @@ mBarLeyManager.setOnQueueMaiUpdateListener(mMaiUpdataListener);
## 3.5 连麦模式更新回调（举手连麦、自由连麦、自动连麦）
首先获取到排麦组件的连麦模式更新监听事件：
mBarLeyManager.setOnLianmaiModeUpdateListener(mLianmaiModeUpdateListener);
mBarLeyManager.setOnSpeakModeUpdateListener(mLianmaiModeUpdateListener);
使用例子：（demo里有实现的代码逻辑，可供参考）
```javascript
private BarLeyManager.OnLianmaiModeUpdateListener mLianmaiModeUpdateListener = new BarLey Manager.OnLianmaiModeUpdateListener() {
private BarLeyManager.OnSpeakModeUpdateListener mSpeakModeUpdateListener = new BarLey Manager.OnSpeakModeUpdateListener() {
@Override
public void onBarLeyMode(int mode) {
}
};
```
## 3.6 连麦模式更新回调（举手连麦、自由连麦、自动连麦）
## 3.6 学生被老师提出房间回调（举手连麦、自由连麦、自动连麦）
首先获取到排麦组件的连麦模式更新监听事件：
mBarLeyManager.setOnLianmaiModeUpdateListener(mLianmaiModeUpdateListener);
首先获取到排麦组件的踢出房间监听事件：
mBarLeyManager.setOnKickOutListener(mKickOutListener);
使用例子：（demo里有实现的代码逻辑，可供参考）
```javascript
private BarLeyManager.OnLianmaiModeUpdateListener mLianmaiModeUpdateListener = new BarLey Manager.OnLianmaiModeUpdateListener() {
@Override
public void onBarLeyMode(int mode) {
}
private BarLeyManager.OnKickOutListener mKickOutListener= new BarLeyManager.OnKickOutListener() {
@Override
public void onKickOut() {
}
};
```
......