IMReceiver

Operates receiver objects

Methods

ReceiverChannelAdd

Adds the media sender to renderer.

Syntax

void ReceiverChannelAdd( 
   object _pSender,
   out string _pbsChannelID,
   string _bsXMLParam
)

Parameters

_pSender - sender object
_pbsChannelID - channel ID
_bsXMLParam - parameters as XML string

ReceiverChannelAddByName

Adds the media sender by its name.

Syntax

void ReceiverChannelAddByName( 
   string _bsSenderName,
   out string _pbsChannelID,
   string _bsXMLParam
)

Parameters

_bsSenderName - name of sender
_pbsChannelID - channel ID
_bsXMLParam - parameters as XML string

ReceiverChannelGetByIndex

Gets the information about sender by its index.

Syntax

void ReceiverChannelGetByIndex( 
   int _nIndex,
   out string _pbsChannelID,
   out string _pbsSenderName,
   out string _pbsTransName,
   out string _pbsXMLParam
)

Parameters

_nIndex - index of sender
_pbsChannelID - output channel ID
_pbsSenderName - output sender name
_pbsTransName - output transformed name
_pbsXMLParam - output parameters as XML string

ReceiverChannelGetCount

Gets the number of connected senders.

Syntax

void ReceiverChannelGetCount( 
   out int _pnCount
)

Parameters

_pnCount - number of connected senders

ReceiverChannelRemove

Removes the media sender.

Syntax

void ReceiverChannelRemove( 
   string _bsChannelID
)

Parameters

_bsChannelID - channel ID

ReceiverPutEOS

Puts the end of stream command to renderer. It is used when stream is no longer needed for data transmission.

Syntax

void ReceiverPutEOS( 
   string _bsChannelID,
   int _bRemoveChannel
)

Parameters

_bsChannelID - channel ID
_bRemoveChannel - "0" is to leave channel, "1" is to remove channel

ReceiverPutFlush

Puts the Flush command to renderer to reset all data in object. It used before object removing.

Syntax

void ReceiverPutFlush( 
   string _bsChannelID
)

Parameters

_bsChannelID - channel ID

ReceiverPutFrame

Puts frame to the renderer

Syntax

void ReceiverPutFrame( 
   string _bsChannelID,
   MFrame _pFrame
)

Parameters

_bsChannelID - channel ID
_pFrame - frame object