Live | 如视 Live SDK

Live 实例。

Type parameters

Snapshot: Record<string, any>

Hierarchy

Subscribe<EventType<Snapshot>>
- Live

Index

Properties

keyframes

Accessors

Methods

Properties

keyframes

keyframes: Subscribe<KeyframeTypes<Snapshot>>

帧数据监听

Accessors

$RTC

get $RTC(): RTCProtocol

- Defined in typings/Live.ts:49
获取RTC实例。一个RTC实例的引用，等同于live.options.rtc。

Returns RTCProtocol

options

get options(): LiveOptions

- Defined in typings/Live.ts:13
Returns LiveOptions

readyState

get readyState(): WebSocketState

- Defined in typings/Live.ts:29
获取当前WebSocket的连接状态。

Returns WebSocketState

selfInfo

get selfInfo(): undefined | UserInfo

- Defined in typings/Live.ts:24
获取本地用户信息

Returns undefined | UserInfo

snapshot

get snapshot(): Partial<Snapshot>

- Defined in typings/Live.ts:39
获取当前帧数据快照。

Returns Partial<Snapshot>

url

get url(): string

- Defined in typings/Live.ts:44
获取当前WebSocket连接的URL。(注意：这个是WebSocket连接的完整连接，附带一些query参数)。

Returns string

userList

get userList(): UserInfo[]

- Defined in typings/Live.ts:34
获取当前会话房间内用户列表。

Returns UserInfo[]

Methods

broadcast

broadcast<T1, T2>(data: T1, toUserIds: string | string[], timeout: number): Error | Promise<T2>

- Defined in typings/Live.ts:78
自定义广播事件

Type parameters
- T1
- T2
Parameters
- data: T1
  
  广播数据：这个数据需要自定义格式，此处不做任何约束。
- toUserIds: string | string[]
  
  希望收到此广播事件的用户，为空时则向所有用户广播。
- timeout: number
  
  等待广播结果的超时设置；默认为"0"，表示一直等结果。
Returns Error | Promise<T2>

connect

connect(options?: { force?: boolean; url?: string }): Promise<boolean | Error>

- Defined in typings/Live.ts:94
执行WebSocket连接

Parameters
- Optional options: { force?: boolean; url?: string }
  - Optional force?: boolean
  - Optional url?: string
Returns Promise<boolean | Error>

emit

emit<K>(name: K, ...data: Parameters<EventType<Snapshot>[K]>): boolean

Inherited from Subscribe.emit
- Defined in shared-utils/Subscribe.ts:127
触发事件

Type parameters
- K: keyof LiveEventType<Snapshot> | keyof WebSocketEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- Rest ...data: Parameters<EventType<Snapshot>[K]>
  
  触发事件的数据
Returns boolean
canceled 是否被触发取消

exit

exit(): Promise<boolean>

- Defined in typings/Live.ts:132
退出带看

Returns Promise<boolean>

forbidMicro

forbidMicro(micro: MicroStatus, toUserIds?: string | string[]): Promise<boolean>

- Defined in typings/Live.ts:109
关闭/开启某个或某些用户的麦克风

Parameters
- micro: MicroStatus
  
  true 开启麦克风；false 关闭麦克风
- Optional toUserIds: string | string[]
  
  希望关闭/开启麦克风的用户，为空时则面向所有用户。
Returns Promise<boolean>

forbidSync

forbidSync(sync: boolean, toUserIds?: string | string[]): Promise<boolean>

- Defined in typings/Live.ts:119
限制/开启某个或某些用户同步帧数据

deprecated
暂不支持

Parameters
- sync: boolean
  
  true 开启同步；false 限制同步
- Optional toUserIds: string | string[]
  
  希望限制/开启同步能力的用户，为空时则面向所有用户。
Returns Promise<boolean>

getFramesByKey

getFramesByKey<Key>(key: Key): undefined | Partial<Snapshot>[Key]

- Defined in typings/Live.ts:61
根据某条 key 获取某条帧数据

Type parameters
- Key: string | number | symbol
Parameters
- key: Key
Returns undefined | Partial<Snapshot>[Key]
帧数据

hasListener

hasListener(name: keyof LiveEventType<Snapshot> | keyof WebSocketEventType): boolean

Inherited from Subscribe.hasListener
- Defined in shared-utils/Subscribe.ts:48
判断是否注册了事件

Parameters
- name: keyof LiveEventType<Snapshot> | keyof WebSocketEventType
  
  事件类型
Returns boolean

kick

kick(toUserIds: string | string[]): Promise<boolean>

- Defined in typings/Live.ts:126
"踢人"：强制让某个用户离开附近。

Parameters
- toUserIds: string | string[]
  
  被"踢"的用户。
Returns Promise<boolean>

off

off<K>(name?: K, callback?: (...args: Parameters<EventType<Snapshot>[K]>) => ReturnType<EventType<Snapshot>[K]>): void

Inherited from Subscribe.off
- Defined in shared-utils/Subscribe.ts:97
解除事件

如果 name 不传的话解除对应所有事件如果 name, callback 不传的话解除所有name的所有事件

Type parameters
- K: keyof LiveEventType<Snapshot> | keyof WebSocketEventType
  
  预设的监听事件名称
Parameters
- Optional name: K
  
  事件类型
