Operates the schedule of MPlaylist object
Methods
SchedulerAdd
Adds a new scheduled item (file, playlist or live source) at specified time. Not implemented yet.
Syntax
void SchedulerAdd( ref M_DATETIME _pTime, object _pExternOrRef, string _bsPath, string _bsParam, out MItem _ppTask )
Parameters
_pTime - schedule time
_pExternOrRef - reference to external object (for example, live source)
_bsPath - path to item
_bsParam - additional parameters of element (“Live” to add live source, “Playlist” to add playlist)
_ppTask - output scheduled item
SchedulerCommandAdd
Adds a new command to task at specified time.
Syntax
void SchedulerCommandAdd( ref M_DATETIME _pTime, string _bsCommand, string _bsParam, object _pSourceOrTargetObject, out MItem _ppTask )
Parameters
_pTime - schedule time
_bsCommand - name of command
_bsParam - parameters of command
_pSourceOrTargetObject - source or target object
_ppTask - output scheduled item
SchedulerGetByIndex
Gets the task by its index.
Syntax
void SchedulerGetByIndex( int _nIndex, out M_DATETIME _pTime, out string _pbsCommand, out MItem _ppTask )
Parameters
_nIndex - index of task
_pTime - task start time
_pbsCommand - command name
_ppTask - MItem of task object
SchedulerGetByTime
Gets the task that is next to the specified time.
Syntax
void SchedulerGetByTime( ref M_DATETIME _pCheckTime, out M_DATETIME _pTaskTime, out string _pbsCommand, out MItem _ppTask )
Parameters
_pCheckTime - check time that is used to calculate start time of next task
_pTaskTime - start time of next task
_pbsCommand - command name
_ppTask - MItem task object
SchedulerGetCount
Gets the count of scheduled tasks.
Syntax
void SchedulerGetCount( out int _pnCount )
Parameters
_pnCount - number of scheduled tasks
SchedulerGetNext
Gets one of next tasks or all next tasks after specified index.
Syntax
void SchedulerGetNext( int _bAllTasks, int _nIndex, out M_DATETIME _pTaskTime, out string _pbsCommand, out MItem _ppTask )
Parameters
_bAllTasks - if this parameter is "1" then all scheduled items will be returned
_nIndex - index of task relative to the current item
_pTaskTime - task start time
_pbsCommand - command name of task
_ppTask - MItem scheduled object
SchedulerRemove
Removes the single task.
Syntax
void SchedulerRemove( MItem _pTask )
Parameters
_pTask - MItem scheduled object
SchedulerRemoveByIndex
Removes multiple tasks by its index.
Syntax
void SchedulerRemoveByIndex( int _nIndex, int _nExtraRemove )
Parameters
_nIndex - index of item to start remove from
_nExtraRemove - number of items to be removed Possible values: 0 - remove single item positive value - number of items to be removed is calculated to the end of playlist negative value - number or items to be removed is calculated to the beginning of playlist
SchedulerStatGet
Gets the information about task (last time of execution and number of executions).
Syntax
void SchedulerStatGet( MItem _pTask, out M_DATETIME _pTimeExecute, out int _pnExecutionCount )
Parameters
_pTask - MItem scheduled object
_pTimeExecute - last time of execution
_pnExecutionCount - number of executions