RTCGuest | wechat-conference-sdk

Hierarchy

EventTarget
- RTCGuest

Implements

Guest

Index

Constructors

constructor

Properties

Accessors

Object literals

Constructors

constructor

new RTCGuest(socket: WebStompSocket, appKey: string): RTCGuest

Overrides EventTarget.constructor

Parameters
- socket: WebStompSocket
  
  Socket对象
- appKey: string
  
  appKey
Returns RTCGuest

Properties

_appKey

_appKey: string

_core

_core: RTCCore

_localStream

_localStream: RTCStream

_participantMap

_participantMap: {}

Type declaration

[key: string]: ConferenceParticipant

_remoteStream

_remoteStream: RTCStream

_remoteStreamMap

_remoteStreamMap: {}

Type declaration

[key: string]: RTCStream

_revoke

_revoke: () => void

Type declaration

- (): void
- Returns void

_selfParticipant

_selfParticipant: ConferenceParticipant

_state

_state: GuestClientState

_taskQueue

_taskQueue: TaskQueue

_videoLayout

_videoLayout: VideoLayout

clientInfo

clientInfo: any

destinations

destinations: SocketDestinations

guestCDProps

guestCDProps: GuestCDProps

listenerMap

listenerMap: {}

Type declaration

[key: string]: Array<EventListenerType>

socket

socket: WebStompSocket

Static reporter

reporter: Reporter = new Reporter('RTCGuest')

Accessors

participantMap

get participantMap(): {}

Returns {}
- [key: string]: ConferenceParticipant

selfParticipant

get selfParticipant(): ConferenceParticipant

Returns ConferenceParticipant

state

get state(): GuestClientState
set state(state: GuestClientState): void

Returns GuestClientState
Parameters
- state: GuestClientState
Returns void

videoLayout

get videoLayout(): VideoLayout

Returns VideoLayout

Methods

Private _clientInit

_clientInit(): (Anonymous function)

初始化方法

Returns (Anonymous function)

Private _destroy

_destroy(): Promise<any>

Returns Promise<any>

_dispatcherr

_dispatcherr(err: any): void

Parameters
- err: any
Returns void

Private _dispatchice

_dispatchice(ice: any): void

处理 ice 消息

Parameters
- ice: any
Returns void

Private _dispatchmsg

_dispatchmsg(msg: any): void

处理信令消息

Parameters
- msg: any
Returns void

Private _dispatchsdp

_dispatchsdp(sdp: any): void

处理 sdp 消息

Parameters
- sdp: any
Returns void

Private _sendSignalling

_sendSignalling(signal: string | Object, options?: { destination?: string; isNewFormat?: boolean; isPlainText?: boolean; needAck?: boolean; type?: "msg" | "ice" | "sdp" | "cmd" }): Promise<any>

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

Parameters
- signal: string | Object
  
  信令消息
- Default value options: { destination?: string; isNewFormat?: boolean; isPlainText?: boolean; needAck?: boolean; type?: "msg" | "ice" | "sdp" | "cmd" } = {}
  - Optional destination?: string
  - Optional isNewFormat?: boolean
  - Optional isPlainText?: boolean
  - Optional needAck?: boolean
  - Optional type?: "msg" | "ice" | "sdp" | "cmd"
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

Parameters
- number: string
- Default value callParam: GuestCallParam = {}
Returns Promise<any>

clearListener

clearListener(): void

Inherited from EventTarget.clearListener

清空所有绑定的事件

Returns void

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>

hasListener

hasListener(type: EventTargetType): boolean

Inherited from EventTarget.hasListener

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

Parameters
- type: EventTargetType
Returns boolean

listAllGroups

listAllGroups(): Promise<GroupInfo>

Implementation of Guest.listAllGroups

Returns Promise<GroupInfo>

login

Implementation of Guest.login

Parameters
- Default value cdProps: GuestCDProps = {}
Returns Promise<any>

logout

logout(): Promise<any>

Implementation of Guest.logout

Returns Promise<any>

oneToOneCall

oneToOneCall(userId: string, callParam?: GuestCallParam): Promise<any>

Parameters
- userId: string
- Default value callParam: GuestCallParam = {}
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 | Object, toUserId?: string | ConferenceParticipant): Promise<any>

Parameters
- type: string
- content: string | Object
- Optional toUserId: string | ConferenceParticipant
  
  接受会议成员的 id0 字符串或是一个ConferenceParticipant对象, null则发给所有会议成员
Returns Promise<any>

setAudioRoute

setAudioRoute(device: WebDeviceInfo): Promise<any>

Parameters
- device: WebDeviceInfo
Returns Promise<any>

setRatio

setRatio(ratio: number): any

Implementation of Guest.setRatio

Parameters
- ratio: number
Returns any

setRequestVideo

setRequestVideo(size: GuestPictureSize): Promise<any>

Implementation of Guest.setRequestVideo

Parameters
- size: GuestPictureSize
Returns Promise<any>

startCameraVideo

startCameraVideo(renderType?: RenderType): Promise<RTCStream>

开启视频输入设备，如摄像头等。

失败会使 Promise 处于 rejected 状态，并返回失败原因。失败原因见 StreamErrorType

Parameters
- Default value renderType: RenderType = RenderType.CONTAIN
  
  渲染方式
Returns Promise<RTCStream>

startVideo

startVideo(): Promise<RTCStream>

Implementation of Guest.startVideo

Returns Promise<RTCStream>

switchCamera

switchCamera(constraints: StreamCameraConstraints): Promise<RTCStream>

Implementation of Guest.switchCamera

Parameters
- constraints: StreamCameraConstraints
Returns Promise<RTCStream>

term

term(): Promise<any>

Implementation of Guest.term

Returns Promise<any>

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: "Guest" = "Guest"

jmdsType

jmdsType: "JSM.JMDS.CallCenter" = "JSM.JMDS.CallCenter"

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

businessList

businessList: string = "/acd/tel_nums"

close

close: string = "/acd/close"

createConference

createConference: string = "/acd/guest/conference"

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Parameters

socket: WebStompSocket

appKey: string

Returns RTCGuest

Properties

_appKey

_core

_localStream

_participantMap

Type declaration

[key: string]: ConferenceParticipant

_remoteStream

_remoteStreamMap

Type declaration

[key: string]: RTCStream

_revoke

Type declaration

Returns void

_selfParticipant

_state

_taskQueue

_videoLayout

clientInfo

destinations

guestCDProps

listenerMap

Type declaration

[key: string]: Array<EventListenerType>

socket

Static reporter

Accessors

participantMap

Returns {}

[key: string]: ConferenceParticipant

selfParticipant

Returns ConferenceParticipant

state

Returns GuestClientState

Parameters

state: GuestClientState

Returns void

videoLayout

Returns VideoLayout

Methods

Private _clientInit

Returns (Anonymous function)

Private _destroy

Returns Promise<any>

_dispatcherr

Parameters

err: any

Returns void

Private _dispatchice

Parameters

ice: any

Returns void

Private _dispatchmsg

Parameters

msg: any

Returns void

Private _dispatchsdp

Parameters

sdp: any

Returns void

Private _sendSignalling

Parameters

signal: string | Object

Default value options: { destination?: string; isNewFormat?: boolean; isPlainText?: boolean; needAck?: boolean; type?: "msg" | "ice" | "sdp" | "cmd" } = {}

Optional destination?: string

Optional isNewFormat?: boolean