Agora Server Gateway SDK Java API Reference
Loading...
Searching...
No Matches
io.agora.rtc.LocalVideoTrackStats Class Reference

Public Member Functions

 LocalVideoTrackStats ()
 
 LocalVideoTrackStats (long numberOfStreams, long bytesMajorStream, long bytesMinorStream, int framesEncoded, int ssrcMajorStream, int ssrcMinorStream, int captureFrameRate, int regulatedCaptureFrameRate, int inputFrameRate, int encodeFrameRate, int renderFrameRate, int targetMediaBitrateBps, int mediaBitrateBps, int totalBitrateBps, int captureWidth, int captureHeight, int regulatedCaptureWidth, int regulatedCaptureHeight, int width, int height, int encoderType, int uplinkCostTimeMs, int qualityAdaptIndication)
 
long getNumberOfStreams ()
 
void setNumberOfStreams (long numberOfStreams)
 
long getBytesMajorStream ()
 
void setBytesMajorStream (long bytesMajorStream)
 
long getBytesMinorStream ()
 
void setBytesMinorStream (long bytesMinorStream)
 
int getFramesEncoded ()
 
void setFramesEncoded (int framesEncoded)
 
int getSsrcMajorStream ()
 
void setSsrcMajorStream (int ssrcMajorStream)
 
int getSsrcMinorStream ()
 
void setSsrcMinorStream (int ssrcMinorStream)
 
int getCaptureFrameRate ()
 
void setCaptureFrameRate (int captureFrameRate)
 
int getRegulatedCaptureFrameRate ()
 
void setRegulatedCaptureFrameRate (int regulatedCaptureFrameRate)
 
int getInputFrameRate ()
 
void setInputFrameRate (int inputFrameRate)
 
int getEncodeFrameRate ()
 
void setEncodeFrameRate (int encodeFrameRate)
 
int getRenderFrameRate ()
 
void setRenderFrameRate (int renderFrameRate)
 
int getTargetMediaBitrateBps ()
 
void setTargetMediaBitrateBps (int targetMediaBitrateBps)
 
int getMediaBitrateBps ()
 
void setMediaBitrateBps (int mediaBitrateBps)
 
int getTotalBitrateBps ()
 
void setTotalBitrateBps (int totalBitrateBps)
 
int getCaptureWidth ()
 
void setCaptureWidth (int captureWidth)
 
int getCaptureHeight ()
 
void setCaptureHeight (int captureHeight)
 
int getRegulatedCaptureWidth ()
 
void setRegulatedCaptureWidth (int regulatedCaptureWidth)
 
int getRegulatedCaptureHeight ()
 
void setRegulatedCaptureHeight (int regulatedCaptureHeight)
 
int getWidth ()
 
void setWidth (int width)
 
int getHeight ()
 
void setHeight (int height)
 
int getEncoderType ()
 
void setEncoderType (int encoderType)
 
int getUplinkCostTimeMs ()
 
void setUplinkCostTimeMs (int uplinkCostTimeMs)
 
int getQualityAdaptIndication ()
 
void setQualityAdaptIndication (int qualityAdaptIndication)
 

Private Attributes

long numberOfStreams
 
long bytesMajorStream
 
long bytesMinorStream
 
int framesEncoded
 
int ssrcMajorStream
 
int ssrcMinorStream
 
int captureFrameRate
 
int regulatedCaptureFrameRate
 
int inputFrameRate
 
int encodeFrameRate
 
int renderFrameRate
 
int targetMediaBitrateBps
 
int mediaBitrateBps
 
int totalBitrateBps
 
int captureWidth
 
int captureHeight
 
int regulatedCaptureWidth
 
int regulatedCaptureHeight
 
int width
 
int height
 
int encoderType
 
int uplinkCostTimeMs
 
int qualityAdaptIndication
 

Detailed Description

The statistics of the local video track.

Constructor & Destructor Documentation

◆ LocalVideoTrackStats() [1/2]

io.agora.rtc.LocalVideoTrackStats.LocalVideoTrackStats ( )

◆ LocalVideoTrackStats() [2/2]

io.agora.rtc.LocalVideoTrackStats.LocalVideoTrackStats ( long numberOfStreams,
long bytesMajorStream,
long bytesMinorStream,
int framesEncoded,
int ssrcMajorStream,
int ssrcMinorStream,
int captureFrameRate,
int regulatedCaptureFrameRate,
int inputFrameRate,
int encodeFrameRate,
int renderFrameRate,
int targetMediaBitrateBps,
int mediaBitrateBps,
int totalBitrateBps,
int captureWidth,
int captureHeight,
int regulatedCaptureWidth,
int regulatedCaptureHeight,
int width,
int height,
int encoderType,
int uplinkCostTimeMs,
int qualityAdaptIndication )

Constructor.

