Download MPEGIO2 SDK User Manual

Input parameter chanNum: 0 ~ totalChans-1: the MPEGIO2 channel number
Input parameter splitFileSize: if not 0, set the new file size in KBytes for splitting: when current recording file size reaches
this value a new file will be split
Input parameter splitFileTime: if not 0, set the new time in minutes for splitting: when current recording time reaches this
value a new file will be split
Input parameter repeatSplitFileNum: if not 0, and parameter splitFileSize or splitFileTime is also not 0, when file split this
many times the split number appended to the original file name will reset to NULL
(the very first recording file after this reset will have no serial number appended to its file
name, the 1st split file after this reset will have 00000001 appeneded to its file name, ...)
Return true on success
Note: If both splitFileSize and splitFileTime are non-zero, recording file split could happen when either recording file size
reaches splitFileSize or recording time reaches splitFileTime.
MPEGIO2_API bool MPEGIO2_getSplitRecord(unsigned long chanNum,
unsigned long &splitFileSize,
unsigned long &splitFileTime,
unsigned long &splitFileNum,
unsigned long &repeatSplitFileNum);
Function: Get the split recording parameters for an MPEGIO2 Channel
Input parameter chanNum: 0 ~ totalChans-1: the channel number
Output parameter splitFileSize: if not 0, is the file size in KBytes for splitting: when current recording file size reaches this
value a new file will be split
Output parameter splitFileTime: if not 0, is the time in minutes for splitting: when current recording time reaches this value
a new file will be split
Output parameter splitFileNum: the numerical number to append to the file name when next split happens
Output parameter repeatSplitFileNum: if not 0, and parameter splitFileSize or splitFileTime is also not 0, when file split
this many times the split number appended to the original file name will reset to NULL
(the very first recording file after this reset will have no serial number appended to its file
name, the 1st split file after this reset will have 00000001 appeneded to its file name, ...)
Return true on success.
MPEGIO2_API bool MPEGIO2_pauseRecording(unsigned long chanNum, bool pause);
Function: Pause or resume MPEG recording(file writing) on an MPEGIO2 channel
Input parameter chanNum: 0 ~ totalChans-1: the channel number
Input parameter pause: true to pause recording, false to resume recording
Return: true for success
Note 1: this function only affects a channel's file writing during its encoding: streaming is not paused
Note 2: if the channel is not recording this function returns false
Note 3: if the channel is already pausing recording passing parameter pause == true returns true without affecting anything,
if the channel is still recording passing parameter pause == false returns true without affecting anything.
MPEGIO2_API bool MPEGIO2_isRecordingPaused(unsigned long chanNum);
Function: Test is file recording is being paused as a result of calling MPEGIO2_pauseEncoding(chanNum, true) or
calling MPEGIO2_pauseRecording(chanNum, true)
for a channel when it is in recording mode.
Input parameter chanNum: 0 ~ totalChans-1: the channel number
Returns true if the channel is being paused recording
Note: if the channel is not in recording mode this function returns false.
MPEGIO2_API bool MPEGIO2_setRecordingTimer(unsigned long chanNum,
unsigned long minutes);
Function: Set file recording timer value for a channel regardless currently it is recording or not
Input parameter chanNum: 0 ~ totalChans-1: the channel number
Input parameter minutes: recording timer in munites, 0(default) means no timer (recording only ends manually)
Returns true for success.
Note: Once set, this timer will be automatically remembered by the SDK for this channel even between SDK exit/restart
(through initFile MPEGIO2.ini)
MPEGIO2_API unsigned long MPEGIO2_getRecordingTimer(unsigned long chanNum);
Function: Get file recording timer value for a channel, regardless it is currently recording or not.
MPEGIO2 SDK User Manual
Page 71
Ver. 1.0.2