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

VideoFrame

class VideoFrame

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

Constructors

<init>

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

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

Properties

buffer

Object containing actual video frame data in some form

val buffer: VideoFrameBuffer

height

Height of the video frame

val height: Int

rotation

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

val rotation: VideoRotation

timestampNs

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.

val timestampNs: Long

width

Width of the video frame

val width: Int

Functions

getRotatedHeight

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

fun getRotatedHeight(): Int

getRotatedWidth

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

fun getRotatedWidth(): Int

release

Helper function to call VideoFrameBuffer.release on the owned buffer

fun release(): Unit

retain

Helper function to call VideoFrameBuffer.retain on the owned buffer

fun retain(): Unit