Interface LiveOptions

依赖配置。

Hierarchy

  • LiveOptions

Properties

__debug__? autoPlayConfirm? builtInRTCType? canForbidUserKick? canForbidUserMicro? canForbidUserSync? getTicket? getVoiceSign? initialMicroStatus? jsBridge? rtc? rtcType? url? useBuiltInJsBridge? useBuiltInRTC?

Properties

Optional __debug__

__debug__?: boolean

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

Optional autoPlayConfirm

autoPlayConfirm?: ((options: {
    onConfirm: (() => void);
}) => void)

Type declaration

    • (options: {
          onConfirm: (() => void);
      }): void

    • 使用webRTC时会有自动播放的安全策略限制，用户有交互

      Returns

      Parameters

      • options: {
            onConfirm: (() => void);
        }
        • onConfirm: (() => void)
            • (): void

            • Returns void

      Returns void

Optional builtInRTCType

builtInRTCType?: BuiltInRTCType

内置的rtc通道类型 trtc or chime , default trtc

Optional canForbidUserKick

canForbidUserKick?: ((users: string | string[]) => boolean)

Type declaration

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

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

      Parameters

      • users: string | string[]

      Returns boolean

Optional canForbidUserMicro

canForbidUserMicro?: ((users: string | string[]) => boolean)

Type declaration

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

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

      Parameters

      • users: string | string[]

      Returns boolean

Optional canForbidUserSync

canForbidUserSync?: ((users: string | string[]) => boolean)

Type declaration

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

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

      Parameters

      • users: string | string[]

      Returns boolean

Optional getTicket

getTicket?: (() => Promise<string>)

Type declaration

    • (): Promise<string>

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

      Returns Promise<string>

Optional getVoiceSign

getVoiceSign?: GetVoiceSign

获取语音签名的接口 使用内置rtc时提供给rtc实例使用

Optional initialMicroStatus

initialMicroStatus?: MicroStatus

麦克风初始状态

Optional jsBridge

jsBridge?: JSBridgeProtocol

jsBridge实例 使用内置rtc时提供给rtc实例使用

Optional rtc

rtc?: RTCProtocol

RTC实例。 优先使用该实例。

Optional rtcType

rtcType?: RTCType

RTC类型 rtc 为空时使用内置的rtc实例类型

Optional url

url?: string

创建WebSocket所依赖的URL。

Optional useBuiltInJsBridge

useBuiltInJsBridge?: boolean

使用内置的jsBridge实例

Optional useBuiltInRTC

useBuiltInRTC?: boolean

使用内置的rtc实例

Settings

Member Visibility

Theme