Class Services_Zencoder

Description

Zencoder API client interface.

Located in /Zencoder.php (line 33)

Services_Zencoder_Base
   |
   --Services_Zencoder
Class Constant Summary
USER_AGENT = 'ZencoderPHP v2.1.0'
Variable Summary
Method Summary
Services_Zencoder __construct ([string $api_key = NULL], [string $api_version = 'v2'], [string $api_host = 'https://app.zencoder.com'], [bool $debug = false])
object The createData (string $path, [ $body = ""], [array $opts = array()], array $params)
object The deleteData (string $path, [array $opts = array()], array $params)
object The retrieveData (string $path, [array $params = array()], [array $opts = array()])
object The updateData (string $path, [ $body = ""], [array $opts = array()], array $params)
Variables
Services_Zencoder_Accounts $accounts (line 57)

Provides access the Zencoder Accounts API

Valid functions: create, details, integration, live

  • access: public
Services_Zencoder_Http $http (line 42)

Contains the HTTP communication class

  • access: protected
Services_Zencoder_Inputs $inputs (line 65)

Provides access the Zencoder Inputs API

Valid functions: details, progress

  • access: public
Services_Zencoder_Jobs $jobs (line 73)

Provides access the Zencoder Jobs API

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

  • access: public
Services_Zencoder_Notifications $notifications (line 81)

Provides access the Zencoder Notifications API

Valid functions: parseIncoming

  • access: public
Services_Zencoder_Outputs $outputs (line 89)

Provides access the Zencoder Outputs API

Valid functions: details, progress

  • access: public
string $version (line 48)

Contains the default API version

  • access: protected

Inherited Variables

Inherited from Services_Zencoder_Base

Services_Zencoder_Base::$proxy
Methods
Constructor __construct (line 99)

Initialize the Services_Zencoder class and sub-classes.

  • access: public
Services_Zencoder __construct ([string $api_key = NULL], [string $api_version = 'v2'], [string $api_host = 'https://app.zencoder.com'], [bool $debug = false])
  • string $api_key: API Key
  • string $api_version: API version
  • string $api_host: API host
  • bool $debug: Enable debug mode

Redefinition of:
Services_Zencoder_Base::__construct()
createData (line 172)

POST to the resource at the specified path.

  • return: object representation of the resource
  • access: public
object The createData (string $path, [ $body = ""], [array $opts = array()], array $params)
  • string $path: Path to the resource
  • array $params: Query string parameters
  • array $opts: Optional overrides
  • $body

Redefinition of:
Services_Zencoder_Base::createData()
deleteData (line 158)

DELETE the resource at the specified path.

  • return: object representation of the resource
  • access: public
object The deleteData (string $path, [array $opts = array()], array $params)
  • string $path: Path to the resource
  • array $params: Query string parameters
  • array $opts: Optional overrides

Redefinition of:
Services_Zencoder_Base::deleteData()
retrieveData (line 140)

GET the resource at the specified path.

  • return: object representation of the resource
  • access: public
object The retrieveData (string $path, [array $params = array()], [array $opts = array()])
  • string $path: Path to the resource
  • array $params: Query string parameters
  • array $opts: Optional overrides

Redefinition of:
Services_Zencoder_Base::retrieveData()
updateData (line 195)

PUT to the resource at the specified path.

  • return: object representation of the resource
  • access: public
object The updateData (string $path, [ $body = ""], [array $opts = array()], array $params)
  • string $path: Path to the resource
  • array $params: Query string parameters
  • array $opts: Optional overrides
  • $body

Redefinition of:
Services_Zencoder_Base::updateData()

Inherited Methods

Inherited From Services_Zencoder_Base

Services_Zencoder_Base::__construct()
Services_Zencoder_Base::createData()
Services_Zencoder_Base::deleteData()
Services_Zencoder_Base::retrieveData()
Services_Zencoder_Base::updateData()
Class Constants
USER_AGENT = 'ZencoderPHP v2.1.0' (line 35)

Documentation generated on Tue, 05 Jun 2012 15:03:11 -0700 by phpDocumentor 1.4.4