Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LiveOptions

依赖配置。

Hierarchy

  • LiveOptions

Index

Properties

Methods

Properties

Optional __debug__

__debug__?: boolean

是否开启调试模式：此模式下会在终端打印日志方便调试。

Optional autoReconnect

autoReconnect?: number | boolean

异常断开是否自动重连：默认 true 重连三次. 可以设置 false 关闭自动重连，以监控 ws.readyStateUpdate 事件自己来实现重连逻辑。

Optional healthCheck

healthCheck?: number | boolean

是否开启定时健康检查

Optional rtc

rtc?: RTCProtocol

RTC实例。

Optional url

url?: string

创建WebSocket所依赖的URL。

Methods

Optional canForbidUserKick

  • canForbidUserKick(users: string | string[]): boolean

  • 能否强制"踢掉"某个/些用户。

    Parameters

    • users: string | string[]

    Returns boolean

Optional canForbidUserMicro

  • canForbidUserMicro(users: string | string[]): boolean

  • 能否禁用某个/些用户的麦克风

    Parameters

    • users: string | string[]

    Returns boolean

Optional canForbidUserSync

  • canForbidUserSync(users: string | string[]): boolean

  • 能否限制某个/些用户的帧数据同步

    Parameters

    • users: string | string[]

    Returns boolean

Optional getTicket

  • getTicket(): Promise<string>

  • 获取建立 WebSocket 连接的依赖Tick

    Returns Promise<string>