Options
All
  • Public
  • Public/Protected
  • All
Menu

Module live

Index

Enumerations

Interfaces

Type aliases

Functions

Type aliases

BuiltinMsg

BuiltinMsg: { action: BuiltinActionType; data: { extension?: Record<string, any> }; event_type: BuiltinEventType; to_user_ids: string[] }

内置事件数据结构体。

Type declaration

  • action: BuiltinActionType
  • data: { extension?: Record<string, any> }
    • [key: string]: any
    • Optional extension?: Record<string, any>
  • event_type: BuiltinEventType
  • to_user_ids: string[]

EventType

EventType<Snapshot>: LiveEventType<Snapshot> & WebSocketEventType

Type parameters

  • Snapshot

KeyframeTypes

KeyframeTypes<Type>: { [ Property in keyof Type as Property]: (nextKeyframes: Type[Property], prevKeyframes: Type[Property], frontRequestId: string) => void }

Type parameters

  • Type

LiveActionReactCallback

LiveActionReactCallback<Snapshot>: Pick<Live<Snapshot>, "broadcast" | "exit" | "kick" | "toggleMicro" | "forbidMicro" | "sendKeyframe" | "getFramesByKey" | "setSelfInfo" | "updateStatus">

Type parameters

  • Snapshot: Record<string, any>

LiveEventType

LiveEventType<Snapshot>: { broadcast: any; builtinEvent: any; error: any; keyframes: any; kickOut: any; readyKeyframeSync: any; roomChange: any; selfInfoUpdate: any; userChange: any; userListUpdate: any }

Type parameters

  • Snapshot

Type declaration

  • broadcast:function
    • broadcast(evtMsg: Record<string, any>, frontRequestId: string): void

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

      Parameters

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

      Returns void

  • builtinEvent:function

    • 内置消息事件

      Parameters

      Returns void

  • error:function

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

      Parameters

      Returns void

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

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

      Parameters

      • keyframes: Partial<Snapshot>
      • frontRequestId: string

      Returns void

  • kickOut:function
    • kickOut(): void

    • 被踢出房间

      Returns void

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

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

      Parameters

      • lastKeyframe: Partial<Snapshot>

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

      Returns void

  • roomChange:function

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

      Parameters

      Returns void

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

    • 个人信息发生更新。

      Parameters

      • userInfo: UserInfo
      • frontRequestId: string

      Returns void

  • userChange:function

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

      Parameters

      Returns void

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

    • 用户列表更新。

      Parameters

      • userList: UserInfo[]
      • frontRequestId: string

      Returns void

LiveMsg

LiveMsg: { appId: string; code: string; command: Command; data: Record<string, any> | Record<string, any>[]; frontRequestId: string; message: string; requestId: string; roomCode: string; triggerUserId: string }

响应的信息结构体。

Type declaration

  • appId: string
  • code: string
  • command: Command
  • data: Record<string, any> | Record<string, any>[]
  • frontRequestId: string
  • message: string
  • requestId: string
  • roomCode: string
  • triggerUserId: string

LiveProviderPropTypes

LiveProviderPropTypes<Snapshot>: { children?: React.ReactNode; live?: Live<Snapshot> }

Type parameters

  • Snapshot

Type declaration

  • Optional children?: React.ReactNode
  • Optional live?: Live<Snapshot>

ReqLiveMsg

ReqLiveMsg: { command: Command; data: { to_user_ids?: string[] }; front_request_id: string }

向服务端请求数据时的数据格式。

Type declaration

  • command: Command

    请求指令。

  • data: { to_user_ids?: string[] }

    数据内容

    • [key: string]: any
    • Optional to_user_ids?: string[]

      如果此数据仅发送给某些用户，请提供这些用户的ucid。

  • front_request_id: string

    前端请求时生成的uuid()。

RoomInfo

RoomInfo: { info: { app_id: string; create_time: string; create_user_id: string; extension: Record<string, any>; id: string | number; room_code: string; status: string | number }; init_timestamp: string; last_frame: Record<string, any> }

Type declaration

  • info: { app_id: string; create_time: string; create_user_id: string; extension: Record<string, any>; id: string | number; room_code: string; status: string | number }
    • app_id: string
    • create_time: string
    • create_user_id: string
    • extension: Record<string, any>
    • id: string | number
    • room_code: string
    • status: string | number
  • init_timestamp: string
  • last_frame: Record<string, any>

UserInfo

UserInfo: { current_ws_online?: boolean; extension?: UserInfoExt; id: string; mem_user_status?: MemUserStatus; micro_status: boolean; once_ws_online?: boolean; permission?: Record<string, boolean>; rtc: boolean; status?: UserStatus; user_role?: number | string }

带看会话房间用户的信息格式。

Type declaration

  • Optional current_ws_online?: boolean

    用户当前是否在线。

  • Optional extension?: UserInfoExt

    用户信息扩展字段。

  • id: string

    用户唯一标识ID。

  • Optional mem_user_status?: MemUserStatus

    内存中的用户状态。

  • micro_status: boolean

    用户当前是否开启麦克风。

  • Optional once_ws_online?: boolean

    用户曾经是否在线过，即进入房间后又由于某种原因离开后重新进入。

  • Optional permission?: Record<string, boolean>

    当前用户的权限配置。（UI层面理解）。

  • rtc: boolean

    RTC 环境是否就绪，即当前语音是否联通。

  • Optional status?: UserStatus

    用户当前的状态。

  • Optional user_role?: number | string

    用户角色定义。（前端不关注此字段）。

UserInfoExt

UserInfoExt: { avatar?: string; nickname?: string }

用户信息扩展字段：比如提供用户画像相关的数据。

Type declaration

  • [key: string]: any

    其他用户相关的字段，比如用户职称、住址、联系方式等信息。

  • Optional avatar?: string

    用户头像。

  • Optional nickname?: string

    用户昵称。

WebSocketError

WebSocketError: { closeError?: WebSocketCloseError; error?: any; target?: Event | CloseEvent; type: WebSocketErrorType }

Type declaration

WebSocketEventType

WebSocketEventType: { ws.afterConnect: any; ws.beforeConnect: any; ws.error: any; ws.message: any; ws.readyStateUpdate: any }

WebSocket 相关异步事件

description

可以

Type declaration

  • ws.afterConnect:function
    • ws.afterConnect(reConnect?: number): void

    • WebSocket 连接后

      Parameters

      • Optional reConnect: number

      Returns void

  • ws.beforeConnect:function
    • ws.beforeConnect(reConnect?: number): void

    • WebSocket 连接前

      Parameters

      • Optional reConnect: number

      Returns void

  • ws.error:function

    • WebSocket 连接过程中遭遇的异常情况信息。

      Parameters

      Returns void

  • ws.message:function

    • WebSocket 收到的消息

      Parameters

      • liveMsg: LiveMsg

        透传 WebSocket 消息

      Returns void

  • ws.readyStateUpdate:function

    • WebSocket 状态发生更新

      Parameters

      Returns void

Functions

createLive

  • 创建 live 实例。

    Type parameters

    • Snapshot

    Parameters

    Returns Live<Snapshot>

createLiveReact

  • 创建 LiveReact 实例，并提供 React 技术栈相关工具链。

    Type parameters

    • Snapshot

    Parameters

    Returns LiveReact<Snapshot>

parseLiveMsg

  • parseLiveMsg(jsonTxt: string): LiveMsg | boolean

  • 解析下后端数据格式。

    Parameters

    • jsonTxt: string

      JSON序列化后的文本。

    Returns LiveMsg | boolean

    false 标识解析失败；解析成功返回 LiveMsg 实例。