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

YandexSoundRequest extends YandexRequest
in

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

Class YandexRequest

Table of Contents

STANDARD_URL 'https://dialogs.yandex.net/api/v1/'
$skillId Идентификатор навыка, необходимый для корректного сохранения аудиофайла (Обязательный параметр). string|null
$request Отправка запроса. Request
$oauth Авторизационный токен. string|null
$error Текст с ошибкой string|null
__construct() YandexSoundRequest constructor. mixed
getSoundsUrl() Получение адреса для загрузки аудиофайлов. string
checkOutPlace() Проверить занятое место. array|null
downloadSoundFile() Загрузить аудиофайл. array|null
getLoadedSounds() Просмотр всех загруженных аудиофайлов. array|null
deleteSound() Удаление выбранного аудиофайла. string|null
deleteSounds() Удаление всех аудиофайла. bool
__construct() YandexRequest constructor. mixed
setOAuth() Установка и инициализация токена. void
call() Отправка запроса для обработки данных. mixed
log() Сохранение логов void

Constants

Properties

$skillId

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

public string|null $skillId

$oauth

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

protected string|null $oauth

$error

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

protected string|null $error

Methods

__construct()

YandexSoundRequest constructor.

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

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

$skillId : string|null = null

Идентификатор навыка.

Tags
see
  • Документация
see
  • Получение токена
Return values
mixed

getSoundsUrl()

Получение адреса для загрузки аудиофайлов.

private getSoundsUrl( ) : string
Tags
api
Return values
string

checkOutPlace()

Проверить занятое место.

public checkOutPlace( ) : array|null

Для каждого аккаунта на Яндексе действует лимит на загрузку аудиофайлов — вы можете хранить на Диалогах не больше 1 ГБ файлов. Обратите внимание, лимит учитывает размер сжатых аудиофайлов, а не размер оригиналов. Диалоги конвертируют загруженные аудиофайлы в формат OPUS и обрезают их до 120 секунд — размер этих файлов и будет учитываться в лимите.

Tags
api
throws
Return values
array|null —

[

  • int total: Все доступное место.
  • int used: Занятое место. ]

downloadSoundFile()

Загрузить аудиофайл.

public downloadSoundFile( $soundDir : string|null ) : array|null
Parameters
$soundDir : string|null

Расположение аудиофайла на сервере.

Tags
api
throws
Return values
array|null —

[

  • string id: Идентификатор аудиофайла.
  • string skillId: Идентификатор навыка.
  • int|null size: Размер файла.
  • string originalName: Название загружаемого файла.
  • string createdAt: Дата создания файла.
  • bool isProcessed: Флаг готовности файла.
  • string|null error: Текст ошибки. ]

getLoadedSounds()

Просмотр всех загруженных аудиофайлов.

public getLoadedSounds( ) : array|null
Tags
api
throws
Return values
array|null —

[ [

  • string id: Идентификатор аудиофайла.
  • string skillId: Идентификатор навыка.
  • int|null size: Размер файла.
  • string originalName: Название загружаемого файла.
  • string createdAt: Дата создания файла.
  • bool isProcessed: Флаг готовности файла.
  • string|null error: Текст ошибки. ] ]

deleteSound()

Удаление выбранного аудиофайла.

public deleteSound( $soundId : string ) : string|null

В случае успеха вернет 'ok'.

Parameters
$soundId : string

Идентификатор аудиофайла, который необходимо удалить.

Tags
api
throws
Return values
string|null

deleteSounds()

Удаление всех аудиофайла.

public deleteSounds( ) : bool

Если при удалении произошел сбой, то аудиофайл останется. Чтобы точно удалить все аудиофайлы лучше использовать грубое удаление.

Tags
api
throws
Return values
bool

__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