Difference between revisions of "CDN API Documentation"

From Sirikata Wiki
Jump to: navigation, search
(Created page with "==Retrieving Single Model Info== * /api/modelinfo/ ==Browsing the CDN== * /api/browse ==Uploading== * /api/upload ==Upload Status== * /upload/processing")
 
Line 1: Line 1:
 +
==Model URLs==
 +
The URL for a model consists of:
 +
meerkat://[HOSTNAME]BASENAME/FORMAT[/VERSION]
 +
 +
Where:
 +
* BASENAME = The user-chosen path for the model, e.g. /jterrace/duck.dae
 +
* HOSTNAME = Address of the CDN server. If not specified, the OH client defaults to open3dhub.com
 +
* FORMAT = One of the CDN formats. Currently supported are "priginal", "pptimized" and "progressive".
 +
* VERSION = The version number of the model. If not specified, the latest version is returned by the CDN.
 +
 +
===Examples===
 +
* Returns the latest version of optimized format:
 +
meerkat:///jterrace/models/plantbox.dae/optimized/plantbox.dae
 +
* Returns progressive format, version 0:
 +
meerkat:///jterrace/models/plantbox.dae/progressive/0/plantbox.dae
 +
 +
===Note===
 +
The filename at the end of the URL is technically optional, but the OH won't pick up dependent files, like textures, without it.
 +
 
==Retrieving Single Model Info==
 
==Retrieving Single Model Info==
 
* /api/modelinfo/
 
* /api/modelinfo/

Revision as of 19:25, 31 January 2012

Model URLs

The URL for a model consists of:

meerkat://[HOSTNAME]BASENAME/FORMAT[/VERSION]

Where:

  • BASENAME = The user-chosen path for the model, e.g. /jterrace/duck.dae
  • HOSTNAME = Address of the CDN server. If not specified, the OH client defaults to open3dhub.com
  • FORMAT = One of the CDN formats. Currently supported are "priginal", "pptimized" and "progressive".
  • VERSION = The version number of the model. If not specified, the latest version is returned by the CDN.

Examples

  • Returns the latest version of optimized format:
meerkat:///jterrace/models/plantbox.dae/optimized/plantbox.dae
  • Returns progressive format, version 0:
meerkat:///jterrace/models/plantbox.dae/progressive/0/plantbox.dae

Note

The filename at the end of the URL is technically optional, but the OH won't pick up dependent files, like textures, without it.

Retrieving Single Model Info

  • /api/modelinfo/

Browsing the CDN

  • /api/browse

Uploading

  • /api/upload

Upload Status

  • /upload/processing