Class TRTCPlugin

Hierarchy

EventTarget
- TRTCPlugin

Index

Constructors

constructor

Properties

Methods

Object literals

DEFAULT_EVENT_LISTENER_OPTIONS

Constructors

constructor

new TRTCPlugin(__namedParameters: { config: any }): TRTCPlugin

Overrides EventTarget.constructor

Parameters
- __namedParameters: { config: any }
  - config: any
Returns TRTCPlugin

Properties

client

client: WeChatGuest

config

config: TRTCPluginConfig

listenerMap

listenerMap: {}

Type declaration

[key: string]: Array<EventListenerType>

socket

socket: WeChatSocket

unsubscribeList

unsubscribeList: Array<() => void>

Static logger

logger: Reporter = new Reporter('TRTCPlugin')

Methods

Private _bindPushStateChange

_bindPushStateChange(event: any): void

desc

绑定 <live-pusher> 的状态改变事件

Parameters
- event: any
Returns void

Private _listenEvent

_listenEvent(client: any): void

desc

绑定监听事件

Parameters
- client: any
Returns void

Private _roomHandle

_roomHandle(code: any, message: any): void

desc

处理 1031-1034 状态改变事件

Parameters
- code: any
- message: any
Returns void

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

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

hasListener

hasListener(type: EventTargetType): boolean

Inherited from EventTarget.hasListener

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

Parameters
- type: EventTargetType
Returns boolean

removeEventListener

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

Inherited from EventTarget.removeEventListener

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

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

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

unuse

unuse(): void

desc

移除插件

Returns void

use

use(__namedParameters: { client: any; socket: any }): void

desc

在WeChatGuest.usePlugin方法中, 会调用该方法以绑定插件.

Parameters
- __namedParameters: { client: any; socket: any }
  - client: any
  - socket: any
Returns void

Object literals

Static DEFAULT_EVENT_LISTENER_OPTIONS

DEFAULT_EVENT_LISTENER_OPTIONS: object

once

once: false = false

Generated using TypeDoc