TimeShiftAPI v3
Использование возможностей Timeshift
Для использования функций TimeShift необходимо:
1. Установить директорию, в которой будут храниться временные файлы с помощью функции
Достаточно это сделать один раз после старта.
2. Если необходимо, изменить максимальную длительность таймшифта с помощью функции
3. Запустить воспроизведение с солюшеном
Все действия с таймшифтом осуществляются через глобальный объект
Команда Stop или запуск другого контента на воспроизведение автоматически освобождает буфер таймшифта.
События
При воспроизведении с помощью солюшена
{"event_code":1,"ident":"TimeShift","event_data":""}
В данном случае
event_code | Описание |
---|---|
1 | запуск воспроизведения |
2 |
остановка воспроизведения |
3 |
|
4 |
При заполнении буфера таймшифта. После прихода этого события в режиме
|
5 | Приходит за 1 минуту до того как заполниться буфер таймшифта (за минуту до события 4 ) |
6 |
Приходит в процессе воспроизведения если носитель недоступен (
|
Методы объекта TimeShift
TimeShift.SetTimeShiftFolder
void SetTimeShiftFolder(string folderPath)
Устанавливает рабочую директорию для модуля
Параметры:
Параметры | Допустимые значения | Описание |
---|---|---|
folderPath | Путь для размещения файлов таймшифта |
Возвращаемое значение:
Нет.
TimeShift. SetMaxDuration
void SetMaxDuration (int duration)
Устанавливает максимальную длительность буфера таймшифта.
Параметры:
Параметры | Допустимые значения | Описание |
---|---|---|
duration | Максимальная длительность в секундах |
Возвращаемое значение:
Нет.
TimeShift.EnterTimeShift
void EnterTimeShift()
Переключиться в режим таймшифта. При этом станут доступны команды паузы и позиционирования по текущему буферу.
Параметры: Нет.
Возвращаемое значение:
Параметры | Допустимые значения | Описание |
---|---|---|
error | int | 0 – операция завершена успешно |
Замечание: Работает, только если воспроизведение запущено с солюшеном extTimeShift.
TimeShift.ExitTimeShift
void ExitTimeShift()
Выйти из режима таймшифта и переключиться в режим реалтайм. При этом буфер таймшифта не сохраняется.
Параметры:
Нет.
Возвращаемое значение:
Параметры | Допустимые значения | Описание |
---|---|---|
error | int | 0 – операция завершена успешно |
Замечание:
Работает, только если воспроизведение запущено с солюшеном extTimeShift.
TimeShift.ExitTimeShiftAndSave
void ExitTimeShiftAndSave(string name)
Выйти из режима таймшифта и переключиться в режим реалтайм. При этом текущий буфер таймшифта сохранится как задача PVR в файле со специальным расширением.
Параметры:
Параметры | Допустимые значения | Описание |
---|---|---|
name | Имя поддиректории, в которой будут сохранены все данные текущего таймшифта |
Возвращаемое значение:
Параметры | Допустимые значения | Описание |
---|---|---|
error | int | 0 – операция завершена успешно |
TimeShift. ExitTimeShiftAndSaveDuration
void ExitTimeShiftAndSaveDuration(string name, int duration)
Выйти из режима таймшифта и остановить воспроизведение. При этом текущий буфер таймшифта сохранится как задача PVR в файле со специальным расширением. Если задан параметр duration
Параметры:
Параметры | Допустимые значения | Описание |
---|---|---|
name | Имя поддиректории, в которой будут сохранены все данные текущего таймшифта. | |
duration | >= 0 | Время в секундах, в течение которого ещё необходимо сохранять поток. |
Возвращаемое значение:
Параметры | Допустимые значения | Описание |
---|---|---|
error | int | 0 – операция завершена успешно |
TimeShift. SetSlidingMode
void SetSlidingMode(bool OnOff);
Параметры:
Параметры | Допустимые значения | Описание |
---|---|---|
On/off | Если устанавливаем «TRUE», то буффер таймшифта по достижении своего придела начинает терять наиболее старые данные. |
Возвращаемое значение:
нет