WeChatConference | webrtc-guest-sdk

Hierarchy

EventTarget
- WeChatConference

Implements

Conference

Index

Constructors

constructor

Properties

Accessors

Object literals

Constructors

constructor

new WeChatConference(socket: WeChatSocket, appKey: string): WeChatConference

Overrides EventTarget.constructor

Parameters
- socket: WeChatSocket
  
  Socket对象
- appKey: string
  
  appKey
Returns WeChatConference

Properties

_appKey

_appKey: string

_localStream

_localStream: WeChatLocalStream

_participantMap

_participantMap: {}

_remoteStreamMap

_remoteStreamMap: {}

Type declaration

[key: string]: WeChatRemoteStream

_revoke

_revoke: () => void

Type declaration

- (): void
- Returns void

_selfParticipant

_selfParticipant: ConferenceParticipant

_state

_state: ConferenceClientState

_videoLayout

_videoLayout: VideoLayout

clientInfo

clientInfo: any

confProps

confProps: ConferenceCDProps

destinations

destinations: SocketDestinations

listenerMap

listenerMap: {}

Type declaration

[key: string]: Array<EventListenerType>

pageTarget

pageTarget: any

微信小程序page页面的 this 对象用于获取自定义组件对象

socket

socket: WeChatSocket

Static reporter

reporter: Reporter = new Reporter('WeChatConference')

Accessors

participantMap

get participantMap(): {}

Returns {}
- [key: string]: ConferenceParticipant

recorder

get recorder(): WeChatMediaRecorder

Returns WeChatMediaRecorder

selfParticipant

get selfParticipant(): ConferenceParticipant

Returns ConferenceParticipant

state

get state(): ConferenceClientState
set state(state: ConferenceClientState): void

Returns ConferenceClientState
Parameters
- state: ConferenceClientState
Returns void

videoLayout

get videoLayout(): VideoLayout

Returns VideoLayout

Methods

Private _clientInit

_clientInit(): (Anonymous function)

初始化方法

Returns (Anonymous function)

_destroy

_destroy(): Promise<any>

Returns Promise<any>

_dispatcherr

_dispatcherr(err: any): void

Parameters
- err: any
Returns void

Private _dispatchmsg

_dispatchmsg(msg: any): void

处理信令消息

Parameters
- msg: any
Returns void

_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>

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)

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

clearListener

clearListener(): void

Inherited from EventTarget.clearListener

清空所有绑定的事件

Returns void

destroy

destroy(): void

Implementation of Conference.destroy

Returns void

disableAudioOutput

disableAudioOutput(): Promise<any>

Implementation of Conference.disableAudioOutput

Returns Promise<any>

disableUploadAudioStream

disableUploadAudioStream(): Promise<any>

Implementation of Conference.disableUploadAudioStream

Returns Promise<any>

disableUploadVideoStream

disableUploadVideoStream(): Promise<any>

Implementation of Conference.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 Conference.enableAudioOutput

Returns Promise<any>

enableUploadAudioStream

enableUploadAudioStream(): Promise<any>

Implementation of Conference.enableUploadAudioStream

Returns Promise<any>

enableUploadVideoStream

enableUploadVideoStream(): Promise<any>

Implementation of Conference.enableUploadVideoStream

Returns Promise<any>

hasListener

hasListener(type: EventTargetType): boolean

Inherited from EventTarget.hasListener

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

Parameters
- type: EventTargetType
Returns boolean

join

join(confNumber: string, video: boolean, joinParam?: ConferenceJoinParam): Promise<any>

Implementation of Conference.join

Parameters
- confNumber: string
- video: boolean
- Default value joinParam: ConferenceJoinParam = {}
Returns Promise<any>

leave

leave(): Promise<any>

Implementation of Conference.leave

Returns Promise<any>

login

Implementation of Conference.login

Parameters
- Default value confProps: ConferenceCDProps = {}
Returns Promise<any>

query

query(channelId: string): Promise<any>

Implementation of Conference.query

Parameters
- channelId: string
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监听器并且移除成功

