Компонент Воспроизведение

Описание

Осуществляет воспроизведение аудио-файла абоненту.
Может инициировать как синхронное воспроизведение, при котором управление следующему компоненту будет передано только после окончания воспроизведения, так и фоновое воспроизведение, при котором передача управления следующему компоненту произойдет сразу после запуска воспроизведения. Управление фоновым воспроизведением допускает паузы и остановки. Возобновление воспроизведения возможно с указанной миллисекунды конкретного файла.
Поддерживается последовательное и цикличное воспроизведение случайных файлов в указанном каталоге.

Table 1. Системные характеристики

Индекс

204

Краткое название

play

Типы сценариев

IVR

Стартовый модуль

r_sip_ivr_script_component_play

Режим

Асинхронный

Иконка

204

Характер разветвления

Разветвляющий, замыкающий

Свойства

Table 2. Свойства
Спецификация Описание

Название: Слой
Код: playerId
Усл. видимости: нет
По умолчанию: "default"

Выбор слоя воспроизведения.
Слоем называется отдельный терминейшен в медиа-контексте IVR, который воспроизводит единовременно не более одного файла.
Таким образом, IVR сценарий в различных режимах воспроизведения, включающих фоновый, может одновременно воспроизводить несколько файлов – все они микшируются.

Название: Режим
Код: mode
Усл. видимости: нет
По умолчанию: Файл полностью

Выбор режима работы компонента.
Возможные варианты:

  • Файл полностью (syncPlayFile, 0) – Производит воспроизведение аудио-файла с ожиданием его завершения. Если в качестве параметров указан каталог, то производится воспроизведение случайного файла из каталога.

  • Предпрослушивание (syncPlayFileLimit, 1) – Производит воспроизведение с ожиданием его завершения и ограничением по времени воспроизведения.

  • Файл + дополнительное время (syncPlayFileExtra, 2) – Производит воспроизведение с ожиданием его завершения и ожиданием дополнительной паузы, применяемой для доввода DTMF символов.

  • Список файлов (syncPlayFiles, 7) – Производит воспроизведение последовательного списка файлов. Опционально может ожидать дополнительной паузы, применяемой для доввода DTMF символов.

  • Фоновое воспроизведение (asyncPlayStart, 3) – Добавляет слой и инициирует фоновое воспроизведение в нем, сразу передавая управление следующему компоненту. Если в указанном слое уже производится воспроизведение, то оно автоматически прерывается.

  • Остановка фона (asyncPlayStop, 4) – Производит остановку воспроизведения в указанном слое.

  • Изменить громкость фона (asyncModifyVolume, 6) – Производит изменение громкости воспроизводимого в фоне файла на указанном слое.

Название: Время, с
Код: playTimeSec
Усл. видимости: да
По умолчанию: — 

Ограничение на время воспроизведения, в секундах.
Применяется в режиме Предпрослушивание.

Название: Доп. время, с
Код: extraTimeSec
Усл. видимости: да
По умолчанию: 0

Таймаут дополнительной паузы после завершения воспроизведения, в секундах.
Применяется в режимах Файл + дополнительное время и Список файлов.

Название: Каталог
Код: folder
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий путь к каталогу.
Должен включать одну из файловых категорий.

Название: Случайно
Код: randomize
Усл. видимости: да
По умолчанию: Да

Режим случайного выбора очередного файла из каталога.
Применяется при указании в качестве источника каталога с аудио-файлами.

  • Да – в начале и при завершении воспроизведения каждого аудио-файла очередной файл выбирается случайным образом.

  • Нет – файлы воспроизводятся в порядке лексико-графической сортировки по именам.

Название: Файл
Код: file
Усл. видимости: да
По умолчанию: — 

Файл для воспроизведения.
Может быть выбран в одном из режимов:

  • статический файл, приложенный к сценарию (загружается из приложения Редактор сценариев или через API);

  • сформированный аргументами путь, который должен включать одну из файловых категорий.

