Set up an Electronic Programming Guide (EPG)
Display your live channel scheduling with an EPG
This is a beta offering.
By using this documentation, you are agreeing to abide by the terms of the JWP Beta Program Agreement.
Our Electronic Programming Guide (EPG) is a self-updating menu to visualize live channel schedules on your app.
You can create an EPG for your app using an app config.
An EPG offers several advantages:
- Enables your users to navigate live streams
- Increases minutes watched due to clear and accessible scheduling information
- Markets various media items to users
Prerequisites
Item | Notes |
---|---|
Active app | Learn more about apps |
App config | App config associated with your app |
Live Channel | One or more live channels in your Media Library
|
Live Channel schedule | Live Channel schedule in JSON format
|
Create an EPG
The instructions described here apply to the open-source Web App. Contact your app partner for instructions for you specific situation.
Use the following steps to create an EPG:
- Set custom parameters for each live channel.
- Create a manual playlist of your live channels.
In step 9, add the following key-value pair under Custom Parameters:- For Key, enter contentType.
- For Value, enter Live.
- Add the playlist of your live channels to the app config (steps 1-4) and click Save.
Set custom parameters for a live channel
To incorporate a live channel into your app, you must add several custom parameters to the channel.
Use the following steps to set custom parameters for a live channel:
-
From your Media Library, select a live channel. The channel details page appears.
-
Under Custom Parameters, add all the values listed in the following table.
Key Description catchupHours Must match the value in your Broadcast Live configuration
Contact your JWP representative for this value.contentType Routes the media item to the app’s live channels page
Value: LiveChannelliveChannelsid Playlist ID for the dynamic playlist containing your live channels scheduleDemo (Web App) Interprets all values as Today when testing your content scheduleType (Web App) Indicates the EPG schedule format for the scheduleUrl
Possible Values:- jwp (default)
- viewnexa
scheduleUrl URL of the schedule
The URL can either be for a schedule data JSON or ViewNexa FAST EPG XML schedule.
-
(Optional) Create default custom parameters.
-
Click Save.
Manage an EPG
The following table explains the various ways to manage an existing EPG.
Action | Notes |
---|---|
Customize | You can customize the appearance of your EPG in the app config. |
Edit or Delete |
To edit or delete schedule data, update your JSON file according to the Broadcast Live chapter points format, such as these sample EPG Schedule Data files:
|
Updated 6 months ago