Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TRTCPlugin

Hierarchy

  • EventTarget
    • TRTCPlugin

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Parameters

    • __namedParameters: { config: any }
      • config: any

    Returns TRTCPlugin

Properties

client

client: WeChatGuest

config

config: TRTCPluginConfig

socket

socket: WeChatSocket

unsubscribeList

unsubscribeList: Array<() => void>

Static logger

logger: Reporter = new Reporter('TRTCPlugin')

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)

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

clearListener

  • clearListener(): void

  • 清空所有绑定的事件

    Returns void

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

hasListener

  • hasListener(type: EventTargetType): boolean

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

    Parameters

    • type: EventTargetType

    Returns boolean

removeEventListener

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

  • 移除事件监听器, 要提供与调用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

Generated using TypeDoc