Agora Java API Reference for Android
Classes | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
io.agora.streaming.VideoStreamConfiguration Class Reference

Classes

enum  FRAME_RATE
 
enum  ORIENTATION_MODE
 
class  VideoDimensions
 

Public Member Functions

 VideoStreamConfiguration (VideoDimensions dimensions, FRAME_RATE frameRate, int bitrate, ORIENTATION_MODE orientationMode, @VideoMirrorMode int mirrorMode)
 
 VideoStreamConfiguration (int width, int height, FRAME_RATE frameRate, int bitrate, ORIENTATION_MODE orientationMode, @VideoMirrorMode int mirrorMode)
 
 VideoStreamConfiguration (int width, int height, int frameRate, int bitrate, ORIENTATION_MODE orientationMode, @VideoMirrorMode int mirrorMode)
 
 VideoStreamConfiguration (int width, int height, int frameRate, int bitrate, ORIENTATION_MODE orientationMode, @VideoMirrorMode int mirrorMode, @VideoEncodingMode int videoEncodingMode)
 
 VideoStreamConfiguration (VideoDimensions dimensions, int frameRate, int bitrate, ORIENTATION_MODE orientationMode, @VideoMirrorMode int mirrorMode)
 
 VideoStreamConfiguration (VideoDimensions dimensions, int frameRate, int bitrate, ORIENTATION_MODE orientationMode, @VideoMirrorMode int mirrorMode, @VideoEncodingMode int videoEncodingMode)
 
int getWidth ()
 
int getHeight ()
 
int getFramerate ()
 
int getBitrate ()
 
int getOrientationMode ()
 
int getMirrorMode ()
 
int getVideoEncodingMode ()
 
String toString ()
 

Public Attributes

VideoDimensions dimensions
 
int frameRate
 
int bitrate
 
ORIENTATION_MODE orientationMode
 
int mirrorMode
 
int videoEncodingMode
 

Static Public Attributes

static final VideoDimensions VD_120x120 = new VideoDimensions(120, 120)
 
static final VideoDimensions VD_160x120 = new VideoDimensions(160, 120)
 
static final VideoDimensions VD_180x180 = new VideoDimensions(180, 180)
 
static final VideoDimensions VD_240x180 = new VideoDimensions(240, 180)
 
static final VideoDimensions VD_320x180 = new VideoDimensions(320, 180)
 
static final VideoDimensions VD_240x240 = new VideoDimensions(240, 240)
 
static final VideoDimensions VD_320x240 = new VideoDimensions(320, 240)
 
static final VideoDimensions VD_424x240 = new VideoDimensions(424, 240)
 
static final VideoDimensions VD_360x360 = new VideoDimensions(360, 360)
 
static final VideoDimensions VD_480x360 = new VideoDimensions(480, 360)
 
static final VideoDimensions VD_640x360 = new VideoDimensions(640, 360)
 
static final VideoDimensions VD_480x480 = new VideoDimensions(480, 480)
 
static final VideoDimensions VD_640x480 = new VideoDimensions(640, 480)
 
static final VideoDimensions VD_840x480 = new VideoDimensions(840, 480)
 
static final VideoDimensions VD_960x720 = new VideoDimensions(960, 720)
 
static final VideoDimensions VD_1280x720 = new VideoDimensions(1280, 720)
 
static final VideoDimensions VD_1920x1080 = new VideoDimensions(1920, 1080)
 
static final VideoDimensions VD_2540x1440 = new VideoDimensions(2540, 1440)
 
static final VideoDimensions VD_3840x2160 = new VideoDimensions(3840, 2160)
 
static final int STANDARD_BITRATE = 0
 

Detailed Description

Configurations for the video stream.

Member Data Documentation

◆ VD_120x120

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_120x120 = new VideoDimensions(120, 120)
static

VD_120x120: The video resolution is 120 × 120.

◆ VD_160x120

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_160x120 = new VideoDimensions(160, 120)
static

VD_160x120: The video resolution is 160 × 120.

◆ VD_180x180

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_180x180 = new VideoDimensions(180, 180)
static

VD_180x180: The video resolution is 180 × 180.

◆ VD_240x180

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_240x180 = new VideoDimensions(240, 180)
static

VD_240x180: The video resolution is 240 × 180.

◆ VD_320x180

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_320x180 = new VideoDimensions(320, 180)
static

VD_320x180: The video resolution is 320 × 180.

◆ VD_240x240

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_240x240 = new VideoDimensions(240, 240)
static

