Class CameraFrame

Represents a camera frame, with all format, resolution, properties and pixel data. When finished using a frame, call Release to return to pool.

Inheritance

Object

CameraFrame

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Microsoft.MixedReality.PhotoCapture

Assembly: cs.temp.dll.dll

Syntax

public class CameraFrame

Constructors

CameraFrame()

Ensures only pools can create frames

Declaration

protected CameraFrame()

Fields

refCount

The actual SoftwareBitmap that was returned from the camera frame.

Declaration

protected int refCount

Field Value

Type	Description
Int32

Properties

Exposure

Exposure duration in seconds for this frame

Declaration

public double Exposure { get; set; }

Property Value

Type	Description
Double

Extrinsics

Camera extrinsics (pose) for this frame

Declaration

public CameraExtrinsics Extrinsics { get; set; }

Property Value

Type	Description
CameraExtrinsics

FrameTime

Exposure start time for this frame. This is a system relative value, and all frames from a single session can be compared to this value.

Declaration

public double FrameTime { get; set; }

Property Value

Type	Description
Double

Gain

Sensor gain for this frame

Declaration

public float Gain { get; set; }

Property Value

Type	Description
Single

Intrinsics

Camera intrinsics for this frame

Declaration

public CameraIntrinsics Intrinsics { get; set; }

Property Value

Type	Description
CameraIntrinsics

PixelData

Pixel data for this frame in PixelFormat

Declaration

public byte[] PixelData { get; set; }

Property Value

Type	Description
Byte[]

PixelFormat

Pixel format of this frame

Declaration

public PixelFormat PixelFormat { get; set; }

Property Value

Type	Description
PixelFormat

RefCount

Current ref count for the frame

Declaration

public int RefCount { get; }

Property Value

Type	Description
Int32

Resolution

Resolution settings of this frame

Declaration

public CameraResolution Resolution { get; set; }

Property Value

Type	Description
CameraResolution

Methods

AddRef()

Adds a reference to the camera frame

Declaration

public virtual void AddRef()

Release()

This must be called when finished with the frame

Declaration

public virtual void Release()

Save(String)

Saves the camera frame's contents to a provided file path

Declaration

public void Save(string filePath)

Parameters

Type	Name	Description
String	filePath