Operates scheduling of CG item.
Methods
ScheduleAdd
adds an item to a scheduled timeline.
Syntax
ScheduleAdd(
string _bsTimelineID,
string _bsItemOrCompositionID,
string _bsParamStringOrXMLFullDesc,
ref CG_SCHEDULE_TIMES _pTimes
)
Parameters
_bsTimelineID - ID of timeline (scheduling identificator)
_bsItemOrCompositionID - ID of item or composition
_bsParamStringOrXMLFullDesc - string with parameters or XML description
_pTimes - item schedule time structure
ScheduleBasic
sets basic schedule task without timelines.
Syntax
ScheduleBasic(
string _bsItemOrCompositionID,
int _bItem,
string _bsParamString,
ref CG_SCHEDULE_TIMES _pTimes
)
Parameters
_bsItemOrCompositionID - ID of an item or composition
_bItem - indicates whether a composition (0) or item (1) is used
_bsParamString - additional parameters
_pTimes - schedule times
ScheduleBasicCancel
cancels a basic schedule task (w/o timelines).
Syntax
ScheduleBasicCancel(
string _bsItemOrCompositionID,
int _bItem,
int _nShowHide
)
Parameters
_bsItemOrCompositionID - ID of an item or composition
_bItem - indicates whether a composition (0) or item (1) is used
_nShowHide - Show/hide composition or item:
1 - Show (Apply compositon)
-1 - Hide (Exit composition)
0 - Do nothing
ScheduleGet
Gets scheduled task info.
Syntax
ScheduleGet(
string _bsTimelineID,
int _nIndex,
out string _pbsItemOrCompositionID,
out string _pbsParamStringOrXMLFullDesc,
out CG_SCHEDULE_TIMES _pTimes
)
Parameters
_bsTimelineID - ID of timeline (scheduling identificator)
_nIndex - scheduling index
_pbsItemOrCompositionID - ID of item or composition
_pbsParamStringOrXMLFullDesc - string with parameters or XML description
_pTimes - item schedule time structure
ScheduleGetCount
Gets scheduled task info.
Syntax
ScheduleGetCount(
string _bsTimelineID,
out int _pnCount
)
Parameters
_bsTimelineID - ID of a timeline (scheduling identification)
_pnCount - number of items
ScheduleLoadFromXML
loads a scheduling from a file or a string.
Syntax
ScheduleLoadFromXML(
string _bsPathNameOrXMLDesc,
int _bRemoveAllTimelines
)
Parameters
_bsPathNameOrXMLDesc - file name or a string with configuration
_bRemoveAllTimelines - indicates whether all previous timelines are removed ("-1" to leave timeliness, "1" to remove all of them)
ScheduleRemove
removes an item from scheduling timeline.
Syntax
ScheduleRemove(
string _bsTimelineID,
int _nIndex
)
Parameters
_bsTimelineID - ID of timeline (scheduling identificator)
_nIndex - index of item
ScheduleSaveToFile
saves scheduling to a file.
Syntax
ScheduleSaveToFile(
string _bsTimelineID,
string _bsFileName,
int _bUnicode
)
Parameters
_bsTimelineID - ID of timeline (scheduling identificator)
_bsFileName - file name
_bUnicode - idicates whether output file is in Unicode ("1" is for Unicode, "-1" is for non-Unicode)
ScheduleSaveToString
saves scheduling to a string.
Syntax
ScheduleSaveToString(
string _bsTimelineID,
out string _pbsTimeLineXMLDesc
)
Parameters
_bsTimelineID - ID of timeline (scheduling identificator)
_pbsTimeLineXMLDesc - output configuration
ScheduleTimelineContinue
seeks a timeline to the position.
Syntax
ScheduleTimelineContinue(
string _bsTimelineID,
double _dblSeekTime
)
Parameters
_bsTimelineID - ID of timeline (scheduling identificator)
_dblSeekTime - position in the timeline
ScheduleTimelineGetCount
gets count of timelines.
Syntax
ScheduleTimelineGetCount(
out int _pnTimelines
)
Parameters
_pnTimelines - number of timelines
ScheduleTimelineGetID
gets timeline ID by its index.
Syntax
ScheduleTimelineGetID(
int _nIndex,
out string _pbsTimelineID
)
Parameters
_nIndex - timeline index
_pbsTimelineID - timeline ID
ScheduleTimelineGetTimes
gets time positions of scheduling.
Syntax
ScheduleTimelineGetTimes(
string _bsTimelineID,
out double _pdblTime,
out double _pdblCicleTime,
out eCG_TimelineState _ptState
)
Parameters
_bsTimelineID - ID of timeline
_pdblTime - current time
_pdblCicleTime - time for a single cicle
_ptState - state of the timeline
ScheduleTimelinePause
pauses a timeline.
Syntax
ScheduleTimelinePause(
string _bsTimelineID
)
Parameters
_bsTimelineID - ID of timeline
ScheduleTimelineStart
starts a timeline.
Syntax
ScheduleTimelineStart(
string _bsTimelineID,
double _dblStartTime,
double _dblCycleTime,
int _bStopAllOthers
)
Parameters
_bsTimelineID - ID of timeline
_dblStartTime - start time
_dblCycleTime - time for a single cicle
_bStopAllOthers - indicates whether all other timelines are stopped
ScheduleTimelineStop
stops a timeline.
Syntax
ScheduleTimelineStop(
string _bsTimelineID
)
Parameters
_bsTimelineID - ID of timeline