Название: Потоковый файл
Код: fileCanGrow
Усл. видимости: да
По умолчанию: Нет

Режим потокового воспроизведения растущего файла.
Применяется только в режимах воспроизведения Файл полностью, Предпрослушивание, Файл + дополнительное время, Фоновое воспроизведение при воспроизведении одного конкретного файла.
Режим полезен для нужд организации потокового воспроизведения, например когда данные генерируются внешним сервисом постепенно, и их необходимо сразу отдавать в голосовой канал.

В таком режиме может воспроизводиться только WAV-файл, у которого в заголовке размер заведомо больше того объема сэмплов, которые размещены в файле.
Если воспроизведение доходит до текущего конца файла, а размер файла, указанный в WAV-заголовке не достигнут, плеер генерирует тишину.
По мере добавления сэмплов в конец файла воспроизведение продолжается.
Воспроизведение завершается тогда, когда количество воспроизведенных сэмплов из файла совпадет с указанным количеством сэмплов в Wav-заголовке.
При этом в Wav-заголовок допускается перезаписать размер, когда данные закончатся.

Возможные варианты:
* Нет – обычный режим воспроизведения.
* Да – допускается воспроизведение из растущего WAV-файла.

Название: Таймаут получения данных, мс
Код: growingTimeoutMs
Усл. видимости: да
По умолчанию: 0

При воспроизведении потокового файла с ожиданием поступления данных, в момент когда данных недостаточно, воспроизводится тишина. Чтобы завершить воспроизведение необходимо прописать в заголовок реальный размер данных.
Параметр позволяет установить предельное время в миллисекундах, когда воспроизводится тишина в ожидании поступления данных.
Значение 0 - таймаут не применяется.

Название: Файлы (JSON-список)
Код: filesArg
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий JSON-структуру в виде массива строк, каждая из которых представляет путь к файлу.
Каждый путь должен включать одну из файловых категорий.
Файлы воспроизводятся в порядке указания в списке.

Название: Зацикливать
Код: loop
Усл. видимости: да
По умолчанию: Нет

Выключение режима непрерывного зацикленного воспроизведения.
При воспроизведении через выбор каталога, всякий раз производится случайный выбор нового файла.

Название: Начало, мс
Код: startAt
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий смещение для старта воспроизведения, в миллисекундах.
Имеет смысл при незацикленном воспроизведении файла.

Название: Конец, мс
Код: stopAt
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий финальную позицию в файле, в миллисекундах.
Имеет смысл при незацикленном воспроизведении файла.

Название: Громкость (делитель)
Код: volumeDiv
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий делитель громкости воспроизведения в слое

Название: Буфер для DTMF
Код: dtmfBuffer
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения получаемых DTMF-символов.

Название: Очистить буфер DTMF
Код: clearDtmfBuffer
Усл. видимости: да
По умолчанию: Да

Выключатель предварительной очистки буфера DTMF.

Название: Количество символов
Код: maxSymbolCount
Усл. видимости: да
По умолчанию: — 

Аргумент, содержащий ограничение на количество вводимых символов.
После получения во время исполнения компонента указанного количества символов DTMF производится автоматическое завершение записи и отправка последней порции голосовых данных сервису распознавания.

Название: Символы прерывания
Код: interruptSymbols
Усл. видимости: да
По умолчанию: — 

Строка, содержащая последовательности символов прерывания через запятую.
После обнаружения на конце буфера DTMF последовательности символов, совпадающей с одной из указанных последовательностей прерывания, производится автоматическое завершение записи и отправка последней порции данных сервису распознавания.
Например, *, 7, 123, 9395.

Название: Вырезать символы прерывания
Код: clearInterrupt
Усл. видимости: да
По умолчанию: Да

Выключатель операции удаления символов прерывания из буфера DTMF после обнаружения последовательности прерывания.

Название: Переход
Код: transfer
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление при успешном завершении операции.

Название: Переход, ошибка
Код: transferError
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление в случае возникновения ошибки.

См. также