Parameters
numberOfStreamsThe number of streams.
bytesMajorStreamThe number of bytes of the major stream.
bytesMinorStreamThe number of bytes of the minor stream.
framesEncodedThe number of encoded frames.
ssrcMajorStreamThe SSRC (synchronization source) of the major stream.
ssrcMinorStreamThe SSRC (synchronization source) of the minor stream.
captureFrameRateThe capture frame rate of the video.
regulatedCaptureFrameRateThe regulated frame rate of capture frame rate according to video encoder configuration.
inputFrameRateThe input frame rate of the encoder.
encodeFrameRateThe output frame rate of the encoder.
renderFrameRateThe rendering frame rate.
targetMediaBitrateBpsThe target bitrate (bps).
mediaBitrateBpsThe bitrate excluding FEC.
totalBitrateBpsThe total bitrate including FEC.
captureWidthThe capture frame width (pixel).
captureHeightThe capture frame height (pixel).
regulatedCaptureWidthThe regulated frame width (pixel) of capture frame width according to video encoder configuration.
regulatedCaptureHeightThe regulated frame height (pixel) of capture frame height according to video encoder configuration.
widthThe frame width (pixel).
heightThe frame height (pixel).
encoderTypeThe video encoder type.
uplinkCostTimeMsThe average time diff between frame captured and framed encoded.
qualityAdaptIndicationQuality change of the local video in terms of target frame rate and target bit rate in this reported interval.
  • 0: The quality of the local video stays the same.
  • 1: The quality improves because the network bandwidth increases.
  • 2: The quality worsens because the network bandwidth decreases.

Member Function Documentation

◆ getBytesMajorStream()

long io.agora.rtc.LocalVideoTrackStats.getBytesMajorStream ( )

◆ getBytesMinorStream()

long io.agora.rtc.LocalVideoTrackStats.getBytesMinorStream ( )

◆ getCaptureFrameRate()

int io.agora.rtc.LocalVideoTrackStats.getCaptureFrameRate ( )

◆ getCaptureHeight()

int io.agora.rtc.LocalVideoTrackStats.getCaptureHeight ( )

◆ getCaptureWidth()

int io.agora.rtc.LocalVideoTrackStats.getCaptureWidth ( )

◆ getEncodeFrameRate()

int io.agora.rtc.LocalVideoTrackStats.getEncodeFrameRate ( )

◆ getEncoderType()

int io.agora.rtc.LocalVideoTrackStats.getEncoderType ( )

◆ getFramesEncoded()

int io.agora.rtc.LocalVideoTrackStats.getFramesEncoded ( )

◆ getHeight()

int io.agora.rtc.LocalVideoTrackStats.getHeight ( )

◆ getInputFrameRate()

int io.agora.rtc.LocalVideoTrackStats.getInputFrameRate ( )

◆ getMediaBitrateBps()

int io.agora.rtc.LocalVideoTrackStats.getMediaBitrateBps ( )

◆ getNumberOfStreams()

long io.agora.rtc.LocalVideoTrackStats.getNumberOfStreams ( )

◆ getQualityAdaptIndication()

int io.agora.rtc.LocalVideoTrackStats.getQualityAdaptIndication ( )

◆ getRegulatedCaptureFrameRate()

int io.agora.rtc.LocalVideoTrackStats.getRegulatedCaptureFrameRate ( )

◆ getRegulatedCaptureHeight()

int io.agora.rtc.LocalVideoTrackStats.getRegulatedCaptureHeight ( )

◆ getRegulatedCaptureWidth()

int io.agora.rtc.LocalVideoTrackStats.getRegulatedCaptureWidth ( )

◆ getRenderFrameRate()

int io.agora.rtc.LocalVideoTrackStats.getRenderFrameRate ( )

◆ getSsrcMajorStream()

int io.agora.rtc.LocalVideoTrackStats.getSsrcMajorStream ( )

◆ getSsrcMinorStream()

int io.agora.rtc.LocalVideoTrackStats.getSsrcMinorStream ( )

◆ getTargetMediaBitrateBps()

int io.agora.rtc.LocalVideoTrackStats.getTargetMediaBitrateBps ( )

◆ getTotalBitrateBps()

int io.agora.rtc.LocalVideoTrackStats.getTotalBitrateBps ( )

◆ getUplinkCostTimeMs()

int io.agora.rtc.LocalVideoTrackStats.getUplinkCostTimeMs ( )

◆ getWidth()

int io.agora.rtc.LocalVideoTrackStats.getWidth ( )

◆ setBytesMajorStream()

void io.agora.rtc.LocalVideoTrackStats.setBytesMajorStream ( long bytesMajorStream)

◆ setBytesMinorStream()

void io.agora.rtc.LocalVideoTrackStats.setBytesMinorStream ( long bytesMinorStream)

◆ setCaptureFrameRate()

void io.agora.rtc.LocalVideoTrackStats.setCaptureFrameRate ( int captureFrameRate)

◆ setCaptureHeight()

void io.agora.rtc.LocalVideoTrackStats.setCaptureHeight ( int captureHeight)

◆ setCaptureWidth()

void io.agora.rtc.LocalVideoTrackStats.setCaptureWidth ( int captureWidth)

◆ setEncodeFrameRate()

void io.agora.rtc.LocalVideoTrackStats.setEncodeFrameRate ( int encodeFrameRate)

◆ setEncoderType()

