文档中心
视频通话 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

Cocos Creator SDK API Reference

概览 agora AgoraRtcEvents

屏幕共享的编码参数配置。

Hierarchy

  • ScreenCaptureParameters

Index

Constructors

Properties

Constructors

constructor

  • new ScreenCaptureParameters(dimensions?: VideoDimensions, frameRate?: number, bitrate?: number, captureMouseCursor?: boolean, windowFocus?: boolean, excludeWindowList: any[], excludeWindowCount?: number): ScreenCaptureParameters

  • Parameters

    • Default value dimensions: VideoDimensions = new VideoDimensions(1920, 1080)
    • Default value frameRate: number = 5
    • Default value bitrate: number = STANDARD_BITRATE
    • Default value captureMouseCursor: boolean = true
    • Default value windowFocus: boolean = false
    • excludeWindowList: any[]
    • Default value excludeWindowCount: number = 0

    Returns ScreenCaptureParameters

Properties

bitrate

bitrate: number

共享视频的码率，单位为 Kbps；默认值为 0，表示 SDK 根据当前共享屏幕的分辨率计算出一个合理的值。

captureMouseCursor

captureMouseCursor: boolean

是否采集鼠标用于屏幕共享

  • true: （默认）采集鼠标
  • false: 不采集鼠标

dimensions

dimensions: VideoDimensions

屏幕共享视频发送的最大像素值。 默认值为 1920 × 1080，即 2073600 像素。该像素值为计费标准。 当共享的屏幕分辨率宽高比与该值设置不一致时，SDK 按如下策略进行编码。假设 dimensions 为 1920 × 1080：

  • 如果屏幕分辨率小于 dimensions，如 1000 × 1000，SDK 直接按 1000 × 1000 进行编码。
  • 如果屏幕分辨率大于 dimensions，如 2000 × 1500，SDK 按屏幕分辨率的宽高比，即 4：3，取 dimensions 以内的最大分辨率进行编码， 即 1440 × 1080。

excludeWindowCount

excludeWindowCount: number

待屏蔽窗口的数量。

excludeWindowList

excludeWindowList: any[]

待屏蔽窗口的 ID 列表。

  • 调用 [startScreenCaptureByScreenRect]{@link agora.startScreenCaptureByScreenRect} 开启屏幕共享时， 你可以通过该参数屏蔽指定的窗口。
  • 开启屏幕共享后，你可以在调用 [updateScreenCaptureParameters]{@link agora.updateScreenCaptureParameters} 更新屏幕共享的配置参数时， 通过该参数动态屏蔽指定的窗口。

frameRate

frameRate: number

共享视频的帧率，单位为 fps；默认值为 5，建议不要超过 15。

windowFocus

windowFocus: boolean

调用 [startScreenCaptureByWindowId]{@link agora.startScreenCaptureByWindowId} 方法共享窗口时，是否将该窗口前置。

  • true: 前置窗口。
  • false:（默认）不前置窗口。