Play or pause encode queue

POST

/wp-json/wp2/media-converter/v1/queue/control

curl --request POST \
  --url https://example.com/wp-json/wp2/media-converter/v1/queue/control \
  --header 'Content-Type: application/json' \
  --header 'X-WP-Nonce: <X-WP-Nonce>' \
  --data '{ "action": "play" }'

Controls the queue: action play or pause, scope site or network. play triggers the encode_videos worker.

Authorizations

• cookie
• applicationPassword

Request Body

Media typeapplication/json

object

action

required

Command (site bulk, or queue play/pause).

string

Allowed values: play pause

scope

Queue scope: site or network.

string

default: site

Allowed values: site network

Example

{
  "action": "play"
}

Responses

200

Current queue_control value.

Media typeapplication/json

object

queue_control

Queue command after play or pause.

string

Allowed values: play pause

Example

{
  "queue_control": "play"
}

400

Invalid_action

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": {}
}

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": {}
}