Get encode-related settings whitelist

GET

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

curl --request GET \
  --url https://example.com/wp-json/wp2/media-converter/v1/settings \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Current allowed encode settings for the site/network (the module field whitelist).

Authorizations

• cookie
• applicationPassword

Responses

200

Media typeapplication/json

Encode-settings whitelist (GET/PATCH /settings). PHP drops keys outside this list.

object

encode

Encode preset key from the format catalog.

string

simultaneous_encodes

How many encode jobs may run at once.

integer

auto_encode

Enqueue new videos for encoding automatically.

boolean

auto_thumb

Generate thumbnails automatically.

boolean

queue_control

Play — queue is running; pause — queue is paused.

string

Allowed values: play pause

h264_profile

H.264 profile.

string

h264_level

H.264 level.

string

h264_CRF

CRF for H.264.

integer

webm_CRF

CRF for WebM.

integer

rate_control

Rate-control mode.

string

hls_time

One of:

integer

integer

string

string

audio_bitrate

Audio bitrate, kbit/s.

integer

replace_format

Format that replaces the source after encoding.

string

video_app

Encoder binary (ffmpeg, etc.).

string

app_path

Path to the encoder binary.

string

generate_thumbs

Generate posters/thumbnails during encode.

boolean

Example

{
  "queue_control": "play"
}

401

Not authenticated. WordPress REST: rest_not_logged_in / rest_forbidden. Use cookie + X-WP-Nonce or Application Password.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

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

403

Insufficient capability or invalid REST nonce. WordPress REST: rest_forbidden / rest_cookie_invalid_nonce.

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

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