会议共享

方法总览

方法名称	行为	含义描述
OnShareStateChange	通知	辅流分享状态变化的通知
EnableShowShareScreenSelect	调用	开始辅流分享，会弹出分享目标选择框
ShareTargetWindow	调用	根据窗口句柄，分享目标窗口辅流，参数是窗口句柄;hwnd: 要共享的窗口id;bShareSound: 共享时是否同时共享声音;bHighVideoMode: 共享时是否流畅度优先
StopShareScreen	调用	停止辅流分享
GetShareScreenState	调用	获取当前是否正在共享辅流
SharePopout	调用	将辅流分享窗口单独弹出
SharePopoutClose	调用	将独立弹出的辅流分享窗口收起，合并入会议窗口
EnableOnlyHostCanShare	调用	设置是否只有主持人可以发起辅流分享;bEnable: 是否只有主持人可以发起辅流分享
ShareJoinMeeting	调用	共享屏幕入会
OpenWhiteBoard	调用	打开共享白板;bShareSound: 共享时是否同时共享声音;bHighVideoMode: 共享时是否流畅度优先
CloseWhiteBoard	调用	关闭共享白板

OnShareStateChange

通知描述

辅流分享状态变化的通知

通知定义

void OnShareStateChange();

参数描述

无参数。

返回值描述

无返回值。

EnableShowShareScreenSelect

接口描述

开始辅流分享，会弹出分享目标选择框

接口定义

YLSDKERR EnableShowShareScreenSelect();

参数描述

无参数。

返回值描述

类型	含义
YLSDKERR	错误码,详情见错误码 YLSDKERR 的定义

ShareTargetWindow

接口描述

根据窗口句柄，分享目标窗口辅流，参数是窗口句柄

接口定义

YLSDKERR ShareTargetWindow(int64_t hwnd, bool bShareSound, bool bHighVideoMode);

参数描述

参数	类型	含义
hwnd	int64_t	要共享的窗口id
bShareSound	bool	共享时是否同时共享声音
bHighVideoMode	bool	共享时是否流畅度优先

返回值描述

类型	含义
YLSDKERR	错误码,详情见错误码 YLSDKERR 的定义

StopShareScreen

接口描述

停止辅流分享

接口定义

YLSDKERR StopShareScreen();

参数描述

无参数。

返回值描述

类型	含义
YLSDKERR	错误码,详情见错误码 YLSDKERR 的定义

GetShareScreenState

接口描述

获取当前是否正在共享辅流

接口定义

bool GetShareScreenState();

参数描述

无参数。

返回值描述

类型	含义
bool	无

SharePopout

接口描述

将辅流分享窗口单独弹出

接口定义

YLSDKERR SharePopout();

参数描述

无参数。

返回值描述

类型	含义
YLSDKERR	错误码,详情见错误码 YLSDKERR 的定义

SharePopoutClose

接口描述

将独立弹出的辅流分享窗口收起，合并入会议窗口

接口定义

YLSDKERR SharePopoutClose();

参数描述

无参数。

返回值描述

类型	含义
YLSDKERR	错误码,详情见错误码 YLSDKERR 的定义

EnableOnlyHostCanShare

接口描述

设置是否只有主持人可以发起辅流分享

接口定义

YLSDKERR EnableOnlyHostCanShare(bool bEnable);

参数描述

参数	类型	含义
bEnable	bool	是否只有主持人可以发起辅流分享

返回值描述

类型	含义
YLSDKERR	错误码,详情见错误码 YLSDKERR 的定义

ShareJoinMeeting

接口描述

共享屏幕入会

接口定义

YLSDKERR ShareJoinMeeting(ShareJoinInfo shareJoinInfo);

参数描述

参数	类型	含义
shareJoinInfo	ShareJoinInfo	无

ShareJoinInfo 当前使用的摄像头设备信息

struct ShareJoinInfo {
    std::string strMeetingId;/** < 会议ID */
    std::string strPassword;/** < 会议密码 */
    std::string strName;/** < 入会使用名 */
    std::string strServer;/** < 未登录入会服务器地址 */
    std::string strPort;/** < 未登录入会服务器端口 */
    bool bShowShareDialog;/** < 是否显示辅流选择弹窗 */
    bool bShareVoice;/** < 是否共享电脑声音 */
    bool bHighQuality;/** < 是否流畅模式 */
}

返回值描述

类型	含义
YLSDKERR	错误码,详情见错误码 YLSDKERR 的定义

OpenWhiteBoard

接口描述

打开共享白板

接口定义

YLSDKERR OpenWhiteBoard(bool bShareSound, bool bHighVideoMode);

参数描述

参数	类型	含义
bShareSound	bool	共享时是否同时共享声音
bHighVideoMode	bool	共享时是否流畅度优先

返回值描述

类型	含义
YLSDKERR	错误码,详情见错误码 YLSDKERR 的定义

CloseWhiteBoard

接口描述

关闭共享白板

接口定义

YLSDKERR CloseWhiteBoard();

参数描述

无参数。

返回值描述

类型	含义
YLSDKERR	错误码,详情见错误码 YLSDKERR 的定义