Contact Us   |    Bookmark and Share
 
   
  VidZapper Live - live web streaming and video management
 		  
 
About Products Support Developers 
 
 

VidZapper was built for Developers.

 

 

We think that VidZapper is the most comprehensive and powerful product available to developers wishing to build complex video based websites and IPTV services.

 

That is why we've published our full API on this page.

 

You can develop solutions in pretty much any authoring language including Flash, HTML and JavaScript, PHP or .Net using our API.

 

Soon we'll be launching the VidZapper Component Framework (VCF) that will enable anyone to write plug-ins for VidZapper. Please contact us if you'd like to be in on the beta program.

VidZapper API

Here is a current description of the webservice methods available for developing players and applications on the VidZapper platform.

Category

Method Name Description
CategoriesByContentID Returns a list of categories limited by that category being associated with the content ID provided.
CategoriesByParentID Returns a list of categories limited by the parent categories ID which is provided.
GetCategory Returns a category limited by the category ID.
GetCategoryTreeByChannelID This method returns categories filter by Channel ID

Channel

Method Name Description
SelectChannel Returns a channel object, information about a particular channel
SelectChannels Returns a list of channel objects

Content

Method Name Description
SearchContent This method searches for content that contains the given keyword a.k.a (Words To Search).
SearchContentByCategory This method searches videos within a category which contains the given keyword.
SearchContentByCategoryAndMetaDataSequence This method searches videos within a category which contains the given keyword, and pick a particular meta data sequence ID
SearchContentByEverything This method searches for content that contains with all the metadata the given keyword.
SearchContentByEverythingAndMetaDataSequence This method searches for content that contains with all the metadata the given keyword. Using the Meta Data Sequence
SearchContentByKeywords This method searches for content that contains the given keyword. Limited to the keywords of the metadata
SearchContentByKeywordsAndMetaDataSequence This method searches for content that contains the given keyword. Limited to the keywords of the metadata. Returning the Meta Data Sequence
SearchContentByMetaData This method searches for content that contains with all the metadata the given keyword. Except the categories.
SearchContentByMetaDataAndMetaDataSequence This method searches for content that contains the given keyword. Limited to the keywords of the metadata. Returning the Meta Data Sequence
SearchContentByMetaDataSequence This method searches for content that contains the given keyword. Returning the Meta Data Sequence
SelectContentByChannelID Returns a list of content objects
SelectContentByChannelIDAndMetaDataSequence Returns a list of content objects Using the Meta Data Sequence
SelectContentByContentID Returns a content object
SelectContentByContentIDAndMetaDataSequence Returns a content object. Using the Meta Data Sequence
SelectContentByMetaDataID Returns a content object
SelectContentByMetaDataIDAndMetaDataSequence Returns a content object with meta data filtered by the metadata sequence ID
SelectContentByPlaylistID Returns a list of Content objects
SelectContentByPlaylistIDAndMetaDataSequence Returns a list of Content objects filtered by the playlist ID and the metaData Sequence ID
UGCContentRejected Reject the content and returns content object Containing message(Error/Successfully Rejected)
UGCContentAccepted Accept the content and returns content object Containing message(Error/Successfully Accepted)
UGCUploadContent Upload new content by Registered user and returns content object Containing message(Error/Successfully uploaded)

ContentType

Method Name Description
ContentTypeList This method returns the List of Content Type
ContentType This method returns the Content Type fileter By Content Type ID

Country

Method Name Description
CountryList Returns a list of countries.

Ecommerce

Method Name Description
GetEcommerce Returns an ecommerce object.
SetEcommerce Creates an ecommerce object.

Feeds

Method Name Description
GenerateMRSSFeed Returns an XML MRSS feed of your content
GenerateMRSSFeedByDateRange Returns an XML MRSS feed of your content, limited by a date range
GenerateMRSSFeedByDateRangeAndMultiPlaylist Returns an XML MRSS feed of your content, limited by a date range, allowing multiple playlists
GenerateMRSSFeedByMultiPlaylist Returns an XML MRSS feed of your content
GenerateRSSFeed Generates an XML RSS feed of your content.

