Methods 1.1:getProgress

From Aviberry API

Contents
Other methods
Still have a question?

---

getProgress - returns detailed information about actual conversion status.
In case of a supertask, returns the status of all supertask sub-tasks.

Contents 1 Signature 2 Parameters 2.1 conversion_id 3 Return value 3.1 conversion_id 3.2 status 3.3 percent 3.4 elapsed_time 3.5 remaining_time 3.6 error_code 3.7 error_message

Signature

object getProgress(
    mixed conversion_id
)

Parameters

conversion_id

---

conversion_id - identifier or identifier array of conversion which progress is to be delivered.
Type: mixed.

Return value

Type: object.
Returns object containing matches key=value, where key is conversion identifier, and value - object containing information on conversion progress and having the following properties:

conversion_id

---

conversion_id - identifier of conversion which information is returned.
Type: string.

status

---

status - conversion status. Possible values are listed in Conversion statuses section.
Type: string.

percent

---

percent - percentage of conversion completion. Actual values are kept only for downloading, converting and uploading statuses. Possible values from 0 to 100.
Type: integer.

elapsed_time

---

elapsed_time - time in seconds from conversion start. Actual value is kept only for converting status.
Type: integer.

remaining_time

---

remaining_time - remaining time in seconds. Actual value is kept only for converting status.
Type: integer.

error_code

---

error_code - error code. Actual value is kept only for finished status.
Type: integer.

error_message

---

error_message - detailed error message. Actual value is kept only for finished status.
Type: string.

---

Contents
Other methods
Still have a question?