文档中心
ScreenCaptureSDK 屏幕共享
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
登录/注册
  • 文档中心
  • 屏幕共享
  • 快速开始
  • 屏幕共享

屏幕共享

更新时间:2023-03-02 16:45

1 简介

本产品为旧版产品,实时音视频已提供更为全面且强大的屏幕共享功能。

  • 如果您是首次实现此功能,建议参考 实时音视频-屏幕共享文档。
  • 如果您此前已经接入了本产品,仍可继续参考本产品文档。

屏幕共享功能是指选取某个屏幕作为采集目标并进行数据采集,并将采集到的数据推流出去,本文主要讲述如何进行屏幕采集。

2 采集调用流程

2.1 获取屏幕列表

调用 enumScreenList 接口,将返回屏幕数组 screenList,从而获取屏幕列表信息。

let screenList = zgScreenCapture.enumScreenList()
console.log("screenList: ", screenList)

其中每个屏幕对象的原型如下。

IZegoExpressPluginScreenCaptureScreenItem {
    /**
     * identification for the screen 
     */
    screenID: any,

    /**
     * is the primary screen 
     */
    isPrimary: boolean
}

2.2 设置采集目标

调用 setTargetScreen 接口传入某个屏幕的 screenID,从而完成采集目标的设置。

// 假如选取第一块屏幕
let theTargetScreen = screenList[0]

// 给 setTargetScreen 中传入选取屏幕的 screenID
zgScreenCapture.setTargetScreen(theTargetScreen.screenID);

2.3 开始采集

调用 startCapture 接口开始屏幕采集。在开始采集前,可以设置屏幕采集帧率,是否同时捕捉光标等信息。

// 设置采集帧率,
// 默认采集帧率为 5fps 建议保持低帧率
zgScreenCapture.setFPS(5);

// 设置是否同时捕捉光标
zgScreenCapture.setCursorVisible(visible=true);

// 设置是否在捕捉到分享画面的同时显示点击动画
zgScreenCapture.enableClickAnimation(enable=false);

// 开始采集
zgScreenCapture.startCapture();
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