Golem.de API

Golem  alpha

Golem.de API > Golem > Golem.Api.Video.Meta
Search:
 
Filters

Class Golem.Api.Video.Meta - extends Golem.Api

Fetches the meta data of a video via Golem.de web interface

Constructor

Golem.Api.Video.Meta ( idVideo )
Parameters:
idVideo <Integer> - Video identifier

Properties

ERROR_INVALID_IDENTIFER - {Integer}

Indicates a missing or invalid video identifier

fetchDone - protected {Boolean}

Marks the video data is populated

idVideo - protected {Integer}

The video identifier

TYPE - protected {String}

The type of access method for the web service

URL - protected {String}

The URL of the used web service

Methods

fetch

void fetch ( obj )
Fetches the video meta data via web service

In case of a successful request, the obj.fnSuccess-callback function will be called. The first argument for the callback method is the result data of the request. The second argument will be the data provided by obj.params.

In case of a failed request, the obj.fnError callback function will be called. The first argument to the callback is the error code, the second ist the error message.

Parameters:
obj <Object> - Object literal specifing the callback methods
Returns: void

getValue

Mixed getValue ( key )
Returns the value of the meta data.

Available values are:

  • videoid - {Integer} - The video identifier
  • embeddedcode - {String} - The HTML code for the embedded videoplayer
  • pageurl - {String} - The URL of the video specific page on Golem.de
  • title - {String} - The title of the video
  • playtime - {Float} - The duration of the video in seconds
  • medium - {Object} - The data for the video in regular quality
    • videourl - {String} - The URL to the video file
    • width - {Integer} - The video width in pixel
    • height - {Integer} - The video height in pixel
    • size - {Integer} - The filesize of the video in bytes
    • mimetype - {String} - The mimetype of the video file
    • image - {Object} - The teaser image for the video
      • url - {String} - The image URL
      • width - {Integer} - The image width in pixel
      • height - {Integer} - The image height in pixel
  • high - {Object} - The data for the video in high quality (Optional)
    • videourl - {String} - The URL to the video file
    • width - {Integer} - The video width in pixel
    • height - {Integer} - The video height in pixel
    • size - {Integer} - The filesize of the video in bytes
    • mimetype - {String} - The mimetype of the video file
    • image - {Object} - The teaser image for the video
      • url - {String} - The image URL
      • width - {Integer} - The image width in pixel
      • height - {Integer} - The image height in pixel
  • apple - {Object} - The data for the video encoded for special devices (Optional)
    • videourl - {String} - The URL to the video file
    • width - {Integer} - The video width in pixel
    • height - {Integer} - The video height in pixel
    • size - {Integer} - The filesize of the video in bytes
    • mimetype - {String} - The mimetype of the video file
    • image - {Object} - The teaser image for the video
      • url - {String} - The image URL
      • width - {Integer} - The image width in pixel
      • height - {Integer} - The image height in pixel

If you ask for a keyword, that does not exists, the method returns undefined

Parameters:
key <String> - one of the value names
Returns: Mixed
the value or undefined


Copyright © 2010 Golem.de.