requestVideo

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

Implementation of Conference.requestVideo

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

sendMessage

sendMessage(type: string, content: string | Object, toUserId: string): Promise<any>

Implementation of Conference.sendMessage

Parameters
- type: string
- content: string | Object
- toUserId: string
Returns Promise<any>

setAudioRoute

setAudioRoute(route: "speaker" | "ear"): Promise<any>

Parameters
- route: "speaker" | "ear"
Returns Promise<any>

setPageTarget

setPageTarget(target: any): void

Parameters
- target: any
Returns void

start

start(confNumber: string, video: boolean, joinParam?: ConferenceJoinParam): Promise<any>

Implementation of Conference.start

Parameters
- confNumber: string
- video: boolean
- Default value joinParam: ConferenceJoinParam = {}
Returns Promise<any>

startCameraVideo

startCameraVideo(): Promise<WeChatLocalStream>

Returns Promise<WeChatLocalStream>

startVideo

startVideo(): Promise<WeChatRemoteStream>

Implementation of Conference.startVideo

Returns Promise<WeChatRemoteStream>

stop

stop(): Promise<any>

Implementation of Conference.stop

Returns Promise<any>

switchCamera

switchCamera(constraints: StreamCameraConstraints): Promise<Stream>

Implementation of Conference.switchCamera

Parameters
- constraints: StreamCameraConstraints
Returns Promise<Stream>

Object literals

Static DEFAULT_CONFERENCE_PROPS

DEFAULT_CONFERENCE_PROPS: object

accountName

accountName: undefined = undefined

accountPwd

accountPwd: string = ""

appKey

appKey: undefined = undefined

cdType

cdType: "WeChat" = "WeChat"

isStart

isStart: undefined = undefined

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

mtcConfReplayKey

mtcConfReplayKey: false = false

mtcConfRoleKey

mtcConfRoleKey: ConferenceRole = ConferenceRole.PARTP

mtcConfSecurityKey

mtcConfSecurityKey: number = 0

mtcConfStateKey

mtcConfStateKey: number = 3

nickName

nickName: string = ""

password

password: string = "123456"

regionId

regionId: string = "0"

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: object

once

once: false = false

Static DEFAULT_JOIN_CONFERENCE_PARAM

DEFAULT_JOIN_CONFERENCE_PARAM: object

capacity

capacity: number = 6

conferencePassword

conferencePassword: null = null

displayName

displayName: null = null

enableRecord

enableRecord: null = null

role

role: ConferenceRole = ConferenceRole.PARTP

Static DEFAULT_SOCKET_DESTINATIONS

DEFAULT_SOCKET_DESTINATIONS: object

close

close: string = "/acd/close"

createConference

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

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Parameters

socket: WeChatSocket

appKey: string

Returns WeChatConference

Properties

_appKey

_localStream

_participantMap

Type declaration

[key: string]: ConferenceParticipant

_recorder

_remoteStream

_remoteStreamMap

Type declaration

[key: string]: WeChatRemoteStream

_revoke

Type declaration

Returns void

_selfParticipant

_state

_videoLayout

clientInfo

confProps

destinations

listenerMap

Type declaration

[key: string]: Array<EventListenerType>

pageTarget

socket

Static reporter

Accessors

participantMap

Returns {}

[key: string]: ConferenceParticipant

recorder

Returns WeChatMediaRecorder

selfParticipant

Returns ConferenceParticipant

state

Returns ConferenceClientState

Parameters

state: ConferenceClientState

Returns void

videoLayout

Returns VideoLayout

Methods

Private _clientInit

Returns (Anonymous function)

_destroy

Returns Promise<any>

_dispatcherr

Parameters

err: any

Returns void

Private _dispatchmsg

Parameters

msg: any

Returns void

_sendSignalling

Parameters

signal: any

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

Optional destination?: string

Optional isPlainText?: boolean

Returns Promise<any>

addEventListener

Parameters

type: EventTargetType

func: EventListenerType

Optional options: EventListenerOptions