Release NotesUser InterfaceSystem Status
API Reference

GetQueueTime

This returns queue statistics for one or more jobs currently processing.

Request

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>GetQueueTime</action>
    <mediaid>[MediaID]</mediaid> <!-- Optional -->
</query>

{
    "query": {
        "userid": "[UserID]",
        "userkey": "[UserKey]",
        "action": "GetQueueTime",
        "mediaid": "[MediaID]"
    }
}
ParameterDescriptionAllowed ValuesDefault Value
mediaidSpecify the mediaIDs in a list.Comma separated list.None

Response

📘

Note

If there are no medias that are waiting for download or encode then request will respond with error ‘The queue is empty!’

  • If <mediaid> not specified, all medias in queue will be returned
  • <average />, <minimum />, <maximum />, and <time /> – queue time in human readable format
  • <type />
    • ‘download’ – media sources are waiting for download
    • ‘encode’ – media sources downloaded, media tasks are waiting for encode
  • <overlimit /> – ‘yes’ if processing limit exceeded
<?xml version="1.0"?>
<response>
	<size>[Queue Size]</size>
	<minimum>[Minimum Queue Time]</minimum>
	<minimumSeconds>[Minimum Queue Time in seconds]</minimumSeconds>
	<maximum>[Maximum Queue Time]</maximum>
	<maximumSeconds>[Maximum Queue Time in seconds]</maximumSeconds>
	<average>[Average Queue Time]</average>
	<averageSeconds>[Average Queue Time in seconds]</averageSeconds>
	<media>
		<id>[Media ID]</id>
        <size>[Media Queue Size]</size>
        <minimum>[Minimum Media Queue Time]</minimum>
        <minimumSeconds>[Minimum Media Queue Time in seconds]</minimumSeconds>
        <maximum>[Maximum Media Queue Time]</maximum>
        <maximumSeconds>[Maximum Media Queue Time in seconds]</maximumSeconds>
        <average>[Average Media Queue Time]</average>
        <averageSeconds>[Average Media Queue Time in seconds]</averageSeconds>
		<job>
			<id>[Task IDs]</id>
			<type>[Download|Encode]</type>
			<status>[Task Status]</status>
			<format>[Task Format]</format>
			<overlimit>[yes|no]</overlimit>
			<time>[Task Queue Time]</time>
			<timeSeconds>[Task Queue Time in seconds]</timeSeconds>
		</job>
	</media>
	<media>
		<!-- Media list -->
	</media>
</response>

{
    "response": {
        "size": "[Queue Size]",
        "minimum": "[Minimum Queue Time]",
        "minimumSeconds": "[Minimum Queue Time in seconds]",
        "maximum": "[Maximum Queue Time]",
        "maximumSeconds": "[Maximum Queue Time in seconds]",
        "average": "[Average Queue Time]",
        "averageSeconds": "[Average Queue Time in seconds]",
        "media": [
            {
                "id": "[Media ID]",
                "size": "[Media Queue Size]",
                "minimum": "[Minimum Media Queue Time]",
                "minimumSeconds": "[Minimum Media Queue Time in seconds]",
                "maximum": "[Maximum Media Queue Time]",
                "maximumSeconds": "[Maximum Media Queue Time in seconds]",
                "average": "[Average Media Queue Time]",
                "averageSeconds": "[Average Media Queue Time in seconds]",
                "job": {
                    "id": "[Task IDs]",
                    "type": "[Download|Encode]",
                    "status": "[Task Status]",
                    "format": "[Task Format]",
                    "overlimit": "[yes|no]",
                    "time": "[Task Queue Time]",
                    "timeSeconds": "[Task Queue Time in seconds]"
                }
            }
        ]
    }
}