Package io.agora.rtc2

Class ScreenCaptureParameters.VideoCaptureParameters

java.lang.Object
io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
Enclosing class:
ScreenCaptureParameters

public static class ScreenCaptureParameters.VideoCaptureParameters extends Object
The video configuration for the shared screen stream. Only available for scenarios where `captureVideo` is `true`.
Since:
v3.7.0
  • Field Details

    • bitrate

      public int bitrate
      The 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 framerate
      The 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 width
      The 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 height
      The 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 contentHint
  • Constructor Details

    • VideoCaptureParameters

      public VideoCaptureParameters()
  • Method Details

    • getBitrate

      public int getBitrate()
    • getFramerate

      public int getFramerate()
    • getWidth

      public int getWidth()
    • getHeight

      public int getHeight()
    • getContentHint

      public int getContentHint()
    • toString

      public String toString()
      Overrides:
      toString in class Object