libomtnet
OMT Library for .NET
Loading...
Searching...
No Matches
libomtnet.OMTMediaFrame Struct Reference

Stores one frame of Video, Audio or Metadata. More...

Static Public Member Functions

static IntPtr ToIntPtr (OMTMediaFrame frame)
static void FreeIntPtr (IntPtr ptr)
static OMTMediaFrame FromIntPtr (IntPtr ptr)

Public Attributes

OMTFrameType Type
long Timestamp
 This is a timestamp where 1 second = 10,000,000 A special value of -1 can be specified to tell the Sender to generate timestamps and throttle as required to maintain the specified FrameRate or SampleRate of the frame.
int Codec
 Sending: Video: 'UYVY', 'YUY2', 'NV12', 'YV12, 'BGRA', 'VMX1' are supported (BGRA will be treated as BGRX where alpha flags are not set) Audio: Only 'FPA1' is supported (32bit floating point planar audio) Receiving: Video: Only 'UYVY', 'BGRA' and 'BGRX' are supported Audio: Only 'FPA1' is supported (32bit floating point planar audio)
int Width
int Height
int Stride
OMTVideoFlags Flags
int FrameRateN
 Frame Rate Numerator/Denominator in Frames Per Second, for example Numerator 60 and Denominator 1 is 60 frames per second.
int FrameRateD
float AspectRatio
 Display aspect ratio expressed as a ratio of width/height. For example 1.777777777777778 for 16/9.
OMTColorSpace ColorSpace
 Color space of the frame. If undefined a height < 720 is BT601 and everything else BT709.
int SampleRate
int Channels
int SamplesPerChannel
IntPtr Data
 Video: Uncompressed pixel data Audio: Planar 32bit floating point audio Metadata: UTF-8 encoded XML string with terminating null character.
int DataLength
 Video: Number of bytes total including stride Audio: Number of bytes (SamplesPerChannel * Channels * 4) Metadata: Number of bytes in UTF-8 encoded string + 1 for terminating null character.
IntPtr CompressedData
 Receive only. Use standard Data/DataLength if sending VMX1 frames with a Sender If IncludeCompressed OMTReceiveFlags is set, this will include the original compressed video frame in VMX1 format. This could then be muxed into an AVI or MOV file using FFmpeg or similar APIs.
int CompressedLength

Properties

float FrameRate [get, set]

Detailed Description

Stores one frame of Video, Audio or Metadata.

Member Function Documentation

◆ FreeIntPtr()

void libomtnet.OMTMediaFrame.FreeIntPtr ( IntPtr ptr)
static

◆ FromIntPtr()

OMTMediaFrame libomtnet.OMTMediaFrame.FromIntPtr ( IntPtr ptr)
static

◆ ToIntPtr()

IntPtr libomtnet.OMTMediaFrame.ToIntPtr ( OMTMediaFrame frame)
static

Member Data Documentation

◆ AspectRatio

float libomtnet.OMTMediaFrame.AspectRatio

Display aspect ratio expressed as a ratio of width/height. For example 1.777777777777778 for 16/9.

◆ Channels

int libomtnet.OMTMediaFrame.Channels

◆ Codec

int libomtnet.OMTMediaFrame.Codec

Sending: Video: 'UYVY', 'YUY2', 'NV12', 'YV12, 'BGRA', 'VMX1' are supported (BGRA will be treated as BGRX where alpha flags are not set) Audio: Only 'FPA1' is supported (32bit floating point planar audio) Receiving: Video: Only 'UYVY', 'BGRA' and 'BGRX' are supported Audio: Only 'FPA1' is supported (32bit floating point planar audio)

◆ ColorSpace

OMTColorSpace libomtnet.OMTMediaFrame.ColorSpace

Color space of the frame. If undefined a height < 720 is BT601 and everything else BT709.

◆ CompressedData

IntPtr libomtnet.OMTMediaFrame.CompressedData

Receive only. Use standard Data/DataLength if sending VMX1 frames with a Sender If IncludeCompressed OMTReceiveFlags is set, this will include the original compressed video frame in VMX1 format. This could then be muxed into an AVI or MOV file using FFmpeg or similar APIs.

◆ CompressedLength

int libomtnet.OMTMediaFrame.CompressedLength

◆ Data

IntPtr libomtnet.OMTMediaFrame.Data

Video: Uncompressed pixel data Audio: Planar 32bit floating point audio Metadata: UTF-8 encoded XML string with terminating null character.

◆ DataLength

int libomtnet.OMTMediaFrame.DataLength

Video: Number of bytes total including stride Audio: Number of bytes (SamplesPerChannel * Channels * 4) Metadata: Number of bytes in UTF-8 encoded string + 1 for terminating null character.

◆ Flags

OMTVideoFlags libomtnet.OMTMediaFrame.Flags

◆ FrameRateD

int libomtnet.OMTMediaFrame.FrameRateD

◆ FrameRateN

int libomtnet.OMTMediaFrame.FrameRateN

Frame Rate Numerator/Denominator in Frames Per Second, for example Numerator 60 and Denominator 1 is 60 frames per second.

◆ Height

int libomtnet.OMTMediaFrame.Height

◆ SampleRate

int libomtnet.OMTMediaFrame.SampleRate

◆ SamplesPerChannel

int libomtnet.OMTMediaFrame.SamplesPerChannel

◆ Stride

int libomtnet.OMTMediaFrame.Stride

◆ Timestamp

long libomtnet.OMTMediaFrame.Timestamp

This is a timestamp where 1 second = 10,000,000 A special value of -1 can be specified to tell the Sender to generate timestamps and throttle as required to maintain the specified FrameRate or SampleRate of the frame.

◆ Type

OMTFrameType libomtnet.OMTMediaFrame.Type

◆ Width

int libomtnet.OMTMediaFrame.Width

Property Documentation

◆ FrameRate

float libomtnet.OMTMediaFrame.FrameRate
getset
The documentation for this struct was generated from the following file: