Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RtcVideoStreamManager

视频流管理器

Hierarchy

  • EventEmitter
    • RtcVideoStreamManager

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

createVideoStream

  • createVideoStream(deviceId: string): number

  • 创建一个新的视频流。

    note

    默认视频流无需创建，在频道加入成功后即有效。

    Parameters

    • deviceId: string

      设备 ID, 此设备会设置给新视频流。

    Returns number

    • OK: 成功
    • 其他: 失败

destroyVideoStream

  • destroyVideoStream(streamId: number): number

  • 销毁一个视频流。

    note

    默认视频流不可销毁。

    Parameters

    • streamId: number

      视频流 ID。

    Returns number

    • OK: 成功
    • 其他: 失败

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

getCaptureDevice

  • getCaptureDevice(streamId: number): number

  • 获取当前使用的视频采集设备

    Parameters

    • streamId: number

      视频流 ID。

    Returns number

    返回QResult来指示调用状态

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

muteVideo

  • muteVideo(streamId: number): number

  • 暂停视频流。

    note

    暂停视频流前请先开启视频流，否则操作将无效。

    Parameters

    • streamId: number

      视频流 ID

    Returns number

    • OK: 成功
    • 其他: 失败

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setCaptureDevice

  • setCaptureDevice(streamId: number, deviceId: string): number

  • 设置或更新视频流的采集设备。

    Parameters

    • streamId: number

      视频流 ID。

    • deviceId: string

      采集设备 ID。

    Returns number

    • OK: 成功
    • 其他: 失败

setMaxListeners

  • setMaxListeners(n: number): this

snapshotVideo

  • snapshotVideo(userId: string, streamId: number, outDir: string, options: Object): number

  • 捕获指定用户的视频流画面

    Parameters

    • userId: string

      目标用户的 ID

    • streamId: number

      视频流 ID

    • outDir: string

      输出路径

    • options: Object

      快照选项

    Returns number

    • OK: 成功
    • 其他: 失败

startVideo

  • startVideo(streamId: number, view: string, options: Object): number

  • 开启视频，并且设置渲染窗口

    Parameters

    • streamId: number

      视频流 ID

    • view: string

      用于显示视频的 DOM 元素，通常为 div

    • options: Object

      渲染配置参数

    Returns number

    • OK: 调用成功
    • others: 调用失败

stopVideo

  • stopVideo(streamId: number): number

  • 关闭视频流

    Parameters

    • streamId: number

      视频流 ID

    Returns number

    • OK: 调用成功
    • others: 调用失败

subscribeVideo

  • subscribeVideo(userId: string, streamId: number, view: string, options: Object): number

  • 订阅用户的视频，并设置渲染窗口。

    note

    订阅用户的视频前，请确保用户已开启视频。

    Parameters

    • userId: string

      客户定义的用户标识。

    • streamId: number

      视频流 ID。

    • view: string

      用于显示视频的 DOM 元素，通常为 div。

    • options: Object

      渲染参数。

    Returns number

    • OK: 成功
    • 其他: 失败

unmuteVideo

  • unmuteVideo(streamId: number): number

  • 恢复视频。

    note

    恢复视频流前请先开启视频流，否则操作将无效。

    Parameters

    • streamId: number

      视频流 ID

    Returns number

    • OK: 成功
    • 其他: 失败

unsubscribeVideo

  • unsubscribeVideo(userId: string, streamId: number): number

  • 取消订阅用户的视频。

    note

    当用户停止视频流或者离开频道的时候，用户的视频流将会被自动取消订阅。

    Parameters

    • userId: string

      客户定义的用户标识。

    • streamId: number

      视频流 ID。

    Returns number

    • OK: 成功
    • 其他: 失败

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc