Forgot Password
Please enter your email address.
Email address:
You found your password? Login here.
Send
Cancel
Please Login
Don't have an account? Register here.
Email address:
Password
I forgot my password!
Login
Cancel
Create Account
Please fill the fields below:
Email address:
Password
Retype Password
Security Code
I agree with Terms & Conditions



Already have an account? Login here.
Register
Cancel
VP Factory API Developer's Guide

Introduction to VP Factory and the benefits of API

VP Factory provides a lightweight video platform that can be easily integrated into websites, blogs and popular social networks, making it very easy to publish and manage video content.

Using the VP Factory API, developers are able to build powerful video solutions based on the platform.

To find out how to get an API key please read this.

Getting Started with Videos

Get All Videos

This section explains how to retrieve an XML containing all of the videos uploaded by a specific user.

Obtaining a request token

To retrieve information about all videos, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey 

http://www.vpfactory.com/api/getAllVideos/?key=[yourKey]
Parameter Description
yourKey* This value specifies your APIkey

* Required parameters

About the response

The getAllVideos return an XML document.

The following XML shows the format of a VP Factory Data API response containing all videos:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<videos>
  <video>
    <id>idOfVideo</id>
    <path>pathToYourVideo</path>
    <title><![CDATA[titleOfVideo]]></title>
    <description>descriptionOfVideo</description>
    <duration>durationOfVideo</duration>
    <codec>codecOfVideo</codec>
    <bitrate>bitrateOfVideo</bitrate>
    <audio>audioOfVideo</audio>
    <width>widthOfVideo</width>
    <height>heightOfVideo</height>
    <size>sizeOfVideo</size>
    <encoded>encodedNumber</encoded>
    <created>createdVideo</created>
    <mdid>mdidOfVideo</mdid>
    <thumbSmall>thumbSmallOfVideo</thumbSmall>
    <thumbBig>thumbBigOfVideo</thumbBig>
  </video>
  <video>
  	...
  </video>
</videos>

The explanation of the results:

Parameter Description
idOfVideo id of video
pathToYourVideo Path to your video
titleOfVideo Title of video
descriptionOfVideo Description of video
durationOfVideo Duration of video in seconds
codecOfVideo Codec of video
bitrateOfVideo Bit rate of video
audioOfVideo Audio of video
widthOfVideo Width of video in pixels
heightOfVideo Height of viode in pixels
sizeOfVideo Size of video
encodedNumber 0 - video not encoded
1 - video encoded
createdVideo Timestamp of video created
mdidOfVideo A secondary video ID used to integrate the video content into our player
thumbSmallOfVideo Path leading to a small thumbnail of the video
thumbBigOfVideo Path leading to a bigger thumbnail of the video

Get Video

This section explains how to retrieve an entry containing information about a specific video.

Obtaining a request token

To retrieve information about a specific video, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text: - [yourKey] with your VP Factory APIkey - [videoid] with video id 

http://www.vpfactory.com/api/getVideo/?key=[yourKey]&videoid=[videoid]
Parameter Description
yourKey* This value specifies your APIkey
videoid* This value specifies video id

* Required parameters

About the response

The getVideo return an XML document.

The following XML shows the format of a VP Factory Data API response containing information about a specific video:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to get specified video.</value>
</result>

if [videoid] is wrong.

or

<video>
  <id>idOfVideo</id>
  <path>pathToYourVideo</path>
  <title><![CDATA[titleOfVideo]]></title>
  <description>descriptionOfVideo</description>
  <duration>durationOfVideo</duration>
  <codec>codecOfVideo</codec>
  <bitrate>bitrateOfVideo</bitrate>
  <audio>audioOfVideo</audio>
  <width>widthOfVideo</width>
  <height>heightOfVideo</height>
  <size>sizeOfVideo</size>
  <encoded>encodedNumber</encoded>
  <created>createdVideo</created>
  <mdid>mdidOfVideo</mdid>
  <thumbSmall>thumbSmallOfVideo</thumbSmall>
  <thumbBig>thumbBigOfVideo</thumbBig>
</video>

The explanation of the results:

Parameter Description
idOfVideo id of video
pathToYourVideo Path to your video
titleOfVideo Title of video
descriptionOfVideo Description of video
durationOfVideo Duration of video in seconds
codecOfVideo Codec of video
bitrateOfVideo Bit rate of video
audioOfVideo Audio of video
widthOfVideo Width of video in pixels
heightOfVideo Height of viode in pixels
sizeOfVideo Size of video
encodedNumber 0 - video not encoded
1 - video encoded
createdVideo Timestamp of video created
mdidOfVideo A secondary video ID used to integrate the video content into our player
thumbSmallOfVideo Path leading to a small thumbnail of the video
thumbBigOfVideo Path leading to a bigger thumbnail of the video

Edit Video

This section explains how to edit a specific video.

Obtaining a request token

To edit the title of a specific video, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [videoid] with video id
- [newTitle] with the new title 

http://www.vpfactory.com/api/editVideo/?key=[yourKey]&videoid=[videoid]&title=[newTitle]
Parameter Description
yourKey* This value specifies your APIkey
videoid* This value specifies video id
newTitle* This value specifies new title for a specific video

* Required parameters

About the response

The editVideo return an XML document.

The following XML shows the format of a VP Factory Data API response containing information about a specific video:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to edit the specified video.</value>
</result>

if [videoid] is wrong.

The successful response is identical with the previous response for the "Get Video" function.

Relocate Hosted Video

This section explains how to relocate hosted video.

Obtaining a request token

To relocate hosted for a specific video, you can submit an HTTP POST or GET form request to the following URL.
Note: The form must contain a <input type="file" name="Filedata"/>
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [videoid] with video id

http://www.vpfactory.com/api/relocateHostedVideo/?key=[yourKey]&videoid=[videoid]
Parameter Description
yourKey* This value specifies your APIkey
videoid* This value specifies video id
newFile* This value specifies new file to upload

* Required parameters

About the response

The relocateHostedVideo return an XML document.

The following XML shows the format of a VP Factory Data API response containing information about a specific video:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to relocate the specified video.</value>
</result>

if [videoid] is wrong.

or

<result>
  <type>error</type>
  <value>ERROR: Your upload input must be named "Filedata".</value>
</result>

if the name of input is not "Filedata".

or

<result>
  <type>error</type>
  <value>ERROR: You don't have enough space to upload this file.</value>
</result>

or

<result>
  <type>error</type>
  <value>ERROR: You don't have enough bandwidth to upload this file.</value>
</result>

The successful response is identical with the previous response for the "Get Video" function.

Relocate URL Video

This section explains how to relocate URL video.

Obtaining a request token

To realocate URL for a specific video, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [videoid] with video id
- [newURL] with the new URL for the video 

http://www.vpfactory.com/api/relocateURLVideo/?key=[yourKey]&videoid=[videoid]&url=[newURL]
Parameter Description
yourKey* This value specifies your APIkey
videoid* This value specifies video id
newURL* This value specifies the new URL of a specific video

* Required parameters

About the response

The relocateURLVideo return an XML document.

The following XML shows the format of a VP Factory Data API response containing information about a specific video:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>The specified video could not be relocated.</value>
</result>

if [videoid] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to relocate the specified video.</value>
</result>

The successful response is identical with the previous response for the "Get Video" function.

Delete Video

This section explains how to delete a specific video.

Obtaining a request token

To delete a specific video, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [videoid] with video id

http://www.vpfactory.com/api/deleteVideo/?key=[yourKey]&videoid=[videoid]
Parameter Description
yourKey* This value specifies your APIkey
videoid* This value specifies video id

* Required parameters

About the response

The deleteVideo return an XML document.

The following XML shows the format of a VP Factory Data API response:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to delete video.</value>
</result>

if [videoid] is wrong.

or

<result>
  <type>success</type>
  <value>Video deleted</value>
</result>

if the video was deleted.

Add URL Video

This section explains how to add URL video.

Obtaining a request token

To add URL video, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [URL] with the URL for the video 

http://www.vpfactory.com/api/addURLVideo/?key=[yourKey]&path=[URL]
Parameter Description
yourKey* This value specifies your APIkey
URL* This value specifies the URL of a specific video

* Required parameters

About the response

The addURLVideo return an XML document.

The following XML shows the format of a VP Factory Data API response containing information about a specific video:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to process the specified video.</value>
</result>

The specified video could not processed.

The successful response is identical with the previous response for the "Get Video" function.

Add Hosted Video

This section explains how to add hosted video.

Obtaining a request token

To upload a specific video to our servers, you can submit an HTTP POST or GET form request to the following URL.
Note: The form must contain a <input type="file" name="Filedata"/>
You need to replace the text:
- [yourKey] with your VP Factory APIkey

http://www.vpfactory.com/api/addHostedVideo/?key=[yourKey]
Parameter Description
yourKey* This value specifies your APIkey
file* This value specifies new file to upload

* Required parameters

About the response

The addHostedVideo return an XML document.

The following XML shows the format of a VP Factory Data API response containing information about a specific video:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to process the specified video.</value>
</result>

if a problem occurred while uploading and encoding your video.

or

<result>
  <type>error</type>
  <value>ERROR: Your upload input must be named "Filedata".</value>
</result>

or

<result>
  <type>error</type>
  <value>ERROR: You don't have enough space to upload this file.</value>
</result>

or

<result>
  <type>error</type>
  <value>ERROR: You don't have enough bandwidth to upload this file.</value>
</result>

The successful response is identical with the previous response for the "Get Video" function.

Getting Started with Playlists

Get All Playlists

This section explains how to retrieve an XML containing all of the playlists created by a specific user.

Obtaining a request token

To retrieve information about all playlists, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey 

http://www.vpfactory.com/api/getAllPlaylists/?key=[yourKey]
Parameter Description
yourKey* This value specifies your APIkey

* Required parameters

About the response

The getAllPlaylists return an XML document.

The following XML shows the format of a VP Factory Data API response containing all playlists:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<playlists>
  <playlist>
    <id>playlistID</id>
    <name>name</name>
    <videos>
      <video>videoid</video>
      <video>...</video>
      ...
    </videos>
    <thumbSmall>thumbSmallOfPlaylist</thumbSmall>
    <thumbBig>thumbBigOfPlaylist</thumbBig>
  </playlist>
  <playlist>
  	...
  </playlist>
</playlists>

The explanation of the results:

Parameter Description
playlistID The playlist id
videoid id of video
thumbSmallOfPlaylist Path leading to a small thumbnail of the first video in the playlist
thumbBigOfPlaylist Path leading to a bigger thumbnail of the first video in the playlist

Get Playlist

This section explains how to retrieve an entry containing information about a specific playlist.

Obtaining a request token

To retrieve information about a specific playlist, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text: - [yourKey] with your VP Factory APIkey - [playlistID] with playlist id 

http://www.vpfactory.com/api/getPlaylist/?key=[yourKey]&playlistid=[playlistID]
Parameter Description
yourKey* This value specifies your APIkey
playlistID* This value specifies playlist id

* Required parameters

About the response

The getPlaylist return an XML document.

The following XML shows the format of a VP Factory Data API response:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to get the specified playlist.</value>
</result>

if [playlistID] is wrong.

or

<playlist>
  <id>playlistID</id>
  <name>name</name>
  <videos>
    <video>videoid</video>
    <video>...</video>
    ...
  </videos>
  <thumbSmall>thumbSmallOfPlaylist</thumbSmall>
  <thumbBig>thumbBigOfPlaylist</thumbBig>	
</playlist>

The explanation of the results:

Parameter Description
playlistID The playlist id
videoid id of video
thumbSmallOfPlaylist Path leading to a small thumbnail of the first video in the playlist
thumbBigOfPlaylist Path leading to a bigger thumbnail of the first video in the playlist

Edit Playlist

This section explains how to edit a specific playlist.

Obtaining a request token

To edit the title of a specific playlist, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [playlistID] with playlist id
- [newTitle] with the new title 

http://www.vpfactory.com/api/editPlaylist/?key=[yourKey]&playlistid=[playlistID]&title=[newTitle]
Parameter Description
yourKey* This value specifies your APIkey
playlistID* This value specifies playlist id
newTitle* This value specifies new title for a specific playlist

* Required parameters

About the response

The editPlaylist return an XML document.

The following XML shows the format of a VP Factory Data API response:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to edit the specified playlist.</value>
</result>

if [playlistID] is wrong.

The successful response is identical with the previous response for the "Get Playlist" function.

Delete Playlist

This section explains how to delete a specific playlist.

Obtaining a request token

To delete a specific playlist, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [playlistID] with playlist id

http://www.vpfactory.com/api/deletePlaylist/?key=[yourKey]&playlistid=[playlistID]
Parameter Description
yourKey* This value specifies your APIkey
playlistID* This value specifies playlist id

* Required parameters

About the response

The deletePlaylist return an XML document.

The following XML shows the format of a VP Factory Data API response:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to delete playlist.</value>
</result>

if [playlistID] is wrong.

or

<result>
  <type>success</type>
  <value>Playlist deleted</value>
</result>

Create Playlist

This section explains how to create a playlist.

Obtaining a request token

To create a playlist, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [title] with the playlist title
- [videos] with the ids of videos comma separated 

http://www.vpfactory.com/api/createPlaylist/?key=[yourKey]&title=[title]&videos=[videos]
Parameter Description
yourKey* This value specifies your APIkey
title* This value specifies playlist's title
videos* This value specifies the ids of videos comma separated

* Required parameters

About the response

The createPlaylist return an XML document.

The following XML shows the format of a VP Factory Data API response:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to create the specified playlist.</value>
</result>

if [playlistID] is wrong.

The successful response is identical with the previous response for the "Get Playlist" function.

Getting Started with Player

Get All Players

This section explains how to retrieve an XML containing all of the players created by a specific user.

Obtaining a request token

To retrieve information about all players, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey 

http://www.vpfactory.com/api/getAllPlayers/?key=[yourKey]
Parameter Description
yourKey* This value specifies your APIkey

* Required parameters

About the response

The getAllPlayers return an XML document.

The following XML shows the format of a VP Factory Data API response containing all players:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<players>
  <player>
    <id>playerID</id>
    <name>name</name>
    <description>description</description>
    <date>date</date>
    <located>located</located>
    <created>created</created>
    <status>status</status>
    <skin>skin</skin>
    <playlists>
      <playlist>playlistID</playlist>
      <playlist>...</playlist>
      ...
    </playlists>
    <videos>
      <video>videoID</video>
      <video>...</video>
      ...
    </videos>
    <thumbSmall>thumbSmallOfPlayer</thumbSmall>
    <thumbBig>thumbBigOfPlayer</thumbBig>		
  </player>
  <player>
  	...
  </player>
