Перейти к содержимому

Получить дескриптор воспроизведения вложения

GET
/wp-json/wp2/media-playback/v1/attachments/{id}
curl --request GET \
--url https://example.com/wp-json/wp2/media-playback/v1/attachments/1 \
--header 'X-WP-Nonce: <X-WP-Nonce>'

Готовый дескриптор плеера: источники, постер, дорожки субтитров/глав. Query blog_id и lang выбирают сайт и язык. Это чтение, не кодирование.

id
required
integer

Числовой идентификатор сущности.

blog_id
integer

ID сайта сети. На одиночном сайте можно не передавать.

lang
string

Язык WPML.

Дескриптор плеера (camelCase, как MediaDescriptor::to_array).

Media typeapplication/json
object
attachmentId

ID вложения.

integer
blogId

ID сайта, на котором собран дескриптор.

integer
title

Заголовок вложения.

string
poster

URL постера или null.

string
nullable
thumbnailsVtt

URL VTT спрайтов шкалы перемотки или null.

string
nullable
sources

Источники плеера.

Array<object>
object
url

URL источника (оригинал или производный формат).

string
type

MIME-тип источника.

string
width

Ширина, если известна.

integer
nullable
height

Высота, если известна.

integer
nullable
label

Подпись варианта качества.

string
nullable
format

Ключ формата кодирования.

string
nullable
tracks

Дорожки субтитров и глав.

Array<object>
object
kind

Subtitles, captions или chapters.

string
src

URL VTT/SRT.

string
srclang

Код языка дорожки.

string
label

Подпись дорожки.

string
default

Дорожка по умолчанию.

boolean
meta

Метаданные ролика из _kgvid-meta.

object
duration

Длительность ролика, секунды.

number
nullable
originalUrl

URL исходного файла в медиатеке.

string
nullable
mimeType

MIME исходного файла.

string
nullable
width

Ширина исходника.

integer
nullable
height

Высота исходника.

integer
nullable
Examplegenerated
{
"attachmentId": 1,
"blogId": 1,
"title": "example",
"poster": "example",
"thumbnailsVtt": "example",
"sources": [
{
"url": "example",
"type": "example",
"width": 1,
"height": 1,
"label": "example",
"format": "example"
}
],
"tracks": [
{
"kind": "example",
"src": "example",
"srclang": "example",
"label": "example",
"default": true
}
],
"meta": {
"duration": 1,
"originalUrl": "example",
"mimeType": "example",
"width": 1,
"height": 1
}
}

Не аутентифицирован. 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
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}

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

Media typeapplication/json
object
code

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

string
message

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

string
data

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

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

Attachment_not_found

Media typeapplication/json
object
code

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

string
message

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

string
data

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

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