本站点除 Legacy 产品与方案外，已迁移至声网新文档中心，当前页面不再维护



全部产品

Console 官网社区技术支持





Agora Web API Reference

概览 AgoraRTC AgoraRTCClient LocalTrack RemoteTrack 错误码

EventEmitter 类提供了定义、触发和处理事件的方式。

Hierarchy

EventEmitter
- IAgoraRTC
- IAgoraRTCClient

Index

Methods

Methods

getListeners

getListeners(event: string): Function[]

指定一个事件名，获取当前所有监听这个事件的回调函数。

Parameters
- event: string
  
  事件名称。
Returns Function[]

off

off(event: string, listener: Function): void

取消一个指定事件的监听。

Parameters
- event: string
  
  指定事件的名称。
- listener: Function
  
  监听事件时传入的回调函数。
Returns void

on

on(event: string, listener: Function): void

监听一个指定的事件，当事件触发时会调用传入的回调函数。

Parameters
- event: string
  
  指定事件的名称。
- listener: Function
  
  传入的回调函数。
Returns void

once

once(event: string, listener: Function): void

监听一个指定的事件，当事件触发时会调用传入的回调函数。

当监听后事件第一次触发时，该监听和回调函数就会被立刻移除，也就是只监听一次指定事件。

Parameters
- event: string
  
  指定事件的名称。
- listener: Function
  
  传入的回调函数。
Returns void

removeAllListeners

removeAllListeners(event?: undefined | string): void

指定一个事件，取消其所有的监听。

Parameters
- Optional event: undefined | string
  
  指定事件的名称，如果没有指定事件，则取消所有事件的所有监听。
Returns void