Station

    Station


    Article summary

    Field

    Max Occurs

    Required

    Attributes

    Description

    Example

    title

    1

    yes

    · overrideCanonicalValue: optional; default value is false
    · lang: optional unless overrideCanonicalValue=true

    Contains title of the content.OpenIngest does not expect attributes to be sent

    description

    1

    no

    · type: optional MIME type of the text
    · overrideCanonicalValue: optional; default value is false
    · lang: optional unless overrideCanonicalValue=true

    For movie,seriesMaster, or episode entityTypes, can use shortDescription,mediumDescription, and/or longDescription instead

    Harry Potter description

    gmrss:contentProviderName

    1

    preferred

    The name of the content provider

    gmrss:contentProviderNameMEDIASET</gmrss:contentProviderName>

    gmrss:distributionRights

    unlimited

    yes

    Information about a set of content which may be made available via a Distributor that is supported by our platform. See DistributionRights table below.

    gmrss:distributor

    1

    yes

    Distributor of the video asset. An example from traditional ADI VOD would be distributor=indemand and brand=NBC Universal. An example from an OTT provider would be distributor=Netflix and brand=NBC Universal. This will be saved as a Merlin ProgramMediaAssociation.companies entry with role=Distributor.

    <gmrss:distributor>Peacock</gmrss:distributor>

    gmrss:durableAppId

    1

    yes

    Our app's X1 user-friendly app identifier, should represent the specific app where this content is intended to be played. Identifier of the OTT app the content is contained in. It is required for X1 integration.

    <gmrss:durableAppId>Peacock</gmrss:durableAppId>

    gmrss:brand

    1

    yes

    Drives the brand logo selectionBrand of the video asset. An example from traditional ADI VOD would be distributor=indemand and brand=NBC Universal. An example from an OTT provider would be distributor=Netflix and brand=NBC Universal. This will be saved as a Merlin ProgramMediaAssociation.companies entry with role=Provider.Also supports "merlin:" instead of Brand name.

    <gmrss:brand>nbcentertainment</gmrss:brand>

    media:thumbnail

    unlimited

    no

    · url: required; url of the image, should be reachable on general internet
    · width: required; width of the image
    · height: required; height of the image
    · format: required; format of the image, only jpeg is supported
    · type: required; type designation of the image, such as 'Poster Art'
    · provider: optional; defaults to THIRD_PARTY. Defines the feed provider type of the Image in the Merlin ingest system. This is used by Myriad for image priority and selection.
    · external: optional; defaults to false. If false, Myriad will download the image once a month and store it locally for resizing. If true, Myriad will not download the image, and the source image will be retrieved when the image TTL is reached on the Comcast CDN (approximately 30 minutes). This allows an image update to the same URL to take effective as frequently as every 30 minutes but the URL must remain available and be able to handle traffic load from Myriad.
    · useUrlHash: optional; defaults to false. Is used to tell imageManagementWebService to hash the url when true. This is needed for urls like https://image.xumo.com/v1/assets/asset/XM008PMCJE4NJN/1280x720.jpg where the path is unique but the file name is not.

    Images for the video or Program the video represents. Note that any size is permissible, but sizes should align with X1 supported sizes otherwise invalid sized images may be ignored. The image URL must be internet accessible so that the X1 image resizing service, Myriad, can retrieve it and store it to the Comcast CDN.

    <media:thumbnail height="1080" url=http://fakeimageurl.com/image.jpg width="1920" type="Provider Poster Art" format="jpeg"/>

    gmrss:nativeId

    1

    yes

    · provider: required, provider of the id and id namespace. Consult the Merlin team to make sure the provider specified is configured for OpenIngest.
    · namespace: optional, namespace where the id is unique – within Merlin this is concatenated together with the value to form a guid such as "watchable:12345". This should be used if multiple ID spaces exist within the same provider to guarantee uniqueness.

    Used to create or update station associated with the current item. NativeIds must be limited to 6 digits. Namespace will be ignored.

    <gmrss:nativeId provider="XUMO" namespace="XUMO">99940</gmrss:nativeId>

    gmrss:stationReference

    1

    no

    · provider: required, provider of the station ID
    · namespace: optional, namespace where the id is unique – within Merlin this is concatenated together with the value to form a guid such as "watchable:12345". This should be used if multiple ID spaces exist within the same provider to guarantee uniqueness.

    A reference to a station using provider and provider's native id. Namespace will be ignored. If you are a provider who contracts with GRACENOTE and a GRACENOTE reference is provided here, you only need to provide ChannelLineups, Stations, and LinearChannel metadata.

    <gmrss:stationReference provider="GRACENOTE">125221</gmrss:stationReference>

    gmrss:languageDetails

    1

    preferred

    · primaryBroadcast: optional; Describes the station language
    · broadcast: optional; Comma-separated list of broadcast languages
    · edited: optional; Comma-separated list of language edits

    Language details for the provided station.

    <gmrss:languageDetails primaryBroadcast="en-US" broadcast="en-US" edited="en-US"</gmrss:languageDetails>

    gmrss:locator

    unlimited

    yes

    Information required to produce a Firebolt "TuneIntent" when a customer expresses the desire to play a particular linear stream. See Locator table below.

    gmrss:videoQuality

    1

    yes

    Describes video stream quality

    <gmrss:videoQuality>HD</gmrss:videoQuality>

    Locator

    Field

    Max Occurs

    Required

    Attributes

    Description

    Example

    gmrss:contentProviderName

    1

    preferred

    The name of the content provider

    <gmrss:contentProviderName>MEDIASET</gmrss:contentProviderName>

    gmrss:distributionRights

    unlimited

    yes

    Information about a set of content which may be made available via a Distributor that is supported by our platform. See DistributionRights table below.

    gmrss:locatorType

    1

    yes

    The type of the fireboltLocator. Defaults to FireboltTune.

    <gmrss:locatorType>FireboltTune</gmrss:locatorType>

    gmrss:fireboltEntityId

    1

    yes

    The unique entity identifier for the TuneIntent

    <gmrss:fireboltEntityId>9999340</gmrss:fireboltEntityId>

    gmrss:fireboltChannelType

    1

    yes

    The channel type of the TuneIntent. Valid values are streaming or overTheAir.

    <gmrss:fireboltChannelType>streaming</gmrss:fireboltChannelType>

    gmrss:fireboltAppContentData

    1

    no

    Additional app content data for TuneIntent

    <gmrss:fireboltAppContentData/>

    Distribution Rights

    Field

    Max Occurs

    Required

    Attributes

    Description

    Example

    gmrss:valid

    unlimited

    yes, if not provided at top level

    · downloadable: Optional

    Specifies the time window during which the contentRights object is applicable.

    <ns3:valid downloandable=false >start=2022-01-01T00:00Z;end=2035-12-31T00:00Z;scheme=W3C-DTF</ns3:valid>

    gmrss:contentCatalog

    1

    yes, if providing separate catalogs for different platforms

    The specific app catalog, if an app provider delivers separate customized catalogs for different products. If not provided, contentProviderName is used.

    <gmrss:contentCatalog>Netflix</gmrss:contentCatalog>

    gmrss:contentClass

    1

    yes

    This is expressed in industry standard terms such as SVOD, TVOD, AVOD, etc. With windows for each

    <gmrss:contentClass>SVOD</gmrss:contentClass>

    gmrss:contentTier

    1

    yes

    The provider-specific term for different tiering rules dictating subscription requirements to consume content

    <gmrss:contentTier>Basic</gmrss:contentTier>

    gmrss:playRegions

    1

    yes

    Contains a list of viable play regions for this content

    <gmrss:playRegions><gmrss:playRegion type="ISODIVISION">IE</gmrss:playRegion><gmrss:playRegion type="ISOSUBDIVISION">GB-NIR</gmrss:playRegion></gmrss:playRegions>

    gmrss:playRegion

    unlimited

    yes

    · type: Required

    Specifies the region where the content can be played. Embedded within gmrss:playRegions

    <gmrss:playRegion type="ISOSUBDIVISION">GB-NIR</gmrss:playRegion>

    Sample

    <gmrss:station>
        <gmrss:nativeId provider="XUMO" namespace="XUMO">9999340</gmrss:nativeId>
        <gmrss:durableAppId>xumo</gmrss:durableAppId>
    
        <title>Food52</title>
        <description>Eat thoughtfully, live joyfully.</description>
    
        <gmrss:distributor>Xumo</gmrss:distributor>
        <gmrss:brand>Xumo Food</gmrss:brand>
    
        <gmrss:stationReference provider="GRACENOTE">125221</gmrss:stationReference>
    
        <gmrss:contentProviderName>XUMO</gmrss:contentProviderName>
        <gmrss:distributionRights>
            <gmrss:valid>start=2021-04-20T00:00:00Z;end=2120-01-01T05:00:00Z;scheme=W3C-DTF</gmrss:valid>
            <gmrss:contentClass>AVOD</gmrss:contentClass>
            <gmrss:contentTier>XumoFree</gmrss:contentTier>
            <gmrss:playRegions>
                <gmrss:playRegion type="ISODIVISION">US</gmrss:playRegion>
                <gmrss:playRegion type="ISODIVISION">CA</gmrss:playRegion>
            </gmrss:playRegions>
        </gmrss:distributionRights>
    
        <media:thumbnail height="640" width="640" url=https://image.xumo.com/v1/channels/channel/9999340/640x640.png?type=color_onWhite_cropped type="Source Logo - gray" format="png"/>
        <media:thumbnail height="640" width="640" url=https://image.xumo.com/v1/channels/channel/9999340/640x640.png?type=channelTile type="Source Logo - dark" format="png"/>
        <media:thumbnail height="640" width="640" url=https://image.xumo.com/v1/channels/channel/9999340/640x640.png?type=white_cropped type="Source Logo - white" format="png"/>
    
        <gmrss:languageDetails primaryBroadcast="en-US" broadcast="en-US" edited="en-US"</gmrss:languageDetails>
    
    
        <gmrss:locator>
            <gmrss:locatorType>FireboltTune</gmrss:locatorType>
            <gmrss:fireboltEntityId>*9999340*</gmrss:fireboltEntityId>
            <gmrss:fireboltChannelType>streaming</gmrss:fireboltChannelType>
            <gmrss:fireboltAppContentData/>
    
            <gmrss:contentProviderName>XUMO</gmrss:contentProviderName>
            <gmrss:distributionRights>
                <gmrss:valid>start=2021-04-20T00:00:00Z;end=2120-01-01T05:00:00Z;scheme=W3C-DTF</gmrss:valid>
                <gmrss:contentClass>AVOD</gmrss:contentClass>
                <gmrss:contentTier>XumoFree</gmrss:contentTier>
                <gmrss:playRegions>
                    <gmrss:playRegion type="ISODIVISION">US</gmrss:playRegion>
                    <gmrss:playRegion type="ISODIVISION">CA</gmrss:playRegion>
                </gmrss:playRegions>
            </gmrss:distributionRights>  
        </gmrss:locator>
    </gmrss:station>
    


    Was this article helpful?

    What's Next