In this article, we cover the following items:
- To Import Videos from an MRSS Feed
- MRSS Elements
- Sample MRSS Format
- Sync Intervals
Zype allows videos from an MRSS feed to be imported into your Video Library. The MRSS feed must conform to the Zype MRSS Import Format for videos to be imported.
Once you have imported videos from an MRSS feed, Zype updates and syncs with the feed on a daily or hourly basis. Videos imported via MRSS feed will remain active in Zype as long as the platform detects an active video source. If the video source for an imported video has been removed from your MRSS feed, Zype will deactivate the video upon the next MRSS sync.
MRSS feeds are supported by all OTT endpoints on Zype, but they need to meet endpoint requirements.
To Import Videos From an MRSS Feed
-
On the Zype navigation menu, click Import & Upload.
-
Scroll down the Import & Upload page and click MRSS.
-
On the MRSS Import page, you may change the feed’s import name, which Zype assigns by default.
-
Enter your MRSS URL. Your MRSS feed must conform to the Zype MRSS Import Format.
-
By default, Zype generates categories for the videos during import based on the title specified in your MRSS feed. You may override this by selecting another category from the list.
NOTE: To manually set categories during import, you must have previously set up categories for your video content (see Introduction to Categories).
-
Enter the category values to be assigned to the videos during import. You may enter as many category values as you want.
-
Optionally, set a starting date and time for importing videos. This means that only those videos that are published after the starting date and time will be imported to your Video Library. Leave this field blank to import the earliest videos in your MRSS feed.
-
Optionally, set an ending date and time for importing videos. This means that only those videos that are published before the ending date and time will be imported to your Video Library. Leave this field blank to import even the most recent videos in your MRSS feed, or if you want to continue auto-syncing your MRSS feed to import newly-added videos.
-
By default, the Auto-Add Videos and Auto-Activate Videos options are toggled On, meaning that all new imported videos will be added to your video library and have access to all features of the Zype platform, respectively. You may toggle Off these options.
-
By default, the Auto Sync Video Data Source option is toggled On, meaning that video source attributes such as thumbnails and video files are updated if they change on the MRSS feed. You may toggle Off this option.
- Select a sync interval - either hourly or daily.
-
By default, the Auto Deactivate Video Data Sources option is toggled Off, meaning that video data sources will remain active even if they are absent from the MRSS feed during sync. You may toggle On this option.
-
Click Continue to preview and ensure your data is correct. Double-check your feed if errors are found in the MRSS import format.
-
If there are no errors, click Save.
-
On the Customize your Import page, the Import metadata option is selected by default.
Go with the default option if your videos are served by an existing CDN and you want to only import the metadata from your MRSS feed.
Select the second option, Import content and metadata, to transcode your videos, add them to your Video Library, and serve your content using Zype's CDN.
- Click Complete Import.
After Zype imports the videos from your feed, you can view or edit the video details by going to your video library. For more details, see Managing Video Imports.
If you opted not to automatically add the videos to your library, they can be found under Tools>Video Imports.
NOTES: Videos imported via MRSS feed will remain active in Zype as long as the platform can detect an active video source. If the video source for an imported video has been removed from your MRSS feed, Zype will deactivate the video upon the next MRSS sync.
It is also possible that the imported videos show a duration that is different from the one the original video has. If this is the case, it is possible that the video has an audio track that is longer/shorter than the video itself, and since the audio presets are the first to be encoded, the video object will also reflect this duration.
MRSS Elements
Element | Requirement | Function |
---|---|---|
channel:title | Required | Sets the title of the channel (the set of your video items). Zype will interpret this as the main category title. |
item:guid | Required | The unique ID of the item |
item:pubDate | Required | The publication date of the item |
media:content:url | Required | The link to the mp4 of your video item |
media:content:duration | Optional | The duration in seconds of your video item |
media:content:width | Required | The width in pixels of your video item |
media:content:height | Required | The height in pixels of your video item |
media:title | Required | The title of your video item |
media:description | Optional | The description of your video item |
media:keywords | Optional | The keywords to associate with your video item. Must be a comma-delimited list |
media:thumbnail:url | Required | The link to the jpg or png of your video thumbnail. Note this will be set as the custom thumbnail image once the video is created in your Zype account. Only required if you are not using Zype for transcoding and delivery. |
media:thumbnail:width | Required | The width in pixels of your video thumbnail |
media:thumbnail:height | Required | The height in pixels of your video thumbnail |
media:source_id | Optional. Recommend if managing video in a 3rd party database | The source ID of your video from its originating database. |
media:category | Optional. Recommended for category playlists |
The category value of your video item. Will be categorized under the main category heading as set in the channel:title, or in another category if specified while importing
This implementation requires that a single category is configured on the MRSS video source, and then individual <media:category> tags for each item are parsed for each “category value” to be added. This does not allow for categories to be added outside of the top level category. |
media:video_category | Optional |
This enables you to send additional category metadata outside of the top-level category configured on the MRSS video source.
Categories and category values that do not exist (by name) at the time of MRSS ingest will be created at ingest. |
media:episode | Optional. Recommended for videos in TV shows & series | An integer value indicating the episode number of the video within a season or series. Example: '1' |
media:season | Optional. Recommended for videos in TV shows & series | An integer value indicating the season number a video belongs to within a series. Example: '3' |
media:series_id | Optional. Recommended for videos in TV shows & series | A string indicating the title of a series that the video belongs to. Example 'The Great Adventures of Funny Dog' |
media:mature_content | Optional | A value of 'true' or 'false'; setting to 'true' determines if this video is mature and may require age verification prior to viewing. |
media:featured | Optional | A value of 'true' or 'false'; setting to 'true' allows you to promote videos in API requests. |
media:on_air | Optional | A value of 'true' or 'false'; setting to 'true' can prioritize players for live events. |
media:country | Optional | A string value for the country where the video was published. |
media:ad_timings | Optional |
A comma separated list of ad cue time offsets in HH:MM:SS format. Precision to the nanosecond can be achieved optionally adding up to 9 decimal points: HH:MM:SS.nnnnnnnnn
This tag does not allow for the parsing of ad_timing metadata. It is advised you use this ad timing method OR the other. |
media:video_ad_timing | Optional |
An additional ad timing tag should be used to ingest granular ad timing data. There can be multiple tags in each item. It is advised you use this ad timing method OR the other.
|
media:subtitle:url | Optional |
The link to the subtitle file. Both url and href attributes are supported. Only VTT files are currently supported. If this tag is used, <media:subtitle:type> and <media:subtitle:lang> become required. |
media:subtitle:type | Conditional |
Value of the type of subtitle, at the moment only VTT are supported: 'application/vtt' (Must be set to "text/vtt" for proper ingestion when using the url attribute.) Required if <media:subtitle:url> is present. |
media:subtitle:lang | Conditional | Indicates the subtitle language (e.g., "en" for English). Required if <media:subtitle:url> is present. |
media:enable_at | Optional |
Metadata that determines when a video will be enabled in the Zype library.
If the “enable_at” field is present, it will take precedence over the “auto_active” flag. This means that even if “auto_active=true,” the video's activation status will be determined by the “enable_at” value. “auto_add” must be set to true. If the video is not added to the library, then there is no video object to enable.
|
media:disable_at | Optional |
Metadata that determines when a video will be disabled in the Zype library.
|
meta name and value | Optional. Recommended for ad server key value pairing |
Custom attributes that can be mapped to a video as key value pair metadata. Name will be mapped as the Key, and Value will map to any values you want to match to that Key. |
Sample MRSS Format
Below is an example of an MRSS feed that is compatible with Zype. To properly import videos from an MRSS feed, you must format your feed to match this example.
We strongly suggest using media:category tags so your content can be automatically organized.
<rss xmlns:media="https://search.yahoo.com/mrss/" xmlns:dcterms="https://purl.org/dc/terms/" version="2.0">
<channel>
<title>MRSS Category Title Example</title>
<link/>
<description/>
<item>
<title>My Video 1</title>
<guid>0_qwert</guid>
<link>0_qwert</link>
<pubDate>Mon, 16 May 2016 20:42:45</pubDate>
<endDate/>
<media:content url="https://www.mrss-example.com/p/123/sp/12300/playManifest/entryId/0_qwert/flavorId/0_4lidycd2/protocol/http/format/url/a.mp4?clientTag=feed:abcd" duration="31" width="1920" height="1080">
<media:title>My Video 1</media:title>
<media:description>Description text goes here</media:description>
<media:keywords>example, video, mrss</media:keywords>
<media:thumbnail url="https://mrss-example-img.revnm.com/p/123/sp/12300/thumbnail/entry_id/0_qwert/version/100012/acv/202/width/1920/height/1080" width="1920" height="1080" />
<media:category>
Example Category Value
</media:category>
<media:video_category>
<category_name>Category Name 1</category_name>
<category_value>Category Value 1</category_value>
<category_value>Category Value 2</category_value>
</media:video_category>
<media:video_category>
<category_name>Category Name 2</category_name>
<category_value>Category Value 3</category_value>
<category_value>Category Value 4</category_value>
</media:video_category>
<media:subtitle type="text/vtt" lang="en-us" url="https://subtitle-example.com/subtitle.vtt"/>
<meta name="custom_field1" value="custom_value1"/>
<meta name="custom_field2" value="custom_value2"/>
</media:content>
<media:ad_timings>00:00:55, 00:03:00</media:ad_timings>
<media:video_ad_timing>
<mode>linear</mode> ## options: 'linear' = Linear, 'off' = Offset
<type>push-out</type> ## options: 'in' = Inline, 'push-out' = Push Out, 'overwrite' = Overwrite
<start_time>00:01:00</start_time> ## start time should be in HH:MM:SS format
<duration>30</duration> ## integer duration of the ad timing
</media:video_ad_timing>
<media:video_ad_timing>
<mode>linear</mode>
<type>push-out</type>
<start_time>00:02:00</start_time>
<duration>30</duration>
</media:video_ad_timing>
</item>
<item>
<title>My Video 2</title>
<guid>0_123abc</guid>
<link>0_123abc</link>
<pubDate>Mon, 16 May 2016 20:35:14</pubDate>
<endDate/>
<media:content url="https://www.mrss-example.com/p/123/sp/12300/playManifest/entryId/0_123abc/flavorId/0_thxezdy6/protocol/http/format/url/a.mp4?clientTag=feed:abcd" duration="52" width="1920" height="1080">
<media:title>My Video 2</media:title>
<media:description>Description text goes here</media:description>
<media:keywords>example, video 2, mrss</media:keywords>
<media:thumbnail url="https://mrss-example-img.revnm.com/p/123/sp/12300/thumbnail/entry_id/0_123abc/version/100012/acv/212/width/1920/height/1080" width="1920" height="1080" />
<media:category>
Example Category
</media:category>
<media:subtitle type="text/vtt" lang="en-us" url="https://subtitle-example.com/subtitle_en.vtt"/>
<media:subtitle type="text/vtt" lang="en-us" url="https://subtitle-example.com/subtitle_es.vtt"/>
<meta name="custom_field3" value="custom_value3"/>
<meta name="custom_field4" value="custom_value4"/>
</media:content>
<media:ad_timings>00:02:03, 00:04:00</media:ad_timings>
</item> </channel> </rss>
Sync Intervals
By default, daily and hourly sync intervals are available:
To learn about additional sync interval frequencies please reach out to your customer success manager.