phpDocumentor
Back to top  

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

Initialize the Services_Zencoder class and sub-classes.

__construct(string $api_key, string $api_version, string $api_host, bool $debug) 

Parameters

$api_key

string

API Key

$api_version

string

API version

$api_host

string

API host

$debug

bool

Enable debug mode

POST to the resource at the specified path.

createData(string $path, string $body, array $opts) : object

Parameters

$path

string

Path to the resource

$body

string

Raw body to post

$opts

array

Optional overrides

Returns

objectThe object representation of the resource

DELETE the resource at the specified path.

deleteData(string $path, array $opts) : object

Parameters

$path

string

Path to the resource

$opts

array

Optional overrides

Returns

objectThe object representation of the resource

GET the resource at the specified path.

retrieveData(string $path, array $params, array $opts) : object

Parameters

$path

string

Path to the resource

$params

array

Query string parameters

$opts

array

Optional overrides

Returns

objectThe object representation of the resource

PUT to the resource at the specified path.

updateData(string $path, string $body, array $opts) : object

Parameters

$path

string

Path to the resource

$body

string

Raw body to post

$opts

array

Optional overrides

Returns

objectThe object representation of the resource

_getApiPath() 

_getApiPath($opts) 

Parameters

$opts

_processJsonResponse() 

_processJsonResponse($status, $headers, $body) 

Parameters

$status

$headers

$body

_processResponse() 

_processResponse($response) 

Parameters

$response

 Properties

 

$accounts : \Services_Zencoder_Accounts

Valid functions: create, details, integration, live

 

$inputs : \Services_Zencoder_Inputs

Valid functions: details, progress

 

$jobs : \Services_Zencoder_Jobs

Valid functions: create, index, details, progress, resubmit, cancel

 

$notifications : \Services_Zencoder_Notifications

Valid functions: parseIncoming

 

$outputs : \Services_Zencoder_Outputs

Valid functions: details, progress

 

$http : \Services_Zencoder_Http
 

$proxy 
Inherited
inherited_from \Services_Zencoder_Base::$$proxy
 

$version : string

 Constants

 

USER_AGENT

USER_AGENT