The Roku Channel live linear ingest specifications (OVP)

Version 3.2

Overview

This specification describes the ingest specifications and EPG requirements required for your channel's content catalog to be included in The Roku Channel. A catalog is the set of movies, series, TV specials, short-form videos or linear stream your channel provides, along with the artwork that represents it in the UI. A catalog feed (JSON) or Gracenote channel ID (aka ProgSrvID) includes the metadata that describes each asset so Roku can index it, categorize it, and present it to users. Note: Gracenote channel id support is currently limited to linear channels with live sports only.

The Roku Channel feed format follows the JSON-Schema Draft 4. All the properties in the schema are case sensitive. Before submitting a feed, make sure it is a valid JSON file. You can do that by using an IDE or free online tools, such as JSON Schema Validator or JSON Schema Lint.

For guidelines about presenting your channel's EPG, see EPG on The Roku Channel.

A note about deduplication of metadata

Roku augments metadata and artwork that appears in The Roku Channel on Roku devices, web browsers, mobile applications, and other off-platform players with data supplied from Gracenote’s database where available. The Gracenote data aids in a unified experience of a title across platforms as well as on the greater Roku ecosystem. Roku will attempt to match all content delivered by our Partners to a corresponding record in Gracenote’s database. At this time all metadata and artwork that appears on The Roku Channel is sourced from Gracenote if that content is found in Gracenote’s database.

Our systems use a combination of methods to match a title its correct Gracenote record. Partners can aid in the matching to a Gracenote record by providing accurate metadata including:

• Exact title of a series, movie, TV special, or short form video

• Release dates that are accurate to the year the title was originally released on any platform

• Accurate season and episode numbers according to the original release order

• Accurate TMS (Gracenote) IDs or IMDB IDs by content type

  • Content classified as an episode with Gracenote must be delivered as an Episode to Roku

  • Content classified as a movie with Gracenote must be delivered as a movie to Roku

  • Content classified as a TV Special with Gracenote can be delivered as a movie to Roku

Inclusion in The Roku Channel

In order for your content to be surfaced in The Roku Channel, you must adhere to this specification. If you already have a channel powered by Direct Publisher and you want its content to appear in The Roku Channel, you must ensure your feed meets the requirements described in this specification. Likewise, if you've built a channel using our developer program, then you must provide Roku with a separate feed adhering to this specification. The new feed must contain only assets that are available for display in The Roku Channel.

* Note that participation in The Roku Channel is currently limited to select partners. Configuring your feed to meet this specification is a prerequisite to be reviewed for inclusion. To submit a feed for approval into The Roku Channel, contact your Roku representative.

All Linear Partners must utilize one of the Linear Certified Partners for their stream and EPG distribution: Amagi, Wurl, Frequency, OTTera, Xumo, Akta, or Zype. Exceptions will only be considered if the partner can agree to abiding by all rules and requirements as outlined in the linear certification agreement which can be provided if such an exemption is necessary.

Error Reporting

Stream and EPG issue reports go directly to the LCPs. Stream issues and high priority EPG issues are reported as needed. Comprehensive EPG issue reports go out weekly to all LCPs.

Roku OVP

Roku now requires all live linear channels on TRC to run through their Online Video Platform (OVP). Below are the ingest specifications and input data template that needs to be filled out and provided to Roku Live Operations for all new live linear channels.

Collection of Linear Channel Input Data

Please fill out the Excel template located here:

https://roku.box.com/v/roku-linear-channel-input-data

Supported Video and Audio Tech Specs

The following outlines what we support. A preferred video set up is outlined in the referenced column.

• Partners should adhere to the below ad length requirements:

  • General Audience

    • 8 minutes of ads per hour
    • Minimum 4 ads and maximum of 6 ads per pod
    • Ad pod length of 2 minutes
    • Duration between ad breaks of at least 10 minutes

  • Kids

    • 6 minutes of ads per hour
    • Minimum 3 ads and maximum of 6 ads per pods
    • Ad pod length of 90 seconds
    • Duration between ad breaks of at least 10 minutes

    • Bumper/lead-in identifying ad break before AND after ad pods occur (6 second maximum)

      • Example: "We'll be right back after this break", "Now back to the show"
  • Flexibility around the ad policy is provided during live events. Please discuss this with your Roku rep.

