Assembly: GrassValley.Mseries.ScheduleEditor (in GrassValley.Mseries.ScheduleEditor.dll) Version: 1.0.0.0
Syntax
C# |
---|
void Take( string eventId, Object date, Object timecode ) |
Visual Basic (Declaration) |
---|
Sub Take ( _ eventId As String, _ date As Object, _ timecode As Object _ ) |
Visual C++ |
---|
void Take( String^ eventId, Object^ date, Object^ timecode ) |
Parameters
- eventId
- Type: System..::.String
The event id to take.
- date
- Type: System..::.Object
The start date. The format is in OleDateTime.
- timecode
- Type: System..::.Object
The start timecode. In UINT or string format ("hh:mm:ss:ff" format with length 11 only).
Remarks
If the event is currently "cued": Event Scheduler will generate a NoticeEventStop for all events in the parent chain. Event Scheduler will also generate a NoticeUpdateEvent for the taken event to show new start time and it's child events. Event Scheduler will also generate a NoticeTakeEvent for the taken event.
If the event is currently "ready": Will also generate a NoticeTakeEvent for the taken event. Will also generate a NoticeEventCued for the taken event.
If it's desired to take the event as soon as possible, pass in string.Empty to the date and startTimecode parameters. IE: Take(eventId, string.Empty, string.Empty);
If a future Follow event is Taken, it will be promoted to an Absolute event and it's (child) follow events will remain in place.
Examples
//Call helper function CreateIScheduleEditor which creates editor object IScheduleEditor schEditor = CreateIScheduleEditor(); string eventID = "some previously inserted event ID"; DateTime date = DateTime.Now.AddSeconds(6); UInt32 startTimecode = ((UInt32)date.Hour << 24) | ((UInt32)date.Minute << 16) | ((UInt32)date.Second << 8); //leaving frames at zero schEditor.Take(eventID, date, startTimecode);