</players>

The explanation of the results:

Parameter Description
playerID The player id
name The name of player
description The description of player
date The date in format yyyy-mm-dd
located
created
status The status of the player (published, not published)
playlistID The playlist id
videoID id of video
thumbSmallOfPlayer Path leading to a small thumbnail of the first video in the player
thumbBigOfPlayer Path leading to a big thumbnail of the first video in the player

Get Player

This section explains how to retrieve an entry containing information about a specific player.

Obtaining a request token

To retrieve information about a specific player, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text: - [yourKey] with your VP Factory APIkey - [playerid] with playerid 

http://www.vpfactory.com/api/getPlayer/?key=[yourKey]&playerid=[playerid]
Parameter Description
yourKey* This value specifies your APIkey
playerid* This value specifies player id

* Required parameters

About the response

The getPlayer return an XML document.

The following XML shows the format of a VP Factory Data API response containing a specific player:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to get player.</value>
</result>

if [playerid] is wrong.

or

<player>
  <id>playerID</id>
  <name>name</name>
  <description>description</description>
  <date>date</date>
  <located>located</located>
  <created>created</created>
  <status>status</status>
  <skin>skin</skin>
  <playlists>
    <playlist>playlistID</playlist>
    <playlist>...</playlist>
    ...
  </playlists>
  <videos>
    <video>videoid</video>
    <video>...</video>
    ...
  </videos>
  <thumbSmall>thumbSmallOfPlayer</thumbSmall>
  <thumbBig>thumbBigOfPlayer</thumbBig>
</player>

The explanation of the results:

Parameter Description
playerID The player id
name The name of player
description The description of player
date The date in format yyyy-mm-dd
located
created
status The status of the player (published, not published)
playlistID The playlist id
videoID id of video
thumbSmallOfPlayer Path leading to a small thumbnail of the first video in the player
thumbBigOfPlayer Path leading to a big thumbnail of the first video in the player

Edit Player

This section explains how to edit a specific player.

Obtaining a request token

To edit player, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [playerid] with player id
- [newName] with the new name
- [newDescription] with the new description
- [skinID] with the skin id
- [videos] with the ids of videos comma separated
- [playlists] with the ids of playlists comma separated

http://www.vpfactory.com/api/editPlayer/?key=[yourKey]&playerid=[playerid]&name=[newName]&description=[newDescription]&skinid=[skinID]&videos=[videos]&playlists=[playlists]
Parameter Description
yourKey* This value specifies your APIkey
playerid* This value specifies player id
newName* This value specifies new name for a specific player
newDescription* This value specifies new description for a specific playlist
skinID* This value specifies the skin id for a specific playlist
videos* This value specifies the ids of videos comma separated
playlists* This value specifies the ids of playlists comma separated

* Required parameters

About the response

The editPlayer return an XML document.

The following XML shows the format of a VP Factory Data API response containing a specific player:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to edit the specified player.</value>
</result>

if [playerid] is wrong.

The successful response is identical with the previous response for the "Get Player" function.

Delete Player

This section explains how to delete a specific player.

Obtaining a request token

To delete a specific player, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [playerid] with playerid

http://www.vpfactory.com/api/deletePlayer/?key=[yourKey]&playerid=[playerid]
Parameter Description
yourKey* This value specifies your APIkey
playerid* This value specifies player playerid

* Required parameters

About the response

The deletePlayer return an XML document.

The following XML shows the format of a VP Factory Data API response:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to delete player.</value>
</result>

if [playerid] is wrong.

or

<result>
  <type>success</type>
  <value>Player deleted</value>
</result>

Create Player

This section explains how to create a player.

Obtaining a request token

To create a player, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey
- [name] with the player name
- [skinID] with the skin id
- [videos] with the ids of videos comma separated 

http://www.vpfactory.com/api/createPlayer/?key=[yourKey]&name=[name]&skinid=[skinID]&videos=[videos]
Parameter Description
yourKey* This value specifies your APIkey
name* This value specifies player's name
skinID* This value specifies skin id
videos* This value specifies the ids of videos comma separated

* Required parameters

About the response

The createPlayer return an XML document.

The following XML shows the format of a VP Factory Data API response containing a specific player:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to create the specified player.</value>
</result>

The successful response is identical with the previous response for the "Get Player" function.

Getting Started with Skins

Get All Skins

This section explains how to retrieve an XML containing all of the skins created by a specific user.

Obtaining a request token

To retrieve information about all skins, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text:
- [yourKey] with your VP Factory APIkey 

http://www.vpfactory.com/api/getAllSkins/?key=[yourKey]
Parameter Description
yourKey* This value specifies your APIkey

* Required parameters

About the response

The getAllSkins return an XML document.

