Class Golem_Api_Video_Meta

Description

Class for accessing meta data for a video via web interface.

  • property-read: Integer $videoid: The video identifier
  • property-read: String $embeddedcode: The HTML code for the embedded videoplayer
  • property-read: String $pageurl: The URL of the video specific page on Golem.de
  • property-read: String $title: The title of the video
  • property-read: Float $playtime: The duration of the video in seconds
  • property-read: Array $medium: The data for the video in regular quality
  • property-read: String $medium['videourl']: The URL to the video file
  • property-read: Integer $medium['height']: The video height in pixel
  • property-read: Integer $medium['width']: The video width in pixel
  • property-read: Integer $medium['size']: The filesize of the video in bytes
  • property-read: String $medium['mimetype']: The mimetype of the video file
  • property-read: Array $medium['image']: The teaser image for the video
  • property-read: String $medium['image']['url']: The image URL
  • property-read: Integer $medium['image']['height']: The image height in pixel
  • property-read: Integer $medium['image']['width']: The image width in pixel
  • property-read: Array $high: The data for the video in high quality (Optional)
  • property-read: String $high['videourl']: The URL to the video file
  • property-read: Integer $high['height']: The video height in pixel
  • property-read: Integer $high['width']: The video width in pixel
  • property-read: Integer $high['size']: The filesize of the video in bytes
  • property-read: String $high['mimetype']: The mimetype of the video file
  • property-read: Array $high['image']: The teaser image for the video
  • property-read: String $high['image']['url']: The image URL
  • property-read: Integer $high['image']['height']: The image height in pixel
  • property-read: Integer $high['image']['width']: The image width in pixel
  • property-read: Array $apple: The data for the video encoded for special devices (Optional)
  • property-read: String $apple['videourl']: The URL to the video file
  • property-read: Integer $apple['height']: The video height in pixel
  • property-read: Integer $apple['width']: The video width in pixel
  • property-read: Integer $apple['size']: The filesize of the video in bytes
  • property-read: String $apple['mimetype']: The mimetype of the video file
  • property-read: Array $apple['image']: The teaser image for the video
  • property-read: String $apple['image']['url']: The image URL
  • property-read: Integer $apple['image']['height']: The image height in pixel
  • property-read: Integer $apple['image']['width']: The image width in pixel
  • author: Alexander Merz <am@golem.de>
  • copyright: 2009 Klaß&Ihlenfeld Verlag GmbH
  • link: http://api.golem.de/
  • license: BSD Licence

Located in /Api/Video/Meta.php (line 88)


	
			
Class Constant Summary
 URL = 'http://api.golem.de/api/video/meta/'
Variable Summary
Integer $idVideo
String $key
Array $video
Method Summary
Golem_Api_Video_Meta __construct (String $key, Integer $id)
Boolean fetch ([Array $curlOptions = array()])
Mixed __get (String $value)
Variables
Integer $idVideo = null (line 111)

Video identifier

  • access: protected
String $key = null (line 117)

Developer access key

  • access: protected
Array $video = array() (line 105)

Holds the meta data of a the video

  • access: protected
Methods
Constructor __construct (line 125)

Creates a Video_Meta object

  • access: public
Golem_Api_Video_Meta __construct (String $key, Integer $id)
  • String $key: the developer key
  • Integer $id: the video identifier
fetch (line 169)

Does the request to get the meta data.

If the request was succesful, true will be returned, else an exception will be thrown.

The possible Exception codes are Golem_Request::DATABASE, Golem_Api_Video_Meta::ERROR_INVALID_IDENITIFER

After a successful request the meta data is available as properties of the class instance

  • return: true, if request was successful
  • access: public
Boolean fetch ([Array $curlOptions = array()])
  • Array $curlOptions: optional options for cUrl
__get (line 140)

Accessor for a meta data value

  • return: the value
  • access: public
Mixed __get (String $value)
  • String $value: the name of the meta data value
Class Constants
ERROR_INVALID_IDENTIFIER = 32 (line 99)

Error code for an invalid video identifier

URL = 'http://api.golem.de/api/video/meta/' (line 94)

Base url of the webservice

Documentation generated on Tue, 20 Apr 2010 14:21:07 +0200 by phpDocumentor 1.4.3