- Optional callback: (...args: Parameters<EventType<Snapshot>[K]>) => ReturnType<EventType<Snapshot>[K]>
  
  事件回调函数
  - - (...args: Parameters<EventType<Snapshot>[K]>): ReturnType<EventType<Snapshot>[K]>
    - Parameters
      - Rest ...args: Parameters<EventType<Snapshot>[K]>
      Returns ReturnType<EventType<Snapshot>[K]>
Returns void

on

on<K>(name: K, callback: (...args: Parameters<EventType<Snapshot>[K]>) => ReturnType<EventType<Snapshot>[K]>, once?: boolean): () => void

Inherited from Subscribe.on
- Defined in shared-utils/Subscribe.ts:62
注册事件

Type parameters
- K: keyof LiveEventType<Snapshot> | keyof WebSocketEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: (...args: Parameters<EventType<Snapshot>[K]>) => ReturnType<EventType<Snapshot>[K]>
  
  事件回调函数
  - - (...args: Parameters<EventType<Snapshot>[K]>): ReturnType<EventType<Snapshot>[K]>
    - Parameters
      - Rest ...args: Parameters<EventType<Snapshot>[K]>
      Returns ReturnType<EventType<Snapshot>[K]>
- Optional once: boolean
  
  是否只执行一次
Returns () => void
解除事件
- - (): void
  - 注册事件
    
    Returns void
    解除事件

once

once<K>(name: K, callback: (...args: Parameters<EventType<Snapshot>[K]>) => ReturnType<EventType<Snapshot>[K]>): () => void

Inherited from Subscribe.once
- Defined in shared-utils/Subscribe.ts:81
注册事件(是否只执行一次)

Type parameters
- K: keyof LiveEventType<Snapshot> | keyof WebSocketEventType
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: (...args: Parameters<EventType<Snapshot>[K]>) => ReturnType<EventType<Snapshot>[K]>
  
  事件回调函数
  - - (...args: Parameters<EventType<Snapshot>[K]>): ReturnType<EventType<Snapshot>[K]>
    - Parameters
      - Rest ...args: Parameters<EventType<Snapshot>[K]>
      Returns ReturnType<EventType<Snapshot>[K]>
Returns () => void
解除事件
- - (): void
  - 注册事件(是否只执行一次)
    
    Returns void
    解除事件

revoke

revoke(): Promise<boolean>

- Defined in typings/Live.ts:137
废弃掉当前实例依赖。

Returns Promise<boolean>

sendKeyframe

sendKeyframe<Key>(key: Key, frame: Snapshot[Key]): boolean | Error

- Defined in typings/Live.ts:69
发送帧数据

Type parameters
- Key: string | number | symbol
Parameters
- key: Key
- frame: Snapshot[Key]
Returns boolean | Error

setSelfInfo

setSelfInfo(userInfo: Partial<UserInfo>): Promise<boolean | Error>

- Defined in typings/Live.ts:19
更新本地用户信息

Parameters
- userInfo: Partial<UserInfo>
Returns Promise<boolean | Error>

toggleMicro

toggleMicro(microStatus: boolean): Promise<boolean>

- Defined in typings/Live.ts:101
开启/关闭自己的麦克风

Parameters
- microStatus: boolean
  
  true 开启麦克风；false 关闭麦克风
Returns Promise<boolean>

updateStatus

updateStatus(evtType: BuiltinEventType, atnType: BuiltinActionType, status: Record<string, any>, toUserIds?: string | string[]): Promise<boolean>

- Defined in typings/Live.ts:87
更新用户或房间状态。

Parameters
- evtType: BuiltinEventType
  
  事件枚举
- atnType: BuiltinActionType
  
  行为枚举
- status: Record<string, any>
  
  状态值
- Optional toUserIds: string | string[]
  
  面向的用户。
Returns Promise<boolean>

Type parameters

Snapshot: Record<string, any>

Hierarchy

Index

Properties

Accessors

Methods

Properties

keyframes

Accessors

$RTC

Returns RTCProtocol

options

Returns LiveOptions

readyState

Returns WebSocketState

selfInfo

Returns undefined | UserInfo

snapshot

Returns Partial<Snapshot>

url

Returns string

userList

Returns UserInfo[]

Methods

broadcast

Type parameters

T1

T2

Parameters

data: T1

toUserIds: string | string[]

timeout: number

Returns Error | Promise<T2>

connect

Parameters

Optional options: { force?: boolean; url?: string }

Optional force?: boolean

Optional url?: string

Returns Promise<boolean | Error>

emit

Type parameters

K: keyof LiveEventType<Snapshot> | keyof WebSocketEventType

Parameters

name: K

Rest ...data: Parameters<EventType<Snapshot>[K]>

Returns boolean

exit

Returns Promise<boolean>

forbidMicro

Parameters

micro: MicroStatus

Optional toUserIds: string | string[]

Returns Promise<boolean>

forbidSync

Parameters

sync: boolean

Optional toUserIds: string | string[]

Returns Promise<boolean>

getFramesByKey

Type parameters

Key: string | number | symbol

Parameters

key: Key

Returns undefined | Partial<Snapshot>[Key]

hasListener

Parameters

name: keyof LiveEventType<Snapshot> | keyof WebSocketEventType

Returns boolean

kick

Parameters

toUserIds: string | string[]

Returns Promise<boolean>

off

Type parameters

K: keyof LiveEventType<Snapshot> | keyof WebSocketEventType

Parameters

Optional name: K

Optional callback: (...args: Parameters<EventType<Snapshot>[K]>) => ReturnType<EventType<Snapshot>[K]>

Parameters