IMStreams

Operates mixing streams

Methods

StreamsAdd

Adds a new mixer stream (file, live or playlist) or replaces the existing one with transition smoothly during the time interval.

Syntax

void StreamsAdd( 
   string _bsStreamID,
   object _pExternOrRef,
   string _bsPath,
   string _bsParam,
   out MItem _ppItem,
   double _dblTimeForChange
)

Parameters

_bsStreamID - stream ID
_pExternOrRef - reference to external object (for example, live source)
_bsPath - path to source
_bsParam - additional parameters of element (“Live” to add live source, “Playlist” to add playlist). If you add file, you can set file properties here (like in FileNameSet), see MFile object: properties.
_ppItem - the new mixer stream
_dblTimeForChange - time interval for changes in seconds

StreamsBackgroundGet

Gets the background of mixer.

Syntax

void StreamsBackgroundGet( 
   out string _pbsPath,
   out MItem _ppItemsItem
)

Parameters

_pbsPath - path to the background source
_ppItemsItem - background item

StreamsBackgroundSet

Sets the background for mixer.

Syntax

void StreamsBackgroundSet( 
   object _pExternOrRef,
   string _bsPath,
   string _bsParam,
   out MItem _ppItemsItem,
   double _dblTimeForChange
)

Parameters

_pExternOrRef - reference to external object (for example, live source)
_bsPath - path to source. Possible values: color name ("red") or #RRGGBB color code; "transparent" for transparent background; path to media file or playlist. empty string to be able to see the last frame of playlist.
_bsParam - parameters for adding
_ppItemsItem - the background item
_dblTimeForChange - time interval for changes in seconds

StreamsGet

Gets the stream by its StreamID

Syntax

void StreamsGet( 
   string _bsStreamID,
   out int _pnIndex,
   out MItem _ppStream
)

Parameters

_bsStreamID - ID of the stream
_pnIndex - index of the stream
_ppStream - stream object

StreamsGetByIndex

Gets the stream by its index.

Syntax

void StreamsGetByIndex( 
   int _nIndex,
   out string _pbsStreamID,
   out MItem _ppStream
)

Parameters

_nIndex - index of the stream
_pbsStreamID - ID of the stream
_ppStream - stream object

StreamsGetCount

Gets the count of miximg streams.

Syntax

void StreamsGetCount( 
   out int _pnCount
)

Parameters

_pnCount - number of the streams

StreamsRemove

Removes the stream.

Syntax

void StreamsRemove( 
   MItem _pStream,
   double _dblTimeForChange
)

Parameters

_pStream - stream object
_dblTimeForChange - time interval for changes in seconds

StreamsRemoveByIndex

Removes multiple streams.

Syntax

void StreamsRemoveByIndex( 
   int _nIndex,
   int _nExtraRemove,
   double _dblTimeForChange
)

Parameters

_nIndex - index of item to start remove from
_nExtraRemove - number of items to be removed Possible values: 0 - remove single stream. positive value - number of streams to be removed is calculated to the end of stream list. negative value - number or streams to be removed is calculated to the beginning of stream list. If this absolute value is greater than _nIndex then all stream list items from the very beginning will be removed.
_dblTimeForChange - time interval for changes in seconds

StreamsReorder

Changes the order of streams.

Syntax

void StreamsReorder( 
   MItem _pStream,
   int _nIndexAdd,
   double _dblTimeForChange
)

Parameters

_pStream - index of item to be changed
_nIndexAdd - index change number Possible values: positive value - position is changed in direction to end of stream list. negative value - position is changed in direction to beggining of stream list.
_dblTimeForChange - time interval for changes in seconds