Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RtcScreenSourceManager

Hierarchy

  • EventEmitter
    • RtcScreenSourceManager

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

addSharedScreenSource

  • addSharedScreenSource(sourceType: number, sourceId: string): number

  • 添加屏幕采集源，必须在 beginConfiguration 之后调用

    Parameters

    • sourceType: number

      屏幕采集源类型，不能为显示器类型

    • sourceId: string

      屏幕源ID

    Returns number

    返回QResult来指示调用状态

addUnsharedScreenSource

  • addUnsharedScreenSource(sourceType: number, sourceId: string): number

  • 添加不被共享的屏幕源，必须在 beginConfiguration 之后调用

    Parameters

    • sourceType: number

      屏幕采集源类型，不能为显示器类型

    • sourceId: string

      不能被共享的屏幕源ID

    Returns number

    返回QResult来指示调用状态

beginConfiguration

  • beginConfiguration(resetConfig: boolean): number

  • 开始配置更改，接下来的配置改变在调用commitConfiguration之前不会立即生效

    Parameters

    • resetConfig: boolean

      是否重置当前配置

    Returns number

    返回QResult来指示调用状态

commitConfiguration

  • commitConfiguration(): number

  • 提交一组配置更改

    Returns number

    返回QResult来指示调用状态

emit

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

  • Parameters

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

    Returns boolean

enableFilterSelfApp

  • enableFilterSelfApp(enable: boolean): number

  • 设置是否过滤自己进程

    note

    默认启用过滤自己进程

    Parameters

    • enable: boolean

    Returns number

    返回QResult来指示调用状态

eventNames

  • eventNames(): Array<string | symbol>

getApplicationList

  • getApplicationList(): Array<Object>

  • 获取应用列表

    Returns Array<Object>

    • 应用列表

getDisplayList

  • getDisplayList(): Array<Object>

  • 获取显示器列表

    Returns Array<Object>

    • 显示器列表

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

listeners

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

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[]

remoeUnsharedScreenSource

  • remoeUnsharedScreenSource(sourceType: number, sourceId: string): number

  • 移除不被共享的屏幕源，必须在 beginConfiguration 之后调用

    Parameters

    • sourceType: number

      屏幕采集源类型，不能为显示器类型

    • sourceId: string

      不能被共享的屏幕源ID

    Returns number

    返回QResult来指示调用状态

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

removeSharedScreenSource

  • removeSharedScreenSource(sourceType: number, sourceId: string): number

  • 移除指定的屏幕采集源，必须在 beginConfiguration 之后调用

    Parameters

    • sourceType: number

      屏幕采集源类型，不能为显示器类型

    • sourceId: string

      屏幕源ID

    Returns number

    返回QResult来指示调用状态

selectSharedDisplay

  • selectSharedDisplay(sourceId: string): number

  • 选择需要共享的显示器，必须在 beginConfiguration 之后调用

    Parameters

    • sourceId: string

    Returns number

    返回QResult来指示调用状态

setMaxListeners

  • setMaxListeners(n: number): this

setScreenOptimization

  • setScreenOptimization(forMotion: boolean): number

  • 设置屏幕采集方式

    Parameters

    • forMotion: boolean

      是否为高帧率采集， 高帧率采集用于内容变化剧烈场景

    Returns number

    返回QResult来指示调用状态

setScreenSource

  • setScreenSource(sourceType: number, sourceId: string): number

  • 设置屏幕采集源

    Parameters

    • sourceType: number

      屏幕采集源类型

    • sourceId: string

      屏幕源ID

    Returns number

    返回QResult来指示调用状态

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