Byn.Awrtc.RawFrame Interface Reference

Obosolete. Will be replaced with IFrame. It is used as a parent interface for IFrame at the moment to make it easier for the users to move their code. More...

Inheritance diagram for Byn.Awrtc.RawFrame:

Properties
byte[]	Buffer [get]
	Returns the image as byte[]. Depending on the platform this can either be a copy or a direct access to the buffer. Do not store this reference. It might be reused for further images.
bool	Buffered [get]
	True if the image is already buffered and available as byte[]. This is the default value.
int	Height [get]
	Height of the image in pixels. (before rotation is applied)
int	Width [get]
	With of the image in pixels. (before rotation is applied)
int	Rotation [get]
	Rotation of the image. Apply this rotation to the image before showing it to the user.
bool	IsTopRowFirst [get]
	If true the top row of the image will be at the start of the buffer.
FramePixelFormat	Format [get]
	Image format.

Detailed Description

Obosolete. Will be replaced with IFrame. It is used as a parent interface for IFrame at the moment to make it easier for the users to move their code.

Property Documentation

Buffer

byte [] Byn.Awrtc.RawFrame.Buffer

get

Returns the image as byte[]. Depending on the platform this can either be a copy or a direct access to the buffer. Do not store this reference. It might be reused for further images.

Implemented in Byn.Awrtc.BufferedFrame.

Buffered

bool Byn.Awrtc.RawFrame.Buffered

get

True if the image is already buffered and available as byte[]. This is the default value.

If platform specific optimization is used the value might be false meaning calling Buffer can either be slow causing the data to be copied into byte[] or even return null if accessing as byte[] isn't supported.

Implemented in Byn.Awrtc.BufferedFrame.

Format

FramePixelFormat Byn.Awrtc.RawFrame.Format

get

Image format.

Implemented in Byn.Awrtc.BufferedFrame.

Height

int Byn.Awrtc.RawFrame.Height

get

Height of the image in pixels. (before rotation is applied)

Implemented in Byn.Awrtc.BufferedFrame.

IsTopRowFirst

bool Byn.Awrtc.RawFrame.IsTopRowFirst

get

If true the top row of the image will be at the start of the buffer.

For Unity users: If this value is true the image needs to be flipped vertically as Unity expects the top row to be at the end of the buffer thus Unity will read the image up-side-down. To undo this you can set the object scaleY to -1.

Implemented in Byn.Awrtc.BufferedFrame.

Rotation

int Byn.Awrtc.RawFrame.Rotation

get

Rotation of the image. Apply this rotation to the image before showing it to the user.

Implemented in Byn.Awrtc.BufferedFrame.

Width

int Byn.Awrtc.RawFrame.Width

get

With of the image in pixels. (before rotation is applied)

Implemented in Byn.Awrtc.BufferedFrame.

---

The documentation for this interface was generated from the following file:

• /Volumes/macdev/wrtc/main_new/awrtc/awrtc_cs_common/Byn.Awrtc/RawFrame.cs