What data is returned and how do I know what it means?
Below is a list of the elements returned in each format with a definition for each.
| XSPF (for Player) | |
| Element | Description |
| Track | A wrapper for each title. |
| Title | The title headline. |
| Type | The format of the media file. 1=video 2=audio 3=image |
| Dimensions | The dimensions of the media file in pixels. |
| Width | The width of the media file in pixels. |
| Height | The height of the media file in pixels. |
| TrackNum | In a Playlist, the track number of the title. |
| Creator | The Publisher/distributor of the content. Reflects your name. |
| Info | The Web site domain name of the Publisher. Reflects your domain name. |
| Annotation | The short description of the title. |
| Album | The category of the title. |
| Duration | The duration of the title in milliseconds. |
| Location | The HTTP address of the media file. |
| Logo | The HTTP address of the Publisher's watermark to display on top of the Flash player. |
| daysFree * | The number of days from insert date that this title may be freely viewed. |
| freeForever * | 1=Title is free forever. 0=Title is not free forever. |
| loginRequired * | 1=Title requires login. 0=Title does not require login. |
| paymentRequired * | 1=Title requires payment. 0=Title does not require payment. |
| * Values are set in VP Admin Title Manager and are available for access control logic in your login / subscription system. | |
| XML, JSON and YAML | |
| Element | Description |
| title_info | A wrapper for each title. |
| refId | A unique, random reference Id for each title. |
| id | The unique, sequential id for each title. |
| type | The format of the media file. 1=video 2=audio 3=image |
| title | The headline of the title. |
| descriptionSmall | The short description of the title. |
| descriptionFull | The long description of the title. |
| sharing | 1=title may be embedded on another site.
0=title may not be embedded on another site. |
| releaseDate | The release date of the title. |
| category | The category of the title. |
| tags | Comma-delimted list of tags assigned to the title. |
| category_name | The category of the title. |
| allowComments | 1=users may submit comments on the title. 2=users may submit comments subject to publisher review. 0=users may not submit comments |
| subPubCode | A unique id to represent the publisher. |
| notes | Internal notes of the title. |
| imageURL | The file name prefix of the thumbnail image. |
| formatsAvailable | Comma-delimited list of file formats available (e.g., flv, mov, jpg) |
| link | An optional Web link for the title. |
| linkText | The display text for the Web link. |
| dimensions | The dimensions of the media file. |
| user | The username who uploaded the title. |
| runTime | The duration of the media file. |
| insertDate | The date the title was uploaded. (e.g.: "2007-09-06 11:49:01") |
| imageURL | The file name prefix of the thumbnail image. |
| formatsAvailable | Comma-delimited list of file formats available (e.g., flv, mov, jpg) |
| cdn_images_host | The Content Delivery Network download URI of the image files. |
| cdn_host | The Content Delivery Network download URI of the video files. |
| watermark_img | The file name of the Publisher watermark logo that lays on top of the Player. |
| movieUrl | The file name prefix of the media file. |
| thumbId | The id of the thumbnail image to represent the media file. (1 - 3) |
| viewCount | The number of times the title was watched (in part or full) on the public venue. |
| name | The Publisher name. |
| credits | A wrapper for all the title's credits |
| .credit_x | A wrapper for each title credit. |
| .id | A unique id for the credit assignment |
| .title | The title of the credit. |
| .value | The value of the credit. |
| comments | A wrapper for all the title's comments. |
| .comment_x | A wrapper for each title comment. |
| .name | The username that submitted the comment. |
| .comment | The comment. |
| .vote | The vote submitted by the user. (1 - 5) |
| .timestamp | The timestamp the comment was submitted. (e.g.: "2007-09-06 11:49:01") |
| daysFree * | The number of days from insert date that this title may be freely viewed. |
| freeForever * | 1=Title is free forever. 0=Title is not free forever. |
| loginRequired * | 1=Title requires login. 0=Title does not require login. |
| paymentRequired * | 1=Title requires payment. 0=Title does not require payment. |
| * Values are set in VP Admin Title Manager and are available for access control logic in your login / subscription system. | |