libomtnet.OMTReceive Class Reference

Inheritance diagram for libomtnet.OMTReceive:

Public Member Functions
	OMTReceive (string address, OMTFrameType frameTypes, OMTPreferredVideoFormat format, OMTReceiveFlags flags)
	Create a new Receiver and begin connecting to the Sender specified by address.
override OMTStatistics	GetVideoStatistics ()
override OMTStatistics	GetAudioStatistics ()
bool	IsConnected ()
OMTSenderInfo	GetSenderInformation ()
IPEndPoint	GetRemoteEndPoint ()
int	Send (OMTMediaFrame metadata)
	Send a metadata frame to the sender. Does not support other frame types.
bool	Receive (OMTFrameType frameTypes, int millisecondsTimeout, ref OMTMediaFrame outFrame)
	Receive any available frames in the buffer, or wait for frames if empty Returns true if a frame was found, false of timed out.
void	SetTally (OMTTally tally)
void	SetFlags (OMTReceiveFlags flags)
void	SetSuggestedQuality (OMTQuality quality)
Public Member Functions inherited from libomtnet.OMTSendReceiveBase
bool	GetTally (int millisecondsTimeout, ref OMTTally tally)
	Receives the current tally state across all connections to a Sender. If this function times out, the last known tally state will be received.
Public Member Functions inherited from libomtnet.OMTBase
void	Dispose ()

Protected Member Functions
override void	DisposeInternal ()
Protected Member Functions inherited from libomtnet.OMTSendReceiveBase
override void	DisposeInternal ()
Protected Member Functions inherited from libomtnet.OMTBase
void	SetExiting ()
virtual void	Dispose (bool disposing)

Properties
string	Address [get]
Properties inherited from libomtnet.OMTBase
bool	Exiting [get]

Additional Inherited Members
Protected Attributes inherited from libomtnet.OMTSendReceiveBase
object	videoLock = new object()
object	audioLock = new object()
object	metaLock = new object()
AutoResetEvent	metadataHandle
AutoResetEvent	tallyHandle
IntPtr	lastMetadata
OMTTally	lastTally = new OMTTally()

Constructor & Destructor Documentation

OMTReceive()

libomtnet.OMTReceive.OMTReceive	(	string	address,
		OMTFrameType	frameTypes,
		OMTPreferredVideoFormat	format,
		OMTReceiveFlags	flags )

Create a new Receiver and begin connecting to the Sender specified by address.

Parameters

address	Address to connect to, either the full name provided by OMTDiscovery or a URL in the format omt://hostname:port
frameTypes	Specify the types of frames to receive, for example to setup audio only or metadata only feeds
format	Specify the preferred uncompressed video format to receive. UYVYorBGRA will only receive BGRA frames when an alpha channel is present.
flags	Specify optional flags such as requesting a Preview feed only, or including the compressed (VMX) data with each frame for further processing (or recording).

Member Function Documentation

DisposeInternal()

override void libomtnet.OMTReceive.DisposeInternal ( )

protectedvirtual

Reimplemented from libomtnet.OMTBase.

GetAudioStatistics()

override OMTStatistics libomtnet.OMTReceive.GetAudioStatistics ( )

virtual

Reimplemented from libomtnet.OMTSendReceiveBase.

GetRemoteEndPoint()

IPEndPoint libomtnet.OMTReceive.GetRemoteEndPoint

(

)

GetSenderInformation()

OMTSenderInfo libomtnet.OMTReceive.GetSenderInformation

(

)

GetVideoStatistics()

override OMTStatistics libomtnet.OMTReceive.GetVideoStatistics ( )

virtual

Reimplemented from libomtnet.OMTSendReceiveBase.

IsConnected()

bool libomtnet.OMTReceive.IsConnected

(

)

Receive()

bool libomtnet.OMTReceive.Receive	(	OMTFrameType	frameTypes,
		int	millisecondsTimeout,
		ref OMTMediaFrame	outFrame )

Receive any available frames in the buffer, or wait for frames if empty Returns true if a frame was found, false of timed out.

Parameters

frameTypes	The frame types to receive
millisecondsTimeout	The maximum time to wait for a new frame if empty
outFrame	The frame struct to fill with the received data

Send()

int libomtnet.OMTReceive.Send

(

OMTMediaFrame

metadata

)

Send a metadata frame to the sender. Does not support other frame types.

Parameters

metadata

Returns

SetFlags()

void libomtnet.OMTReceive.SetFlags

(

OMTReceiveFlags

flags

)

SetSuggestedQuality()

void libomtnet.OMTReceive.SetSuggestedQuality

(

OMTQuality

quality

)

SetTally()

void libomtnet.OMTReceive.SetTally

(

OMTTally

tally

)

Property Documentation

Address

string libomtnet.OMTReceive.Address

get

---

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

• E:/OMT Projects/libomtnet/src/OMTReceive.cs