Introduction
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 List of involved entities with schema examples
| 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. |
Endpoints overview
| Endpoint | HTTP method | Purpose |
|---|---|---|
| /api/metadata/v1/channels | GET | Get an index of channels. |
| /api/metadata/v1/channels/{channel_id} | GET | 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) |
Trickplay Service Config
From Wikipedia
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 List of use cases presented in a logical order
First use case
Write a short explanation of the use case here.
API specifications for the endpoints is created under their respective implementation tickets. List the steps needed to perform the use case with corresponding links to the API documentation below.
| Step name | Step description | API endpoint |
|---|---|---|
If the use case related endpoint(s) implement pagination, please mention it in the info boxes below
Possible info text for the use case and how it is linked to other use cases |
Second use case
Third use case
Migration guide
If the feature is replacing some legacy functionality, explain the process of migrating the clients to deprecate the old feature and start using the new one here.
Known issues and limitations
If there is some known issues and/or limitations for the feature, please document them here.
Info level limitation example |
Warning level limitation example |
Postman collection
Postman collection for the feature is created under a separate ticket. Compress the collection under one zip file and attach it here.
Table of Contents
Child Pages