Live Events

The following additional details are required for Roku discrete live events (DLEs) and insertion into Roku owned and operated linear channels.

• All live events must have both a primary and backup source

  • SRT or Zixi Push preferred; HLS and RTMP are not supported

• Live events intended for Roku O&Os must include program start/stop SCTE messages

  • Splice Insert messages are preferred; Time Signal message type must include a splice command

Metadata

• Ensure all event metadata is delivered to your Roku rep for the event as early as possible

  • A Gracenote TMS ID for the event is preferred
  • Metadata fields can be found here based on event type: https://developer.roku.com/en-gb/trc-docs/live-linear/epg-on-trc.md#metadata-by-content-type

Recurring events

• Roku has the ability to access third party APIs for recurring events. Ask your Roku rep for details.

Direct Publisher Feed Schema

These are the properties for the root object of your EPG feed. It contains basic information such as your company's name, when the feed was last updated, and other objects that will describe all your content in detail. The URL for your feed should have the form "https://[yourfeeddomain.com](http://yourfeeddomain.com/)".

The format of the feed is a comma-separated list with each property enclosed in double quotes. You must assign each asset (object) its own reference ID, which is a string. Note: The ID for an asset must not exceed 50 characters.

Note: Partners should not make programming updates to content scheduled to air within 48 hours of live broadcast.

*At least one of these content types is required

The Roku Channel Feed Root Object Template:

{ "providerName": "Acme Productions", "lastUpdated": "2015-11-11T22:21:37+00:00", "language": "en-US", "categories": [ ... ], "playlists": [ ... ], "movies": [ ... ], "series": [ ... ], "shortFormVideos": [ ... ], "tvSpecials": [ ... ],"liveFeeds": [ ... ]
 }

Artwork for all content

Each image must be delivered in the JPEG format (.jpg or .jpeg file extension).

Make sure your CDN is using the following ContentType headers

• image/jpeg
• image/jpg

Artwork content guidelines

• Key art (graphic with the full title of the asset visible)

• No sexually explicit or graphically violent artwork

• Artwork should be post-theatrical and not include language such as “In Theaters Now” or “Coming Soon”

• Artwork designed specifically for digital delivery is preferred

• Artwork for international territories should be localized for each territory

**For content on TRC, Roku will not accept branded artwork without prior approval for any individual video asset nor for season/series entities.

Object Example:

thumbnail: "http://thumbnail.jpg"

Linear Channel Branding and Policies

• Partners are permitted to have Logos, bugs and lower thirds in their channels

Content Expectations

• Content Hours: minimum of 150 hours of content
• Content per Hour: minimum of 50 minutes per hour of content
• Daily Refresh: 2 hours minimum of refreshed content daily

• Content Recommendation

  • Content Loop: minimum of 8 hours of content before loop

Content Policy

• Content rated R and TV-MA is allowed only between 9pm-5am Eastern Time
• Public policy and political issues must be presented with accuracy, honesty and fairness

• Foreign Language Programming

  • On English-language channels, subtitles must be included.
  • No foreign-language (subtitled) programming allowed on Kids & Family channels.
• Every program must have a rating. If a program has an MPAA rating, the partner must use the MPAA rating for the program. If the program does not have an MPAA rating, the partner must use a TV Ratings (USA_PR) rating. See Advisory Ratings object

Slate Requirements

• Must be animated & have audio

• Must include the linear channel logo/branding

• Must include a countdown timer for the duration of the ad break

  • Note: Countdown timer does not satisfy the animation requirement

• Must include messaging to indicate a break is in progress and programming will resume shortly

• No CTA

• Cannot promote a channel outside of TRC

LiveFeed Promotion Guidelines

• Partners are not allowed to promote Partner content without explicit permission from TRC.
• Calls to action (CTAs) or links to external platforms or sites (including QR codes) are not permissible and must be removed from the video prior to delivery to Roku.

Content types

LiveFeed Content Type

Child object of root property liveFeeds.

This object represents a live linear stream. Please contact your Roku representative if you want to create a channel that streams live linear content.

Live Feed Object Example:

{ "id": "1509428502953", "title": "Sample Stream", "content": { ... }, "language": { "en" }, "thumbnail": "https://example.org/cdn/thumbnails/1509428502952/1", "shortDescription": "A live description", "longDescription": "A longer description of a live stream","genres": [ "drama", "comedy", "horror" ],"tags": [ "kidsdirected" ] }

