My Project
函数
zego-windowthumbnail.h 文件参考
#include "zego-windowthumbnail-defines.h"
zego-windowthumbnail.h 的引用(Include)关系图:

浏览源代码.

函数

SCREENCAPTURE_API void zego_windowthumbnail_find_windows_async (bool isAsync)
 异步获取窗口列表的缩略图(windows未实现) 更多...
 
SCREENCAPTURE_API struct ZegoThumbnailWindowInfozego_windowthumbnail_find_windows (int *count)
 枚举可建立缩略图的窗口列表,包括窗口标题和窗口句柄 更多...
 
SCREENCAPTURE_API void zego_windowthumbnail_free_windows (struct ZegoThumbnailWindowInfo *window_list, int count)
 释放枚举到的窗口列表 更多...
 
SCREENCAPTURE_API bool zego_windowthumbnail_register (ZegoWindowHandle handle)
 同步注册缩略图 更多...
 
SCREENCAPTURE_API bool zego_windowthumbnail_update (int thumbnail_id, struct ZegoRect *destination_rect, struct ZegoRect *destination_client_rect)
 更新缩略图位置 更多...
 
SCREENCAPTURE_API bool zego_windowthumbnail_window_checkStatus (ZegoWindowHandle handle)
 检测是否能够开始共享 更多...
 
SCREENCAPTURE_API bool zego_windowthumbnail_unregister (int thumbnail_id)
 反注册缩略图同时反注册状态监测 更多...
 
SCREENCAPTURE_API bool zego_windowthumbnail_show_source_window (ZegoWindowHandle handle, enum ZegoThumbnailShowWindowCmd cmd)
 显示或隐藏源窗口 更多...
 
SCREENCAPTURE_API void zego_windowthumbnail_reg_window_status_change_notify (zego_windowthumbnail_window_status_change_notify_func notify, void *user_data)
 注册窗口状态变化回调 更多...
 

函数说明

SCREENCAPTURE_API struct ZegoThumbnailWindowInfo* zego_windowthumbnail_find_windows ( int *  count)

枚举可建立缩略图的窗口列表,包括窗口标题和窗口句柄

参数
count窗口数量
返回
窗口列表首地址,需配对调用zego_thumbnail_free_windows释放
参见
zego_thumbnail_free_windows
SCREENCAPTURE_API void zego_windowthumbnail_find_windows_async ( bool  isAsync)

异步获取窗口列表的缩略图(windows未实现)

参数
isAsync默认为false。设置为true,zego_windowthumbnail_find_windows接口不返回缩略图,需要通过zego_windowthumbnail_register异步获取缩略图
参见
需在zego_windowthumbnail_find_windows调用。
SCREENCAPTURE_API void zego_windowthumbnail_free_windows ( struct ZegoThumbnailWindowInfo window_list,
int  count 
)

释放枚举到的窗口列表

参数
window_list枚举到的窗口列表首地址,由zego_windowthumbnail_find_windows返回的窗口信息列表
count窗口信息列表长度
参见
zego_windowthumbnail_find_windows
SCREENCAPTURE_API void zego_windowthumbnail_reg_window_status_change_notify ( zego_windowthumbnail_window_status_change_notify_func  notify,
void *  user_data 
)

注册窗口状态变化回调

参数
notify通知函数
user_data用户自定义数据,回调时透传
SCREENCAPTURE_API bool zego_windowthumbnail_register ( ZegoWindowHandle  handle)

同步注册缩略图

参数
handle缩略图标志 为zego_thumbnail_find_windows或者zego_windowthumbnail_window_status_change_notify_func返回的窗口列表中的handle
返回
成功或失败
参见
zego_thumbnail_find_windows
zego_windowthumbnail_window_status_change_notify_func
SCREENCAPTURE_API bool zego_windowthumbnail_show_source_window ( ZegoWindowHandle  handle,
enum ZegoThumbnailShowWindowCmd  cmd 
)

显示或隐藏源窗口

参数
handle窗口句柄
cmd最大化、最小化、显示、隐藏
返回
成功或失败
SCREENCAPTURE_API bool zego_windowthumbnail_unregister ( int  thumbnail_id)

反注册缩略图同时反注册状态监测

参数
thumbnail_id缩略图标志为zego_thumbnail_find_windows或者zego_windowthumbnail_window_status_change_notify_func返回的窗口列表中的thumbnail_id
返回
成功或失败
参见
zego_thumbnail_find_windows
zego_windowthumbnail_window_status_change_notify_func
SCREENCAPTURE_API bool zego_windowthumbnail_update ( int  thumbnail_id,
struct ZegoRect destination_rect,
struct ZegoRect destination_client_rect 
)

更新缩略图位置

参数
thumbnail_id缩略图标志 为zego_thumbnail_find_windows或者zego_windowthumbnail_window_status_change_notify_func返回的窗口列表中的thumbnail_id
destination_rect缩略图显示新的区域,目的窗口坐标系
destination_client_rect目的窗口客户区区域,目的窗口坐标系
返回
成功或失败
参见
zego_thumbnail_find_windows
zego_windowthumbnail_window_status_change_notify_func
macOS没有实现
SCREENCAPTURE_API bool zego_windowthumbnail_window_checkStatus ( ZegoWindowHandle  handle)

检测是否能够开始共享

参数
handle缩略图标志 为zego_thumbnail_find_windows或者zego_windowthumbnail_window_status_change_notify_func返回的窗口列表中的handle
返回
是否能够共享窗口
参见
zego_thumbnail_find_windows
zego_windowthumbnail_window_status_change_notify_func
注解
Windows下总会返回true