InterfaceLiveOptions

依赖配置。

interface LiveOptions {
    __debug__?: boolean;
    autoPlayConfirm?: ((options: {
        onConfirm: (() => void);
    }) => void);
    builtInRTCType?: BuiltInRTCType;
    canForbidUserKick?: ((users: string | string[]) => boolean);
    canForbidUserMicro?: ((users: string | string[]) => boolean);
    canForbidUserSync?: ((users: string | string[]) => boolean);
    getTicket?: (() => Promise<string>);
    getVoiceSign?: ((params: GetVoiceSignParams) => Promise<GetVoiceSignReturnType>);
    initialMicroStatus?: MicroStatus;
    jsBridge?: JSBridgeProtocol;
    rtc?: RTCProtocol;
    rtcType?: RTCType;
    url?: string;
    useBuiltInJsBridge?: boolean;
    useBuiltInRTC?: boolean;
}

Properties

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

Properties

Optional__debug__

__debug__?: boolean

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

OptionalautoPlayConfirm

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

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

Type declaration

    • (options): void

    • Parameters

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

            • Returns void

      Returns void

OptionalbuiltInRTCType

builtInRTCType?: BuiltInRTCType

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

OptionalcanForbidUserKick

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

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

OptionalcanForbidUserMicro

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

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

OptionalcanForbidUserSync

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

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

OptionalgetTicket

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

获取建立 WebSocket 连接的依赖Tick

OptionalgetVoiceSign

getVoiceSign?: ((params: GetVoiceSignParams) => Promise<GetVoiceSignReturnType>)

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

Type declaration

    • (params): Promise<GetVoiceSignReturnType>

    • 获取用户语音签名的函数

      用于获取加入 RTC 语音房间所需的签名信息。 通常需要调用后端 API 来生成签名。

      Parameters

      • params: GetVoiceSignParams

        获取语音签名所需的参数，包含以下属性：

        • voiceId: 语音房间ID
        • userId: 用户ID
        • roomId: 房间ID

      Returns Promise<GetVoiceSignReturnType>

      Promise 返回包含签名信息的 Promise，包含：

      • sdkAppId: RTC的sdkAppId
      • userId: RTC的用户ID
      • roomId: RTC的语音房间号
      • userSig: RTC的用户签名

      Example

      const getVoiceSign: GetVoiceSign = async (params) => {
        const response = await fetch('/api/get-voice-sign', {
          method: 'POST',
          headers: { 'Content-Type': 'application/json' },
          body: JSON.stringify(params)
        })
        return response.json()
      }

OptionalinitialMicroStatus

initialMicroStatus?: MicroStatus

麦克风初始状态

OptionaljsBridge

jsBridge?: JSBridgeProtocol

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

Optionalrtc

rtc?: RTCProtocol

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

OptionalrtcType

rtcType?: RTCType

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

Optionalurl

url?: string

创建WebSocket所依赖的URL。

OptionaluseBuiltInJsBridge

useBuiltInJsBridge?: boolean

使用内置的jsBridge实例

OptionaluseBuiltInRTC

useBuiltInRTC?: boolean

使用内置的rtc实例

Settings

Member Visibility

On This Page

Properties