The following XML shows the format of a VP Factory Data API response containing all skins:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<skins>
  <skin>
    <title>title</id>
    <id>skinid</id>
    <description>description</description>
    <buttons>buttons</buttons>
    <autoResize>autoResize</autoResize>
    <playerWidth>playerWidth</playerWidth>
    <playerHeight>playerHeight</playerHeight>
    <autoLoad>autoLoad</autoLoad>
    <autoPlay>autoPlay</autoPlay>
    <playContinuously>playContinuously</playContinuously>
    <random>random</random>
    <volume>volume</volume>
    <showPreviewImage>showPreviewImage</showPreviewImage>
    <showMiddlePlayBtn>showMiddlePlayBtn</showMiddlePlayBtn>
    <showWatermark>showWatermark</showWatermark>
    <watermarkPos>watermarkPos</watermarkPos>
    <watermarkAlpha>watermarkAlpha</watermarkAlpha>
    <cBarAutoHide>cBarAutoHide</cBarAutoHide>
    <cBarHideDelay>cBarHideDelay</cBarHideDelay>
    <playlistAutoHide>playlistAutoHide</playlistAutoHide>
    <playlistHideType>playlistHideType</playlistHideType>
    <playlistHideDelay>playlistHideDelay</playlistHideDelay>
    <backgroundPlayer>backgroundPlayer</backgroundPlayer>
    <backgroundVideo>backgroundVideo</backgroundVideo>
    <controllerBackground>controllerBackground</controllerBackground>
    <controllerButtonsNormal>controllerButtonsNormal</controllerButtonsNormal>
    <controllerButtonsOver>controllerButtonsOver</controllerButtonsOver>
    <controllerButtonsDown>controllerButtonsDown</controllerButtonsDown>
    <progressBarBackground>progressBarBackground</progressBarBackground>
    <progressBarElapse>progressBarElapse</progressBarElapse>
    <progressBarDownload>progressBarDownload</progressBarDownload>
    <scrubBtnBckNormal>scrubBtnBckNormal</scrubBtnBckNormal>
    <scrubBtnBckOver>scrubBtnBckOver</scrubBtnBckOver>
    <scrubBtnBckDown>scrubBtnBckDown</scrubBtnBckDown>
    <times>times</times>
    <preloaderBackground>preloaderBackground</preloaderBackground>
    <preloaderBckAlpha>preloaderBckAlpha</preloaderBckAlpha>
    <preloaderText>preloaderText</preloaderText>
    <playlistSelectorBck>playlistSelectorBck</playlistSelectorBck>
    <preloaderCircle>preloaderCircle</preloaderCircle>
    <middlePlayBtnArrowNormal>middlePlayBtnArrowNormal</middlePlayBtnArrowNormal>
    <middlePlayBtnBckNormal>middlePlayBtnBckNormal</middlePlayBtnBckNormal>
    <middlePlayBtnAlphaNormal>middlePlayBtnAlphaNormal</middlePlayBtnAlphaNormal>
    <middlePlayBtnArrowOver>middlePlayBtnArrowOver</middlePlayBtnArrowOver>
    <middlePlayBtnBckOver>middlePlayBtnBckOver</middlePlayBtnBckOver>
    <middlePlayBtnAlphaOver>middlePlayBtnAlphaOver</middlePlayBtnAlphaOver>
    <middlePlayBtnArrowDown>middlePlayBtnArrowDown</middlePlayBtnArrowDown>
    <middlePlayBtnBckDown>middlePlayBtnBckDown</middlePlayBtnBckDown>
    <middlePlayBtnAlphaDown>middlePlayBtnAlphaDown</middlePlayBtnAlphaDown>
    <volumebarBck>volumebarBck</volumebarBck>
    <shareBackground>shareBackground</shareBackground>
    <shareBckAlpha>shareBckAlpha</shareBckAlpha>
    <shareBoxBck>shareBoxBck</shareBoxBck>
    <shareBoxBckAlpha>shareBoxBckAlpha</shareBoxBckAlpha>
    <shareLabels>shareLabels</shareLabels>
    <shareErrorText>shareErrorText</shareErrorText>
    <shareText>shareText</shareText>
    <shareTextBck>shareTextBck</shareTextBck>
    <shareTextBrd>shareTextBrd</shareTextBrd>
    <shareBtnsNormal>shareBtnsNormal</shareBtnsNormal>
    <shareBtnsOver>shareBtnsOver</shareBtnsOver>
    <shareBtnsDown>shareBtnsDown</shareBtnsDown>
    <playlistBackground>playlistBackground</playlistBackground>
    <playlistBckAlpha>playlistBckAlpha</playlistBckAlpha>
    <playlistThumbBck>playlistThumbBck</playlistThumbBck>
    <playlistThumbNormalAlpha>playlistThumbNormalAlpha</playlistThumbNormalAlpha>
    <playlistThumbOverAlpha>playlistThumbOverAlpha</playlistThumbOverAlpha>
    <playlistThumbSelectedAlpha>playlistThumbSelectedAlpha</playlistThumbSelectedAlpha>
    <buttonStyle>buttonStyle</buttonStyle>
    <playlistSelectorTxtNormal>playlistSelectorTxtNormal</playlistSelectorTxtNormal>
    <playlistSelectorTxtOver>playlistSelectorTxtOver</playlistSelectorTxtOver>
    <playlistSelectorTxtDown>playlistSelectorTxtDown</playlistSelectorTxtDown>
    <playlistItemsBck>playlistItemsBck</playlistItemsBck>
    <playlistItemsTxtNormal>playlistItemsTxtNormal</playlistItemsTxtNormal>
    <playlistItemsTxtOver>playlistItemsTxtOver</playlistItemsTxtOver>
    <playlistItemsTxtDown>playlistItemsTxtDown</playlistItemsTxtDown>
    <watermarkFile>watermarkFile</watermarkFile>
    <defaultskin>defaultskin</defaultskin>
    <created>created</created>
  </skin>
  <skin>
  	...
  </skin>
