Skip to content

Commit f3c56c2

Browse files
SundoggyNewSundoggyNew
committed
修改文档
Change-Id: Ie63b58c437be0409cfc53bf07eea103d29c27b67
1 parent 9087b6d commit f3c56c2

File tree

2 files changed

+56
-53
lines changed

2 files changed

+56
-53
lines changed

‎sdk/video-advanced-app-android/README.md‎

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -51,85 +51,88 @@
5151
5252
#### 获取RoomKey，
5353
54-
需先通过 [云API]( https://github.com/tencentyun/iot-link-android/blob/video-v2.6.x/sdk/video-advanced-app-android/src/main/java/com/tencent/iot/video/link/service/VideoBaseService.kt#L197-L209) 获取到链接通话参数转换成RoomKey模型，RoomKey是TIoTCoreXP2PBridge中initWithRoomKey所需链接通话参数，
54+
需先通过 [云API]( https://github.com/tencentyun/iot-link-android/blob/video-v2.6.x/sdk/video-advanced-app-android/src/main/java/com/tencent/iot/video/link/service/VideoBaseService.kt#L197-L209) 获取到链接对端参数转换成RTCParams模型，RoomKey是IoTVideoCloud中startAppWith所需链接通话参数IoTVideoParams->RTCParams，
5555
由于云API需要配置SecretId、SecretKey，该参数直接放在客户端，会有泄漏风险，故建议通过自建服务访问该API获取到链接通话参数，再将链接通话参数传进SDK。
5656
5757
#### com.tencent.iot.video.link.rtc.impl.IoTVideoCloud
5858
59-
1、初始化 TIoTCoreXP2PBridge#startAppWith(Context context)
59+
1、链接对端 IoTVideoCloud#startAppWith(IoTVideoParams params)
6060
6161
| 参数 | 类型 | 描述 |
6262
|:-|:-|:-|
63-
| context | Context | 上下文 |
63+
| params | IoTVideoParams | p2p模式 必传参数xp2pinfo、productid、devicename rtc模式 必传参数RTCParams |
6464
65-
| 返回值 | 描述 |
66-
|:-|:-|
67-
| TIoTCoreXP2PBridge | TIoTCoreXP2PBridge实例 |
68-
69-
2、开始进房 TIoTCoreXP2PBridge#enterRoom(RoomKey roomKey)
65+
2、设置事件回调 IoTVideoCloud#setListener(IoTVideoCloudListener mIoTVideoCloudListener)
7066
7167
| 参数 | 类型 | 描述 |
7268
|:-|:-|:-|
73-
| roomKey | RoomKey | 链接通话参数 |
69+
| mIoTVideoCloudListener | IoTVideoCloudListener | 获得来自 SDK 的各类事件通知（比如：错误码，警告码，音视频状态参数等）。 |
7470
75-
3、设置回调 TIoTCoreXP2PBridge#setCallback(XP2PCallback callback)
71+
3、开始推送本地音视频流 IoTVideoCloud#startLocalStream(String deviceName)
7672
7773
| 参数 | 类型 | 描述 |
7874
|:-|:-|:-|
79-
| callback | XP2PCallback | 回调 |
75+
| deviceName | String | 要推给某个设备的名称。 |
8076
81-
4、释放链接 TIoTCoreXP2PBridge#release()
77+
4、停止推送本地音视频流 IoTVideoCloud#stopLocalStream()
8278
83-
5、发送信令 TIoTCoreXP2PBridge#sendMsgToPeer(String msg)
79+
5、断开链接 IoTVideoCloud#stopAppService(String deviceName)
8480
8581
| 参数 | 类型 | 描述 |
8682
|:-|:-|:-|
87-
| msg | String | 信令消息 |
83+
| deviceName | String | 断开链接设备的名称。 |
84+
85+
6、使用通道发送自定义消息给链接中的设备 IoTVideoCloud#sendCustomCmdMsg(String deviceName, String msg, long timeout_us)
8886
89-
| 返回值 | 描述 |
90-
|:-|:-|
91-
| boolean | 发送是否成功 |
87+
| 参数 | 类型 | 描述 |
88+
|:-|:-|:-|
89+
| deviceName | String | 设备的名称。 |
90+
| msg | String | 待发送的消息，rtc单个消息的最大长度被限制为 1KB。p2p 可以为任意格式字符或二进制数据(格式必须为`action=user_define&cmd=xxx`,需要传输的数据跟在`cmd=`后面)，长度由cmd_len提供，建议在16KB以内，否则会影响实时性。 |
91+
| timeout_us | long | rtc忽略此参数。 p2p命令超时时间，单位为微秒，值为0时采用默认超时(7500ms左右) 。 |
9292
93-
6、打开摄像头预览 TIoTCoreXP2PBridge#openCamera(boolean isFrontCamera, TXCloudVideoView txCloudVideoView)
93+
7、打开摄像头预览 IoTVideoCloud#openCamera(boolean isFrontCamera, TXCloudVideoView txCloudVideoView)
9494
9595
| 参数 | 类型 | 描述 |
9696
|:-|:-|:-|
97-
| isFrontCamera | boolean | 是否是前置摄像头 |
98-
| txCloudVideoView | TXCloudVideoView | 承载视频画面的控件 |
97+
| isFrontCamera | boolean | true：前置摄像头；false：后置摄像头。 |
98+
| txCloudVideoView | TXCloudVideoView | 承载视频画面的控件。 |
9999
100-
7、开始推流 TIoTCoreXP2PBridge#sendVoiceToServer()
100+
8、关闭摄像头预览 IoTVideoCloud#closeCamera()
101101
102-
8、绑定远端视频渲染控件 TIoTCoreXP2PBridge#startRemoteView(String userId, TXCloudVideoView txCloudVideoView)
102+
9、绑定远端视频渲染控件 IoTVideoCloud#startRemoteView(String userId, TXCloudVideoView txCloudVideoView)
103103
104104
| 参数 | 类型 | 描述 |
105105
|:-|:-|:-|
106106
| userId | String | 远端用户id |
107107
| txCloudVideoView | TXCloudVideoView | 承载视频画面的控件 |
108108
109-
9、切换摄像头 TIoTCoreXP2PBridge#switchCamera(boolean isFrontCamera)
109+
10、切换摄像头 IoTVideoCloud#changeCameraPositon(boolean isFrontCamera)
110110
111111
| 参数 | 类型 | 描述 |
112112
|:-|:-|:-|
113-
| isFrontCamera | boolean | 是否是前置摄像头 |
113+
| isFrontCamera | boolean | true：前置摄像头；false：后置摄像头。 |
114114
115-
10、设置麦克风是否静音 TIoTCoreXP2PBridge#setMicMute(boolean isMute)
115+
11、设置关闭打开麦克风 IoTVideoCloud#muteLocalAudio(boolean mute)
116116
117117
| 参数 | 类型 | 描述 |
118118
|:-|:-|:-|
119-
| isMute | boolean | 是否静音 |
119+
| mute | boolean | true：静音；false：恢复。 |
120120
121-
11、设置是否免提 TIoTCoreXP2PBridge#setHandsFree(boolean isHandsFree)
121+
12、设置是否免提 IoTVideoCloud#setHandsFree(boolean isHandsFree)
122122
123123
| 参数 | 类型 | 描述 |
124124
|:-|:-|:-|
125-
| isHandsFree | boolean | 是否免提 |
125+
| isHandsFree | boolean | true：免提（扬声器）；false：听筒。 |
126126
127-
12、关闭摄像头预览 TIoTCoreXP2PBridge#closeCamera()
127+
13、设置是否适配重力感应 IoTVideoCloud#setEnableGSensor(boolean enable)
128128
129+
| 参数 | 类型 | 描述 |
130+
|:-|:-|:-|
131+
| enable | boolean | true：适配重力感应；false：不适配重力感应。 |
129132
130-
### iot-video-advanced-app-android SDK 回调callback 设计说明
133+
### iot-video-advanced-app-android SDK 回调listener 设计说明
131134
132-
com.tencent.iot.video.link.rtc.IoTVideoCloudListener 回调callback说明如下：
135+
com.tencent.iot.video.link.rtc.IoTVideoCloudListener 回调listener说明如下：
133136
134137
| 回调接口 | 功能 |
135138
| ----------------------- | ---------- |

‎sdk/video-advanced-app-android/src/main/java/com/tencent/iot/video/link/rtc/impl/IoTVideoCloud.java‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,15 @@ public void setListener(IoTVideoCloudListener mIoTVideoCloudListener) {
126126
this.mIoTVideoCloudListener = mIoTVideoCloudListener;
127127
}
128128

129+
/**
130+
* 开始推送本地音视频流
131+
* @param deviceName 要推给某个设备的名称。
132+
*/
133+
public void startLocalStream(String deviceName) {
134+
mRTCCloud.muteLocalAudio(false);
135+
mRTCCloud.muteLocalVideo(0, false);
136+
}
137+
129138
/**
130139
* 停止推送本地音视频流
131140
*/
@@ -191,15 +200,6 @@ public void closeCamera() {
191200
mRTCCloud.stopLocalPreview();
192201
}
193202

194-
/**
195-
* 开始推送本地音视频流
196-
* @param deviceName 要推给某个设备的名称。
197-
*/
198-
public void startLocalStream(String deviceName) {
199-
mRTCCloud.muteLocalAudio(false);
200-
mRTCCloud.muteLocalVideo(0, false);
201-
}
202-
203203
/**
204204
* 开始渲染远端音视频流
205205
* @param userId 渲染设备的userid。
@@ -212,18 +212,6 @@ public void startRemoteView(String userId, TXCloudVideoView txCloudVideoView) {
212212
mRTCCloud.startRemoteView(userId, TRTC_VIDEO_STREAM_TYPE_BIG, txCloudVideoView);
213213
}
214214

215-
/**
216-
* 设置是否适配重力感应
217-
* @param enable true：适配重力感应；false：不适配重力感应。
218-
*/
219-
public void setEnableGSensor(boolean enable) {
220-
if (enable) {
221-
mRTCCloud.setGSensorMode(TRTC_GSENSOR_MODE_UIAUTOLAYOUT);
222-
} else {
223-
mRTCCloud.setGSensorMode(TRTC_GSENSOR_MODE_DISABLE);
224-
}
225-
}
226-
227215
/**
228216
* 切换前后摄像头
229217
* @param isFrontCamera true：前置摄像头；false：后置摄像头。
@@ -237,7 +225,7 @@ public void changeCameraPositon(boolean isFrontCamera) {
237225
}
238226

239227
/**
240-
* 暂停/恢复发布本地的音频流
228+
* 设置关闭打开麦克风
241229
* @param mute true：静音；false：恢复。
242230
*/
243231
public void muteLocalAudio(boolean mute) {
@@ -256,6 +244,18 @@ public void setHandsFree(boolean isHandsFree) {
256244
}
257245
}
258246

247+
/**
248+
* 设置是否适配重力感应
249+
* @param enable true：适配重力感应；false：不适配重力感应。
250+
*/
251+
public void setEnableGSensor(boolean enable) {
252+
if (enable) {
253+
mRTCCloud.setGSensorMode(TRTC_GSENSOR_MODE_UIAUTOLAYOUT);
254+
} else {
255+
mRTCCloud.setGSensorMode(TRTC_GSENSOR_MODE_DISABLE);
256+
}
257+
}
258+
259259
/**
260260
* RTC的监听器
261261
*/

0 commit comments

Comments
 (0)