Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZegoScreenCaptureSource

Hierarchy

Index

Methods

Abstract enableCursorVisible

  • enableCursorVisible(visible: boolean): void
  • 设置是否显示光标

    支持版本:3.25.0 及以上。 详情描述:设置是否显示光标。 调用时机:在创建屏幕采集实例 [createScreenCaptureSource] 之后。 使用限制:仅适用于 OHOS,需要 OHOS API 15 及以上。

    Parameters

    • visible: boolean

      是否显示光标。true 为显示光标,false 不显示光标,默认 true。

    Returns void

Abstract enableHightLight

  • 设置是否高亮采集区域

    支持版本:3.25.0 及以上。 详情描述:设置是否高亮采集区域。 调用时机:在创建屏幕采集实例 [createScreenCaptureSource] 之后,且必须在 [ZegoScreenCaptureSource.startCapture] 前调用。 使用限制:仅适用于 OHOS,需要 OHOS API 22 及以上。

    Parameters

    • enable: boolean

      是否高亮采集区域。true 为高亮,false 不高亮,默认 false。

    • Optional config: ZegoLayerBorderConfig

      高亮采集区域边框配置。

    Returns void

Abstract getIndex

  • getIndex(): number
  • 获取屏幕采集源索引。

    Returns number

    屏幕采集源索引。

Abstract startCapture

  • 开始屏幕采集。

    支持版本:3.25.0 及以上。 详情描述:开始屏幕采集,可携带屏幕采集参数配置。 调用时机:在创建屏幕采集实例 [createScreenCaptureSource] 之后。 使用限制:仅适用于 OHOS。OHOS 使用该接口统一移动端和桌面端的 source 调用入口。 注意事项:config.showPicker 用于控制 start 时是否显示系统选择器。

    Parameters

    Returns void

Abstract stopCapture

  • stopCapture(): void
  • 停止屏幕采集。

    支持版本:3.1.0 及以上。 详情描述:停止屏幕采集。

    Returns void

Abstract updateScreenCaptureConfig

  • 更新屏幕采集参数配置。

    支持版本:3.25.0 及以上。 详情描述:更新屏幕采集参数配置。 调用时机:在调用 [ZegoScreenCaptureSource.startCapture] 开始采集后。 使用限制:仅适用于 OHOS。只有 start 时 config.showPicker=true,update 时 config.showPicker=true 才会重新显示系统选择器,可用于切换采集源或窗口。 注意事项:OHOS 当前支持动态更新的字段包括 captureVideo、captureAudio、microphoneVolume、applicationVolume、cropRect、orientation、showPicker。其中 microphoneVolume 和 applicationVolume 仅在当前采集音频有效时生效;showPicker 在 start 时已开启 picker 的前提下,用于重新显示系统选择器并切换采集源或窗口。audioParam 等其它字段暂不支持动态更新,如需变更应重新开始采集。

    Parameters

    Returns void

Generated using TypeDoc