</skins>

The explanation of the results:

Parameter Description
title The title of the skin
skind The player id
description The description of the skin
buttons The order of buttons separated by "|"
autoResize The number:
0 - auto resize
2 - not auto resize
playerWidth The width of player in pixels
playerHeight The height of player in pixels
autoLoad The number:
1 - auto load
0 - not auto load
autoPlay The number:
1 - play auto
2 - not play auto
playContinuously The number:
1 - play continuously
0 - not play continuously
random The number:
0 -
1 -
volume The number between 0 and 100
showPreviewImage The number:
1 - show preview image
2 - hide preview image
showMiddlePlayBtn The number:
1 - show middle play buttont
2 - hide middle play button
showWatermark The number:
1 - show Watermark
2 - hide watermark
watermarkPos The position of watermark
watermarkAlpha The alpha of watermark
cBarAutoHide The number:
1 - autohide cBar
2 - not autohide cBar
cBarHideDelay The time in second of cbar hide display
playlistAutoHide The number:
1 - autohide playlist
2 - not autohide playlist
playlistHideType The type of playlist hide
playlistHideDelay The time in second of playlist hide display
backgroundPlayer The background color of player
backgroundVideo The background color of video
controllerBackground The background color of controller
controllerButtonsNormal The color of controller buttons normal
controllerButtonsOver The color of controller buttons over
controllerButtonsDown The color of controller buttons down
progressBarBackground The color of progress bar background
progressBarElapse The color of progress bar elapse
progressBarDownload The color of progress bar download
scrubBtnBckNormal The color of scrub button background normal
scrubBtnBckOver The color of scrub button background over
scrubBtnBckDown The color of scrub button background down
times The color of times
preloaderBackground The color of preloader background
preloaderBckAlpha The alpha of preloader background
preloaderText The color of preloader text
playlistSelectorBck The color of playlist selector background
preloaderCircle The color of preloader circle
middlePlayBtnArrowNormal The color of middle play button arrow normal
middlePlayBtnBckNormal The color of middle play button background normal
middlePlayBtnAlphaNormal The alpha of middle play button normal
middlePlayBtnArrowOver The color of middle play button arrow over
middlePlayBtnBckOver The color of middle play button background over
middlePlayBtnAlphaOver The alpha of middle play button over
middlePlayBtnArrowDown The color of middle play button arrow down
middlePlayBtnBckDown The color of middle play button background
middlePlayBtnAlphaDown The alpha of middle play button down
volumebarBck The color of volume bar background
shareBackground The color of share background
shareBckAlpha The alpha of share background
shareBoxBck The color of share box background
shareBoxBckAlpha The alpha of share box background
shareLabels The color of share labels
shareErrorText The color of share error text
shareText The color of share text
shareTextBck The color of share text background
shareTextBrd The color of share text brd/td>
shareBtnsNormal The color of share button normal
shareBtnsOver The color of share button over
shareBtnsDown The color of share button down
playlistBackground The color of playlist background
playlistBckAlpha The alpha of playlist background
playlistThumbBck The color of playlist thumb background
playlistThumbNormalAlpha The alpha of playlist thumb normal
playlistThumbOverAlpha The alpha of playlist thumb over
playlistThumbSelectedAlpha The alpha of playlist thumb selected
buttonStyle The style of button
playlistSelectorTxtNormal The color of playlist selector text normal
playlistSelectorTxtOver The color of playlist selector text over
playlistSelectorTxtDown The color of playlist selector text down
playlistItemsBck The color of playlist items background
playlistItemsTxtNormal The color of playlist items text normal
playlistItemsTxtOver The color of playlist text over
playlistItemsTxtDown The color of playlist items text down
watermarkFile Id of watermark file
defaultskin
created The timestamp of created time

Get Skin

This section explains how to retrieve an entry containing information about a specific skin.

Obtaining a request token

To retrieve information about a specific skin, you can submit an HTTP POST or GET request to the following URL.
You need to replace the text: - [yourKey] with your VP Factory APIkey - [skinid] with skin id 

http://www.vpfactory.com/api/getSkin/?key=[yourKey]&skinid=[skinid]
Parameter Description
yourKey* This value specifies your APIkey
skinid* This value specifies skin id

* Required parameters

