The channel v4 APIs allow clients to get list of channels with paginations by operator if operator config is enabled. Besides, client can get channel by ID to look at information of specific channel. They are cacheable and do not requite authentication.
Entities
Entity
Purpose
Channel
This stores information of channels. It also stores flags indicate services of channels such as npvr/live/catchup.
ChannelConfig
This stores configs of channels which describe specific availabilities of channels such as startover, recording window, catchup horizon, etc.
ChannelDomains
Domains belongs to channels. A channel can have multi domains.
Get information of a specific channel by channel_id
The APIs accept request parameter language to return channel's name and description by language. The request parameter "show_hidden" in the index of channels API indicate whether hidden channels should be displayed or not.
Explanation of services
Table of services that are available to users
Value in API
Service description
live
The user may watch this channel as a live stream. User can pause live stream if the channel supports that service.
npvr
The user is allowed to record this channel to their cloud storage account. User can watch an ongoing program if the channel support that service.
catchup
The user is permitted to watch programs that aired previously and are still within the defined catchup window (typically 2 weeks)
Trick mode, sometimes called trick play, is a feature of digital video systems including Digital Video Recorders and Video on Demand systems that mimics the visual feedback given during fast-forward and rewind operations that were provided by analogue systems such as VCRs. Trick play manipulates the video stream to include only a subset of frames.
The AminoTV platform allows trickplay to be enabled on three services. The following table outlines what enabling trickplay on each service enables the user to do.
Value in API
Trickplay features allow the user to
live
This refers to the ability to fast-forward or rewind through live television.
catchup
This refers to the ability to fast-forward or rewind through television that is being watched in catchup.
npvr
Fast-forward and rewind.
Explanation of features
Hidden channels
Channels are mainly hidden from the channels' list. They are not disabled. We can still get the channel's info if we know the channel_id. Besides, recordings, epgs, streams and related things are still available for hidden channels. The purpose of hidden channels are for being prepared before official release or they are in maintenance.
Use cases
First use case
Step name
Step description
API endpoint
Possible info text for the use case and how it is linked to other use cases