WeChatGuest | wechat-conference-sdk

微信小程序Client

Hierarchy

EventTarget
- WeChatGuest

Implements

Guest

Index

Constructors

constructor

Properties

Methods

Object literals

Constructors

constructor

new WeChatGuest(socket: WeChatSocket, confProps: ConferenceProps, type: WeChatGuestType): WeChatGuest

Overrides EventTarget.constructor

Parameters
- socket: WeChatSocket
- confProps: ConferenceProps
  
  会议参数
- type: WeChatGuestType
  
  指定WeChatGuest的类型，仅限访客或会议
Returns WeChatGuest

Properties

_destroy

_destroy: () => void

Type declaration

- (): void
- Returns void

clientInfo

clientInfo: any

confProps

confProps: ConferenceProps

destinations

destinations: SocketDestinations

listenerMap

listenerMap: {}

Type declaration

[key: string]: Array<EventListenerType>

localStream

localStream: WeChatLocalStream

pluginList

pluginList: any[] = []

remoteStreamMap

remoteStreamMap: {}

Type declaration

[key: string]: WeChatRemoteStream

socket

socket: WeChatSocket

Static reporter

reporter: Reporter = new Reporter('WeChatGuest')

Methods

Private _addRemoteStream

_addRemoteStream(stream: WeChatRemoteStream): void

添加远端媒体流

Parameters
- stream: WeChatRemoteStream
Returns void

Private _clientInit

_clientInit(): (Anonymous function)

WeChatGuest初始化, 监听传入的WeChatSocket实例的SocketEventType.MESSAGE事件

Returns (Anonymous function)

Private _dispatchcmd

_dispatchcmd(msg: any): void

Parameters
- msg: any
Returns void

Private _dispatchmsg

_dispatchmsg(msg: any): void

处理从WeChatSocket接收到的type为 msg 信令然后触发对应的事件

Parameters
- msg: any
Returns void

Private _removeRemoteStream

_removeRemoteStream(userId: any): void

移除远端媒体流, 以 userId 为key

Parameters
- userId: any
Returns void

Private _sendSignalling

_sendSignalling(signal: string | Object, options?: { destination?: string }): Promise<any>

发送信令消息, 可指定发送的目的地

Parameters
- signal: string | Object
  
  信令消息
- Default value options: { destination?: string } = {}
  - Optional destination?: string
Returns Promise<any>

addEventListener

addEventListener(type: EventTargetType, func: EventListenerType, options?: EventListenerOptions): () => void

Inherited from EventTarget.addEventListener

添加事件监听器

Parameters
- type: EventTargetType
  
  要监听的事件类型
- func: EventListenerType
  
  事件监听回调
- Optional options: EventListenerOptions
Returns () => void

若添加成功则返回一个函数, 用于移除事件监听
- - (): void
  - Returns void

addEventListeners

addEventListeners(types: Array<EventTargetType>, func: EventListenerType, options?: EventListenerOptions): false | (Anonymous function)

Inherited from EventTarget.addEventListeners

对多个事件添加同一个事件监听器

Parameters
- types: Array<EventTargetType>
  
  要监听的事件类型
- func: EventListenerType
  
  事件监听回调
- Optional options: EventListenerOptions
  
  设置监听器参数
Returns false | (Anonymous function)

若添加成功则返回一个函数, 用于移除事件监听

call

call(number: string, callParam?: GuestCallParam): Promise<any>

Implementation of Guest.call

desc

发起呼叫

Parameters
- number: string
  
  业务号
- Default value callParam: GuestCallParam = {}
  
  呼叫参数
Returns Promise<any>

clearListener

clearListener(): void

Inherited from EventTarget.clearListener

清空所有绑定的事件

Returns void

destroy

destroy(): Promise<any>

销毁Client并移除所有事件监听器

Returns Promise<any>

disableAudioOutput

disableAudioOutput(): Promise<any>

Implementation of Guest.disableAudioOutput

Returns Promise<any>

disableUploadAudioStream

disableUploadAudioStream(): Promise<any>

Implementation of Guest.disableUploadAudioStream

Returns Promise<any>

disableUploadVideoStream

disableUploadVideoStream(): Promise<any>

Implementation of Guest.disableUploadVideoStream

Returns Promise<any>

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent

分发事件

Parameters
- event: Event
  
  分发的事件对象
Returns boolean

事件是否发送成功

dispatchEventLite

dispatchEventLite(type: EventTargetType, message?: EventTargetData, error?: string | number): void

Inherited from EventTarget.dispatchEventLite

Parameters
- type: EventTargetType
- Optional message: EventTargetData
- Optional error: string | number
Returns void

enableAudioOutput

enableAudioOutput(): Promise<any>

Implementation of Guest.enableAudioOutput

Returns Promise<any>

enableUploadAudioStream

enableUploadAudioStream(): Promise<any>

Implementation of Guest.enableUploadAudioStream

Returns Promise<any>

enableUploadVideoStream

enableUploadVideoStream(): Promise<any>

Implementation of Guest.enableUploadVideoStream

Returns Promise<any>

getLocalStream

getLocalStream(): WeChatLocalStream

获取本地推流WeChatLocalStream对象

Returns WeChatLocalStream

getRemoteStreamList

getRemoteStreamList(): Array<WeChatRemoteStream>

以数组形式获取所有远端流对象

Returns Array<WeChatRemoteStream>

hasListener

hasListener(type: EventTargetType): boolean

Inherited from EventTarget.hasListener

指定类型的事件是否被监听

Parameters
- type: EventTargetType
Returns boolean

join

join(roomId: any, joinParam?: {}): Promise<any>

desc

加入会议

