Package io.agora.rtc2
Class ScreenCaptureParameters.VideoCaptureParameters
java.lang.Object
io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
- Enclosing class:
- ScreenCaptureParameters
The video configuration for the shared screen stream.
Only available for scenarios where `captureVideo` is `true`.
- Since:
- v3.7.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionintThe video encoding bitrate (Kbps).intThe content hint of the screen sharing: -SCREEN_CAPTURE_CONTENT_HINT_NONE(0)- (Default)SCREEN_CAPTURE_CONTENT_HINT_MOTION(1)-SCREEN_CAPTURE_CONTENT_HINT_DETAILS(2)intThe video encoding frame rate (fps).intThe height of the video encoding resolution.intThe width of the video encoding resolution. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
bitrate
public int bitrateThe video encoding bitrate (Kbps). For recommended values, see [Recommended video profiles](https://docs.agora.io/en/Interactive%20Broadcast/game_streaming_video_profile?platform=Android#recommended-video-profiles). -
framerate
public int framerateThe video encoding frame rate (fps). The default value is `15`. For recommended values, see [Recommended video profiles](https://docs.agora.io/en/Interactive%20Broadcast/game_streaming_video_profile?platform=Android#recommended-video-profiles). -
width
public int widthThe width of the video encoding resolution. The default value is `1280`. For recommended values, see [Recommended video profiles](https://docs.agora.io/en/Interactive%20Broadcast/game_streaming_video_profile?platform=Android#recommended-video-profiles). If the aspect ratio is different between width and height and the screen, the SDK adjusts the video encoding resolution according to the following rules (using an example where `width` × `height` is 1280 × 720): - When the width and height of the screen are both lower than `width` and `height`, the SDK uses the resolution of the screen for video encoding. For example, if the screen is 640 × 360, The SDK uses 640 × 360 for video encoding. - When either the width or height of the screen is higher than `width` or `height`, the SDK uses the maximum values that do not exceed those of `width` and `height` while maintaining the aspect ratio of the screen for video encoding. For example, if the screen is 2000 × 1500, the SDK uses 960 × 720 for video encoding. -
height
public int heightThe height of the video encoding resolution. The default value is 720. For recommended values, see [Recommended video profiles](https://docs.agora.io/en/Interactive%20Broadcast/game_streaming_video_profile?platform=Android#recommended-video-profiles). If the aspect ratio is different between `width` and `height` and the screen, the SDK adjusts the video encoding resolution according to the following rules (using an example where `width` × `height` is 1280 × 720): - When the width and height of the screen are both lower than `width` and `height`, the SDK uses the resolution of the screen for video encoding. For example, if the screen is 640 × 360, The SDK uses 640 × 360 for video encoding. - When either the width or height of the screen is higher than `width` or `height`, the SDK uses the maximum values that do not exceed those of `width` and `height` while maintaining the aspect ratio of the screen for video encoding. For example, if the screen is 2000 × 1500, the SDK uses 960 × 720 for video encoding. -
contentHint
public int contentHintThe content hint of the screen sharing: -SCREEN_CAPTURE_CONTENT_HINT_NONE(0)- (Default)SCREEN_CAPTURE_CONTENT_HINT_MOTION(1)-SCREEN_CAPTURE_CONTENT_HINT_DETAILS(2)
-
-
Constructor Details
-
VideoCaptureParameters
public VideoCaptureParameters()
-
-
Method Details