... | @@ -122,6 +122,7 @@ rtc.createLocalStream(object); |
... | @@ -122,6 +122,7 @@ rtc.createLocalStream(object); |
|
|参数名称 | 参数类型 | 说明 | 是否必须 |
|
|
|参数名称 | 参数类型 | 说明 | 是否必须 |
|
|
| --- | --- | --- | --- |
|
|
| --- | --- | --- | --- |
|
|
| streamName | String | 创建本地流名称 |必选|
|
|
| streamName | String | 创建本地流名称 |必选|
|
|
|
|
| showVoice| function | 音量值回调 |可选|
|
|
| createData | object | 创建本地流自定义参数 |可选|
|
|
| createData | object | 创建本地流自定义参数 |可选|
|
|
| success | function | 创建本地流成功回调(含参数) |必选|
|
|
| success | function | 创建本地流成功回调(含参数) |必选|
|
|
| fail | function | 创建本地流失败回调(含参数) |可选|
|
|
| fail | function | 创建本地流失败回调(含参数) |可选|
|
... | @@ -130,6 +131,10 @@ object:为创建本地流参数对象,包含以下属性 |
... | @@ -130,6 +131,10 @@ object:为创建本地流参数对象,包含以下属性 |
|
* (必选)streamName 创建本地流名称,数据类型(String),可选参数值为 'main'、'assist'、'picture'
|
|
* (必选)streamName 创建本地流名称,数据类型(String),可选参数值为 'main'、'assist'、'picture'
|
|
此参数为区分多条本地流操作,如果本地只创建一条流,就使用'main'
|
|
此参数为区分多条本地流操作,如果本地只创建一条流,就使用'main'
|
|
|
|
|
|
|
|
* (可选)showVoice 音量值回调
|
|
|
|
object.showVoice = function(value){
|
|
|
|
// value值范围(0-100)
|
|
|
|
}
|
|
|
|
|
|
* (可选) createData 选用特定音视频设备创建本地流,数据类型(object),不选该参数,系统自动识别设备
|
|
* (可选) createData 选用特定音视频设备创建本地流,数据类型(object),不选该参数,系统自动识别设备
|
|
object.createData = {
|
|
object.createData = {
|
... | @@ -160,6 +165,10 @@ object.fail = function(str){ |
... | @@ -160,6 +165,10 @@ object.fail = function(str){ |
|
```javascript
|
|
```javascript
|
|
rtc.createLocalStream({
|
|
rtc.createLocalStream({
|
|
streamName: 'main',
|
|
streamName: 'main',
|
|
|
|
showVoice: function(value){
|
|
|
|
// value值范围(0-100)
|
|
|
|
|
|
|
|
},
|
|
success: function(stream){
|
|
success: function(stream){
|
|
stream.show('id'); // 将本地流显示在元素id值为id的盒子中
|
|
stream.show('id'); // 将本地流显示在元素id值为id的盒子中
|
|
},
|
|
},
|
... | @@ -270,6 +279,7 @@ object.success = function(){ |
... | @@ -270,6 +279,7 @@ object.success = function(){ |
|
|
|
|
|
}
|
|
}
|
|
|
|
|
|
|
|
|
|
* (可选)fail 失败回调
|
|
* (可选)fail 失败回调
|
|
object.fail = function(str){
|
|
object.fail = function(str){
|
|
// 返回值为失败原因,字符串类型
|
|
// 返回值为失败原因,字符串类型
|
... | @@ -528,6 +538,7 @@ rtc.trySubscribeStream(object); |
... | @@ -528,6 +538,7 @@ rtc.trySubscribeStream(object); |
|
| --- | --- | --- | --- |
|
|
| --- | --- | --- | --- |
|
|
| tryStream | object | 要订阅的流对象 |必选|
|
|
| tryStream | object | 要订阅的流对象 |必选|
|
|
| tryData | Number | 选择音视频订阅项(默认音视频都订阅) |可选|
|
|
| tryData | Number | 选择音视频订阅项(默认音视频都订阅) |可选|
|
|
|
|
| showVoice | function | 音量值回调(含参数) |可选|
|
|
| success | function | 成功回调(含参数) |可选|
|
|
| success | function | 成功回调(含参数) |可选|
|
|
| fail | function | 失败回调(含参数) |可选|
|
|
| fail | function | 失败回调(含参数) |可选|
|
|
```javascript
|
|
```javascript
|
... | @@ -543,6 +554,11 @@ object.success = function(stream){ |
... | @@ -543,6 +554,11 @@ object.success = function(stream){ |
|
// 返回值为已订阅流对象
|
|
// 返回值为已订阅流对象
|
|
}
|
|
}
|
|
|
|
|
|
|
|
* (可选)showVoice 音量值回调
|
|
|
|
object.showVoice = function(value){
|
|
|
|
// value值范围(0-100)
|
|
|
|
}
|
|
|
|
|
|
* (可选)fail 失败回调
|
|
* (可选)fail 失败回调
|
|
object.fail = function(str){
|
|
object.fail = function(str){
|
|
// 返回值为失败原因,字符串类型
|
|
// 返回值为失败原因,字符串类型
|
... | @@ -557,6 +573,9 @@ rtc.trySubscribeStream({ |
... | @@ -557,6 +573,9 @@ rtc.trySubscribeStream({ |
|
success: function(stream){
|
|
success: function(stream){
|
|
console.log('订阅流成功', stream.id());
|
|
console.log('订阅流成功', stream.id());
|
|
},
|
|
},
|
|
|
|
showVoice: function(value){
|
|
|
|
// value值范围(0-100)
|
|
|
|
},
|
|
fail: function(str){
|
|
fail: function(str){
|
|
console.log(str);
|
|
console.log(str);
|
|
}
|
|
}
|
... | @@ -597,6 +616,7 @@ rtc.unSubscribeStream({ |
... | @@ -597,6 +616,7 @@ rtc.unSubscribeStream({ |
|
success: function(stream){
|
|
success: function(stream){
|
|
console.log('取消订阅流成功', stream.id());
|
|
console.log('取消订阅流成功', stream.id());
|
|
},
|
|
},
|
|
|
|
|
|
fail: function(str){
|
|
fail: function(str){
|
|
console.log(str);
|
|
console.log(str);
|
|
}
|
|
}
|
... | @@ -1272,6 +1292,105 @@ rtc.getHistory({ |
... | @@ -1272,6 +1292,105 @@ rtc.getHistory({ |
|
});
|
|
});
|
|
```
|
|
```
|
|
|
|
|
|
|
|
### 2.1.6 网络节点选择
|
|
|
|
#### 2.1.6.1 查询节点
|
|
|
|
```javascript
|
|
|
|
rtc.getNetPoint(object);
|
|
|
|
```
|
|
|
|
参数说明:
|
|
|
|
|
|
|
|
|参数名称 | 参数类型 | 说明 | 是否必须 |
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
| timeOut | number | 回调事件设置(默认3s) |可选|
|
|
|
|
| success | function | 成功回调(含参数) |可选|
|
|
|
|
| fail | function | 失败回调(含参数) |可选|
|
|
|
|
```javascript
|
|
|
|
object:包含以下属性
|
|
|
|
* (可选)success 成功回调
|
|
|
|
object.success = function(data){
|
|
|
|
// 返回可用节点
|
|
|
|
}
|
|
|
|
|
|
|
|
// data数据如下:
|
|
|
|
[{
|
|
|
|
area_code:"DNYX", // 地区码缩写
|
|
|
|
is_abroad:1, // 是否属于国外
|
|
|
|
loc:"新加坡", // 地区名
|
|
|
|
delay: 63 // 延时,(设置回调时间过短可能没有此字段)
|
|
|
|
|
|
|
|
}
|
|
|
|
...
|
|
|
|
]
|
|
|
|
|
|
|
|
* (可选)fail 失败回调
|
|
|
|
object.fail = function(data){
|
|
|
|
// 返回错误数据
|
|
|
|
console.log(data);
|
|
|
|
}
|
|
|
|
|
|
|
|
```
|
|
|
|
使用例子:
|
|
|
|
```javascript
|
|
|
|
rtc.getNetPoint({
|
|
|
|
success: function(data){
|
|
|
|
console.log('获取成功', data);
|
|
|
|
}
|
|
|
|
});
|
|
|
|
```
|
|
|
|
####2.1.6.2 推拉流使用节点
|
|
|
|
初始化sdk时传入地区码
|
|
|
|
```
|
|
|
|
new Rtc({
|
|
|
|
userid: 'xxxxxxxx',
|
|
|
|
sessionid: 'xxxxxxxx',
|
|
|
|
areaCode: 'HB' // 使用节点
|
|
|
|
});
|
|
|
|
```
|
|
|
|
### 2.1.6 开启、结束、暂停、恢复录制接口
|
|
|
|
用于控制直播过程中开启、关闭、暂停、恢复录制
|
|
|
|
```
|
|
|
|
rtc.liveRecord(object);
|
|
|
|
```
|
|
|
|
参数说明:
|
|
|
|
|
|
|
|
|参数名称 | 参数类型 | 说明 | 是否必须 |
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
| status | str | 'start' 开启, 'end' 结束, 'pause' 暂停, 'resume' 恢复 |必选|
|
|
|
|
| success | function | 成功回调(含参数) |可选|
|
|
|
|
| fail | function | 失败回调(含参数) |可选|
|
|
|
|
```
|
|
|
|
object:包含以下属性
|
|
|
|
* (必须) status 表示执行动作
|
|
|
|
|
|
|
|
* (可选)success 成功回调
|
|
|
|
object.success = function(data){
|
|
|
|
// 返回数据
|
|
|
|
}
|
|
|
|
|
|
|
|
* (可选)fail 失败回调
|
|
|
|
object.fail = function(str){
|
|
|
|
// 返回值为字符串类型
|
|
|
|
console.log(str);
|
|
|
|
}
|
|
|
|
|
|
|
|
```
|
|
|
|
使用例子:
|
|
|
|
```javascript
|
|
|
|
rtc.liveRecord({
|
|
|
|
status:'start',
|
|
|
|
success: function(data){
|
|
|
|
console.log('成功', data);
|
|
|
|
},
|
|
|
|
fail: function(str){
|
|
|
|
console.log(str);
|
|
|
|
}
|
|
|
|
});
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
##2.2 被动监听事件
|
|
##2.2 被动监听事件
|
|
事件监听,建议在初始化sdk后做监听
|
|
事件监听,建议在初始化sdk后做监听
|
... | @@ -1296,3 +1415,54 @@ rtc.on('online_users' function(data){ |
... | @@ -1296,3 +1415,54 @@ rtc.on('online_users' function(data){ |
|
console.log(data);
|
|
console.log(data);
|
|
});
|
|
});
|
|
```
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
### 2.2.4 用户加入房间通知其他人员
|
|
|
|
```
|
|
|
|
rtc.on("join_room_user", function(data){
|
|
|
|
console.log(data);
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
// data 数据格式如下
|
|
|
|
{id: 'xxxxxx',name: 'xxxxx'}
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
### 2.2.5 用户退出房间通知其他人员
|
|
|
|
```
|
|
|
|
rtc.on("exit_room_user", function(data){
|
|
|
|
console.log(data);
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
// data 数据格式如下
|
|
|
|
{id: 'xxxxxx',name: 'xxxxx'}
|
|
|
|
|
|
|
|
```
|
|
|
|
### 2.2.3 自定义消息发送、接收
|
|
|
|
```
|
|
|
|
// 发送自定义消息,data 可自定义
|
|
|
|
rtc.sendPublishMessage(data);
|
|
|
|
|
|
|
|
// 接收自定义消息
|
|
|
|
rtc.on('publish_message', function(data){
|
|
|
|
console.log(data);
|
|
|
|
});
|
|
|
|
|
|
|
|
// 此方法发送的数据如需保存记录,需联系我们,告知需要记录的数据格式
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 更新日志
|
|
|
|
| 更新日期 | 功能 |
|
|
|
|
| -------- | ----- |
|
|
|
|
| 2018/8/7 | 新增进出人员回调、自定义事件发送接收、节点选择 |
|
|
|
|
| 2018/11/20 | 支持合流回放暂停、回复录制功能 |
|
|
|
|
| 2019/3/1 | 支持音频大小动态显示、支持节点探测返回节点延时 |
|
|
|
|
|
|
|
|
|