About the response

The getSkin return an XML document.

The following XML shows the format of a VP Factory Data API response containing all skins:

<result>
  <type>error</type>
  <value>Authentication failed.</value>
</result>

if [yourKey] is wrong.

or

<result>
  <type>error</type>
  <value>Unable to retrieve the specified skin.</value>
</result>

if [skinid] is wrong.

or

<skin>
  <title>title</title>
  <id>skind</id>
  <description>description</description>
  <buttons>buttons</buttons>
  <autoResize>autoResize</autoResize>
  <playerWidth>playerWidth</playerWidth>
  <playerHeight>playerHeight</playerHeight>
  <autoLoad>autoLoad</autoLoad>
  <autoPlay>autoPlay</autoPlay>
  <playContinuously>playContinuously</playContinuously>
  <random>random</random>
  <volume>volume</volume>
  <showPreviewImage>showPreviewImage</showPreviewImage>
  <showMiddlePlayBtn>showMiddlePlayBtn</showMiddlePlayBtn>
  <showWatermark>showWatermark</showWatermark>
  <watermarkPos>watermarkPos</watermarkPos>
  <watermarkAlpha>watermarkAlpha</watermarkAlpha>
  <cBarAutoHide>cBarAutoHide</cBarAutoHide>
  <cBarHideDelay>cBarHideDelay</cBarHideDelay>
  <playlistAutoHide>playlistAutoHide</playlistAutoHide>
  <playlistHideType>playlistHideType</playlistHideType>
  <playlistHideDelay>playlistHideDelay</playlistHideDelay>
  <backgroundPlayer>backgroundPlayer</backgroundPlayer>
  <backgroundVideo>backgroundVideo</backgroundVideo>
  <controllerBackground>controllerBackground</controllerBackground>
  <controllerButtonsNormal>controllerButtonsNormal</controllerButtonsNormal>
  <controllerButtonsOver>controllerButtonsOver</controllerButtonsOver>
  <controllerButtonsDown>controllerButtonsDown</controllerButtonsDown>
  <progressBarBackground>progressBarBackground</progressBarBackground>
  <progressBarElapse>progressBarElapse</progressBarElapse>
  <progressBarDownload>progressBarDownload</progressBarDownload>
  <scrubBtnBckNormal>scrubBtnBckNormal</scrubBtnBckNormal>
  <scrubBtnBckOver>scrubBtnBckOver</scrubBtnBckOver>
  <scrubBtnBckDown>scrubBtnBckDown</scrubBtnBckDown>
  <times>times</times>
  <preloaderBackground>preloaderBackground</preloaderBackground>
  <preloaderBckAlpha>preloaderBckAlpha</preloaderBckAlpha>
  <preloaderText>preloaderText</preloaderText>
  <playlistSelectorBck>playlistSelectorBck</playlistSelectorBck>
  <preloaderCircle>preloaderCircle</preloaderCircle>
  <middlePlayBtnArrowNormal>middlePlayBtnArrowNormal</middlePlayBtnArrowNormal>
  <middlePlayBtnBckNormal>middlePlayBtnBckNormal</middlePlayBtnBckNormal>
  <middlePlayBtnAlphaNormal>middlePlayBtnAlphaNormal</middlePlayBtnAlphaNormal>
  <middlePlayBtnArrowOver>middlePlayBtnArrowOver</middlePlayBtnArrowOver>
  <middlePlayBtnBckOver>middlePlayBtnBckOver</middlePlayBtnBckOver>
  <middlePlayBtnAlphaOver>middlePlayBtnAlphaOver</middlePlayBtnAlphaOver>
  <middlePlayBtnArrowDown>middlePlayBtnArrowDown</middlePlayBtnArrowDown>
  <middlePlayBtnBckDown>middlePlayBtnBckDown</middlePlayBtnBckDown>
  <middlePlayBtnAlphaDown>middlePlayBtnAlphaDown</middlePlayBtnAlphaDown>
  <volumebarBck>volumebarBck</volumebarBck>
  <shareBackground>shareBackground</shareBackground>
  <shareBckAlpha>shareBckAlpha</shareBckAlpha>
  <shareBoxBck>shareBoxBck</shareBoxBck>
  <shareBoxBckAlpha>shareBoxBckAlpha</shareBoxBckAlpha>
  <shareLabels>shareLabels</shareLabels>
  <shareErrorText>shareErrorText</shareErrorText>
  <shareText>shareText</shareText>
  <shareTextBck>shareTextBck</shareTextBck>
  <shareTextBrd>shareTextBrd</shareTextBrd>
  <shareBtnsNormal>shareBtnsNormal</shareBtnsNormal>
  <shareBtnsOver>shareBtnsOver</shareBtnsOver>
  <shareBtnsDown>shareBtnsDown</shareBtnsDown>
  <playlistBackground>playlistBackground</playlistBackground>
  <playlistBckAlpha>playlistBckAlpha</playlistBckAlpha>
  <playlistThumbBck>playlistThumbBck</playlistThumbBck>
  <playlistThumbNormalAlpha>playlistThumbNormalAlpha</playlistThumbNormalAlpha>
  <playlistThumbOverAlpha>playlistThumbOverAlpha</playlistThumbOverAlpha>
  <playlistThumbSelectedAlpha>playlistThumbSelectedAlpha</playlistThumbSelectedAlpha>
  <buttonStyle>buttonStyle</buttonStyle>
  <playlistSelectorTxtNormal>playlistSelectorTxtNormal</playlistSelectorTxtNormal>
  <playlistSelectorTxtOver>playlistSelectorTxtOver</playlistSelectorTxtOver>
  <playlistSelectorTxtDown>playlistSelectorTxtDown</playlistSelectorTxtDown>
  <playlistItemsBck>playlistItemsBck</playlistItemsBck>
  <playlistItemsTxtNormal>playlistItemsTxtNormal</playlistItemsTxtNormal>
  <playlistItemsTxtOver>playlistItemsTxtOver</playlistItemsTxtOver>
  <playlistItemsTxtDown>playlistItemsTxtDown</playlistItemsTxtDown>
  <watermarkFile>watermarkFile</watermarkFile>
  <defaultskin>defaultskin</defaultskin>
  <created>created</created>
