文档中心
视频通话 (Legacy)
API 参考
Agora C++ API Reference for All Platforms
Agora C++ API Reference for All Platforms
|
| ScreenCaptureParameters () |
|
| ScreenCaptureParameters (const VideoDimensions &d, int f, int b, bool c, bool focus, view_t *ex=NULL, int cnt=0) |
|
| ScreenCaptureParameters (int width, int height, int f, int b, bool c, bool focus, view_t *ex=NULL, int cnt=0) |
|
◆ ScreenCaptureParameters() [1/3]
agora::rtc::ScreenCaptureParameters::ScreenCaptureParameters |
( |
| ) |
|
|
inline |
◆ ScreenCaptureParameters() [2/3]
agora::rtc::ScreenCaptureParameters::ScreenCaptureParameters |
( |
const VideoDimensions & |
d, |
|
|
int |
f, |
|
|
int |
b, |
|
|
bool |
c, |
|
|
bool |
focus, |
|
|
view_t * |
ex = NULL , |
|
|
int |
cnt = 0 |
|
) |
| |
|
inline |
◆ ScreenCaptureParameters() [3/3]
agora::rtc::ScreenCaptureParameters::ScreenCaptureParameters |
( |
int |
width, |
|
|
int |
height, |
|
|
int |
f, |
|
|
int |
b, |
|
|
bool |
c, |
|
|
bool |
focus, |
|
|
view_t * |
ex = NULL , |
|
|
int |
cnt = 0 |
|
) |
| |
|
inline |
◆ dimensions
共享的屏幕流的视频编码分辨率。
默认值为 1920 × 1080,即 2073600 像素。该像素值为计费标准。
当共享的屏幕分辨率宽高比与该值设置不一致时,SDK 按如下策略进行编码。假设 dimensions 为 1920 × 1080:
- 如果屏幕分辨率小于 dimensions,如 1000 × 1000,SDK 直接按 1000 × 1000 进行编码
- 如果屏幕分辨率大于 dimensions,如 2000 × 1500,SDK 按屏幕分辨率的宽高比,即 4:3,取 dimensions 以内的最大分辨率进行编码,即 1440 × 1080
◆ frameRate
int agora::rtc::ScreenCaptureParameters::frameRate |
共享的屏幕流的视频编码帧率,单位为 fps;默认值为 5,建议不要超过 15。
◆ bitrate
int agora::rtc::ScreenCaptureParameters::bitrate |
共享的屏幕流的视频编码码率,单位为 Kbps;默认值为 0,表示 SDK 根据当前共享屏幕的分辨率计算出一个合理的值。
◆ captureMouseCursor
bool agora::rtc::ScreenCaptureParameters::captureMouseCursor |
是否采集鼠标用于屏幕共享
- true: (默认)采集鼠标
- false: 不采集鼠标
◆ windowFocus
bool agora::rtc::ScreenCaptureParameters::windowFocus |
◆ excludeWindowList
view_t* agora::rtc::ScreenCaptureParameters::excludeWindowList |
◆ excludeWindowCount
int agora::rtc::ScreenCaptureParameters::excludeWindowCount |
◆ highLightWidth
int agora::rtc::ScreenCaptureParameters::highLightWidth |
(仅适用于 macOS)描边的宽度 (px)。默认值为 0,取值范围为 [0,50]。
- 自从
- v3.7.0
◆ highLightColor
unsigned int agora::rtc::ScreenCaptureParameters::highLightColor |
(仅适用于 macOS)描边的 RGBA 颜色。默认值为 0xFF8CBF26。
- 自从
- v3.7.0
◆ enableHighLight
bool agora::rtc::ScreenCaptureParameters::enableHighLight |
(仅适用于 macOS)是否对共享的窗口或屏幕进行描边:
- true: 描边。
- false: (默认)不描边。
- 注解
- 当你共享窗口或屏幕的部分区域时,如果设置描边,SDK 会对整个窗口或屏幕进行描边。
- 自从
- v3.7.0