Type alias LiveEventType<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: Record<string, any>, frontRequestId: string): void

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

      Parameters

      • evtMsg: Record<string, any>
      • frontRequestId: string

      Returns void

  • builtinEvent:function
    • builtinEvent(builtinMsg: BuiltinMsg): void

    • 内置消息事件

      Parameters

      Returns void

  • error:function
    • error(liveMsg: LiveMsg): void

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

      Parameters

      Returns void

  • keyframes:function
    • keyframes(keyframes: Partial<KeyframesSnapshot>, frontRequestId: string): void

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

      Parameters

      • keyframes: Partial<KeyframesSnapshot>
      • frontRequestId: string

      Returns void

  • kickOut:function
    • kickOut(): void

    • 被踢出房间

      Returns void

  • readyKeyframeSync:function
    • readyKeyframeSync(lastKeyframe: Partial<KeyframesSnapshot>): void

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

      Parameters

      • lastKeyframe: Partial<KeyframesSnapshot>

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

      Returns void

  • roomChange:function
    • roomChange(builtinMsg: BuiltinMsg): void

    • 内置消息事件：房间信息改变

      Parameters

      Returns void

  • selfInfoUpdate:function
    • selfInfoUpdate(userInfo: UserInfo, frontRequestId: string): void

    • 个人信息发生更新。

      Parameters

      • userInfo: UserInfo
      • frontRequestId: string

      Returns void

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

    • 带看状态变化

      Parameters

      Returns void

  • userChange:function
    • userChange(builtinMsg: BuiltinMsg): void

    • 内置消息事件: 用户信息改变

      Parameters

      Returns void

  • userListUpdate:function
    • userListUpdate(userList: UserInfo[], frontRequestId: string): void

    • 用户列表更新。

      Parameters

      • userList: UserInfo[]
      • frontRequestId: string

      Returns void

Settings

Member Visibility

Theme