General

Method Name Description
Authenticate Used to check you are authenticated. You will need to include the soap:header in all calls to the webservice.
FlushCache Used to flush the system's cache, This is usually only used on the development environment while you test your code.

Heartbeat

Method Name Description
Pulse Stats Sends a pulse to statistics.
StartHeartBeat Stats Starts the process of the heartbeat for statistics.

Player

Method Name Description
SelectPlayer Returns a player object
SelectPlayers Returns a list of player objects

Playlist

Method Name Description
SelectPlaylist Returns a playlist object
SelectPlaylists Returns a list of playlist objects

StatsAdmin

Method Name Description
GetClientAverageNoVidoesViewed Returns the average number of videos viewed.
GetClientAverageNoVidoesViewedPerSession Returns the average number of videos viewed per viewer session.
GetClientAverageSessionsPerViewer Returns the average number of sessions per viewer
GetClientAverageSessionTime Returns the average session viewing time
GetClientAverageViewingTime Returns the average viewing time
GetChartViewers Returns chart viewers over time
GetClientTotalData Returns Total data transfered
GetClientTotalDataByDate Returns the Total data transfered by date
GetClientTotalVideosViewed Returns the number of total videos viewed
GetClientTotalSessions Returns the Total number of viewer sessions
GetClientTotalSessionTime Returns the total session time
GetClientTotalStorage Returns the total storage
GetClientTotalVideos Returns the Total number of videos
GetClientTotalViewers Returns the Total number of viewers
GetOverview Returns an overview of the statistics.
GetTop10Videos Returns the Top 10 popular videos.
GetTotalStorage Get total storage space from CDN

Stats Admin Advanced

Method Name Description
GetClipPlays Returns the number of times a clip has been played
GetViewerSessionLengthByGUID Returns the session length by GUID
GetViewerTotalLength Returns the time a viewer has been watching.

TagCloud

Method Name Description
AddTag Adds a new Tag to the Tag Cloud manually.
CreateTagCloud Automatically run through all the videos in a given playlist and generate the tags and the quanitity fields.
GetTagCloud Returns the tagCloud. A list of TagCloud objects.
GetTagCloudByPlaylistID Returns the tagCloud. Ffiltered by a playlist ID.
GetTagCloudByPlaylistIDs Returns the tagCloud. Filtered by a list of playlist IDs.
RemoveTag Removes a specified Tag from the Tag Cloud.
RemoveTagByChannelID Removes all Tags from the Tag Cloud. For a specified Channel
RemoveTagByID Removes a specific Tag from the Tag Cloud.
TagClicked Increments the value of the Search Quantity, filtered by the channelID and the TagID.
TagClickedByWord Increments the value of the Search Quantity, filtered by the channelID and the Search Word.

Users

Method Name Description
GetUserRole Returns a UserRole object limited by the ID.
SendPasswordReminder This Method sends the user a reminder of their password.
UserRoleList Returns the full list of User Roles available
Share This method used by Registered user to share currently playing content(Tell a Friend)
Registration This method used for Registeration of New User

VzSync

Method Name Description
CreateVzSync Creates a new VzSync Object.
GetVzSyncByContentMetaDataID Returns the VzSync object By Content Meta Data ID
GetVzSyncByID Returns the VzSync object By ID.
UpdateVzSync Updates a VzSync Object

 


 
 
 
 
About
 Products
Resell
Resources
News
About Us
Support
Contact Details
Demo Channels
 VidZapper
VZPlayer
VZMobile
VidZapper Live
AdZapper
StreamZapper
VZPlugins
 For Web & Online Agencies
For Video Producers
For Internet TV Specialists
Reseller List
Community		 VidZapper Documentation
API & Web Service
 
  VidZapper is a TV Everywhere company © 2009