Описание класса YandexSpeechKit | Universal Bot

YandexSpeechKit extends YandexRequest
in

Класс отвечающий за преобразование текста в аудио файл.

Преобразование осуществляется через сервис Yandex SpeechKit.

Class YandexSpeechKit

Table of Contents

TTS_API_URL 'https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize'
E_GOOD 'good'
E_EVIL 'evil'
E_NEUTRAL 'neutral'
V_OKSANA 'oksana'
V_JANE 'jane'
V_OMAZH 'omazh'
V_ZAHAR 'zahar'
V_ERMIL 'ermil'
V_SILAERKAN 'silaerkan'
V_ERKANYAVAS 'erkanyavas'
V_ALYSS 'alyss'
V_NICK 'nick'
V_ALENA 'alena'
V_FILIPP 'filipp'
L_RU 'ru-RU'
L_EN 'en_EN'
L_TR 'tr-TR'
F_LPCM 'lpcm'
F_OGGOPUS 'oggopus'
$text Текст, который нужно озвучить, в кодировке UTF-8. string|null
$lang Язык. string
$voice Желаемый голос для синтеза речи из списка. Значение параметра по умолчанию: oksana. string
$emotion Эмоциональная окраска голоса. Поддерживается только при выборе русского языка (ru-RU) и голосов jane или omazh. string
$speed Скорость (темп) синтезированной речи. Для премиум-голосов временно не поддерживается. int|float
$format Формат синтезируемого аудио. string
$sampleRateHertz Частота дискретизации синтезируемого аудио. string|int|null
$folderId Идентификатор каталога, к которому у вас есть доступ. Требуется для авторизации с пользовательским аккаунтом (см. ресурс UserAccount ). Не используйте это поле, если вы делаете запрос от имени сервисного аккаунта. string|null
$request Отправка запроса. Request
$oauth Авторизационный токен. string|null
$error Текст с ошибкой string|null
__construct() YandexSpeechKit constructor. mixed
initPost() Инициализация параметров для отправки запроса. mixed
getTts() Получение голосового текста. mixed
__construct() YandexRequest constructor. mixed
setOAuth() Установка и инициализация токена. void
call() Отправка запроса для обработки данных. mixed
log() Сохранение логов void

Constants

TTS_API_URL

mixed $TTS_API_URL = 'https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize'

Properties

$text

Текст, который нужно озвучить, в кодировке UTF-8.

public string|null $text
Можно использовать только одно из полей text и ssml. Для передачи слов-омографов используйте + перед ударной гласной. Например, гот+ов или def+ect. Чтобы отметить паузу между словами, используйте -. Ограничение на длину строки: 5000 символов.

$lang

Язык.

public string $lang
Допустимые значения: ru-RU (по умолчанию) — русский язык; en-US — английский язык; tr-TR — турецкий язык.

$voice

Желаемый голос для синтеза речи из списка. Значение параметра по умолчанию: oksana.

public string $voice

$emotion

Эмоциональная окраска голоса. Поддерживается только при выборе русского языка (ru-RU) и голосов jane или omazh.

public string $emotion
Допустимые значения: good — доброжелательный; evil — злой; neutral (по умолчанию) — нейтральный.

$speed

Скорость (темп) синтезированной речи. Для премиум-голосов временно не поддерживается.

public int|float $speed
Скорость речи задается дробным числом в диапазоне от 0.1 до 3.0. Где: 3.0 — самый быстрый темп; 1.0 (по умолчанию) — средняя скорость человеческой речи; 0.1 — самый медленный темп.

$format

Формат синтезируемого аудио.

public string $format
Допустимые значения: lpcm — аудиофайл синтезируется в формате LPCM без WAV-заголовка. Характеристики аудио: Дискретизация — 8, 16 или 48 кГц в зависимости от значения параметра sampleRateHertz. Разрядность квантования — 16 бит. Порядок байтов — обратный (little-endian). Аудиоданные хранятся как знаковые числа (signed integer). oggopus (по умолчанию) — данные в аудиофайле кодируются с помощью аудиокодека OPUS и упаковываются в контейнер OGG (OggOpus).

$sampleRateHertz

Частота дискретизации синтезируемого аудио.

public string|int|null $sampleRateHertz
Применяется, если значение format равно lpcm. Допустимые значения: 48000 (по умолчанию) — частота дискретизации 48 кГц; 16000 — частота дискретизации 16 кГц; 8000 — частота дискретизации 8 кГц.

$folderId

Идентификатор каталога, к которому у вас есть доступ. Требуется для авторизации с пользовательским аккаунтом (см. ресурс UserAccount ). Не используйте это поле, если вы делаете запрос от имени сервисного аккаунта.

public string|null $folderId
Максимальная длина строки в символах — 50.

$oauth

Авторизационный токен.

protected string|null $oauth

$error

Текст с ошибкой

protected string|null $error

Methods

__construct()

YandexSpeechKit constructor.

public __construct( [ $oauth : string|null = null ] ) : mixed
Parameters
$oauth : string|null = null

Авторизационный токен для успешного получения tts.

Return values
mixed

initPost()

Инициализация параметров для отправки запроса.

protected initPost( ) : mixed
Return values
mixed

getTts()

Получение голосового текста.

public getTts( [ $text : string|null = null ] ) : mixed

Если синтез прошел успешно, в ответе будет бинарное содержимое аудиофайла. Формат выходных данных зависит от значения параметра format.

Parameters
$text : string|null = null

Текст для преобразования

Tags
throws
api
see

Смотри тут

Return values
mixed

__construct()

YandexRequest constructor.

public __construct( [ $oauth : string|null = null ] ) : mixed
Parameters
$oauth : string|null = null

Авторизационный токен для загрузки данных.

Return values
mixed

setOAuth()

Установка и инициализация токена.

public setOAuth( $oauth : string|null ) : void
Parameters
$oauth : string|null

Авторизационный токен для загрузки данных.

Tags
api

call()

Отправка запроса для обработки данных.

public call( [ $url : string|null = null ] ) : mixed
Parameters
$url : string|null = null

Адрес запроса.

Tags
api
throws
Return values
mixed

log()

Сохранение логов

protected log( $error : string ) : void
Parameters
$error : string

Текст ошибки

Tags
throws
api

Search results