Movie content type

Child object of root property movies.

This object represents a movie.

Movie ad policy

• No adBreaks should be listed during the first 10 minutes of program start
• No pre-roll adBreak should be listed - 00:00:00
• adBreak cue points should be provided at naturally occurring scene breaks and/or fades to black
• There should be no less than 10 minutes between each adBreak
• No adBreaks within 10 minutes of end credits.

Movie Object Example:

{ "id": "1509428502952", "title": "Sample Movie", "content": { ... }, "genres": [ "drama", "comedy", "horror" ], "thumbnail": "https://example.org/cdn/thumbnails/1509428502952/1", "releaseDate": "2016-01-01", "shortDescription": "Incredible movie description", "longDescription": "Even more incredible and longer movie description", "tags": [ "amazing", "drama", "comedy", "horror" ] }

Series content type

Child object of root property series.

This object represents a series, such as a season of a TV show or a mini-series.

*Must have either seasons or episodes

Series Object Example (seasons):

{ "id": "1509428502952", "title": "The Amazing Series with Seasons!", "seasons": [ ... ], "genres": [ "educational", "science fiction", "thriller", ], "thumbnail": "https://example.org/cdn/thumbnails/1509428502952/1", "shortDescription": "Wondrous series seasons." }

Series Object Example (mini-series):

{ "id": "1509428502952", "title": "The Amazing Series with Episodes Only!", "episodes": [ ... ], "genres": [ "fashion", "romance", "technology", ], "thumbnail": "https://example.org/cdn/thumbnails/1509428502952/1", "shortDescription": "Unbelievables series episodes." }

Season content type

Child object of property series -> seasons.

This object represents a single season of a series.

Season Object Example:

{ "seasonNumber": 1, "episodes": [ ... ] }

Episode content type

Child object of property:

• series -> episodes
• series -> seasons -> episodes

This object represents a single episode in a series or a season.

Episode ad policy

Content length longer than 15 minutes:

• No adBreaks should be listed during the first 4 mins of program start
• No pre-roll adBreak should be listed - 00:00:00
• adBreak cue points should be provided at naturally occurring scene breaks and/or fades to black
• There should be no less than 6 mins between each adBreak
• No adBreaks within the last 4 minutes of end credits

Episode Object Example:

{ "id": "1509428502952", "title": "The Amazing First Episode Title", "content": { ... }, "thumbnail": "https://example.org/cdn/thumbnails/1509428502952/1", "episodeNumber": 1, "shortDescription": "Marvelous episode description" }

ShortFormVideo content type

Child object of root property shortFormVideos.

Short-form videos are generally less than 15 minutes long, and are not TV Shows or Movies. Must be included in a composite EPG block of 15 mins or greater.

Short-form Video Object Example:

{ "id": "1509428502952", "title": "The Amazing Short-form Video", "content": { ... }, "thumbnail": "https://example.org/cdn/thumbnails/1509428502952/1", "shortDescription": "Astonishing short-form video", "releaseDate": "2016-01-01" }

TvSpecial content type

Child object of root property tvSpecials.

TvSpecial ad policy

Content length longer than 15 minutes:

• No adBreaks should be listed during the first 4 mins of program start
• No pre-roll adBreak should be listed - 00:00:00
• adBreak cue points should be provided at naturally occurring scene breaks and/or fades to black
• There should be no less than 6 mins between each adBreak
• No adBreaks within the last 4 minutes of end credits

TV Special Object Example:

{ "id": "1509428502952", "title": "The Amazing First Episode Title", "content": { ... }, "genres": [ "animals", "animated", "fantasy", ], "thumbnail": "https://example.org/cdn/thumbnails/1509428502952/1", "shortDescription": "Unusual episode description" }

Schedule object

All linear feeds require a schedule as part of the livefeed content object.

Schedule object example

{
    "id": "programId",

    "isLive": false,

    "date": "2020-01-13",

    "times": [

        "21:30"

    ],

    "durationInSeconds": 2760,

    "attributes": [

        "CC"

    ]
}

EPG

EPG Requirement

8 days of full data (1 week forward and 24 Hours back) to populate the EPG

