Namespace JuphoonRTCGuest

Index

Functions

Functions

createGuestClient

createGuestClient(appKey: string, token: string, socketAddress?: string): RTCGuest

创建访客client

Parameters
- appKey: string
  
  appKey
- token: string
  
  token
- Optional socketAddress: string
  
  WebSocket的连接地址
Returns RTCGuest

detect

detect(requestUser?: boolean): Promise<RTCSupportInfo>

检测浏览器环境的支持程度

Parameters
- Default value requestUser: boolean = true
  
  是否请求用户的媒体设备, 请求媒体设备能够得到更加完整的兼容信息
Returns Promise<RTCSupportInfo>

getMediaDevices

getMediaDevices(): Promise<_WebDevicesInfo>

获取设备媒体信息

Returns Promise<_WebDevicesInfo>

getVersion

getVersion(): any

获取SDK版本信息

Returns any

setConfig

setConfig(_config: { address: string; transportPolicy?: RTCIceTransportPolicy; webSocketAuthType?: StompSocketAuthType; webSocketOptions?: PlatformStandardWebSocketOptions }): void

配置SDK参数

Parameters
- _config: { address: string; transportPolicy?: RTCIceTransportPolicy; webSocketAuthType?: StompSocketAuthType; webSocketOptions?: PlatformStandardWebSocketOptions }
  - address: string
    
    设置服务环境地址. 支持类型 http(s)://IP:PORT. 设置后createGuestClient不再需要传入 socketAddress 参数
  - Optional transportPolicy?: RTCIceTransportPolicy
    
    指定WebRTC传输协议
  - Optional webSocketAuthType?: StompSocketAuthType
    
    指定token校验方式
  - Optional webSocketOptions?: PlatformStandardWebSocketOptions
    
    WebSocket连接选项
Returns void

Generated using TypeDoc