libomtnet
OMT Library for .NET
Loading...
Searching...
No Matches
libomtnet.OMTSend Class Reference
Inheritance diagram for libomtnet.OMTSend:
libomtnet.OMTSendReceiveBase libomtnet.OMTBase

Public Member Functions

 OMTSend (string name, OMTQuality quality)
 Create a new instance of the OMT Sender.
override OMTStatistics GetVideoStatistics ()
override OMTStatistics GetAudioStatistics ()
void SetSenderInformation (OMTSenderInfo senderInfo)
 Specify information to describe the Sender to any Receivers.
bool Receive (int millisecondsTimeout, ref OMTMediaFrame outFrame)
 Receive any available metadata in the buffer, or wait for metadata if empty Returns true if metadata was found, false of timed out.
int Send (OMTMediaFrame frame)
 Send a frame to any receivers currently connected. Video: Supports UYVY, YUY2, RGBA or RGBX frames Audio: Supports planar 32bit floating point audio Metadata: Supports UTF8 encoded XML.
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

int Port [get]
string Address [get]
 Discovery address in the format HOSTNAME (NAME)
string URL [get]
 Direct connection address in the format omt://hostname:port.
int Connections [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

◆ OMTSend()

libomtnet.OMTSend.OMTSend ( string name,
OMTQuality quality )

Create a new instance of the OMT Sender.

Parameters
nameSpecify the name of the source not including hostname
qualitySpecify the quality to use for video encoding. If Default, this can be automatically adjusted based on Receiver requirements.

Member Function Documentation

◆ DisposeInternal()

override void libomtnet.OMTSend.DisposeInternal ( )
protectedvirtual

Reimplemented from libomtnet.OMTBase.

◆ GetAudioStatistics()

override OMTStatistics libomtnet.OMTSend.GetAudioStatistics ( )
virtual

Reimplemented from libomtnet.OMTSendReceiveBase.

◆ GetVideoStatistics()

override OMTStatistics libomtnet.OMTSend.GetVideoStatistics ( )
virtual

Reimplemented from libomtnet.OMTSendReceiveBase.

◆ Receive()

bool libomtnet.OMTSend.Receive ( int millisecondsTimeout,
ref OMTMediaFrame outFrame )

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

Parameters
millisecondsTimeoutThe maximum time to wait for a new frame if empty
outFrameThe frame struct to fill with the received data

◆ Send()

int libomtnet.OMTSend.Send ( OMTMediaFrame frame)

Send a frame to any receivers currently connected. Video: Supports UYVY, YUY2, RGBA or RGBX frames Audio: Supports planar 32bit floating point audio Metadata: Supports UTF8 encoded XML.

Parameters
frameThe frame to send

◆ SetSenderInformation()

void libomtnet.OMTSend.SetSenderInformation ( OMTSenderInfo senderInfo)

Specify information to describe the Sender to any Receivers.

Parameters
senderInfo

Property Documentation

◆ Address

string libomtnet.OMTSend.Address
get

Discovery address in the format HOSTNAME (NAME)

◆ Connections

int libomtnet.OMTSend.Connections
get

◆ Port

int libomtnet.OMTSend.Port
get

◆ URL

string libomtnet.OMTSend.URL
get

Direct connection address in the format omt://hostname:port.


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