Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WeChatGuest

微信小程序Client

Hierarchy

  • EventTarget
    • WeChatGuest

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Properties

_destroy

_destroy: () => void

Type declaration

    • (): void

    • Returns void

clientInfo

clientInfo: any

confProps

confProps: ConferenceProps

destinations

destinations: SocketDestinations

localStream

localStream: WeChatLocalStream

pluginList

pluginList: any[] = []

remoteStreamMap

remoteStreamMap: {}

Type declaration

  • [key: string]: WeChatRemoteStream

socket

socket: WeChatSocket

Static reporter

reporter: Reporter = new Reporter('WeChatGuest')

Methods

addEventListener

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

  • 添加事件监听器

    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)

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

    Parameters

    • types: Array<EventTargetType>

      要监听的事件类型

    • func: EventListenerType

      事件监听回调

    • Optional options: EventListenerOptions

      设置监听器参数

    Returns false | (Anonymous function)

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

call

  • desc

    发起呼叫

    Parameters

    • number: string

      业务号

    • Default value callParam: GuestCallParam = {}

      呼叫参数

    Returns Promise<any>

clearListener

  • clearListener(): void

  • 清空所有绑定的事件

    Returns void

destroy

  • destroy(): Promise<any>

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

    Returns Promise<any>

disableAudioOutput

  • disableAudioOutput(): Promise<any>

disableUploadAudioStream

  • disableUploadAudioStream(): Promise<any>

disableUploadVideoStream

  • disableUploadVideoStream(): Promise<any>

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • 分发事件

    Parameters

    • event: Event

      分发的事件对象

    Returns boolean

    事件是否发送成功

dispatchEventLite

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

  • 简化分发事件接口, 如需要分发的是错误事件, error参数传入具体错误类型

    Parameters

    • type: EventTargetType

      事件类型

    • Optional message: EventTargetData

      消息

    • Optional error: string | number

      错误类型

    Returns void

enableAudioOutput

  • enableAudioOutput(): Promise<any>

enableUploadAudioStream

  • enableUploadAudioStream(): Promise<any>

enableUploadVideoStream

  • enableUploadVideoStream(): Promise<any>

getLocalStream

  • getLocalStream(): WeChatLocalStream

getRemoteStreamList

  • getRemoteStreamList(): Array<WeChatRemoteStream>

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

    Returns Array<WeChatRemoteStream>

hasListener

  • hasListener(type: EventTargetType): boolean

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

    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

login

  • login(): Promise<any>

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

    Returns Promise<any>

logout

  • logout(): Promise<any>

removeEventListener

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

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

    Parameters

    • type: EventTargetType

      要移除的事件监听器类型

    • func: EventListenerType

      要移除的事件监听器

    Returns boolean

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

requestUrgent

  • requestUrgent(): Promise<any>

requestVideo

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

sendMessage

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

  • 发送文字消息

    Parameters

    • type: string

      消息类型

    • content: string

      消息内容

    • Optional userId: string

    Returns Promise<any>

sendSignalling

  • sendSignalling(signal: any, options?: { destination?: string; isPlainText?: boolean }): Promise<any>

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

    Parameters

    • signal: any

      信令消息

    • Default value options: { destination?: string; isPlainText?: boolean } = {}
      • Optional destination?: string
      • Optional isPlainText?: boolean

    Returns Promise<any>

setAudioRoute

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

setRatio

  • setRatio(ratio: number): Promise<any>

  • Parameters

    • ratio: number

    Returns Promise<any>

setRequestSize

setRequestVideo

startCameraVideo

  • startCameraVideo(renderType: any): Promise<Stream>

startVideo

  • startVideo(): Promise<Stream>

switchCamera

term

  • term(): Promise<any>

  • Returns Promise<any>

usePlugin

Object literals

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"

Generated using TypeDoc