void io.agora.rtc.LocalVideoTrackStats.setEncoderType ( int encoderType)

◆ setFramesEncoded()

void io.agora.rtc.LocalVideoTrackStats.setFramesEncoded ( int framesEncoded)

◆ setHeight()

void io.agora.rtc.LocalVideoTrackStats.setHeight ( int height)

◆ setInputFrameRate()

void io.agora.rtc.LocalVideoTrackStats.setInputFrameRate ( int inputFrameRate)

◆ setMediaBitrateBps()

void io.agora.rtc.LocalVideoTrackStats.setMediaBitrateBps ( int mediaBitrateBps)

◆ setNumberOfStreams()

void io.agora.rtc.LocalVideoTrackStats.setNumberOfStreams ( long numberOfStreams)

◆ setQualityAdaptIndication()

void io.agora.rtc.LocalVideoTrackStats.setQualityAdaptIndication ( int qualityAdaptIndication)

◆ setRegulatedCaptureFrameRate()

void io.agora.rtc.LocalVideoTrackStats.setRegulatedCaptureFrameRate ( int regulatedCaptureFrameRate)

◆ setRegulatedCaptureHeight()

void io.agora.rtc.LocalVideoTrackStats.setRegulatedCaptureHeight ( int regulatedCaptureHeight)

◆ setRegulatedCaptureWidth()

void io.agora.rtc.LocalVideoTrackStats.setRegulatedCaptureWidth ( int regulatedCaptureWidth)

◆ setRenderFrameRate()

void io.agora.rtc.LocalVideoTrackStats.setRenderFrameRate ( int renderFrameRate)

◆ setSsrcMajorStream()

void io.agora.rtc.LocalVideoTrackStats.setSsrcMajorStream ( int ssrcMajorStream)

◆ setSsrcMinorStream()

void io.agora.rtc.LocalVideoTrackStats.setSsrcMinorStream ( int ssrcMinorStream)

◆ setTargetMediaBitrateBps()

void io.agora.rtc.LocalVideoTrackStats.setTargetMediaBitrateBps ( int targetMediaBitrateBps)

◆ setTotalBitrateBps()

void io.agora.rtc.LocalVideoTrackStats.setTotalBitrateBps ( int totalBitrateBps)

◆ setUplinkCostTimeMs()

void io.agora.rtc.LocalVideoTrackStats.setUplinkCostTimeMs ( int uplinkCostTimeMs)

◆ setWidth()

void io.agora.rtc.LocalVideoTrackStats.setWidth ( int width)

Member Data Documentation

◆ bytesMajorStream

long io.agora.rtc.LocalVideoTrackStats.bytesMajorStream
private

◆ bytesMinorStream

long io.agora.rtc.LocalVideoTrackStats.bytesMinorStream
private

◆ captureFrameRate

int io.agora.rtc.LocalVideoTrackStats.captureFrameRate
private

◆ captureHeight

int io.agora.rtc.LocalVideoTrackStats.captureHeight
private

◆ captureWidth

int io.agora.rtc.LocalVideoTrackStats.captureWidth
private

◆ encodeFrameRate

int io.agora.rtc.LocalVideoTrackStats.encodeFrameRate
private

◆ encoderType

int io.agora.rtc.LocalVideoTrackStats.encoderType
private

◆ framesEncoded

int io.agora.rtc.LocalVideoTrackStats.framesEncoded
private

◆ height

int io.agora.rtc.LocalVideoTrackStats.height
private

◆ inputFrameRate

int io.agora.rtc.LocalVideoTrackStats.inputFrameRate
private

◆ mediaBitrateBps

int io.agora.rtc.LocalVideoTrackStats.mediaBitrateBps
private

◆ numberOfStreams

long io.agora.rtc.LocalVideoTrackStats.numberOfStreams
private

◆ qualityAdaptIndication

int io.agora.rtc.LocalVideoTrackStats.qualityAdaptIndication
private

◆ regulatedCaptureFrameRate

int io.agora.rtc.LocalVideoTrackStats.regulatedCaptureFrameRate
private

◆ regulatedCaptureHeight

int io.agora.rtc.LocalVideoTrackStats.regulatedCaptureHeight
private

◆ regulatedCaptureWidth

int io.agora.rtc.LocalVideoTrackStats.regulatedCaptureWidth
private

◆ renderFrameRate

int io.agora.rtc.LocalVideoTrackStats.renderFrameRate
private

◆ ssrcMajorStream

int io.agora.rtc.LocalVideoTrackStats.ssrcMajorStream
private

◆ ssrcMinorStream

int io.agora.rtc.LocalVideoTrackStats.ssrcMinorStream
private

◆ targetMediaBitrateBps

int io.agora.rtc.LocalVideoTrackStats.targetMediaBitrateBps
private

◆ totalBitrateBps

int io.agora.rtc.LocalVideoTrackStats.totalBitrateBps
private

◆ uplinkCostTimeMs

int io.agora.rtc.LocalVideoTrackStats.uplinkCostTimeMs
private

◆ width

int io.agora.rtc.LocalVideoTrackStats.width
private

The documentation for this class was generated from the following file: