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

Public Member Functions

 EncodedVideoFrameInfo ()
 
 EncodedVideoFrameInfo (int codecType, int width, int height, int framesPerSecond, int frameType, int rotation, int trackId, long captureTimeMs, long renderTimeMs, long internalSendTs, int uid, int streamType)
 
int getCodecType ()
 
void setCodecType (int codecType)
 
int getWidth ()
 
void setWidth (int width)
 
int getHeight ()
 
void setHeight (int height)
 
int getFramesPerSecond ()
 
void setFramesPerSecond (int framesPerSecond)
 
int getFrameType ()
 
void setFrameType (int frameType)
 
int getRotation ()
 
void setRotation (int rotation)
 
int getTrackId ()
 
void setTrackId (int trackId)
 
long getCaptureTimeMs ()
 
void setCaptureTimeMs (long captureTimeMs)
 
long getDecodeTimeMs ()
 
void setDecodeTimeMs (long decodeTimeMs)
 
long getInternalSendTs ()
 
void setInternalSendTs (long internalSendTs)
 
int getUid ()
 
void setUid (int uid)
 
int getStreamType ()
 
void setStreamType (int streamType)
 

Private Attributes

int codecType
 
int width
 
int height
 
int framesPerSecond
 
int frameType
 
int rotation
 
int trackId
 
long captureTimeMs
 
long decodeTimeMs
 
long internalSendTs
 
int uid
 
int streamType
 

Detailed Description

The EncodedVideoFrameInfo class.

Constructor & Destructor Documentation

◆ EncodedVideoFrameInfo() [1/2]

io.agora.rtc.EncodedVideoFrameInfo.EncodedVideoFrameInfo ( )

◆ EncodedVideoFrameInfo() [2/2]

io.agora.rtc.EncodedVideoFrameInfo.EncodedVideoFrameInfo ( int codecType,
int width,
int height,
int framesPerSecond,
int frameType,
int rotation,
int trackId,
long captureTimeMs,
long renderTimeMs,
long internalSendTs,
int uid,
int streamType )

Constructor.

Parameters
codecTypeThe video codec.
  • 0: None.
  • 1: VP8.
  • 2: H.264.
  • 3: H.265.
  • 5: VP9.
  • 6: Generic.
  • 7: Generic H264.
  • 12: AV1.
  • 20: JPEG.
widthThe width (px) of the video.
heightThe height (px) of the video.
framesPerSecondThe number of video frames per second. This value will be used for calculating timestamps of the encoded image.
frameTypeThe frame type of the encoded video frame。
  • 0: Blank frame.
  • 3: Key frame. For the H.264 encoding type, Agora SDK classifies I frames with sps and pps as key frames.
  • 4: Delta frame. For the H.264 encoding type, Agora SDK classifies P frames and I frames without sps and pps as delta frames.
  • 5: B frame.
  • 6: Droppable frame.
  • 7: Unknown frame type.
rotationThe rotation information of the encoded video frame.
  • 0: Rotate the video by 0 degree clockwise.
  • 90: Rotate the video by 90 degrees clockwise.
  • 180: Rotate the video by 180 degrees clockwise.
  • 270: Rotate the video by 270 degrees clockwise.
trackIdThe track ID of the video frame.
captureTimeMsThe timestamp (ms) for capturing the video.
renderTimeMsThe timestamp (ms) for rendering the video.
internalSendTsUse this timestamp for audio and video sync. You can get this timestamp from the onEncodedVideoImageReceived callback when encodedFrameOnly is 0.
uidID of the user.
streamTypeThe type of video streams:
  • VIDEO_STREAM_HIGH(0): High-quality video stream.
  • VIDEO_STREAM_LOW(1): Low-quality video stream.

Member Function Documentation

◆ getCaptureTimeMs()

long io.agora.rtc.EncodedVideoFrameInfo.getCaptureTimeMs ( )

◆ getCodecType()

int io.agora.rtc.EncodedVideoFrameInfo.getCodecType ( )

◆ getDecodeTimeMs()

long io.agora.rtc.EncodedVideoFrameInfo.getDecodeTimeMs ( )

◆ getFramesPerSecond()

int io.agora.rtc.EncodedVideoFrameInfo.getFramesPerSecond ( )

◆ getFrameType()

int io.agora.rtc.EncodedVideoFrameInfo.getFrameType ( )

◆ getHeight()

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

◆ getInternalSendTs()

long io.agora.rtc.EncodedVideoFrameInfo.getInternalSendTs ( )

◆ getRotation()

int io.agora.rtc.EncodedVideoFrameInfo.getRotation ( )

◆ getStreamType()

int io.agora.rtc.EncodedVideoFrameInfo.getStreamType ( )

◆ getTrackId()

int io.agora.rtc.EncodedVideoFrameInfo.getTrackId ( )

◆ getUid()

int io.agora.rtc.EncodedVideoFrameInfo.getUid ( )

◆ getWidth()

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

◆ setCaptureTimeMs()

void io.agora.rtc.EncodedVideoFrameInfo.setCaptureTimeMs ( long captureTimeMs)

◆ setCodecType()

void io.agora.rtc.EncodedVideoFrameInfo.setCodecType ( int codecType)

◆ setDecodeTimeMs()

void io.agora.rtc.EncodedVideoFrameInfo.setDecodeTimeMs ( long decodeTimeMs)

◆ setFramesPerSecond()

void io.agora.rtc.EncodedVideoFrameInfo.setFramesPerSecond ( int framesPerSecond)

◆ setFrameType()

void io.agora.rtc.EncodedVideoFrameInfo.setFrameType ( int frameType)

◆ setHeight()

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

◆ setInternalSendTs()

void io.agora.rtc.EncodedVideoFrameInfo.setInternalSendTs ( long internalSendTs)

◆ setRotation()

void io.agora.rtc.EncodedVideoFrameInfo.setRotation ( int rotation)

◆ setStreamType()

void io.agora.rtc.EncodedVideoFrameInfo.setStreamType ( int streamType)

◆ setTrackId()

void io.agora.rtc.EncodedVideoFrameInfo.setTrackId ( int trackId)

◆ setUid()

void io.agora.rtc.EncodedVideoFrameInfo.setUid ( int uid)

◆ setWidth()

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

Member Data Documentation

◆ captureTimeMs

long io.agora.rtc.EncodedVideoFrameInfo.captureTimeMs
private

◆ codecType

int io.agora.rtc.EncodedVideoFrameInfo.codecType
private

◆ decodeTimeMs

long io.agora.rtc.EncodedVideoFrameInfo.decodeTimeMs
private

◆ framesPerSecond

int io.agora.rtc.EncodedVideoFrameInfo.framesPerSecond
private

◆ frameType

int io.agora.rtc.EncodedVideoFrameInfo.frameType
private

◆ height

int io.agora.rtc.EncodedVideoFrameInfo.height
private

◆ internalSendTs

long io.agora.rtc.EncodedVideoFrameInfo.internalSendTs
private

◆ rotation

int io.agora.rtc.EncodedVideoFrameInfo.rotation
private

◆ streamType

int io.agora.rtc.EncodedVideoFrameInfo.streamType
private

◆ trackId

int io.agora.rtc.EncodedVideoFrameInfo.trackId
private

◆ uid

int io.agora.rtc.EncodedVideoFrameInfo.uid
private

◆ width

int io.agora.rtc.EncodedVideoFrameInfo.width
private

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