Profile: listenable

Profile Schema

The listenable profile indicates a document that contains listenable audio as a primary component of its content. Not all documents containing audio should be considered “listenable”; listenable indicates that listening is a first-class method of consumption for this content.

A listenable profile is required to get content served within NPR One.

Structure

A listenable document must also have the has-audio profile, which specifies an audio attribute. listenable requires that one of the links in the audio array contains a rel value of primary.

Example listenable document

{
    "id": "12345",
    "profiles": [
        {
            "href": "/v1/profiles/listenable",
            "rels": ["type"]
        },
        {
            "href": "/v1/profiles/has-audio"
        },
        {
            "href": "/v1/profiles/document"
        }
    ],

    "assets": {
        "5678": {
            "id": "5678",
            "profiles": [
                {
                    "href": "/v1/profiles/audio"
                }
            ],

            "title": "Freezing all night, freezing all day: life on Hoth for a rebel commander",
            "enclosures": [
                {
                    "href": "https://npr-audio-host.org/life-on-other-planets/episode-3.mp3",
                    "rels": ["sponsored"],
                    "type": "audio/mpeg"
                }
            ]
        }
    },

    "audio": [
        {
            "href": "#/assets/5678",
            "rels": ["primary", "headline"]
        }
    ]
}