Частично обновить настройки кодирования

PATCH

/wp-json/wp2/media-converter/v1/settings

curl --request PATCH \
  --url https://example.com/wp-json/wp2/media-converter/v1/settings \
  --header 'Content-Type: application/json' \
  --header 'X-WP-Nonce: <X-WP-Nonce>' \
  --data '{ "encode": "example", "simultaneous_encodes": 1, "auto_encode": true, "auto_thumb": true, "queue_control": "play", "h264_profile": "example", "h264_level": "example", "h264_CRF": 1, "webm_CRF": 1, "rate_control": "example", "hls_time": 1, "audio_bitrate": 1, "replace_format": "example", "video_app": "example", "app_path": "example", "generate_thumbs": true }'

Частично меняет настройки кодирования. Неизвестные ключи модуль отбрасывает.

Authorizations

• cookie
• applicationPassword

Request Body

Media typeapplication/json

Whitelist настроек кодирования (GET/PATCH /settings). Ключи вне списка PHP отбрасывает.

object

encode

Пресет кодирования (ключ из каталога форматов).

string

simultaneous_encodes

Сколько заданий кодировать одновременно.

integer

auto_encode

Ставить новое видео в очередь кодирования автоматически.

boolean

auto_thumb

Генерировать миниатюры автоматически.

boolean

queue_control

Play — очередь работает; pause — приостановлена.

string

Allowed values: play pause

h264_profile

Профиль H.264.

string

h264_level

Уровень H.264.

string

h264_CRF

CRF для H.264.

integer

webm_CRF

CRF для WebM.

integer

rate_control

Режим управления битрейтом.

string

hls_time

One of:

integer

integer

string

string

audio_bitrate

Битрейт аудио, кбит/с.

integer

replace_format

Формат, которым заменять исходник после кодирования.

string

video_app

Бинарник кодирования (ffmpeg и т.п.).

string

app_path

Путь к бинарнику кодирования.

string

generate_thumbs

Генерировать постеры/миниатюры при кодировании.

boolean

Responses

200

Media typeapplication/json

Whitelist настроек кодирования (GET/PATCH /settings). Ключи вне списка PHP отбрасывает.

object

encode

Пресет кодирования (ключ из каталога форматов).

string

simultaneous_encodes

Сколько заданий кодировать одновременно.

integer

auto_encode

Ставить новое видео в очередь кодирования автоматически.

boolean

auto_thumb

Генерировать миниатюры автоматически.

boolean

queue_control

Play — очередь работает; pause — приостановлена.

string

Allowed values: play pause

h264_profile

Профиль H.264.

string

h264_level

Уровень H.264.

string

h264_CRF

CRF для H.264.

integer

webm_CRF

CRF для WebM.

integer

rate_control

Режим управления битрейтом.

string

hls_time

One of:

integer

integer

string

string

audio_bitrate

Битрейт аудио, кбит/с.

integer

replace_format

Формат, которым заменять исходник после кодирования.

string

video_app

Бинарник кодирования (ffmpeg и т.п.).

string

app_path

Путь к бинарнику кодирования.

string

generate_thumbs

Генерировать постеры/миниатюры при кодировании.

boolean

Example

{
  "queue_control": "play"
}

400

Missing_fields / invalid_queue_control

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

401

Не аутентифицирован. WordPress REST: rest_not_logged_in / rest_forbidden. Cookie + X-WP-Nonce или Application Password.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

403

Нет права или невалидный REST nonce. WordPress REST: rest_forbidden / rest_cookie_invalid_nonce.

Media typeapplication/json

object

code

Машинный код ошибки или события.

string

message

Текст сообщения (лог, PIN, сброс пароля).

string

data

Дополнительные данные WP_Error или лицензии.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}