</skin>

The explanation of the results:

Parameter Description
title The title of the skin
skinid The skin id
description The description of the skin
buttons The order of buttons separated by "|"
autoResize The number:
0 - auto resize
2 - not auto resize
playerWidth The width of player in pixels
playerHeight The height of player in pixels
autoLoad The number:
1 - auto load
0 - not auto load
autoPlay The number:
1 - play auto
2 - not play auto
playContinuously The number:
1 - play continuously
0 - not play continuously
random The number:
0 -
1 -
volume The number between 0 and 100
showPreviewImage The number:
1 - show preview image
2 - hide preview image
showMiddlePlayBtn The number:
1 - show middle play buttont
2 - hide middle play button
showWatermark The number:
1 - show Watermark
2 - hide watermark
watermarkPos The position of watermark
watermarkAlpha The alpha of watermark
cBarAutoHide The number:
1 - autohide cBar
2 - not autohide cBar
cBarHideDelay The time in second of cbar hide display
playlistAutoHide The number:
1 - autohide playlist
2 - not autohide playlist
playlistHideType The type of playlist hide
playlistHideDelay The time in second of playlist hide display
backgroundPlayer The background color of player
backgroundVideo The background color of video
controllerBackground The background color of controller
controllerButtonsNormal The color of controller buttons normal
controllerButtonsOver The color of controller buttons over
controllerButtonsDown The color of controller buttons down
progressBarBackground The color of progress bar background
progressBarElapse The color of progress bar elapse
progressBarDownload The color of progress bar download
scrubBtnBckNormal The color of scrub button background normal
scrubBtnBckOver The color of scrub button background over
scrubBtnBckDown The color of scrub button background down
times The color of times
preloaderBackground The color of preloader background
preloaderBckAlpha The alpha of preloader background
preloaderText The color of preloader text
playlistSelectorBck The color of playlist selector background
preloaderCircle The color of preloader circle
middlePlayBtnArrowNormal The color of middle play button arrow normal
middlePlayBtnBckNormal The color of middle play button background normal
middlePlayBtnAlphaNormal The alpha of middle play button normal
middlePlayBtnArrowOver The color of middle play button arrow over
middlePlayBtnBckOver The color of middle play button background over
middlePlayBtnAlphaOver The alpha of middle play button over
middlePlayBtnArrowDown The color of middle play button arrow down
middlePlayBtnBckDown The color of middle play button background
middlePlayBtnAlphaDown The alpha of middle play button down
volumebarBck The color of volume bar background
shareBackground The color of share background
shareBckAlpha The alpha of share background
shareBoxBck The color of share box background
shareBoxBckAlpha The alpha of share box background
shareLabels The color of share labels
shareErrorText The color of share error text
shareText The color of share text
shareTextBck The color of share text background
shareTextBrd The color of share text brd/td>
shareBtnsNormal The color of share button normal
shareBtnsOver The color of share button over
shareBtnsDown The color of share button down
playlistBackground The color of playlist background
playlistBckAlpha The alpha of playlist background
playlistThumbBck The color of playlist thumb background
playlistThumbNormalAlpha The alpha of playlist thumb normal
playlistThumbOverAlpha The alpha of playlist thumb over
playlistThumbSelectedAlpha The alpha of playlist thumb selected
buttonStyle The style of button
playlistSelectorTxtNormal The color of playlist selector text normal
playlistSelectorTxtOver The color of playlist selector text over
playlistSelectorTxtDown The color of playlist selector text down
playlistItemsBck The color of playlist items background
playlistItemsTxtNormal The color of playlist items text normal
playlistItemsTxtOver The color of playlist text over
playlistItemsTxtDown The color of playlist items text down
watermarkFile Id of watermark file
defaultskin
created The timestamp of created time