Encode Status (REST)

Overview

The REST Web Service, located at /xml/encode_status, returns whether the server is encoding or not, and if it is encoding, the elapsed time (in seconds) of the encode.

NOTE: API Authorization Required!

Request URL

http://myserver:3000/xml/encode_status?api_key=[api_key]

NOTE: JSON response is also available by accessing xml/encode_status.json

Return

Success

A return for an active encode:

<!--?xml version="1.0" encoding="UTF-8"?-->
 
  encoding
  202

A return for no active encode:

<!--?xml version="1.0" encoding="UTF-8"?-->
 
  stopped
  0

Failure

The following is typically the result of an invalid API Key:

&lt; ?xml version="1.0" encoding="utf-8" ?&gt;
 
  Access Denied

History

Introduced
Princeton Server 3.16.0
Facebooktwittergoogle_pluslinkedin