JSDoc: Namespace: timeShift

Main TimeShift object.

Operation on TimeShift states such as timeShift.EnterTimeShift, timeShift.ExitTimeShift, etc. takes effect only if playback was started with solution "extTimeShift".

EnterTimeShift <static> EnterTimeShift ()

Enter TimeShift mode.

In this mode trick mode commands like pause, resume, seek is allowed.

ExitTimeShift <static> ExitTimeShift ()

Exit from TimeShift mode and return to real-time mode.

All temporary files will be removed.

ExitTimeShiftAndSave <static> ExitTimeShiftAndSave ( path, name )

Exit from TimeShift mode and save current TimeShift buffer via PVR.

Parameters:

Name	Type	Description
`path`	string	path to location where recording will be saved
`name`	string	name of the recording

ExitTimeShiftAndSaveDuration <static> ExitTimeShiftAndSaveDuration ( path, name, duration )

Exit from TimeShift, stop playback and save TimeShift buffer via PVR with possibility to continue recording.

Parameters:

Name	Type	Description
`path`	string	path to location where recording will be saved
`name`	string	name of the recording
`duration`	number	in second for how log PVR should continue to save stream into specified recording task

SetMaxDuration <static> SetMaxDuration ( duration )

Set maximum size of TimeShift window in seconds.

Parameters:

Name	Type	Description
`duration`	number	window duration in seconds

SetSlidingMode <static> SetSlidingMode ( onOff )

Set sliding TimeShift mode which defines what happens after reaching the left boundary of TimeShift buffer in paused mode.

By default sliding mode is disabled on start of each playback.

Parameters:

Name Type Description

onOff

boolean

possible values:

Value	Description
true	Slide TimeShift buffer after overflow in paused mode. `Event 36 (0x24)` will appear with code 3 in arguments. After that buffer continues writing to right boundary and drop all data from left boundary in paused mode.
false	Do not slide after buffer overflow in pause mode. `Event 36 (0x24)` will appear with code 4 in arguments. From this point we can play or seek inside current TimeShift buffer but right boundary will never grow until we switch into real-time mode.

SetTimeShiftFolder <static> SetTimeShiftFolder ( folderPath )

Set path to folder where TimeShift files will be located.

Parameters:

Name	Type	Description
`folderPath`	string	path to timeShift working folder