AgoraScreenCaptureParameters 类

Inherits from NSObject
Declared in AgoraObjects.h

概览

设置屏幕共享编码配置的类

  dimensions

屏幕共享视频发送的最大像素值

@property (assign, nonatomic) CGSize dimensions

详情

默认值为 1920 x 1080,即 2073600 像素。该像素值为计费标准。

当共享的屏幕分辨率宽高比与该值设置不一致时,SDK 按如下策略进行编码。假设 dimensions 为 1920 x 1080:

  • 如果屏幕分辨率小于 dimensions,如 1000 x 1000,SDK 直接按 1000 x 1000 进行编码。
  • 如果屏幕分辨率大于 dimensions,如 2000 x 1500,SDK 按屏幕分辨率的宽高比,即 4:3,取 dimensions 以内的最大分辨率进行编码,即 1440 x 1080。

无论实际编码分辨率如何,均按 dimensions 设置的值计费。

Declared In

AgoraObjects.h

  frameRate

共享视频的帧率,单位为 fps;默认值为 5,建议不要超过 15。

@property (assign, nonatomic) NSInteger frameRate

Declared In

AgoraObjects.h

  bitrate

共享视频的码率,单位为 Kbps;默认值为 0,表示由 SDK 根据当前共享的分辨率计算出一个合理的值。

@property (assign, nonatomic) NSInteger bitrate

Declared In

AgoraObjects.h

  captureMouseCursor

是否采集鼠标用于屏幕共享

@property (assign, nonatomic) BOOL captureMouseCursor

详情

  • YES:(默认)采集鼠标
  • NO:不采集鼠标

Declared In

AgoraObjects.h