Parameters
- roomId: any
  
  房间号
- Default value joinParam: {} = {}
  
  加入会议参数
Returns Promise<any>

leave

leave(): Promise<any>

挂断与客服的通话或离开会议。

Returns Promise<any>

listAllGroups

listAllGroups(): Promise<Array<GroupInfo>>

Implementation of Guest.listAllGroups

Returns Promise<Array<GroupInfo>>

login

呼叫之前需要先进行登录，登录结果会在GuestEventType.LOGIN回调

Returns Promise<any>

logout

logout(): Promise<any>

Implementation of Guest.logout

Returns Promise<any>

removeEventListener

removeEventListener(type: EventTargetType, func: EventListenerType): boolean

Inherited from EventTarget.removeEventListener

移除事件监听器, 要提供与调用addEventListener或addEventListeners时相同的参数

Parameters
- type: EventTargetType
  
  要移除的事件监听器类型
- func: EventListenerType
  
  要移除的事件监听器
Returns boolean

返回true表示有该fun监听器并且移除成功

requestUrgent

requestUrgent(): Promise<any>

Implementation of Guest.requestUrgent

请求加急

Returns Promise<any>

requestVideo

requestVideo(participant: string, pictureSize: ConferencePictureSize): Promise<any>

Implementation of Guest.requestVideo

Parameters
- participant: string
- pictureSize: ConferencePictureSize
Returns Promise<any>

sendMessage

sendMessage(type: string, content: string, userId?: string): Promise<any>

发送文字消息

Parameters
- type: string
  
  消息类型
- content: string
  
  消息内容
- Optional userId: string
Returns Promise<any>

setAudioRoute

setAudioRoute(...args: any): Promise<any>

Implementation of Guest.setAudioRoute

Parameters
- Rest ...args: any
Returns Promise<any>

setRatio

setRatio(ratio: number): void

Implementation of Guest.setRatio

Parameters
- ratio: number
Returns void

setRequestSize

setRequestSize(level: GuestPictureSize): Promise<any>

设置请求分辨率

Parameters
- level: GuestPictureSize
Returns Promise<any>

setRequestVideo

setRequestVideo(pictureSize: GuestPictureSize): Promise<any>

Implementation of Guest.setRequestVideo

Parameters
- pictureSize: GuestPictureSize
Returns Promise<any>

startCameraVideo

startCameraVideo(renderType: any): Promise<Stream>

Implementation of Guest.startCameraVideo

Parameters
- renderType: any
Returns Promise<Stream>

startVideo

startVideo(): Promise<Stream>

Implementation of Guest.startVideo

Returns Promise<Stream>

switchCamera

switchCamera(constraints: StreamCameraConstraints): Promise<Stream>

Implementation of Guest.switchCamera

Parameters
- constraints: StreamCameraConstraints
Returns Promise<Stream>

term

term(): Promise<any>

Implementation of Guest.term

Returns Promise<any>

usePlugin

usePlugin(plugin: TRTCPlugin): void

使用插件, 目前仅支持TRTCPlugin

Parameters
- plugin: TRTCPlugin
Returns void

Object literals

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: object

once

once: false = false

Static DEFAULT_GUEST_PROPS

DEFAULT_GUEST_PROPS: object

accountName

accountName: null = null

appKey

appKey: null = null

cdType

cdType: "WeChat" = "WeChat"

jmdsType

jmdsType: "JSM.JMDS.WeChat" = "JSM.JMDS.WeChat"

mediaType

mediaType: "1" = "1"

mtcConfCapacityKey

mtcConfCapacityKey: number = 100

mtcConfCompositeModeKey

mtcConfCompositeModeKey: number = 5

mtcConfPasswordKey

mtcConfPasswordKey: string = "123456"

mtcConfQualityGradeKey

mtcConfQualityGradeKey: number = 1

mtcConfRoleKey

mtcConfRoleKey: number = 4

mtcConfSecurityKey

mtcConfSecurityKey: number = 0

mtcConfStateKey

mtcConfStateKey: number = 3

nickName

nickName: null = null

regionId

regionId: string = "0"

Static DEFAULT_SOCKET_DESTINATIONS

DEFAULT_SOCKET_DESTINATIONS: object

close

close: string = "/acd/close"

createConference

createConference: string = "/acd/meeting/start"

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

socket: WeChatSocket

confProps: ConferenceProps

type: WeChatGuestType

Returns WeChatGuest

Properties

_destroy

Type declaration

Returns void

clientInfo

confProps

destinations

listenerMap

Type declaration

[key: string]: Array<EventListenerType>

localStream

pluginList

remoteStreamMap

Type declaration

[key: string]: WeChatRemoteStream

socket

Static reporter

Methods

Private _addRemoteStream

Parameters

stream: WeChatRemoteStream

Returns void

Private _clientInit

Returns (Anonymous function)

Private _dispatchcmd

Parameters

msg: any

Returns void

Private _dispatchmsg

Parameters

msg: any

Returns void

Private _removeRemoteStream

Parameters

userId: any

Returns void

Private _sendSignalling

Parameters

signal: string | Object

Default value options: { destination?: string } = {}

Optional destination?: string

Returns Promise<any>

addEventListener

Parameters

type: EventTargetType

func: EventListenerType

Optional options: EventListenerOptions

Returns () => void

Returns void

addEventListeners

Parameters

types: Array<EventTargetType>

func: EventListenerType

Optional options: EventListenerOptions

Returns false | (Anonymous function)

call

Parameters

number: string

Default value callParam: GuestCallParam = {}

Returns Promise<any>

clearListener

Returns void

destroy

Returns Promise<any>

disableAudioOutput

Returns Promise<any>