usc-rtc-client 1.1.6 → 2.1.0

package/Readme.md

@@ -1,13 +1,16 @@
-## 音视频通话 webrtc sdk开发手册 
+# 音视频通话 webrtc sdk 开发手册
 
-### 1.安装
-```
-//使用yarn安装 
+## 1.安装
+
+```sh
+//使用yarn安装
 yarn add usc-rtc-client
 //使用npm安装
 npm install usc-rtc-client
 ```
-### 2.简单使用demo
+
+## 2.简单使用 demo
+
 ```javascript
 //用户A，演示主叫端的逻辑
 import { RtcClient, createRtcClient, RtcSessionEvent, RtcClientEvent } from "usc-rtc-client"
@@ -56,10 +59,14 @@ startClientB()
 
 ```
 
-### 3.sdk说明
-此项目为typescript项目，按照npm的约定生成了type描述文件，具体api说明请在type描述文件中进行查看，以下是一些重要的Api说明：
-#### 1.createRtcClient
-此方法用来创建一个webrtc的终端，内部已经封装了心跳，信令交互，以及视频处理的逻辑,api描述如下：
+## 3.sdk 说明
+
+此项目为 typescript 项目，按照 npm 的约定生成了 type 描述文件，具体 api 说明请在 type 描述文件中进行查看，以下是一些重要的 Api 说明：
+
+### 1.createRtcClient
+
+此方法用来创建一个 webrtc 的终端，内部已经封装了心跳，信令交互，以及视频处理的逻辑,api 描述如下：
+
 ```javascript
 declare const createRtcClient: (config: {
     server: string; //信令服务器的地址
@@ -68,36 +75,44 @@ declare const createRtcClient: (config: {
     expireTime?: number; //注册信令的过期时间，默认是60s
 }) => Promise<RtcClient>; //注意，这里返回的是Promise的对象，resolve前置是在创建websocket链接之后发送一次心跳信息，等待服务器返回确认信息
 ```
+
 使用事例:
+
 ```javascript
-import { createRtcClient } from "usc-rtc-client"
-let client  = await createRtcClient({server:"wss://xxxxxx.com/",localNumber:"7001"})
+import { createRtcClient } from 'usc-rtc-client'
+let client = await createRtcClient({ server: 'wss://xxxxxx.com/', localNumber: '7001' })
 ```
 
-#### 2.RtcClient
-RtcClient是用来实例化webrtc终端的对象，内部主要方法如下
+### 2.RtcClient
+
+RtcClient 是用来实例化 webrtc 终端的对象，内部主要方法如下
+
 - createSession(remoteNumber?: string): RtcSession 用来来创建一个会话
-- destory() 销毁客户端，会销毁所有创建的会话以及断开与信令服务器的链接，与信令服务器断开链接之后也会自动触发此方法
-- reConnect() 重新连接信令服务器，如果之前处于连接状态会自动调用destory的方法
-- on(event:RtcClientEvent,cb:Function)  注册相关监听事件
-- sendPttMessage() 此方法是后续添加,是用来发送ptt消息,消息具体格式请参考ptt对讲以及ims开发文档
+- destroy() 销毁客户端，会销毁所有创建的会话以及断开与信令服务器的链接，与信令服务器断开链接之后也会自动触发此方法
+- reConnect() 重新连接信令服务器，如果之前处于连接状态会自动调用 destory 的方法
+- on(event:RtcClientEvent,cb:Function) 注册相关监听事件
+- sendPttMessage() 此方法是后续添加,是用来发送 ptt 消息,消息具体格式请参考 ptt 对讲以及 ims 开发文档
 
 事例代码：
+
 ```javascript
-import { createRtcClient,RtcClientEvent,RtcSession,RtcCalledSession } from "usc-rtc-client"
-let client  = await createRtcClient({server:"wss://xxxxxx.com/",localNumber:"7001"})
-let session:RtcSession = client.createSession("7002")
-client.on(RtcClientEvent.invite,(calledSession:RtcCalledSession)=>{})
+import { createRtcClient, RtcClientEvent, RtcSession, RtcCalledSession } from 'usc-rtc-client'
+let client = await createRtcClient({ server: 'wss://xxxxxx.com/', localNumber: '7001' })
+let session: RtcSession = client.createSession('7002')
+client.on(RtcClientEvent.invite, (calledSession: RtcCalledSession) => {})
 ```
 
-#### 3.RtcClientEvent
+### 3.RtcClientEvent
+
 RtcClientEvent 表示底层封装向上抛出的一些业务与非业务的生命周期事件，具体如下
+
 - connected 信令服务器连接成功事件
 - disconnected 信令服务器断开事件，连接失败这里也可以触发
-- invite  收到音视频通话邀请的事件
-- FPREInfo 收到ptt消息通知事件(目前主要为ptt组在线用户查询消息,具体格式参考ptt对讲以及ims开发文档)
+- invite 收到音视频通话邀请的事件
+- FPREInfo 收到 ptt 消息通知事件(目前主要为 ptt 组在线用户查询消息,具体格式参考 ptt 对讲以及 ims 开发文档)
 
 事例代码
+
 ```javascript
 import { createRtcClient , RtcClientEvent,RtcCalledSession } from "usc-rtc-client"
 let client  = await createRtcClient({server:"wss://xxxxxx.com/",localNumber:"7001"})
@@ -111,28 +126,31 @@ client.on(RtcClientEvent.invite,(session:RtcCalledSession)=>{
 })
 ```
 
-#### 4.RtcSession
-RtcSession是用来实例化RtcClient所创建的音视频会话的对象，内部主要方法如下
-- addRemote(remoteNumber: string)  修改需要呼叫的用户
+### 4.RtcSession
+
+RtcSession 是用来实例化 RtcClient 所创建的音视频会话的对象，内部主要方法如下
+
+- addRemote(remoteNumber: string) 修改需要呼叫的用户
 - rejectCall() 拒绝邀请，使用于创建会话过程中的会议类型变更
 - acceptCall() 接受邀请，使用于创建会话过程中的会议类型变更
 - start() 开始呼叫
-- destory() 销毁会话，如果呼叫已经开始，会先向被叫端发送bye请求
-- getAllInputResource()  获取所有的音视频输入源
-- useDefaultDevice(container: HTMLVideoElement)  使用默认的本地音视频输入设备（麦克风与摄像头）,并将本地的流媒体渲染到对应的video上（可以不传），实际上是下面几个方法的组合使用
-- useAudio(deviceId) 使用对应deviceId的麦克风设备作为音频流，如果deviceId为undefined，那么使用默认的设备作为音频源
-- useDeviceVideo(deviceId) 使用对应deviceid摄像头设备的视频流，如果deviceId为undefined，那么使用默认的设备作为视频源
-- useDeskTopVideo()  使用桌面流作为视频流输入
+- destroy() 销毁会话，如果呼叫已经开始，会先向被叫端发送 bye 请求
+- getAllInputResource() 获取所有的音视频输入源
+- useDefaultDevice(container: HTMLVideoElement) 使用默认的本地音视频输入设备（麦克风与摄像头）,并将本地的流媒体渲染到对应的 video 上（可以不传），实际上是下面几个方法的组合使用
+- useAudio(deviceId) 使用对应 deviceId 的麦克风设备作为音频流，如果 deviceId 为 undefined，那么使用默认的设备作为音频源
+- useDeviceVideo(deviceId) 使用对应 deviceid 摄像头设备的视频流，如果 deviceId 为 undefined，那么使用默认的设备作为视频源
+- useDeskTopVideo() 使用桌面流作为视频流输入
 - disableAudio() 禁用本地流的音频输入,本地音频静音
 - disableVideo() 禁用本地流的视频输入，关闭本地视频画面
-- enableAudio()  启用本地音频输入
-- enableVideo()  启用本地视频输入
-- renderLocalStreamToContainer(container:HTMLVideoElement|HTMLAudioElement) 将本地的流媒体使用对应的video或者audio元素进行播放
-- on(event:RtcSessionEvent,cb:Function)  注册相关监听事件
+- enableAudio() 启用本地音频输入
+- enableVideo() 启用本地视频输入
+- renderLocalStreamToContainer(container:HTMLVideoElement|HTMLAudioElement) 将本地的流媒体使用对应的 video 或者 audio 元素进行播放
+- on(event:RtcSessionEvent,cb:Function) 注册相关监听事件
 - addDeviceChangeListener(listener) 注册物理输入设备变化监听事件，如摄像头拔线之类的操作
-- removeDeviceChangeListener(listener) 删除物理输入设备变化监听事件（组件化的框架如react之类的，在组件销毁的时候使用这个方法进行回收）
+- removeDeviceChangeListener(listener) 删除物理输入设备变化监听事件（组件化的框架如 react 之类的，在组件销毁的时候使用这个方法进行回收）
 
 事例代码
+
 ```javascript
 ...
 session.addRemote("7003")
@@ -140,27 +158,30 @@ await session.useDefaultDevice(document.getElementById("localplayer"))
 session.start()
 ```
 
-#### 5.RtcCalledSession
-RtcCalledSession是用来实例化被叫会话的对象，主要方法如下
+### 5.RtcCalledSession
+
+RtcCalledSession 是用来实例化被叫会话的对象，主要方法如下
+
 - getRemoteNumber() 获取呼叫自己的远端号码
 - rejectCall() 拒绝邀请，使用于创建会话与会话过程中的会议类型变更
 - acceptCall() 接受邀请，使用于创建会话与会话过程中的会议类型变更
-- destory() 销毁会话，如果呼叫已经开始，会先向被叫端发送bye请求
-- getAllInputResource()  获取所有的音视频输入源
-- useDefaultDevice(container: HTMLVideoElement)  使用默认的本地音视频输入设备（麦克风与摄像头）,并将本地的流媒体渲染到对应的video上（可以不传），实际上是下面几个方法的组合使用
-- useAudio(deviceId) 使用对应deviceId的麦克风设备作为音频流，如果deviceId为undefined，那么使用默认的设备作为音频源
-- useDeviceVideo(deviceId) 使用对应deviceid摄像头设备的视频流，如果deviceId为undefined，那么使用默认的设备作为视频源
-- useDeskTopVideo()  使用桌面流作为视频流输入
+- destroy() 销毁会话，如果呼叫已经开始，会先向被叫端发送 bye 请求
+- getAllInputResource() 获取所有的音视频输入源
+- useDefaultDevice(container: HTMLVideoElement) 使用默认的本地音视频输入设备（麦克风与摄像头）,并将本地的流媒体渲染到对应的 video 上（可以不传），实际上是下面几个方法的组合使用
+- useAudio(deviceId) 使用对应 deviceId 的麦克风设备作为音频流，如果 deviceId 为 undefined，那么使用默认的设备作为音频源
+- useDeviceVideo(deviceId) 使用对应 deviceid 摄像头设备的视频流，如果 deviceId 为 undefined，那么使用默认的设备作为视频源
+- useDeskTopVideo() 使用桌面流作为视频流输入
 - disableAudio() 禁用本地流的音频输入,本地音频静音
 - disableVideo() 禁用本地流的视频输入，关闭本地视频画面
-- enableAudio()  启用本地音频输入
-- enableVideo()  启用本地视频输入
-- renderLocalStreamToContainer(container:HTMLVideoElement|HTMLAudioElement) 将本地的流媒体使用对应的video或者audio元素进行播放
-- on(event:RtcSessionEvent,cb:Function)  注册相关监听事件
+- enableAudio() 启用本地音频输入
+- enableVideo() 启用本地视频输入
+- renderLocalStreamToContainer(container:HTMLVideoElement|HTMLAudioElement) 将本地的流媒体使用对应的 video 或者 audio 元素进行播放
+- on(event:RtcSessionEvent,cb:Function) 注册相关监听事件
 - addDeviceChangeListener(listener) 注册物理输入设备变化监听事件，如摄像头拔线之类的操作
-- removeDeviceChangeListener(listener) 删除物理输入设备变化监听事件（组件化的框架如react之类的，在组件销毁的时候使用这个方法进行回收
+- removeDeviceChangeListener(listener) 删除物理输入设备变化监听事件（组件化的框架如 react 之类的，在组件销毁的时候使用这个方法进行回收
 
 事例代码
+
 ```javascript
 ...
 client.on(RtcClientEvent.invite,async (session:RtcCalledSession)=>{
@@ -169,16 +190,19 @@ client.on(RtcClientEvent.invite,async (session:RtcCalledSession)=>{
 })
 ```
 
-#### 6.RtcSessionEvent
+### 6.RtcSessionEvent
+
 会话流程事件
+
 - bye 会话结束事件
 - stream 会话收到流的事件
-- localAudioChange  本地音频流设备发生了变化
-- localVideoChange  本地视频流设备发生了变化
-- reInvite 会话过程中修改会话类型会重新发invite 比如原先只是语音通话，然后变成视频会话
+- localAudioChange 本地音频流设备发生了变化
+- localVideoChange 本地视频流设备发生了变化
+- reInvite 会话过程中修改会话类型会重新发 invite 比如原先只是语音通话，然后变成视频会话
 - localStreamChange 本地流发生了变化
 
 事例代码
+
 ```javascript
 ...
 session.on(RtcSessionEvent.stream,({audioOnly,stream})=>{
@@ -186,8 +210,8 @@ session.on(RtcSessionEvent.stream,({audioOnly,stream})=>{
         //use audio to play
     }else{
         let playerContainer = document.getElementById("player")
-        playerContainer.srcObject = data.stream
-        playerContainer.remoteVideoContainer.play()
+        playerContainer.srcObject = stream
+        playerContainer.play()
     }
 })
 ...
@@ -197,30 +221,97 @@ session.on(RtcSessionEvent.bye,()=>{
 })
 ```
 
-### 4.ptt消息接口
-#### 1.启用ptt客户端功能
-本客户端(webrtc)集成了ptt对讲客户端的全部接口,功能等同于usc-ptt-sdk提供的功能,若想单独使用ptt功能,可直接安装usc-ptt-sdk即可;以下是集成的功能及用法说明:
+## 4.监控模式
+
+监控模式是本 SDK 提供的一种特殊功能，允许在不建立完整通话会话的情况下，单向播放远程流。
+
+### 1.使用 playRemote 函数
+
 ```javascript
-await createRtcClient({ 
-server, 
-localNumber, 
-enablePtt: true, // 初始化客户端时,可传入enablePtt,true表示启用ptt客户端,不传或flase表示不使用ptt客户端,
- pttServer: 'ws://localhost:40000' //pttClient服务器地址,当enablePtt为true时,需要传入该字段,否则初始化失败
- })
+import { playRemote } from 'usc-rtc-client'
+
+// 监控模式播放远程流
+async function startMonitoring(remoteNumber) {
+  try {
+    // 创建监控播放器
+    const monitorPlayer = document.getElementById('monitor-player')
+
+    // 开始监控远程号码
+    const player = await playRemote(
+      'ws://your-signaling-server-url', // 信令服务器地址
+      remoteNumber, // 要监控的远程号码
+      monitorPlayer, // 视频容器
+      {
+        audioOnly: false, // 是否仅播放音频
+        autoPlay: true, // 是否自动播放
+        muted: false, // 是否静音
+      }
+    )
+
+    console.log('监控会话创建成功')
+
+    // 5秒后结束监控
+    setTimeout(() => {
+      player.destroy()
+      console.log('监控会话已结束')
+    }, 5000)
+  } catch (error) {
+    console.error('监控会话创建失败:', error)
+  }
+}
 ```
 
-#### 2.RtcClient集成的ptt接口
-当启用ptt客户端时,ptt客户端提供的接口将可以在RtcClient上使用,接口说明如下:
+### 2.playRemote 函数参数说明
+
+| 参数名       | 类型             | 描述             | 是否必填 |
+| ------------ | ---------------- | ---------------- | -------- |
+| server       | string           | 信令服务器地址   | 是       |
+| remoteNumber | string           | 要监控的远程号码 | 是       |
+| container    | HTMLVideoElement | 视频播放容器     | 是       |
+| options      | object           | 可选配置项       | 否       |
+
+options 配置项：
+| 配置项 | 类型 | 默认值 | 描述 |
+|--------|------|--------|------|
+| audioOnly | boolean | false | 是否仅播放音频 |
+| autoPlay | boolean | true | 是否自动播放 |
+| muted | boolean | false | 是否静音 |
+
+### 3.监控模式的特点
+
+- 监控模式下会自动禁用心跳功能，减少网络通信
+- 监控模式是单向的，被监控方不会收到任何通知
+- 监控模式适合用于监控、预览等场景
+
+## 5.ptt 消息接口
+
+### 1.启用 ptt 客户端功能
+
+本客户端(webrtc)集成了 ptt 对讲客户端的全部接口,功能等同于 usc-ptt-sdk 提供的功能,若想单独使用 ptt 功能,可直接安装 usc-ptt-sdk 即可;以下是集成的功能及用法说明:
+
+```javascript
+await createRtcClient({
+  server,
+  localNumber,
+  enablePtt: true, // 初始化客户端时,可传入enablePtt,true表示启用ptt客户端,不传或flase表示不使用ptt客户端,
+  pttServer: 'ws://localhost:40000', //pttClient服务器地址,当enablePtt为true时,需要传入该字段,否则初始化失败
+})
+```
+
+### 2.RtcClient 集成的 ptt 接口
+
+当启用 ptt 客户端时,ptt 客户端提供的接口将可以在 RtcClient 上使用,接口说明如下:
 joinGroup('100114','10000008003','10.168.1.17',20023) //加入对讲组
 quitGroup() //退出组
-talk()      //说话
-stop()      //停止说话
+talk() //说话
+stop() //停止说话
 
 事例代码
+
 ```javascript
 const client = await createRtcClient({ server, localNumber, enablePtt: true, pttServer: 'ws://localhost:40000' })
 // 加入组
-client.joinGroup('100114','10000008003','10.168.1.17',20023)
+client.joinGroup('100114', '10000008003', '10.168.1.17', 20023)
 //退出组
 client.quitGroup()
 //本客户端用户需要说话时调用(须先加入一个对讲组)
@@ -228,9 +319,11 @@ client.talk()
 //停止说话
 client.stop()
 
-以上接口只作为向服务器发送请求消息,结果将以客户端事件的形式响应给用户,开发人员只需要在初始化完客户端后监听相应的事件即可
+以上接口只作为向服务器发送请求消息, 结果将以客户端事件的形式响应给用户, 开发人员只需要在初始化完客户端后监听相应的事件即可
 ```
-#### 3.PTTEvent
+
+### 3.PTTEvent
+
 ```javascript
 PTTEvent 表示底层封装向上抛出的一些业务与非业务的生命周期事件，具体如下
 const clientEvent = {
@@ -243,41 +336,118 @@ const clientEvent = {
 ```
 
 事例代码
+
 ```javascript
- const client = await createRtcClient({ server, localNumber, enablePtt: true, pttServer: 'ws://localhost:40000' })
-  client.on(PTTEvent.ACTIVE_GROUP,(e)=>{
-    // e为空字符串时表示当前没有加入任何组,否则e为加入的组的组id
-    if(e)
-      console.log(`进入组:${e}`)
-    else
-      console.log('退出组')
-  })
-  client.on(PTTEvent.SPEAKER,(e)=>{
-    // e为空字符串时表示当前没有人在说话或当前说话人停止说话,否则e为说话人的ptt号
-    if(e)
-    console.log(`${e}正在说话`)
-    else
-    console.log(`停止说话`)
-  })
-  client.on(PTTEvent.TALKING,(e)=>{
-    // e为true时表示当前自己在说话,否则表示自己停止说话
-    if(e)
-    console.log(`您正在说话`)
-    else
-    console.log(`您已停止说话`)
-  })
-  client.on(PTTEvent.JOIN_INFO,(e)=>{
-    // 有用户加入组时通知,
-    // e的结构如下
-      // {
-      //   user:8003, 加入的用户号
-      //   group:100114, 组id
-      //   code:1,  0表示退出组,1表示加入组
-      // }
-    console.log(`用户加入通知:${JSON.stringify(e)}`)
-  })
+const client = await createRtcClient({ server, localNumber, enablePtt: true, pttServer: 'ws://localhost:40000' })
+client.on(PTTEvent.ACTIVE_GROUP, (e) => {
+  // e为空字符串时表示当前没有加入任何组,否则e为加入的组的组id
+  if (e) console.log(`进入组:${e}`)
+  else console.log('退出组')
+})
+client.on(PTTEvent.SPEAKER, (e) => {
+  // e为空字符串时表示当前没有人在说话或当前说话人停止说话,否则e为说话人的ptt号
+  if (e) console.log(`${e}正在说话`)
+  else console.log(`停止说话`)
+})
+client.on(PTTEvent.TALKING, (e) => {
+  // e为true时表示当前自己在说话,否则表示自己停止说话
+  if (e) console.log(`您正在说话`)
+  else console.log(`您已停止说话`)
+})
+client.on(PTTEvent.JOIN_INFO, (e) => {
+  // 有用户加入组时通知,
+  // e的结构如下
+  // {
+  //   user:8003, 加入的用户号
+  //   group:100114, 组id
+  //   code:1,  0表示退出组,1表示加入组
+  // }
+  console.log(`用户加入通知:${JSON.stringify(e)}`)
+})
+```
+
+## 6.最佳实践
+
+### 1.错误处理
+
+在使用 SDK 时，建议添加适当的错误处理，以提高应用的稳定性：
+
+```javascript
+try {
+  const client = await createRtcClient({ server, localNumber })
+  // 使用client
+} catch (error) {
+  console.error('创建RTC客户端失败:', error)
+  // 处理错误，如提示用户重试
+}
+
+// 会话事件处理
+session.on(RtcSessionEvent.stream, ({ stream }) => {
+  if (stream) {
+    const container = document.getElementById('player')
+    container.srcObject = stream
+    container.play().catch((error) => {
+      console.error('播放流失败:', error)
+      // 处理自动播放失败的情况
+    })
+  }
+})
 ```
 
-### 5.限制
-- 1.目前仅做了chrome浏览器的兼容支持，要求chrome内核版本在90以上
-- 2.webrtc接口调用的页面需要依赖https环境(本地地址如localhost,127.0.0.1除外)，页面运行环境如果无法提供支持，请在chrome的unsafely-treat-insecure中添加白名单来让页面支持webrtc(chrome 浏览器打开chrome://flags/#unsafely-treat-insecure-origin-as-secure，在Insecure origins treated as secure下面的输入框中添加您的网页地址，选择右边的enable，重启浏览器生效)
+### 2.资源释放
+
+在不需要使用 SDK 或会话结束时，建议释放相关资源：
+
+```javascript
+// 销毁会话
+session.destroy()
+
+// 销毁客户端
+client.destroy()
+
+// 释放流资源
+releaseStreamFromContainer(container)
+```
+
+### 3.设备管理
+
+在使用音视频设备前，建议先检查设备是否可用：
+
+```javascript
+const resources = await session.getAllInputResource()
+if (resources.audio.length === 0) {
+  console.error('没有检测到麦克风')
+  // 处理没有麦克风的情况
+}
+if (resources.video.length === 0) {
+  console.error('没有检测到摄像头')
+  // 处理没有摄像头的情况
+}
+```
+
+## 7.限制
+
+- 目前仅做了 chrome 浏览器的兼容支持，要求 chrome 内核版本在 90 以上
+- webrtc 接口调用的页面需要依赖 https 环境(本地地址如 localhost,127.0.0.1 除外)，页面运行环境如果无法提供支持，请在 chrome 的 unsafely-treat-insecure 中添加白名单来让页面支持 webrtc(chrome 浏览器打开 chrome://flags/#unsafely-treat-insecure-origin-as-secure，在 Insecure origins treated as secure 下面的输入框中添加您的网页地址，选择右边的 enable，重启浏览器生效)
+
+## 8.API 参考
+
+### 核心函数
+
+- `createRtcClient(config)`: 创建 RTC 客户端
+- `playRemote(server, remoteNumber, container, options)`: 监控模式播放远程流
+- `renderStreamToContainer(stream, container)`: 渲染流到容器
+- `releaseStreamFromContainer(container)`: 从容器释放流
+- `enableLog()`: 启用日志
+
+### 事件类型
+
+- `RtcClientEvent`: 客户端事件
+- `RtcSessionEvent`: 会话事件
+- `PTTEvent`: PTT 事件
+
+### 类
+
+- `RtcClient`: RTC 客户端类
+- `RtcSession`: 会话类
+- `RtcCalledSession`: 被叫会话类

package/dist/client/RtcClient.d.ts

@@ -0,0 +1,16 @@
+import { RtcSession } from './../session/RtcSession';
+import { RtcClientBase } from './RtcClientBase';
+import { RtcAbstractSession } from '../session/RtcAbstractSession';
+export declare class RtcClient extends RtcClientBase {
+    allSession: RtcAbstractSession[];
+    createSession(remoteNumber?: string): RtcSession;
+    playRemote(remoteNumber: string, container: HTMLVideoElement, options?: {
+        audioOnly?: boolean;
+        autoPlay?: boolean;
+        muted?: boolean;
+    }): Promise<RtcSession>;
+    processMessage(data: any): void;
+    destroy(): void;
+    removeSession(session: RtcAbstractSession): void;
+    onDisConnected(): void;
+}

package/dist/client/RtcClientBase.d.ts

@@ -0,0 +1,32 @@
+import { RtcSignalApi } from './RtcSignalApi';
+/**
+ * RTC终端基础类，用来处理心跳等信息
+ */
+export declare abstract class RtcClientBase extends RtcSignalApi {
+    static defaultExpireTime: number;
+    pttClient?: any;
+    pttServer?: string;
+    enablePtt?: boolean;
+    constructor(config: {
+        server: string;
+        localNumber: string;
+        heartTime?: number;
+        expireTime?: number;
+        enablePtt?: boolean;
+        pttServer?: string;
+    });
+    initPttClient(): Promise<undefined>;
+    /**
+     *
+     * @param group 对讲组Id
+     * @param user 用户ptt账号
+     * @param ptts ptt对讲组使用的webscoket服务器,从ptt组中获取
+     * @param port ptt对讲组使用的webscoket服务器端口,从ptt组中获取
+     */
+    joinGroup(group: string, user: string, ptts: string, port: number): void;
+    quitGroup(): void;
+    talk(): void;
+    stop(): void;
+    onConnected(): void;
+    onDisConnected(): void;
+}

package/dist/client/RtcClientEvent.d.ts

@@ -0,0 +1,15 @@
+export declare enum RtcClientEvent {
+    connected = "connected",
+    disconnected = "disconnected",
+    invite = "invite"
+}
+export declare enum PTTEvent {
+    PTTInfo = "PTTInfo",
+    FPREInfo = "FPREInfo",
+    IMSInfo = "IMSInfo",
+    ERROR = "error",
+    SPEAKER = "speaker",
+    TALKING = "talking",
+    ACTIVE_GROUP = "activeGroup",
+    JOIN_INFO = "joinInfo"
+}

package/dist/client/RtcSignalApi.d.ts

@@ -0,0 +1,51 @@
+import { RtcInviteStatus } from './../session/RtcInviteStatus';
+import { RtcSignalServer } from './RtcSignalServer';
+/**
+ * 信令请求Api
+ */
+export declare abstract class RtcSignalApi extends RtcSignalServer {
+    /**
+     * send register message to the server
+     */
+    register(): Promise<any>;
+    unRegister(): void;
+    /**
+     * send a invite request to user
+     * @param user the remote user who you want invite
+     * @param cid the session id
+     * @param sdp  sdp content
+     * @returns
+     */
+    invite(user: string, cid: string, sdp?: string): Promise<any>;
+    /**
+     * send a ice request to user
+     * @param user the remote user
+     * @param cid  session id
+     * @param ice ice message
+     * @returns
+     */
+    sendIce(user: string, cid: string, ice: RTCIceCandidate): void;
+    /**
+     * send  bye message
+     * @param user the remote user
+     * @param cid session id
+     */
+    sendBye(user: string, cid: string): void;
+    /**
+     *  answer message
+     * @param status  answer status
+     * @param seq  the seq number from offer
+     * @param to  the remote offer user
+     * @param cid  session id
+     * @param sdp sdp content
+     */
+    answer(status: RtcInviteStatus, seq: number, to: string, cid: string, sdp?: string): void;
+    /**
+     *  answer message
+     * @param xd_oper  ptt infoType
+     * @param xd_name  the groupId
+     * @param user  the ptt user number
+     */
+    sendPttMessage(data: any): void;
+    sendDtmf(user: string, cid: string, dtmf: string): Promise<any>;
+}

package/dist/client/RtcSignalServer.d.ts

@@ -0,0 +1,19 @@
+import { SignalMessage } from './../message/SignalMessage';
+import { RtcSocketServerHandler } from '../websocket/RtcSocketServerHandler';
+/**
+ * rtc 信令服务器，用来处理信令消息，以及按照协议获取信令的返回结果
+ */
+export declare abstract class RtcSignalServer extends RtcSocketServerHandler {
+    asyncProducer: Map<number, Function>;
+    /**
+    * 发送需要回应消息的信令消息
+    */
+    sendRespondableMessage(message: SignalMessage): Promise<any>;
+    /**
+     * 获取异步回调
+     */
+    getAsyncResolve(seq: number): Function | undefined;
+    onDisConnected(e?: CloseEvent): void;
+    onReviceMessage(data: any): void;
+    abstract processMessage(data: any): any;
+}