Type AliasLiveEventType<KeyframesSnapshot>

LiveEventType<KeyframesSnapshot>: {
    broadcast(evtMsg: Record<string, any>, frontRequestId: string): void;
    builtinEvent(builtinMsg: BuiltinMsg): void;
    error(liveMsg: LiveMsg): void;
    keyframes(keyframes: Partial<KeyframesSnapshot>, frontRequestId: string): void;
    kickOut(): void;
    readyKeyframeSync(lastKeyframe: Partial<KeyframesSnapshot>): void;
    roomChange(builtinMsg: BuiltinMsg): void;
    selfInfoUpdate(userInfo: UserInfo, frontRequestId: string): void;
    stateChange(state: LiveState, prevState?: LiveState): void;
    userChange(builtinMsg: BuiltinMsg): void;
    userListUpdate(userList: UserInfo[], frontRequestId: string): void;
}

带看事件列表

Type Parameters

  • KeyframesSnapshot

Type declaration

  • broadcast:function
    • broadcast(evtMsg, frontRequestId): void

    • 收到其他用户的广播消息事件

      当收到其他用户通过 broadcast 方法发送的自定义消息时触发。

      Parameters

      • evtMsg: Record<string, any>

        广播消息数据对象

      • frontRequestId: string

        前端请求ID，用于匹配请求和响应

      Returns void

      Example

      live.on('broadcast', (data, requestId) => {
        console.log('收到广播:', data, '请求ID:', requestId)
      })
  • builtinEvent:function
    • builtinEvent(builtinMsg): void

    • 内置消息事件

      当收到任何内置消息时触发，包括用户变化和房间变化。

      Parameters

      Returns void

      Example

      live.on('builtinEvent', (msg) => {
        console.log('内置消息:', msg.event_type, msg.action)
      })
  • error:function
    • error(liveMsg): void

    • 异常消息：不符合规范。

      Parameters

      Returns void

  • keyframes:function
    • keyframes(keyframes, frontRequestId): void

    • 获取其他用户输送的帧数据：根据此帧数据更新UI状态。

      Parameters

      Returns void

  • kickOut:function
    • kickOut(): void

    • 被踢出房间

      Returns void

  • readyKeyframeSync:function
    • readyKeyframeSync(lastKeyframe): void

    • 带看已经就绪，可以发送帧数据。

      Parameters

      • lastKeyframe: Partial<KeyframesSnapshot>

        带看最后一帧数据（链接切换、断网等重连恢复上次会话帧状态），你可以通过此数据拉齐当前UI状态。

      Returns void

      Deprecated

      此事件已废弃，请使用 keyframes 事件替代，最后的帧数据会通过 keyframes 事件发送，同时 keyframes 对象在 ready 后会自动更新。

  • roomChange:function
    • roomChange(builtinMsg): void

    • 房间信息改变事件

      当房间信息发生变化时触发，是 builtinEvent 的子集。

      Parameters

      • builtinMsg: BuiltinMsg

        内置消息对象，event_type 为 RoomChange

      Returns void

      Example

      live.on('roomChange', (msg) => {
        if (msg.action === BuiltinActionType.RoomClose) {
          console.log('房间已关闭')
        }
      })
  • selfInfoUpdate:function
    • selfInfoUpdate(userInfo, frontRequestId): void

    • 个人信息发生更新。

      Parameters

      • userInfo: UserInfo
      • frontRequestId: string

      Returns void

  • stateChange:function
    • stateChange(state, prevState?): void

    • 带看连接状态变化事件

      Parameters

      • state: LiveState

        当前连接状态

      • OptionalprevState: LiveState

        之前的连接状态（可选）

      Returns void

      Example

      live.on('stateChange', (state, prevState) => {
        console.log(`状态从 ${prevState} 变为 ${state}`)
      })
  • userChange:function
    • userChange(builtinMsg): void

    • 用户信息改变事件

      当用户信息发生变化时触发，是 builtinEvent 的子集。

      Parameters

      • builtinMsg: BuiltinMsg

        内置消息对象，event_type 为 UserChange

      Returns void

      Example

      live.on('userChange', (msg) => {
        if (msg.action === BuiltinActionType.UserMicroStatus) {
          console.log('麦克风状态变化:', msg.data.status)
        }
      })
  • userListUpdate:function
    • userListUpdate(userList, frontRequestId): void

    • 用户列表更新。

      Parameters

      • userList: UserInfo[]
      • frontRequestId: string

      Returns void

Settings

Member Visibility