phpDocumentor » \Services_Zencoder

Zencoder API client interface.

category	Services
package	Services_Zencoder
author	Michael Christopher
version	Release: 2.1.2
license	http://creativecommons.org/licenses/MIT/MIT
link	http://github.com/zencoder/zencoder-php

Methods

__construct()

__construct(\Services_Zencoder_HttpProxy $proxy)

Inherited

inherited_from	\Services_Zencoder_Base::__construct()

Parameters

$proxy

Cancel a job

cancel(integer $job_id, array $params) : bool

Parameters

$job_id

integer

ID of the job you want to cancel

$params

array

Optional overrides

Returns

boolIf the operation was successful

Create a new job

create(array $job, array $params) : \Services_Zencoder_Job

Parameters

$job

array

Array of attributes to use when creating the job

$params

array

Optional overrides

Returns

\Services_Zencoder_JobThe object representation of the resource

createData()

createData($path, $body, array $opts)

Inherited

inherited_from	\Services_Zencoder_Base::createData()

Parameters

$path

$body

$opts

deleteData()

deleteData($path, array $opts)

Inherited

inherited_from	\Services_Zencoder_Base::deleteData()

Parameters

$path

$opts

Return details of a specific job

details(integer $job_id, array $params) : \Services_Zencoder_Job

Parameters

$job_id

integer

ID of the job you want details for

$params

array

Optional overrides

Returns

\Services_Zencoder_JobThe object representation of the resource

List all jobs on your account

index(array $args, array $params) : array

Parameters

$args

array

Array of filters to use when loading index

$params

array

Optional overrides

Returns

arrayAn array of Services_Zencoder_Job objects

Return progress of a specific job

progress(integer $job_id, array $params) : \Services_Zencoder_Progress

Parameters

$job_id

integer

ID of the job you want progress for

$params

array

Optional overrides

Returns

\Services_Zencoder_ProgressThe object representation of the resource

Resubmit a job

resubmit(integer $job_id, array $params) : bool

Parameters

$job_id

integer

ID of the job you want to resubmit

$params

array

Optional overrides

Returns

boolIf the operation was successful

retrieveData()

retrieveData($path, array $params, array $opts)

Inherited

inherited_from	\Services_Zencoder_Base::retrieveData()

Parameters

$path

$params

$opts

updateData()

updateData($path, $body, array $opts)

Inherited

inherited_from	\Services_Zencoder_Base::updateData()

Parameters

$path

$body

$opts

Properties

$proxy

Inherited

inherited_from	\Services_Zencoder_Base::$$proxy