SAFR Windows SDK
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
RealNetworks.CameraKit.VideoFrame Class Reference

A video frame. More...

Inheritance diagram for RealNetworks.CameraKit.VideoFrame:

Public Member Functions

 VideoFrame (Image image, Timestamp timestamp)
 
 VideoFrame (Image image, Timestamp timestamp, bool isSceneChange, bool isMirrored, ContrastEnhacenmentParameters? conEnhParams)
 
 VideoFrame (Image image, IDepthData depthData, Timestamp timestamp, Microseconds latency, bool isSceneChange, bool isMirrored, ContrastEnhacenmentParameters? conEnhParams)
 
void Dispose ()
 
void Dispose (bool disposing)
 
void Retain ()
 Increments the use count of the video frame. The video frame backing image is kept alive as long as the use count is > 0. The backing image is freed when the use count becomes 0. More...
 
void Release ()
 Reduces the use count of the video frame. The backing image is freed once the use count hits 0. More...
 

Properties

Image Image [get]
 The image which contains the video frame pixels. More...
 
Size Size [get]
 Returns the pixel resolution of the video frame. More...
 
IDepthData DepthData [get]
 The depth data. This data is only available if the video source is capable of capturing / generating depth information. Also note that the depth data resolution is typically a fraction of the video frame resolution. More...
 
Timestamp Timestamp [get]
 The presentation timestamp of the video frame. More...
 
Microseconds Latency [get]
 The frame latency in seconds. More...
 
bool IsSceneChange [get]
 Returns true if this video frame is a key frame; false otherwise. More...
 
bool IsMirrored [get]
 Returns true if the video frame was mirrored. E.g. the video frame was recorded from the front facing camera and thus had to be mirrored to make the content look right. More...
 
ContrastEnhacenmentParametersDetectionOnlyContrastEnhancementParameters [get]
 Optinal contrast enhancement parameters. If present then contrast enhancement is applied right before face detection. More...
 

Detailed Description

A video frame.

Constructor & Destructor Documentation

◆ VideoFrame() [1/3]

RealNetworks.CameraKit.VideoFrame.VideoFrame ( Image  image,
Timestamp  timestamp 
)

◆ VideoFrame() [2/3]

RealNetworks.CameraKit.VideoFrame.VideoFrame ( Image  image,
Timestamp  timestamp,
bool  isSceneChange,
bool  isMirrored,
ContrastEnhacenmentParameters conEnhParams 
)

◆ VideoFrame() [3/3]

RealNetworks.CameraKit.VideoFrame.VideoFrame ( Image  image,
IDepthData  depthData,
Timestamp  timestamp,
Microseconds  latency,
bool  isSceneChange,
bool  isMirrored,
ContrastEnhacenmentParameters conEnhParams 
)

Member Function Documentation

◆ Dispose() [1/2]

void RealNetworks.CameraKit.VideoFrame.Dispose ( )

◆ Dispose() [2/2]

void RealNetworks.CameraKit.VideoFrame.Dispose ( bool  disposing)

◆ Release()

void RealNetworks.CameraKit.VideoFrame.Release ( )

Reduces the use count of the video frame. The backing image is freed once the use count hits 0.

◆ Retain()

void RealNetworks.CameraKit.VideoFrame.Retain ( )

Increments the use count of the video frame. The video frame backing image is kept alive as long as the use count is > 0. The backing image is freed when the use count becomes 0.

Property Documentation

◆ DepthData

IDepthData RealNetworks.CameraKit.VideoFrame.DepthData
get

The depth data. This data is only available if the video source is capable of capturing / generating depth information. Also note that the depth data resolution is typically a fraction of the video frame resolution.

◆ DetectionOnlyContrastEnhancementParameters

ContrastEnhacenmentParameters? RealNetworks.CameraKit.VideoFrame.DetectionOnlyContrastEnhancementParameters
get

Optinal contrast enhancement parameters. If present then contrast enhancement is applied right before face detection.

◆ Image

Image RealNetworks.CameraKit.VideoFrame.Image
get

The image which contains the video frame pixels.

◆ IsMirrored

bool RealNetworks.CameraKit.VideoFrame.IsMirrored
get

Returns true if the video frame was mirrored. E.g. the video frame was recorded from the front facing camera and thus had to be mirrored to make the content look right.

◆ IsSceneChange

bool RealNetworks.CameraKit.VideoFrame.IsSceneChange
get

Returns true if this video frame is a key frame; false otherwise.

◆ Latency

Microseconds RealNetworks.CameraKit.VideoFrame.Latency
get

The frame latency in seconds.

◆ Size

Size RealNetworks.CameraKit.VideoFrame.Size
get

Returns the pixel resolution of the video frame.

◆ Timestamp

Timestamp RealNetworks.CameraKit.VideoFrame.Timestamp
get

The presentation timestamp of the video frame.