Videos module

This module provides access to Video On-Demand (VOD) platform.

URL Format

You can use GET or POST variables in your requests.

baseUrl/vod.php?action=ACTION&params...

When the visitor token is required, add

&token=TOKEN_HERE

Reference

Some responses may return defined objects inside the JSON that refer to existing classes.

See related:

• Section
• Show
• Video

Pagination

All requests that return lists can support pagination. Add page=PAGE_NUMBER and limit=[1-1000|default:30] (limit per page) to paginate the responses.

List of actions

The parameter "action" determines the action you would like to match. See below list.

sections_list

List all publicly visible sections.

Parameters:

• videos: 0/1, whether to include all videos inside this show in the response

Response:

data: [ { Section object } ] 

shows_list

List all publicly visible shows or ones within a section.

Parameters:

• sectionId: integer, to filter by a section ID. Can accept comma-separated values for multiple sections.
• videos: 0/1, whether to include all videos inside this show in the response

Response:

data: [ { Show object } ] 

videos_list

List all publicly visible videos

Parameters:

• showId: integer, to filter by a show ID. Can accept comma-separated values for multiple shows.

Response:

data: [ { Video object } ] 

section_view

Get a specific section's details.

Parameters:

• sectionId: integer
• videos: 0/1, whether to include all videos inside this show in the response

Response:

data: [ { Section object } ] 

show_view

Get a specific show's details.

Parameters:

• showId: integer
• videos: 0/1, whether to include all videos inside this show in the response

Response:

data: [ { Show object } ] 

video_view

Get a specific video's details.

A video object can be used to display videos on your web frontends, by using the embeddable player, or on your mobile or non-web platforms too.

The embeddable player has many features including:

• Analytics
• Advertising support
• Automatic bandwidth sensing with HLS
• Configurable bandwidth choices
• Mobile support
• Keyboard shortcuts
• Related videos end card
• Start where you left off (coming soon)

If you plan to use your own player, you will need to implement the features you need. We require that you implement the analytics functionality at least.

Parameters:

• videoId: integer

Response:

data: [ { Video object } ]