EncodedVideoFrameInfo

Information about externally encoded video frames.

struct EncodedVideoFrameInfo {
  EncodedVideoFrameInfo()
    : codecType(VIDEO_CODEC_H264),
      width(0),
      height(0),
      framesPerSecond(0),
      frameType(VIDEO_FRAME_TYPE_BLANK_FRAME),
      rotation(VIDEO_ORIENTATION_0),
      trackId(0),
      captureTimeMs(0),
      decodeTimeMs(0),
      uid(0),
      streamType(VIDEO_STREAM_HIGH) {}

  EncodedVideoFrameInfo(const EncodedVideoFrameInfo& rhs)
    : codecType(rhs.codecType),
      width(rhs.width),
      height(rhs.height),
      framesPerSecond(rhs.framesPerSecond),
      frameType(rhs.frameType),
      rotation(rhs.rotation),
      trackId(rhs.trackId),
      captureTimeMs(rhs.captureTimeMs),
      decodeTimeMs(rhs.decodeTimeMs),
      uid(rhs.uid),
      streamType(rhs.streamType) {}

  EncodedVideoFrameInfo& operator=(const EncodedVideoFrameInfo& rhs) {
    if (this == &rhs) return *this;
    codecType = rhs.codecType;
    width = rhs.width;
    height = rhs.height;
    framesPerSecond = rhs.framesPerSecond;
    frameType = rhs.frameType;
    rotation = rhs.rotation;
    trackId = rhs.trackId;
    captureTimeMs = rhs.captureTimeMs;
    decodeTimeMs = rhs.decodeTimeMs;
    uid = rhs.uid;
    streamType = rhs.streamType;
    return *this;
  }

Attributes

codecType
The codec type of the local video stream. See VIDEO_CODEC_TYPE. The default value is VIDEO_CODEC_H264 (2).
width
Width (pixel) of the video frame.
height
Height (pixel) of the video frame.
framesPerSecond

The number of video frames per second.

When this parameter is not 0, you can use it to calculate the Unix timestamp of externally encoded video frames.

frameType
The video frame type. See VIDEO_FRAME_TYPE.
rotation
The rotation information of the video frame. See VIDEO_ORIENTATION.
trackId
Reserved for future use.
The track ID. Used in scenarios with multiple video tracks in the channel.
captureTimeMs
The Unix timestamp (ms) for capturing the external encoded video frames.
decodeTimeMs
The Unix timestamp (ms) for decoding the external encoded video frames.
uid
The user ID to push the externally encoded video frame.
streamType
The type of video streams. See VIDEO_STREAM_TYPE.