BitmovinApiSdk\Models\Task
Synopsis
class Task
extends BitmovinResponse
{
- // members
- public Status $status;
- public float $eta;
- public int $progress;
- public array $subtasks;
- public array $messages;
- public Carbon $createdAt;
- public Carbon $queuedAt;
- public Carbon $runningAt;
- public Carbon $finishedAt;
- public Carbon $errorAt;
- public ErrorDetails $error;
- // Inherited members from BitmovinResponse
- public string $id;
- // methods
- public void __construct()
- public $this status()
- public $this eta()
- public $this progress()
- public $this subtasks()
- public $this messages()
- public $this createdAt()
- public $this queuedAt()
- public $this runningAt()
- public $this finishedAt()
- public $this errorAt()
- public $this error()
- // Inherited methods from BitmovinResponse
- public void __construct()
- // Inherited methods from ApiResource
- public void __construct()
- public static $this create()
- public void toArray()
Hierarchy
Members
public
- $createdAt — Carbon\Carbon
- $error — BitmovinApiSdk\Models\ErrorDetails
- $errorAt — Carbon\Carbon
- $eta — float
- $finishedAt — Carbon\Carbon
- $id — string
- $messages — \BitmovinApiSdk\Models\Message[]
- $progress — int
- $queuedAt — Carbon\Carbon
- $runningAt — Carbon\Carbon
- $status — BitmovinApiSdk\Models\Status
- $subtasks — \BitmovinApiSdk\Models\Subtask[]
Methods
public
- __construct()
- createdAt() — Timestamp when the task was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- error() — Additional optional error details
- errorAt() — Timestamp when the subtask status changed to 'ERROR', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp is deprecated and is equivalent to finishedAt in case of an 'ERROR'.
- eta() — Estimated ETA in seconds
- finishedAt() — Timestamp when the subtask status changed to a final state like 'FINISHED', 'ERROR', 'CANCELED', returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Note that this timestamp might be inaccurate for tasks which ran prior to the [1.50.0 REST API release](https://bitmovin.com/docs/encoding/changelogs/rest).
- messages() — Task specific messages
- progress() — Progress in percent
- queuedAt() — Timestamp when the task status changed to \"QUEUED\", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- runningAt() — Timestamp when the task status changed to \"RUNNING\", returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
- status() — Current status (required)
- subtasks() — List of subtasks