TRTCScreenCaptureProperty

TRTCScreenCaptureProperty

屏幕分享的进阶控制参数

该参数用于屏幕分享相关的接口 selectScreenCaptureTarget,用于在指定分享目标时设定一系列进阶控制参数。 比如:是否采集鼠标、是否要采集子窗口、是否要在被分享目标周围绘制一个边框等。

注意:设置高亮边框颜色参数在 Mac 平台不支持。

Constructor

new TRTCScreenCaptureProperty(enableCaptureMouse, enableHighLight, enableHighPerformance, highLightColor, highLightWidth, enableCaptureChildWindow)

Parameters:
Name Type Description
enableCaptureMouse Boolean required

是否采集目标内容的同时采集鼠标,默认为 true

enableHighLight Boolean required

是否高亮正在共享的窗口(在被分享目标周围绘制一个边框),默认为 true。

enableHighPerformance Boolean required

是否开启高性能模式(只会在分享屏幕时会生效),默认为 true。【特殊说明】开启后屏幕采集性能最佳,但会丧失抗遮挡能力,如果您同时开启 enableHighLight + enableHighPerformance,远端用户可以看到高亮的边框。

highLightColor Number required

指定高亮边框的颜色,RGB 格式,传入 0 时代表采用默认颜色,默认颜色为 #8CBF26。MacOS 平台不支持。

highLightWidth Number required

指定高亮边框的宽度,传入0时采用默认描边宽度,默认宽度为 5 像素,您可以设置的最大值为 50。

enableCaptureChildWindow Boolean required

窗口采集时是否采集子窗口(需要子窗口与被采集窗口具有 Owner 或 Popup 属性),默认为 false。