IMItem

Operates items (that is playlists, breaks, schedulers, live sources, files) and commands

Methods

FileFrameGet

Gets the video frame from the specific position of file.

Syntax

void FileFrameGet( 
   double _dblPos,
   double _dblPreroll,
   out MFrame _ppFrame
)

Parameters

_dblPos - position in file from which the frame will be received
_dblPreroll - preroll value
_ppFrame - pointer to the frame

FileFrameGetByTC

Gets the video frame from the specific position of the file by timecode.

Syntax

void FileFrameGetByTC( 
   ref M_TIMECODE _pTC,
   out MFrame _ppFrame
)

Parameters

_pTC - timecode position to get frame from
_ppFrame - output frame

FileInOutGet

Get Input and Output time points of file in seconds. If Out value less than In that means that Out value is not specified and file will be played to the end.

Syntax

void FileInOutGet( 
   out double _pdblIn,
   out double _pdblOut,
   out double _pdblDuration
)

Parameters

_pdblIn - input time point of file in seconds Default value is 0. File plays from the beginning.
_pdblOut - output time point of file in seconds. Default value is 0. File plays to the end (file duration value).
_pdblDuration - duration of the file in seconds

FileInOutGetTC

Gets the in and out points as timecode. If Out point is not specified it returns last frame timecode.

Syntax

void FileInOutGetTC( 
   out M_TIMECODE _pTCIn,
   out M_TIMECODE _pTCOut,
   out int _pbOutSpecified
)

Parameters

_pTCIn - timecode In value
_pTCOut - timecode Out value
_pbOutSpecified - flag that indicates whether out point is specified

FileInOutSet

Sets the Input and Output time points of a file in seconds

Syntax

void FileInOutSet( 
   double _dblIn,
   double _dblOut
)

Parameters

_dblIn - input time point of file in seconds
_dblOut - output time point of file in seconds

FileInOutSetTC

Sets the In and Out points as timecode. If Out point is less then In point then it sets out point as timecode of the clip last frame.

Syntax

void FileInOutSetTC( 
   ref M_TIMECODE _pTCIn,
   ref M_TIMECODE _pTCOut
)

Parameters

_pTCIn - timecode of the in point
_pTCOut - timecode of the out point

FileNameGet

Gets the file name, the user properties and the file media information.

Syntax

void FileNameGet( 
   out string _pbsFile
)

Parameters

_pbsFile - full file name (including full path) and its properties

FileNameSet

Allows you to: Set file name of currently played file. Seamlessly replace currently played file to another one. Set next played file. It will be played after current file is finished. Insert break to file playback: interrupt current file playback, play another file till the end and resume current file playback. Set properties of the file.

Syntax

void FileNameSet( 
   string _bsFile,
   string _bsParam
)

Parameters

_bsFile - full file name (including full path)
_bsParam - string containing properties set by user

FilePlayPause

Pauses the playback.

Syntax

void FilePlayPause( 
   double _dblSeconds
)

Parameters

_dblSeconds - number of seconds for pause Possible values: 0 - pauses playback forever. n - pauses playback for n seconds

FilePlayStart

Starts the file playback.

Syntax

void FilePlayStart()

FilePlayStop

Stops the file playback for _dblSeconds seconds. To stop file as usual use 0 secods as parameter.

Syntax

void FilePlayStop( 
   double _dblSeconds
)

Parameters

_dblSeconds - time interval of stop in seconds

FilePosGet

Gets the current play position of file in seconds. The position is calculatid from the beginning of file without breaks and in-points.

Syntax

void FilePosGet( 
   out double _pdblFilePos
)

Parameters

_pdblFilePos - file position in seconds

FilePosGetTC

Gets the position of file as timecode. The position is calculatid from the beginning of file without breaks and in-points.

Syntax

void FilePosGetTC( 
   out M_TIMECODE _pTC
)

Parameters

_pTC - timecode of the position

FilePosSet

Sets a position of file in seconds. The position is calculatid from the beginning of file without breaks and in-points.

Syntax

void FilePosSet( 
   double _dblPos,
   double _dblPreroll
)

Parameters

_dblPos - play position of file in seconds to be set from in-point of current file
_dblPreroll - preroll value in seconds. It will be passed from the beginning of file before position set

FilePosSetTC

Sets the position in file as timecode. The position is calculatid from the beginning of file without breaks and in-points.

Syntax

void FilePosSetTC( 
   ref M_TIMECODE _pTC
)

Parameters

_pTC - timecode of the position

FileRateGet

Gets the playing rate of current file.

Syntax

void FileRateGet( 
   out double _pdblRate
)

Parameters

_pdblRate - current playing rate value. Negative value means reverse playback

FileRateSet

Sets the playing rate of current file.

Syntax

void FileRateSet( 
   double _dblRate
)

Parameters

_dblRate - current playing rate value. Negative value means reverse playback

FileStateGet

Gets the current file state.

Syntax

void FileStateGet( 
   out eMState _peState,
   out double _pdblTimeRemain
)

Parameters

_peState - state of the file
_pdblTimeRemain - time that remains for this state

ItemCommandExecute

Executes the command.

Syntax

void ItemCommandExecute( 
   object _pSourceObject
)

Parameters

_pSourceObject - source object of command

ItemCommandGet

Gets the command properties (only for command).

Syntax

void ItemCommandGet( 
   out string _pbsCommand,
   out string _pbsParam,
   out object _ppTargetObject
)

Parameters

_pbsCommand - command name
_pbsParam - parameters of command
_ppTargetObject - target object

ItemCommandSet

Sets the command properties (only for command).

Syntax

void ItemCommandSet( 
   string _bsCommand,
   string _bsParam,
   object _pTargetObject
)

Parameters

_bsCommand - command name
_bsParam - command parameters
_pTargetObject - target object

ItemInnerGet

Gets the inner object of playlist item (MFile, MLive or MPlaylist).

Syntax

void ItemInnerGet( 
   out object _ppInnerObject
)

Parameters

_ppInnerObject - inner object of playlist item

ItemPlayTimeGet

Gets the playlist item playback time including breaks.

Syntax

void ItemPlayTimeGet( 
   out double _pdblPlayTime
)

Parameters

_pdblPlayTime - playlist item playback time

ItemPosGet

Gets item position in playlist and breaks.

Syntax

void ItemPosGet( 
   out double _pdblPlayPos,
   out int _pnPlaylistIndex
)

Parameters

_pdblPlayPos - position in playlist (in seconds)
_pnPlaylistIndex - index of item

ItemStartTimeSet

Sets the absolute start time of playlist item.

Syntax

void ItemStartTimeSet( 
   ref M_DATETIME _pStartTime,
   eMStartType _eStartType
)

Parameters

_pStartTime - start time
_eStartType - start type

ItemTimesGet

Gets the absolute start and stop time of playlist item.

Syntax

void ItemTimesGet( 
   out M_DATETIME _pStartTime,
   out M_DATETIME _pStopTime,
   out eMStartType _peStartType
)

Parameters

_pStartTime - start time
_pStopTime - stop time
_peStartType - start type

ItemTypeGet

Gets the playlist item type

Syntax

void ItemTypeGet( 
   out eMItemType _peType
)

Parameters

_peType - type of the item