amazon-chime-sdk/com.amazonaws.services.chime.sdk.meetings.audiovideo.video/VideoFrame

VideoFrame

class VideoFrame(val timestampNs: Long, val buffer: VideoFrameBuffer, val rotation: VideoRotation = VideoRotation.Rotation0)

VideoFrame is a class which contains a VideoFrameBuffer and metadata necessary for transmission Typically produced via a VideoSource and consumed via a VideoSink

Constructors

VideoFrame

constructor(timestampNs: Long, buffer: VideoFrameBuffer, rotation: VideoRotation = VideoRotation.Rotation0)

Properties

buffer

val buffer: VideoFrameBuffer

Object containing actual video frame data in some form

height

val height: Int

Height of the video frame

rotation

val rotation: VideoRotation

Rotation of the video frame buffer in degrees clockwise from intended viewing horizon.

timestampNs

val timestampNs: Long

Timestamp in nanoseconds at which the video frame was captured from some system monotonic clock. Will be aligned and converted to NTP (Network Time Protocol) within AmazonChimeSDKMedia library, which will then be converted to a system monotonic clock on remote end. May be different on frames emanated from AmazonChimeSDKMedia library.

width

val width: Int

Width of the video frame

Functions

getRotatedHeight

fun getRotatedHeight(): Int

Height of frame when the reverse of rotation is applied to the buffer e.g. a frame with width = 1 and height = 2 with 90 degrees rotation will have rotated width = 2 and height = 1

getRotatedWidth

fun getRotatedWidth(): Int

Width of frame when the reverse of rotation is applied to the buffer e.g. a frame with width = 1 and height = 2 with 90 degrees rotation will have rotated width = 2 and height = 1

release

fun release()

Helper function to call VideoFrameBuffer.release on the owned buffer

retain

fun retain()

Helper function to call VideoFrameBuffer.retain on the owned buffer