跳转至
400-881-9892

文档中心

官方文档,可查阅产品介绍、快速入门、用户指南、开发指南、API参考、SDK参考、帮助等信息。

文档中心 互动课堂

startsharescreen

  • 简要描述

    开始共享桌面

  • 回调

    on_sharescreenstate

  • 接口详解

    int startsharescreen(struct roomclient* client, const DesktopSource_C& source)

  • 返回值:return 0 success
  • 参数source:桌面共享源,详情请查看DesktopSource_C

  • 使用示例

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    DesktopSource_C m_desktopSource;
    std::vector<ValidWindow> list;
    ValidWindow_C windows[];
    int size = 0;
    getvalidwindowlist(client, TK_SOURCE_SCREEN_C, windows, size);
    m_desktopSource.window = "windows窗口句柄";
    m_desktopSource.type = TK_SOURCE_WINDOW;
    m_desktopSource.rect = {0,0,0,0};
    m_desktopSource.cursorMonitor = true;
    startShareScreen(client, m_desktopSource);
    

stopsharescreen

  • 简要描述

    停止共享桌面

  • 回调

    on_sharescreenstate

  • 接口详解

    int stopsharescreen(struct roomclient* client) 返回值:return 0 success

updatesharescreen

  • 简要描述

    更新共享桌面 专门用于更新播放用户分享的屏幕共享流接口

  • 接口详解

    int updatesharescreen(struct roomclient* client, const DesktopSource_C& source) 返回值:return 0 success 参数source:桌面共享源,详情请查看DesktopSource_C

getvalidwindowlist

  • 简要描述

    获取有效共享窗口 此接口用于获取到有效的窗口 来给 startsharescreen()函数使用

  • 接口详解

    int getvalidwindowlist(struct roomclient client , TK_SOURCETYPE_C type , ValidWindow_C windows[] , int& size) 返回值*:return 0 success

  • 参数

    参数 说明
    windows 窗口ValidWindow_C
    type window类型,0:桌面,1:应用程序窗口,2:区域共享
    TK_SOURCETYPE_C
  • 使用示例

    请见本章startsharescreen的使用示例

playscreen

  • 简要描述

    播放屏幕共享 专门用于更新播放用户分享的屏幕共享流接口

  • 接口详解

    int playscreen(struct roomclient* client, const char* peerID, VideoCanvas_C canvas)

  • 返回值:return 0 success
  • 参数

    参数 说明
    peerID 用户ID
    canvas 视频VideoCanvas_C

unplayscreen

  • 简要描述

    停止播放屏幕共享

  • 接口详解

    int unplayscreen(struct roomclient* client, const char* peerID) 返回值:return 0 success 参数peerID:用户ID

updateScreenCaptureParameters

  • 简要描述

    更新屏幕共享的参数配置

  • 注意

    开启屏幕共享或窗口共享前后都可以调用该方法

  • 接口详解

    void updateScreenCaptureParameters(struct roomclient* client, const ScreenCaptureParameters_C& captureParams)

  • 参数

    参数 说明
    captureParams(ScreenCaptureParameters 屏幕共享的参数配置