15-minute minimum duration for content block

For full details and guidance on constructing your EPG, please refer this this guide.

https://developer.roku.com/en-ot/trc-docs/live-linear/epg-on-trc.md

Notes:

• Please include the liveFeed as the first item in a feed.
• Only a title or a TMS ExternalID is required for programs referenced in a schedule. We will reject anything that's not a valid ExternalID.
• When referencing an episode, the parent items must also be in included (series and season when applicable). These parent items must be fully populated with required fields as specified in the Roku Direct Published feed specification or the series item must contain a valid External TMS id.

EPG logos

To be provided via .zip file to Roku

For EPG Spine

• 1 logo for white background, 1 for black background (can be the same image if reads well on both backgrounds).
• Logos need to be transparent PNGs
• 114 pixels wide x 60 pixels tall
• Center aligned on the horizontal & vertical axis
• 3 pixel top and bottom border

For Info HUD

• Logos need to be transparent PNGs
• Logos need to be monochromatic hex #efefef
• 260 pixels wide x 147 pixels tall
• 1x logo center aligned

Feed Example:

{
    "liveFeeds": [
        {
            "id": "providerx-live",
            "title": "Provider X Live",
            "content": {
                "dateAdded": "2019-06-01",
                "language": "en",
                "schedule": [
                    {
                        "id": "movie-id-1",
                        "durationInSeconds": 7200,
                        "isLive": false,
                        "date": "2018-04-05",
                        "times": [
                            "10:00"                       
                        ]                       
                    },
                    {
                        "id": "episode-id-1",
                        "durationInSeconds": 7200,
                        "isLive": false,
                        "date": "2018-04-05",
                        "times": [                           
                            "12:00",                           
                            "16:00"
                        ]                       
                    },
                    {
                        "id": "shortformvideo-id-1",
                        "durationInSeconds": 7200,
                        "isLive": false,
                        "date": "2018-04-05",
                        "times": [                   
                            "14:00"                           
                        ]                       
                    },
                    {
                        "id": "tvspecial-id-1",
                        "durationInSeconds": 7200,
                        "isLive": true,
                        "date": "2018-04-05",
                        "times": [
                            "18:00"
                        ]                       
                    },
                    {
                        "id": "movie-id-2",
                        "durationInSeconds": 3600,
                        "isLive": false,
                        "date": "2018-04-05",
                        "times": [
                            "20:00"
                        ]                       
                    },
                    {
                        "id": "movie-id-3",
                        "durationInSeconds": 7200,
                        "isLive": false,
                        "date": "2018-04-05",
                        "times": [
                            "21:00"
                        ]                       
                    }
                ]
            },
            "thumbnail": "https://<imageUrl>.jpg",
            "shortDescription": "Live business and national news, with top executives interviews and coverage of the technologies transforming our lives and economy.",
            "longDescription": "Live business and national news, with top executives interviews and coverage of the technologies transforming our lives and economy."           
        }
    ],
    "movies": [
        {
        "id": "movie-id-1",
        "title": "Between Worlds",
        "externalIds": [
            {
                "id": "MV015001100000",
                "idType": "TMS"
                }
            ]
        },
        {
            "id": "movie-id-2",
            "title": "Between Worlds 2",
            "thumbnail": "https://<imageUrl>.jpg",
            "shortDescription": "A truck driver whose life spirals out of control after the spirit of his deceased wife comes to life.",
            "advisoryRatings": [
                {
                "source": "MPAA",
                "value": "R"
                },
                {
                "source": "CPR",
                "value": "14+"
                }
                  ],
            "genres":
                [
                "animals",
                "animated",
                "fantasy",
                ]
        },        
    ],
    "series": [
        {
            "id": "series-id-1",
            "title": "series1",
            "seasons": [
                {
                     "seasonNumber": 6,
                        "episodes": [
                        {
                            "id": "episode-id-1",
                            "title": "episode1",
                            "episodeNumber": 59
                        }                       
                    ]
                }
            ]
        }
    ],
    "tvSpecials": [
        {
            "id": "tvspecial-id-1",
            "title": "tvspecial1"
        }
    ],
    "shortFormVideos": [
        {
            "id": "shortformvideo-id-1",
            "title": "shortformvideo1"
        }
    ]
}

