李勇

更新MCUClientAPI文档

@@ -297,7 +297,34 @@ img { @@ -297,7 +297,34 @@ img {
297 297
298 <hr /> 298 <hr />
299 299
300 -<h2>创建McuClient对象</h2> 300 +<h2><font color=blue>McuClient 目录</font></h2>
  301 +
  302 +<blockquote>
  303 + <ul>
  304 + <li><p><strong>创建McuClient对象</strong></p></li>
  305 + <li><p><strong>McuClient方法</strong></p></li>
  306 + <li><p><strong>McuClient回调事件</strong></p></li>
  307 + <li><p><strong>ErrorCode 错误码查询</strong></p></li>
  308 + </ul>
  309 +</blockquote>
  310 +
  311 +<hr />
  312 +
  313 +<h2><font color=blue>使用步骤说明</font></h2>
  314 +
  315 +<blockquote>
  316 + <ol>
  317 + <li>创建McuClient对象</li>
  318 + <li>McuClient初始化init</li>
  319 + <li>添加MessageTypes中的事件监听(接收各个模块的消息)</li>
  320 + <li>McuClient加入会议</li>
  321 + <li>加入会议成功之后可以操作客户端界面</li>
  322 + </ol>
  323 +</blockquote>
  324 +
  325 +<hr />
  326 +
  327 +<h2><font color=blue>创建McuClient对象</font></h2>
301 328
302 <p>只创建一次</p> 329 <p>只创建一次</p>
303 330
@@ -313,11 +340,11 @@ img { @@ -313,11 +340,11 @@ img {
313 340
314 <hr /> 341 <hr />
315 342
316 -<h2>McuClient方法</h2> 343 +<h2><font color=blue>McuClient方法 </font></h2>
317 344
318 <h3>初始化</h3> 345 <h3>初始化</h3>
319 346
320 -<h4>client.init(paramInfo,onSuccess,mcuErrorEventHandler)</h4> 347 +<h4>client.init (paramInfo,onSuccess,mcuErrorEventHandler)</h4>
321 348
322 <p>client创建完成之后第一步需要初始化。</p> 349 <p>client创建完成之后第一步需要初始化。</p>
323 350
@@ -331,7 +358,6 @@ img { @@ -331,7 +358,6 @@ img {
331 }; 358 };
332 //初始化 359 //初始化
333 client.init(paramInfo,onSuccess,mcuErrorEventHandler); 360 client.init(paramInfo,onSuccess,mcuErrorEventHandler);
334 -  
335 function onSuccess(callbackData){ 361 function onSuccess(callbackData){
336 //初始化成功回调 362 //初始化成功回调
337 //{"siteId":"h5test","passwordRequired":true,"md5":"de399d5540b3da2fbc1eb0a770d4fd66","code":0,"msType":1} 363 //{"siteId":"h5test","passwordRequired":true,"md5":"de399d5540b3da2fbc1eb0a770d4fd66","code":0,"msType":1}
@@ -407,7 +433,7 @@ function mcuErrorEventHandler(callbackData){ @@ -407,7 +433,7 @@ function mcuErrorEventHandler(callbackData){
407 433
408 <h3>加入会议</h3> 434 <h3>加入会议</h3>
409 435
410 -<h4>client.joinClass(paramInfo,onSuccess)</h4> 436 +<h4>client.joinClass (paramInfo,onSuccess)</h4>
411 437
412 <p>client初始化成功之后,加入会议。</p> 438 <p>client初始化成功之后,加入会议。</p>
413 439
@@ -581,7 +607,7 @@ client.sendChatMsg(paramInfo); @@ -581,7 +607,7 @@ client.sendChatMsg(paramInfo);
581 607
582 <hr /> 608 <hr />
583 609
584 -<h2>client回调事件</h2> 610 +<h2><font color=blue>McuClient 回调事件 </font></h2>
585 611
586 <h3>会议日志信息 事件回调</h3> 612 <h3>会议日志信息 事件回调</h3>
587 613
@@ -688,7 +714,7 @@ client.sendChatMsg(paramInfo); @@ -688,7 +714,7 @@ client.sendChatMsg(paramInfo);
688 714
689 <hr /> 715 <hr />
690 716
691 -<h2>ErrorCode 错误码查询</h2> 717 +<h2><font color=blue>ErrorCode 错误码查询</font></h2>
692 718
693 <pre><code>MessageTypes.ERR_NETWORK=10000;//网络错误 719 <pre><code>MessageTypes.ERR_NETWORK=10000;//网络错误
694 MessageTypes.ERR_UNKNOWN=10001;//未知错误 720 MessageTypes.ERR_UNKNOWN=10001;//未知错误
1 # McuClient API参考说明 # 1 # McuClient API参考说明 #
2 </p> 2 </p>
3 3
  4 +----------
  5 +##<font color=blue>McuClient 目录</font> ##
  6 +
  7 +> - **创建McuClient对象**
  8 +>
  9 +> - **McuClient方法**
  10 +>
  11 +> - **McuClient回调事件**
  12 +>
  13 +> - **ErrorCode 错误码查询**
  14 +
  15 +----------
  16 +##<font color=blue>使用步骤说明</font> ##
  17 +> 1. 创建McuClient对象
  18 +> 2. McuClient初始化init
  19 +> 3. 添加MessageTypes中的事件监听(接收各个模块的消息)
  20 +> 3. McuClient加入会议
  21 +> 4. 加入会议成功之后可以操作客户端界面
4 22
5 ---------- 23 ----------
6 24
7 -##创建McuClient对象 ## 25 +##<font color=blue>创建McuClient对象</font> ##
8 只创建一次 26 只创建一次
9 27
10 示例代码 28 示例代码
@@ -17,9 +35,9 @@ @@ -17,9 +35,9 @@
17 } 35 }
18 36
19 ---------- 37 ----------
20 -## McuClient方法 ## 38 +## <font color=blue>McuClient方法 </font>##
21 ### 初始化 ### 39 ### 初始化 ###
22 -#### client.init(paramInfo,onSuccess,mcuErrorEventHandler) #### 40 +#### client.init (paramInfo,onSuccess,mcuErrorEventHandler) ####
23 client创建完成之后第一步需要初始化。 41 client创建完成之后第一步需要初始化。
24 42
25 示例代码 43 示例代码
@@ -32,7 +50,6 @@ client创建完成之后第一步需要初始化。 @@ -32,7 +50,6 @@ client创建完成之后第一步需要初始化。
32 }; 50 };
33 //初始化 51 //初始化
34 client.init(paramInfo,onSuccess,mcuErrorEventHandler); 52 client.init(paramInfo,onSuccess,mcuErrorEventHandler);
35 -  
36 function onSuccess(callbackData){ 53 function onSuccess(callbackData){
37 //初始化成功回调 54 //初始化成功回调
38 //{"siteId":"h5test","passwordRequired":true,"md5":"de399d5540b3da2fbc1eb0a770d4fd66","code":0,"msType":1} 55 //{"siteId":"h5test","passwordRequired":true,"md5":"de399d5540b3da2fbc1eb0a770d4fd66","code":0,"msType":1}
@@ -109,7 +126,7 @@ client创建完成之后第一步需要初始化。 @@ -109,7 +126,7 @@ client创建完成之后第一步需要初始化。
109 126
110 127
111 ### 加入会议 ### 128 ### 加入会议 ###
112 -#### client.joinClass(paramInfo,onSuccess) #### 129 +#### client.joinClass (paramInfo,onSuccess) ####
113 client初始化成功之后,加入会议。 130 client初始化成功之后,加入会议。
114 131
115 示例代码 132 示例代码
@@ -274,7 +291,7 @@ client初始化成功之后,加入会议。 @@ -274,7 +291,7 @@ client初始化成功之后,加入会议。
274 291
275 ---------- 292 ----------
276 293
277 -## client回调事件 ## 294 +## <font color=blue>McuClient 回调事件 </font>##
278 295
279 296
280 ### 会议日志信息 事件回调 ### 297 ### 会议日志信息 事件回调 ###
@@ -362,7 +379,7 @@ client初始化成功之后,加入会议。 @@ -362,7 +379,7 @@ client初始化成功之后,加入会议。
362 379
363 ---------- 380 ----------
364 381
365 -## ErrorCode 错误码查询 ## 382 +## <font color=blue>ErrorCode 错误码查询</font> ##
366 383
367 MessageTypes.ERR_NETWORK=10000;//网络错误 384 MessageTypes.ERR_NETWORK=10000;//网络错误
368 MessageTypes.ERR_UNKNOWN=10001;//未知错误 385 MessageTypes.ERR_UNKNOWN=10001;//未知错误