Show
A show is a grouping of videos in the VOD module.
Properties
- id (integer)
- name (string): Name of the show
- section (integer): ID of the section this show is in
- host (string): The name of the show's host.
- url (string): URL for the show (used for web frontends and mobile app deep-linking), format: /show/ID-slug
- cover (string): Cover image URL
- logo (string): Logo image URL
- background (string): Background image URL
- description (string): Show description in plain-text
Additional properties
In some cases, additional properties are available:
- firstEpisode (Episode object): the first episode in this show
- lastEpisode (Episode object): the most recent episode in this show
When the parameters (videos=1) is passed to some requests, you can get an expanded version of the Show with:
- videos (Array of Video object): all videos inside this show
Sample API Response
{"id":"5","name":"The Late Night Show","section":"2","host":"Jane Doe","url":"http:\/\/demo.local\/show\/5\/the-late-night-show","cover":"https:\/\/demo.local\/storage\/shows\/4287880111017166278.jpg","logo":"https:\/\/demo.local\/storage\/shows\/8410340711353586935.jpg","background":"https:\/\/demo.local\/storage\/shows\/8659946281048033846.jpg","description":"Late Night show's description goes here","firstEpisode":{"id":"14","title":"Demo Video","url":"\/watch\/14\/demo-video","duration":"69","number":null,"status":"available","showId":"5","showName":"The Late Night Show","showUrl":"http:\/\/demo.local\/show\/5\/the-late-night-show","brief":"<p>Demo video description goes here<\/p>","thumbnail":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340.jpeg","thumbnailPlay":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340_play.jpeg","filename":"\/mnt\/c\/Users\/rudyz\/Sites\/whitebeardcms\/deployments\/demo\/storage\/videos\/Demo-Video_873041.mp4","publishDate":"2021-03-31 12:29:00","views":"0","publish":"0","formats":[{"format":"1080p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_1080p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"720p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_720p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"360p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_360p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"480p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_480p.mp4","cdnPath":"","mime":"video\/mp4"}]},"lastEpisode":{"id":"14","title":"Demo Video","url":"\/watch\/14\/demo-video","duration":"69","number":null,"status":"available","showId":"5","showName":"The Late Night Show","showUrl":"http:\/\/demo.local\/show\/5\/the-late-night-show","brief":"<p>Demo video description goes here<\/p>","thumbnail":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340.jpeg","thumbnailPlay":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340_play.jpeg","filename":"\/mnt\/c\/Users\/rudyz\/Sites\/whitebeardcms\/deployments\/demo\/storage\/videos\/Demo-Video_873041.mp4","publishDate":"2021-03-31 12:29:00","views":"0","publish":"0","formats":[{"format":"1080p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_1080p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"720p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_720p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"360p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_360p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"480p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_480p.mp4","cdnPath":"","mime":"video\/mp4"}]},"videos":[{"id":"14","title":"Demo Video","url":"\/watch\/14\/demo-video","duration":"69","number":null,"status":"available","showId":"5","showName":"The Late Night Show","showUrl":"http:\/\/demo.local\/show\/5\/the-late-night-show","brief":"<p>Demo video description goes here<\/p>","thumbnail":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340.jpeg","thumbnailPlay":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340_play.jpeg","filename":"\/mnt\/c\/Users\/rudyz\/Sites\/whitebeardcms\/deployments\/demo\/storage\/videos\/Demo-Video_873041.mp4","publishDate":"2021-03-31 12:29:00","views":"0","publish":"0","formats":[{"format":"1080p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_1080p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"720p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_720p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"360p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_360p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"480p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_480p.mp4","cdnPath":"","mime":"video\/mp4"}]}]}