- Video-on-demand programming – movies, TV series, and documentaries
- Linear broadcast content – TV channels, Free Ad-Supported Television (FAST) channels, and 24-hour schedules
- Live event programming – sports events, concerts, and special performances
| Property | Value |
|---|---|
| XSD file | EMBER_1.0.0.xsd |
| Schema version | 1.0.0 |
XSD schema architecture
Every EMBER document contains oneDataCollections root element that serves as the top-level container for all catalog types.
schemaVersion attribute identifies the EMBER schema version. The default value is 1.0.0. This attribute enables version-aware processing, which supports future schema evolution.
Catalog types
EMBER organizes metadata into six specialized catalog types, each addressing a specific aspect of the content delivery chain. The following table describes each catalog type and its key elements. For examples of each catalog type, see EMBER Examples.Core concepts
This section covers the foundational concepts that apply across all EMBER catalog types.Element order dependency
The EMBER schema usesxs:sequence within each program type and entity. Child elements at those levels must appear in the exact order defined in the XSD schema. Incorrect element ordering causes XML validation failure, even if all required elements are present. For example, elements within Movie and within nested containers such as Credits, must follow XSD-defined order.
However, the root DataCollections element and the catalog containers (ProgramCatalog, ScheduleCatalog, OfferCatalog, StationCatalog, LineupCatalog, PolicyCatalog) use xs:choice, so their child elements can appear in any order. For example, within a ProgramCatalog, program types such as Movie, TVEpisode, and TVSeries can appear in any order.
Valid movie example – Correct order
The following example shows the correct element order for a Movie element.
Genres element is placed before Images, which causes a validation error.
Cross-catalog references
EMBER catalogs reference each other through a structured reference system that maintains referential integrity and enables flexible organization. The reference system links entities across catalogs without data duplication. There are two types of references: entity references and catalog references. Entity references are attributes that link to specific entities by their ID. The following table describes these attributes.| Attribute name | Description | Used in |
|---|---|---|
programRef | References a program by ID. Points to Movie, TVSeries, TVSeason, TVEpisode, SportsEvent, Event, Extra, or Other. | ProgramOffers, ProgramAiringOffers, ProgramDiscovery, Airing, Relationships |
stationRef | References a station by ID. Points to Station or ExternalStation. | StationOffers, Schedule, Channel |
policyRef | References a policy by ID. Points to RegionPolicy or EntitlementPolicy. | GeoRestriction, Entitlement |
programCatalogRef– Specifies whichProgramCatalogcontains the program. Default:DEFAULT_PROGRAM_CATALOG.stationCatalogRef– Specifies whichStationCatalogcontains the station. Default:DEFAULT_STATION_CATALOG.policyCatalogRef– Specifies whichPolicyCatalogcontains the policy. Default:DEFAULT_POLICY_CATALOG.scheduleCatalogRef– Specifies whichScheduleCatalogcontains schedules. Default:DEFAULT_SCHEDULE_CATALOG.
ProgramOffer catalog can reference a movie from a program catalog.
- All references must resolve to existing entities.
- The referenced ID must exist in the specified or default catalog, and the referenced entity must be the appropriate type, for example, a
programRefmust point to a program, not a station. - Circular dependencies aren’t allowed.
Identifiers
Every entity in EMBER has a uniqueid attribute that serves as its primary identifier. The id attribute must meet the following requirements:
- Durable – Don’t change the ID after entity creation.
- Unique – The ID must be unique within your partner namespace and entity type.
- Case-sensitive –
MOVIE_123andmovie_123are different IDs. - Format – Alphanumeric characters plus
_,-,., and:are valid. - Minimum length – One character.
| Entity type | Pattern | Example |
|---|---|---|
| Movie | MOVIE_TITLE_YEAR | MOVIE_AVENGERS_2024 |
| TV series | SERIES_TITLE | SERIES_FRIENDS |
| TV season | SERIES_S## | SERIES_FRIENDS_S01 |
| TV episode | SERIES_S##E## | SERIES_FRIENDS_S01E01 |
| Sports event | LEAGUE_SEASON_DETAILS | NFL_2025_W01_SEA_SF |
| Station | CALLSIGN_NETWORK_CITY | KIRO_CBS_SEATTLE |
Movie element.
External IDs
External identifiers link EMBER entities to external metadata systems, enabling content matching and cross-system tracking.| Scheme | System | Used for | Example |
|---|---|---|---|
imdb | Internet Movie Database | Movies, TV, people | tt0076759, nm0000123 |
tms | Tribune Media Services | Movies, TV, stations | MV123456789012, TMS87654321 |
gvd | Gracenote Video Data | Movies, TV, stations | GVD_HBO_EAST, GVD_12345 |
isan | International Standard Audiovisual Number | Movies, TV | 0000-0000-0000-0000-0-0000-0000-0 |
eidr | Entertainment Identifier Registry | Movies, TV | 10.5240/XXXX-XXXX-XXXX-XXXX-XXXX-X |
asin | Amazon Standard Identification Number | Amazon content | B09ABCD123 |
ean | European Article Number | Physical media | 5051890000000 |
upc | Universal Product Code | Physical media | 012345678905 |
sportsradar | Sports Radar | Sports events, teams, players | sr:match:12345678 |
Versioning
Theversion attribute provides optimistic concurrency control, ensuring consistency when updates arrive out of order. The version value is an integer—either sequential or timestamp-based—where a higher number takes precedence. The system ignores lower versions, even if they arrive later. The default value is 1 if omitted.
- Sequential – Increment by one for each update: 1, 2, 3, and so on.
- Timestamp – Use Unix epoch seconds: 1713622889, 1713622890, and so on.
- Hybrid – Combine date and sequence: 20250420001, 20250420002, and so on.
Localization
EMBER provides multi-language, multi-territory support through three coordinated attributes:language– A BCP-47 language code, such asen,es,es-MX,pt-BR, orfr-CA.territories– ISO 3166-1 alpha-2 country codes, comma-separated orGLOBAL. For example,US,US,CA,MX, orGLOBAL.default– A boolean flag (trueorfalse) that marks the fallback value.
- Exact match – Both language and territories match.
- Language match – Language matches, territories ignored.
- Default fallback – Uses the entry with
default="true".
- A UK customer (en-GB) sees “Marvel Avengers Assemble” through exact match.
- A US customer (en-US) sees “The Avengers” through language match to default.
- A Spanish customer (es-MX) sees “Los Vengadores” through language match.
- A German customer (de-DE) sees “The Avengers” through default fallback.
- One entry must have
default="true"per property. - The default should be the original or primary language.
- Use simple language codes such as
enandesunless dialect differentiation is needed. - Use
territories="GLOBAL"or omit the attribute for worldwide content.
US(United States)CA(Canada)MX(Mexico)GB(United Kingdom)DE(Germany)FR(France)ES(Spain)IT(Italy)JP(Japan)AU(Australia)BR(Brazil)IN(India)
Relationships
EMBER models content hierarchies and associations through structuredRelationship elements within programs.
Television content follows a three-level hierarchy connected by relationship elements.
TVSerieslinks toTVSeasonbyisSeasonOfSeriesusing theseasonNumattribute.TVSeasonlinks toTVEpisodebyisEpisodeOfSeasonusing theepisodeNumattribute.
| Relationship | From | To | Required attributes | Purpose |
|---|---|---|---|---|
isSeasonOfSeries | TVSeason | TVSeries | seasonNum | Links season to parent series |
isEpisodeOfSeason | TVEpisode | TVSeason | episodeNum | Links episode to parent season |
isEpisodeOfSeries | TVEpisode | TVSeries | episodeNum | Links episode to parent series. Mini series uses isEpisodeOfSeries without isEpisodeOfSeason. |
isExtraOf | Extra | Any program | orderNum (optional) | Links bonus content to main content |
isRelatedTo | Any program | Any program | None | General content relationship |
TVSeason– Must includeisSeasonOfSeries.TVEpisode– For regular TV series episodes, includeisEpisodeOfSeasonandisEpisodeOfSeries. For mini series episodes, includeisEpisodeOfSeries.Extra– Should includeisExtraOf(recommended but not required).
TVSeriesTVSeasonTVEpisode
TVEpisode that links to both its parent season and parent series using isEpisodeOfSeason and isEpisodeOfSeries.
isExtraOf.
isRelatedTo to create non-hierarchical connections between content.
Source attributes
Source attributes provide provenance tracking for editorial content, documenting where metadata originated. The attribute group includes:sourceName– Name of the metadata provider, such as “IMDb”, “Gracenote”, or “Rotten Tomatoes.”sourceDate– Date the metadata was retrieved, in YYYY-MM-DD format.sourceId– The provider’s identifier for the data record.
Delete and catalog actions
TheDelete element removes entities from catalogs by using ID and version matching. A delete succeeds if the specified version is greater than or equal to the current entity version. The system ignores a delete if the specified version is lower than the current entity version. This protects against out-of-order message delivery.
action attribute controls catalog-level update behavior. The following table describes the available values.
| Action | Behavior | Use case |
|---|---|---|
upsert (default) | Adds new entities, updates existing entities, and preserves others. | Incremental updates. This is the most common action. |
replace | Removes all existing entities and adds new ones. | Complete catalog rebuild. Use with caution. |
action="upsert" to add a new movie, update an existing movie, and delete an expired movie without affecting the rest of the catalog.
action="replace" to rebuild the entire catalog, which removes any movies not included in the submission.
action="upsert" for regular updates. Reserve action="replace" for complete catalog rebuilds and full refreshes.
Data type reference
The EMBER schema uses both built-in XML data types and custom EMBER-specific data types. The following tables describe each type.Built-in XML data types
| Data type | Format or range | Description |
|---|---|---|
boolean | true, false | Boolean values. Used for flags such as default, adultProduct, notRated, closed, homeTeam, premiere, and finale. |
decimal | Any decimal number | Numbers with fractional components, such as 5.2, 8.99, or 100.0. Used for prices and rating scores. Example: score="4.8" maxScore="5". |
int | -2147483648 through 2147483647 | Standard integers. Used for counts and year values in copyright. |
long | -9223372036854775808 through 9223372036854775807 | Large integers. Used for version numbers and timestamps. Examples: version="1", version="1713622889". |
nonNegativeInteger | 0, 1, 2, 3, … | Zero or positive integers. Used for seasonNum, episodeNum, and orderNum. Examples: seasonNum="1", episodeNum="5". |
positiveInteger | 1,2, 3, … | Positive integers with a minimum of 1. Used when zero isn’t valid. |
string | Any text | General text content. Used for names, descriptions, and URLs. Supports Unicode for international characters. |
unsignedInt | 0 through 4294967295 | Non-negative integers with large range. Used for numVotes in customer ratings. |
EMBER-specific data types
| Data type | Format or values | Description |
|---|---|---|
| AspectRatioType | 16:9, 4:3, 3:4, 2:3, 1:1, other | Image aspect ratios:
|
| CatalogActionType | upsert, replace | Catalog update behavior:
|
| DateTimeType | YYYY-MM-DDTHH:MM:SS±HH:MM | ISO-8601 date-time with time zone. Time zone is required as Z or ±offset.Examples: 2025-04-20T15:30:00Z (Coordinated Universal Time), 2025-04-20T08:30:00-07:00 (PST). |
| DateType | YYYY-MM-DD | ISO-8601 date format. Used for schedule dates and release dates. Examples: 2025-04-20, 2025-12-31. |
| DurationType | P[n]Y[n]M[n]DT[n]H[n]M[n]S | ISO-8601 duration.
T for time components.Examples: PT30M (30 minutes), PT2H (2 hours), PT1H30M (1 hour 30 minutes). |
| EditTypeList | ORIGINAL, DIRECTORSCUT, EXTENDED, UNRATED, CENSORED, REGIONALIZED, COLORIZED, SHORTENED | A comma-separated list that indicates the edit version of the program. Valid edit types:
edit="DIRECTORSCUT,UNRATED" |
| EntitlementTypeEnumType | free, subscription | Entitlement types:
policyRef for complex tiers. |
| ExtraCategoryType | trailer, teaser, clip, featurette, behindthescenes, deletedscenes, bloopers, commentary, interview, highlights, preevent, postevent | Enumeration that represents the category of extra content. The extra content must relate to the original content, such as the movie or TV series available in the catalog. Valid values:
|
| ID | Alphanumeric plus the characters: _ - . : | Partner identifiers. Minimum length one character. Case-sensitive. Example: id="MOVIE_AVENGERS_2024". |
| ImageCategory | background, cover, poster, episodic, title, logo | Image types:
|
| ImageColorType | color, white, light, black, gray, dark | Logo color variants for different UI backgrounds. |
| LanguageType | BCP-47 codes | Language tags. Examples: en (English), es (Spanish), es-MX (Mexican Spanish), pt-BR (Brazilian Portuguese), fr-CA (Canadian French), zh-Hans (Simplified Chinese). |
| LaunchTargetTypeEnum | WEB, FIRETV | Launch target types for launch URLs:
|
| LocalizedStringType | string with attributes | A string with the addition of the language, territories, and default attributes. |
| MimeType | image/jpeg, image/png | Image formats. JPEG for photos and backgrounds, PNG for logos with transparency. |
| OriginalBroadcastType | Full Power Broadcast, Low Power Broadcast, Cable Only, Satellite, Over the Top, Network, TV, VOD, Radio, Digital Broadcast Network, Split | The type of broadcast the station provides. An example of Split is full power broadcast during the day and low power broadcast at night. |
| PictureColorEnumType | color, bandw, colorized, composite, unknown | Picture color characteristics:
|
| PolicyFilterType | allow_all, allow_only, block_only | Geographic filters for postal codes:
|
| ReleaseType | theater, video, streaming | Distribution mechanism for the release:
|
| ResolutionType | 8K, 4K, FullHD, HD, SD | Video resolution levels in descending order of quality. |
| SourceDateType | YYYY-MM-DD | Represents the date that the provider in the sourceName attribute delivered the data. Restricted to DateType format. |
| SourceIdType | string | The identifier associated with this piece of data, provided by the source in the sourceName attribute. |
| SourceNameType | string | The name of the provider of the metadata contained in this element. |
| TerritoriesType | ISO 3166-1 alpha-2 | Country codes, comma-separated. Examples: US, US,CA,MX, GLOBAL.Common codes: US, CA, MX, GB, DE, FR, ES, IT, JP, AU, BR, IN. |