Kids-directed content

“Kids-Directed Content” means content that either: (i) is directed to children as defined by the applicable law of the jurisdiction in which the content is shown (e.g., The Children's Online Privacy Protection Act); or (ii) was made for viewing primarily by children within the jurisdiction in which the content is shown.

You may NOT submit or distribute Kids-Directed Content unless you have Roku’s express written approval.

The following additional obligations apply to all Kids-Directed Content:

The following additional obligations apply to all live linear streams that include Kids-Directed Content:

• You will only include Kids-Directed Content in a live linear stream if that live linear stream is (and will always be) comprised exclusively of Kids-Directed Content. Do not mingle Kids-Directed Content and non-Kids-Directed Content in a live linear feed.

• You will provide a single TV content rating in the Rating Object reflecting the most restrictive rating of all Kids-Directed Content that will be available on the live linear feed.

Additional kidsdirected guidelines

A kidsdirected tag should be inserted for any channel that is directed to children, based on a variety of factors, including the following:

• Ratings which designate the content as designed to be appropriate for children

  • Allowable ratings: Rating = TVPG, PG, TVY, TVY7, TVG, G
  • TVY and TVY7 are reserved for kidsDirected channels only
• Content subject matter (e.g., teaching the alphabet)
• Visual content (e.g., unicorns)
• Use of animated characters (e.g., My Little Pony)
• Child-oriented activities and incentives
• Music or other audio content designed for children (e.g., nursery rhymes)
• Young age of models (e.g., toddlers)
• Presence of child celebrities or celebrities who appeal to children
• Language or other characteristics of the content that target children
• Whether advertising appearing with the content is directed to children
• Whether your intended audience for the content is children
• Whether you have competent and reliable empirical evidence that your audience composes primarily of children

Content properties

Content property

Child object of property:

• liveFeed

This object represents the details about the liveFeed

Content Object Example:

{ "dateAdded": "2015-11-11T22:21:37+00:00", "language": "es", "schedule": [...], "validityPeriodStart": "2020-03-13", "validityPeriodEnd": "2100-03-12"}

Genres property

The following genres are supported:

ExternalIds property

Child object of property:

• movie
• series
• series -> episodes -> episode
• series -> seasons -> episodes -> episode
• shortFormVideo
• tvSpecial

This object represents a third-party metadata provider ID (such as TMS, Rovi, IMDB, EIDR) that can provide more information about a specific video content. This metadata optimizes the opportunity for your content to be discovered by Roku search and to provide more details to users.

External IDs Object Example:

{ "id": "123456789", "idType": "TMS" }, 

{ "id": "tt0371724", "idType": "IMDB" }, 

{ "id": "10.5240/48A5-E3C5-6B11-D874-FD2B-V", "idType": "EIDR" }

AdvisoryRatings property

Child object of property:

• movie
• series -> episodes -> episode
• shortFormVideo
• tvSpecial
• livefeed

This object represents the ratings across multiple territories for the video content. You can define the parental rating, as well as the source (USA Parental Rating, UK Content Provider, etc). See Parental Ratings and Rating Sources for acceptable values.

UK content - rating is required**. If there is no BBFC rating, please note a content rating of 'NR'

Rating Object Example:

"advisoryRatings": [
        {
          "source": "MPAA",
          "value": "PG13"
        },
        {
          "source": "CPR",
          "value": "14+"
        }
      ],

Accepted parental ratings

The following parental ratings can be used to better help your viewers find age-appropriate content.

Note: No content can be targeted specifically to children. No pornographic or porn industry-related content is allowed.

Rating source property

These are the accepted values for the ratingSource property:

• BBFC - British Board of Film Classification
• CHVRS - Canadian Home Video Rating System
• CPR - Canadian Parental Rating
• MPAA - Motion Picture Association of America
• USA_PR - USA Parental Rating
• RTC - General Directorate of Radio Television and Cinematography - Mexico
• ACB - Australian Classification Board
• CLASSIND - Classificação Indicativa - Brazil

Credit property

Child object of property:

• movie
• series
• series -> episodes -> episode
• shortFormVideo
• tvSpecial

This object represents a single person in the credits of a video content.

Credit Object Example:

{ "name": "Douglas N. Adams", "role": "screenwriter", "birthDate": "1952-03-11" }