IMBreaks

Operates breaks

Methods

BreaksAdd

Adds a new break to a specific time of a playlist, file or live source.

Syntax

void BreaksAdd( 
   double _dblTime,
   object _pExternOrRef,
   string _bsPath,
   string _bsParam,
   out MItem _ppBreakItem
)

Parameters

_dblTime - break time in seconds
_pExternOrRef - reference to MItem object. When this parameter is not null then path and param values are ignored. Possible values: null - a path from _bsPath parameter is used. MItem object - MItem object is used.
_bsPath - full path of the clip
_bsParam - additional parameters
_ppBreakItem - newly created break object

BreaksCommandAdd

Adds a new break command to a specific time playlist, file or live source.

Syntax

void BreaksCommandAdd( 
   double _dblTime,
   string _bsCommand,
   string _bsParam,
   object _pTargetObject,
   out MItem _ppBreakItem
)

Parameters

_dblTime - break time in seconds
_bsCommand - command name
_bsParam - additional parameters
_pTargetObject - bject that performs the command
_ppBreakItem - newly created break item

BreaksGetByIndex

Gets the break by its index.

Syntax

void BreaksGetByIndex( 
   int _nIndex,
   out double _pdblBreakTime,
   out string _pbsPath,
   out MItem _ppBreakItem
)

Parameters

_nIndex - break index
_pdblBreakTime - break time in seconds
_pbsPath - full path to the source file
_ppBreakItem - break item object

BreaksGetCount

Gets the number of breaks in file, playlist or live source and total breaks duration.

Syntax

void BreaksGetCount( 
   out int _pnCount,
   out double _pdblTotalDuration
)

Parameters

_pnCount - a number of breaks
_pdblTotalDuration - total breaks duration in seconds

BreaksRemove

Removes the break.

Syntax

void BreaksRemove( 
   MItem _pBreakItem
)

Parameters

_pBreakItem - break item object

BreaksRemoveByIndex

Removes break by its index. This method also allows removing number of breaks by a single call.

Syntax

void BreaksRemoveByIndex( 
   int _nIndex,
   int _nExtraRemove
)

Parameters

_nIndex - break index
_nExtraRemove - a number of breaks to remove Possible values: 0 is to remove single break. 1, 2, 3 ... , n are to remove a positive number of breaks starting from current one. -1, -2, -3 ... , n is to remove a negative number of breaks starting from the current one

BreaksTimeSet

Changes the break time for a specific break.

Syntax

void BreaksTimeSet( 
   int _nIndex,
   double _dblNewTime
)

Parameters

_nIndex - break index
_dblNewTime - new break time in seconds