VD_240x240: The video resolution is 240 × 240.

◆ VD_320x240

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_320x240 = new VideoDimensions(320, 240)
static

VD_320x240: The video resolution is 320 × 240.

◆ VD_424x240

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_424x240 = new VideoDimensions(424, 240)
static

VD_424x240: The video resolution is 424 × 240.

◆ VD_360x360

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_360x360 = new VideoDimensions(360, 360)
static

VD_360x360: The video resolution is 360 × 360.

◆ VD_480x360

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_480x360 = new VideoDimensions(480, 360)
static

VD_480x360: The video resolution is 480 × 360.

◆ VD_640x360

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_640x360 = new VideoDimensions(640, 360)
static

VD_640x360: The video resolution is 640 × 360.

◆ VD_480x480

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_480x480 = new VideoDimensions(480, 480)
static

VD_480x480: The video resolution is 480 × 480.

◆ VD_640x480

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_640x480 = new VideoDimensions(640, 480)
static

VD_640x480: The video resolution is 640 × 480.

◆ VD_840x480

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_840x480 = new VideoDimensions(840, 480)
static

VD_840x480: The video resolution is 840 × 480.

◆ VD_960x720

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_960x720 = new VideoDimensions(960, 720)
static

VD_960x720: The video resolution is 640 × 360.

◆ VD_1280x720

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_1280x720 = new VideoDimensions(1280, 720)
static

VD_1280x720: The video resolution is 640 × 360.

◆ VD_1920x1080

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_1920x1080 = new VideoDimensions(1920, 1080)
static

Not supported.

◆ VD_2540x1440

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_2540x1440 = new VideoDimensions(2540, 1440)
static

Not supported.

◆ VD_3840x2160

final VideoDimensions io.agora.streaming.VideoStreamConfiguration.VD_3840x2160 = new VideoDimensions(3840, 2160)
static

Not supported.

◆ STANDARD_BITRATE

final int io.agora.streaming.VideoStreamConfiguration.STANDARD_BITRATE = 0
static

0: The standard bitrate mode.

◆ dimensions

VideoDimensions io.agora.streaming.VideoStreamConfiguration.dimensions

The video frame dimensions (px), which is used to specify the video quality and measured by the total number of pixels along a frame's width and height. The default value is 640 × 360. Users can either set the resolution manually or choose from the following options:

Note
  • The value of the dimension does not indicate the orientation mode of the output ratio. For how to set the video orientation, see ORIENTATION_MODE.
  • Whether 720p+ can be supported depends on the device. If the device cannot support 720p, the frame rate will be lower than the one listed in the table.

◆ frameRate

int io.agora.streaming.VideoStreamConfiguration.frameRate

The video frame rate (fps). The default value is 15. Users can either set the frame rate manually or choose from the following options. We do not recommend setting this to a value greater than 30.

◆ bitrate

int io.agora.streaming.VideoStreamConfiguration.bitrate

The bitrate of the video (Kbps). Refer to the table below and set your bitrate. If you set a bitrate beyond the proper range, the SDK automatically adjusts it to a value within the range. You can also choose from the following options:

  • STANDARD_BITRATE(0): (Recommended) The standard bitrate mode.

Video Bitrate Table

Resolution Frame rate(fps) Standard Bitrate (Kbps)
160 × 120 15 130
120 × 120 15 100
320 × 180 15 280
180 × 180 15 200
240 × 180 15 240
320 × 240 15 400
240 × 240 15 280
424 × 240 15 440
640 × 360 15 800
360 × 360 15 520
640 × 360 30 1200
360 × 360 30 800
480 × 360 15 640
480 × 360 30 980
640 × 480 15 1000
480 × 480 15 800
640 × 480 30 1500
480 × 480 30 1200
848 × 480 15 1220
848 × 480 30 1860
640 × 480 10 800
1280 × 720 15 2260
1280 × 720 30 3420
960 × 720 15 1820
960 × 720 30 2760
Note
We recommend setting the bitrate mode as STANDARD_BITRATE = 0.

◆ orientationMode

ORIENTATION_MODE io.agora.streaming.VideoStreamConfiguration.orientationMode

The orientation mode. See ORIENTATION_MODE.

◆ mirrorMode

int io.agora.streaming.VideoStreamConfiguration.mirrorMode

The video mirror mode See VideoMirrorMode

◆ videoEncodingMode

int io.agora.streaming.VideoStreamConfiguration.videoEncodingMode

The video encoding mode See VideoEncodingMode