Namespace Juphoon_WeChat

Index

Functions

Object literals

Functions

attachAllRemoteStreamComponents

attachAllRemoteStreamComponents(selector: any, that: any): void

desc

绑定 <remote-stream> 组件, 坐席接通后或成员数量变化时需要重新绑定

Parameters
- selector: any
  
  选择器, 语法遵循CSS选择器, 建议使用class类选择组件, 因为 <remote-stream> 组件可能会存在多个.
- that: any
  
  微信小程序页面的this
Returns void

attachLocalStreamComponent

attachLocalStreamComponent(selector: any, that: any): void

desc

绑定 <local-stream> 组件

Parameters
- selector: any
  
  选择器, 语法遵循CSS选择器
- that: any
  
  微信小程序页面的this
Returns void

createConferenceClient

createConferenceClient(appKey: string, username: string, token: string, socketAddress: string): WeChatGuest

desc

创建会议的WeChatGuest

Parameters
- appKey: string
  
  appKey
- username: string
  
  用户名，传 null 即可（弃用）
- token: string
  
  自行获取到的token
- socketAddress: string
  
  WebSocket的连接地址
Returns WeChatGuest

createGuestClient

createGuestClient(appKey: string, username: string, token: string, socketAddress: string): WeChatGuest

desc

创建访客的WeChatGuest

Parameters
- appKey: string
  
  appKey
- username: string
  
  用户名，传 null 即可（弃用）
- token: string
  
  自行获取到的token
- socketAddress: string
  
  WebSocket的连接地址
Returns WeChatGuest

destroy

destroy(): void

desc

销毁创建的WeChatSocket, WeChatGuest, WeChatLocalStream, WeChatRemoteStream以释放资源。

Returns void

getToken

getToken(url: string, username: string): Promise<any>

desc

获取用于WebSocket校验的token

Parameters
- url: string
  
  获取token的http地址
- username: string
  
  以 wx_user_ 为前缀的用户名
Returns Promise<any>

getVersion

getVersion(): any

desc

获取SDK版本信息

Returns any

setConfig

setConfig(_config: { address: string }): void

配置SDK参数

Parameters
- _config: { address: string }
  - address: string
    
    设置服务环境地址. 支持类型 http(s)://IP:PORT. 设置后createConferenceClient不再需要传入 socketAddress 参数
Returns void

Object literals

Const config

config: object

client

client: null = null

envInfo

envInfo: null = null

userId

userId: null = null

Const plugins

plugins: object

TRTC

TRTC: TRTCPlugin = TRTCPlugin

Generated using TypeDoc