Contents
Get Encoding Settings - Plugixa Stream
GET /plugixa-stream/v1/admin/transcode/settings
The settings that turn an uploaded video into a multi-quality HLS stream on your own server, and what ffmpeg the server has.
Needs a user with the plugixa_stream_manage_settings capability (signed in with an Application Password or the login cookie). Administrators hold it; other roles only when you grant it.
Request
GET https://your-site.example/wp-json/plugixa-stream/v1/admin/transcode/settings
Responses
200 OK.
{
"success": true,
"data": {
"ffmpeg_path": "",
"heights": [1080, 720, 480],
"preset": "veryfast",
"auto": false,
"max_jobs": 1,
"heights_all": [2160, 1440, 1080, 720, 480, 360],
"presets": ["ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow"],
"can_paths": true,
"ffmpeg": {
"available": true,
"can_spawn": true,
"version": "6.1.1",
"path": "/usr/bin/ffmpeg"
}
}
}
| Field | Type | Meaning |
|---|---|---|
data.ffmpeg_path |
string |
A custom ffmpeg path, empty to find it |
data.heights |
integer[] |
The renditions made, by height |
data.preset |
string |
x264 preset |
data.auto |
boolean |
Encode new uploads automatically |
data.max_jobs |
integer |
Encodes at once, 1 to 4 |
data.heights_all |
integer[] |
Heights you can choose. presets lists the presets |
data.can_paths |
boolean |
The caller is a site administrator and may set ffmpeg_path |
data.ffmpeg |
object |
available, can_spawn (the server may start it), version, and path (empty unless can_paths) |
Errors
| Status | Code | When |
|---|---|---|
401 / 403 |
plugixa_stream_forbidden |
The caller lacks the capability. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-stream/v1/admin/transcode/settings" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/transcode/settings');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/admin/transcode/settings', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share