kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
875 wiersze
42 KiB
Markdown
875 wiersze
42 KiB
Markdown
# RSS Namespace Extension for Podcasting (Tag Specification)
|
|
|
|
A wholistic RSS namespace for podcasting that is meant to synthesize the fragmented world of podcast namespaces. As elements are canonized, they will be added to this document so developers can begin implementation. The specifications below are considered locked and the team will prioritize backward compatibility. We are operating under the [Rules for Standards-Makers](http://scripting.com/2017/05/09/rulesForStandardsmakers.html).
|
|
|
|
The namespace for this extension is `https://podcastindex.org/namespace/1.0`. Clients which recognize this namespace must also recognize `https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md` as identical. The suggested tag prefix for use in XML is `podcast`, but clients should support alternate prefixes for this namespace. If your application generates RSS feeds and you implement one or more elements below, you will need to link this document in your XML:
|
|
|
|
```xml
|
|
<rss version="2.0" xmlns:podcast="https://podcastindex.org/namespace/1.0">
|
|
```
|
|
|
|
# Podcast Tags
|
|
Each tag below exists in the podcast namespace within the specified parent. All attributes are required unless explicitly specified as optional.
|
|
|
|
Anywhere the url of a hyper-text based resource is specified, it must be given as `https:` and not `http:`.
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Transcript
|
|
`<podcast:transcript>`<br><br>
|
|
This tag is used to link to a transcript or closed captions file. Multiple tags can be present for multiple transcript formats.
|
|
|
|
Detailed file format information and example files are [here](../transcripts/transcripts.md).
|
|
|
|
### Parent
|
|
`<item>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Attributes
|
|
- **url (required):** URL of the podcast transcript.
|
|
|
|
- **type (required):** Mime type of the file such as `text/plain`, `text/html`, `text/vtt`, `application/json`, `application/x-subrip`
|
|
|
|
- **language (optional):** The language of the linked transcript. If there is no language attribute given, the linked file is assumed to be the same language that is specified by the RSS `<language>` element.
|
|
|
|
- **rel (optional):** If the rel="captions" attribute is present, the linked file is considered to be a closed captions file, regardless of what the mime type is. In that scenario, time codes are assumed to be present in the file in some capacity.
|
|
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:transcript url="https://example.com/episode1/transcript.html" type="text/html" />
|
|
```
|
|
|
|
```xml
|
|
<podcast:transcript url="https://example.com/episode1/transcript.vtt" type="text/vtt" />
|
|
```
|
|
|
|
```xml
|
|
<podcast:transcript url="https://example.com/episode1/transcript.json" type="application/json" language="es" rel="captions" />
|
|
```
|
|
|
|
```xml
|
|
<podcast:transcript url="https://example.com/episode1/transcript.srt" type="application/x-subrip" rel="captions" />
|
|
```
|
|
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Locked
|
|
`<podcast:locked>`<br><br>
|
|
This tag may be set to `yes` or `no`. The purpose is to tell other podcast hosting platforms whether they are allowed to import this feed. A value of `yes` means that any attempt to import this feed into a new platform should be rejected.
|
|
|
|
### Parent
|
|
`<channel>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Node value
|
|
The node value must be "yes" or "no".
|
|
|
|
### Attributes
|
|
- **owner (required):** The owner attribute is an email address that can be used to verify ownership of this feed during move and import operations. This could be a public email or a virtual email address at the hosting provider that redirects to the owner's true email address. This is a critical element, and it is expected that podcast hosting providers (if not providing virtual addresses) will allow setting this element's value in their GUI with an emphasis to their users of how important it is to have this be a valid, working email address.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:locked owner="email@example.com">yes</podcast:locked>
|
|
```
|
|
|
|
```xml
|
|
<podcast:locked owner="email@example.com">no</podcast:locked>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Funding
|
|
`<podcast:funding>`<br><br>
|
|
This tag lists possible donation/funding links for the podcast. The content of the tag is the recommended string to be used with the link.
|
|
|
|
### Parent
|
|
`<channel>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Node value
|
|
This is a free form string supplied by the creator which they expect to be displayed in the app next to the link. Please do not exceed `128 characters` for the node value or it may be
|
|
truncated by aggregators.
|
|
|
|
### Attributes
|
|
- **url (required):** The URL to be followed to fund the podcast.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:funding url="https://www.example.com/donations">Support the show!</podcast:funding>
|
|
```
|
|
|
|
```xml
|
|
<podcast:funding url="https://www.example.com/members">Become a member!</podcast:funding>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Chapters
|
|
`<podcast:chapters>`<br><br>
|
|
Links to an external file (see example file) containing chapter data for the episode. See the [jsonChapters.md](https://github.com/Podcastindex-org/podcast-namespace/blob/main/chapters/jsonChapters.md) file for a description of the chapter file syntax. And, see the [example.json](https://github.com/Podcastindex-org/podcast-namespace/blob/main/chapters/example.json) example file for a real world example.
|
|
|
|
Benefits with this approach are that chapters do not require altering audio files, and the chapters can be edited after publishing, since they are a separate file that can be requested on playback (or cached with download). JSON chapter information also allows chapters to be displayed by a wider range of playback tools, including web browsers (which typically have no access to ID3 tags), thus greatly simplifying chapter support; and images can be retrieved on playback, rather than bloating the filesize of the audio. The data held is compatible with normal ID3 tags, thus requiring no additional work for the publisher.
|
|
|
|
### Parent
|
|
`<item>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Attributes
|
|
- **url (required):** The URL where the chapters file is located.
|
|
- **type (required):** Mime type of file - JSON prefered, 'application/json+chapters'.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:chapters url="https://example.com/episode1/chapters.json" type="application/json+chapters" />
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Soundbite
|
|
`<podcast:soundbite>`<br><br>
|
|
Points to one or more soundbites within a podcast episode. The intended use includes episodes previews, discoverability, audiogram generation, episode highlights, etc. It should be assumed that the
|
|
audio/video source of the soundbite is the audio/video given in the item's [`<enclosure>`](https://cyber.harvard.edu/rss/rss.html#ltenclosuregtSubelementOfLtitemgt) element.
|
|
|
|
### Parent
|
|
`<item>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Node value
|
|
This is a free form string from the podcast creator to specify a title for the soundbite. If the podcaster does not provide a value for the soundbite title, then leave the value blank, and podcast apps can decide to use the episode title or some other placeholder value in its place. Please do not exceed `128 characters`
|
|
for the node value or it may be truncated by aggregators.
|
|
|
|
### Attributes
|
|
- **startTime (required):** The time where the soundbite begins
|
|
- **duration (required):** How long is the soundbite (recommended between 15 and 120 seconds)
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:soundbite startTime="73.0" duration="60.0" />
|
|
```
|
|
|
|
```xml
|
|
<podcast:soundbite startTime="1234.5" duration="42.25">Why the Podcast Namespace Matters</podcast:soundbite>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Person
|
|
`<podcast:person>`<br><br>
|
|
This element specifies a person of interest to the podcast. It is primarily intended to identify people like hosts, co-hosts and guests. Although, it is flexible enough to allow fuller credits to be
|
|
given using the roles and groups that are listed in the [Podcast Taxonomy Project](https://podcasttaxonomy.com/)
|
|
|
|
### Parent
|
|
`<item>` or `<channel>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Node value
|
|
This is the full name or alias of the person. This value cannot be blank. Please do not exceed `128 characters` for the node value or it may be truncated by aggregators.
|
|
|
|
### Attributes
|
|
- **role:** (optional) Used to identify what role the person serves on the show or episode. This should be a reference to an official role within the Podcast Taxonomy Project list (see below). If `role` is missing then "host" is assumed.
|
|
- **group:** (optional) This should be a reference to an official group within the Podcast Taxonomy Project list. If `group` is not present, then "cast" is assumed.
|
|
- **img:** (optional) This is the url of a picture or avatar of the person.
|
|
- **href:** (optional) The url to a relevant resource of information about the person, such as a homepage or third-party profile platform. Please see the [example feed](https://github.com/Podcastindex-org/podcast-namespace/blob/main/example.xml) for possible choices of what to use here.
|
|
|
|
The `role` and `group` attributes are case-insensitive. So, "Host" is the same as "host", and "Cover Art Designer" is the same as "cover art designer".
|
|
|
|
The full taxonomy list is [here](https://github.com/Podcastindex-org/podcast-namespace/blob/main/taxonomy.json) as a json file.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:person href="https://example.com/johnsmith/blog" img="http://example.com/images/johnsmith.jpg">John Smith</podcast:person>
|
|
```
|
|
|
|
```xml
|
|
<podcast:person role="guest" href="https://www.imdb.com/name/nm0427852888/" img="http://example.com/images/janedoe.jpg">Jane Doe</podcast:person>
|
|
```
|
|
|
|
```xml
|
|
<podcast:person role="guest" href="https://www.wikipedia/alicebrown" img="http://example.com/images/alicebrown.jpg">Alice Brown</podcast:person>
|
|
```
|
|
|
|
```xml
|
|
<podcast:person group="writing" role="guest" href="https://www.wikipedia/alicebrown" img="http://example.com/images/alicebrown.jpg">Alice Brown</podcast:person>
|
|
```
|
|
|
|
```xml
|
|
<podcast:person group="visuals" role="Cover Art Designer" href="https://example.com/artist/beckysmith">Becky Smith</podcast:person>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Location
|
|
`<podcast:location>`<br><br>
|
|
This tag is intended to describe the location of editorial focus for a podcast's content (i.e. "what place is this podcast about?"). The tag has many use cases and is one of the more complex ones. You
|
|
are **highly encouraged** to read the full [implementation document](https://github.com/Podcastindex-org/podcast-namespace/blob/main/location/location.md) before starting to code for it.
|
|
|
|
### Parent
|
|
`<item>` or `<channel>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Node Value
|
|
This is a free-form string meant to be a human readable location. It may conform to conventional location verbiage (i.e. "Austin, TX"), but it shouldn't be depended on to be parseable in any specific
|
|
way. This value cannot be blank. Please do not exceed `128 characters` for the node value or it may be truncated by aggregators.
|
|
|
|
### Attributes
|
|
- **geo:** (recommended) This is a latitude and longitude given in "geo" notation (i.e. "geo:30.2672,97.7431").
|
|
- **osm:** (recommended) The Open Street Map identifier of this place, given using the OSM notation (i.e. "R113314")
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:location geo="geo:30.2672,97.7431" osm="R113314">Austin, TX</podcast:location>
|
|
```
|
|
|
|
```xml
|
|
<podcast:location geo="geo:33.51601,-86.81455" osm="R6930627">Birmingham Civil Rights Museum</podcast:location>
|
|
```
|
|
|
|
```xml
|
|
<podcast:location geo="geo:-27.86159,153.3169" osm="W43678282">Dreamworld (Queensland)</podcast:location>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Season
|
|
`<podcast:season>`<br><br>
|
|
This element allows for identifying which episodes in a podcast are part of a particular "season", with an optional season name attached.
|
|
|
|
### Parent
|
|
`<item>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Node Value
|
|
The node value is an integer, and represents the season "number". It is required.
|
|
|
|
### Attributes
|
|
- **name:** (optional) - This is the "name" of the season. If this attribute is present, applications are free to **not** show the season number to the end user, and may use it simply for chronological sorting and grouping purposes.
|
|
|
|
Please do not exceed `128 characters` for the name attribute.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:season>5</podcast:season>
|
|
```
|
|
|
|
```xml
|
|
<podcast:season name="Race for the Whitehouse 2020">3</podcast:season>
|
|
```
|
|
|
|
```xml
|
|
<podcast:season name="Egyptology: The 19th Century">1</podcast:season>
|
|
```
|
|
|
|
```xml
|
|
<podcast:season name="The Yearling - Chapter 3">3</podcast:season>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Episode
|
|
`<podcast:episode>`<br><br>
|
|
This element exists largely for compatibility with the `season` tag. But, it also allows for a similar idea to what "name" functions as in that element.
|
|
|
|
### Parent
|
|
`<item>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Node Value
|
|
The node value is a decimal number. It is required.
|
|
|
|
### Attributes
|
|
- **display:** (optional) - If this attribute is present, podcast apps and aggregators are encouraged to show its value instead of the purely numerical node value. This attribute is a string.
|
|
|
|
The episode numbers are decimal, so numbering such as `100.5` is acceptable if there was a special mini-episode published between two other episodes. In that scenario, the number would help with proper
|
|
chronological sorting, while the `display` attribute could specify an alternate special "number" (a moniker) to display for the episode in a podcast player app UI.
|
|
|
|
Please do not exceed `32 characters` for the display attribute.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:episode>3</podcast:episode>
|
|
```
|
|
|
|
```xml
|
|
<podcast:episode>315.5</podcast:episode>
|
|
```
|
|
|
|
```xml
|
|
<podcast:episode display="Ch.3">204</podcast:episode>
|
|
```
|
|
|
|
```xml
|
|
<podcast:episode display="Day 5">9</podcast:episode>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Trailer
|
|
`<podcast:trailer>`<br><br>
|
|
This element is used to define the location of an audio or video file to be used as a trailer for the entire podcast or a specific season. There can be more than one trailer present in the channel of the
|
|
feed. This element is basically just like an [`<enclosure>`](https://cyber.harvard.edu/rss/rss.html#ltenclosuregtSubelementOfLtitemgt) with the extra `pubdate` and `season` attributes added.
|
|
|
|
If there is more than one trailer tag present in the channel, the most recent one (according to its `pubdate`) should be chosen as the preview by default within podcast apps.
|
|
|
|
### Parent
|
|
`<channel>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Node Value
|
|
The node value is a string, which is the title of the trailer. It is required. Please do not exceed `128 characters` for the node value or it may be truncated by aggregators.
|
|
|
|
### Attributes
|
|
- **url:** (required) This is a url that points to the audio or video file to be played. This attribute is a string.
|
|
- **pubdate:** (required) The date the trailer was published. This attribute is an RFC2822 formatted date string.
|
|
- **length:** (recommended) The length of the file in bytes. This attribute is a number.
|
|
- **type:** (recommended) The mime type of the file. This attribute is a string.
|
|
- **season:** (optional) If this attribute is present it specifies that this trailer is for a particular season number. This attribute is a number.
|
|
|
|
If the `season` attribute is present, it must be a number that matches the format of the `<podcast:season>` tag. So, for a podcast that has 3 published seasons, a new `<podcast:trailer season="4">` tag can
|
|
be put in the channel to later be matched up with a `<podcast:season>4<podcast:season>` tag when it is published within a new `<item>`.
|
|
|
|
#### Examples
|
|
```xml
|
|
<podcast:trailer pubdate="Thu, 01 Apr 2021 08:00:00 EST" url="https://example.org/trailers/teaser" length="12345678" type="audio/mp3">Coming April 1st, 2021</podcast:trailer>
|
|
```
|
|
|
|
```xml
|
|
<podcast:trailer pubdate="Thu, 01 Apr 2021 08:00:00 EST" url="https://example.org/trailers/season4teaser" length="12345678" type="video/mp4" season="4">Season 4: Race for the Whitehouse</podcast:trailer>
|
|
|
|
(later matches with)
|
|
|
|
<podcast:season name="Race for the Whitehouse">4</podcast:season>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## License
|
|
`<podcast:license>`<br><br>
|
|
This element defines a license that is applied to the audio/video content of a single episode, or the audio/video of the podcast as a whole. Custom licenses must always include a url attribute. Implementors are encouraged
|
|
to read the license tag companion [document](https://github.com/Podcastindex-org/podcast-namespace/blob/main/proposal-docs/license/license.md) for a more complete picture of what this tag is intended to accomplish.
|
|
|
|
### Parent
|
|
`<channel>` or `<item>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Node Value
|
|
The node value must be a lower-cased reference to a license "identifier" defined in the [SPDX License List](https://spdx.org/licenses/) file if the license being used is a well-known, public license. Or, if it is a custom license, it
|
|
must be a free form abbreviation of the name of the license as you reference it publicly. Please do not exceed `128 characters` for the node value or it may be truncated by aggregators.
|
|
|
|
### Attributes
|
|
- **url:** (optional) This is a url that points to the full, legal language of the license being referenced. This attribute is optional for well-known public licenses. For new, or custom licenses it is required.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:license>cc-by-4.0</podcast:license>
|
|
```
|
|
|
|
```xml
|
|
<podcast:license url="https://example.org/mypodcastlicense/full.pdf">my-podcast-license-v1</podcast:license>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Alternate Enclosure
|
|
`<podcast:alternateEnclosure>`<br><br>
|
|
This element is meant to provide different versions of, or companion media to the main [`<enclosure>`](https://cyber.harvard.edu/rss/rss.html#ltenclosuregtSubelementOfLtitemgt) file. This could be an audio only version of a video podcast to allow apps to switch back and forth between audio/video,
|
|
lower (or higher) bitrate versions for bandwidth constrained areas, alternative codecs for different device platforms, alternate URI schemes and download types such as IPFS or WebTorrent, commentary tracks or supporting source clips, etc.
|
|
This is a complex tag, so implementors are highly encouraged to read the companion [document](https://github.com/Podcastindex-org/podcast-namespace/blob/main/proposal-docs/alternateEnclosure/alternateEnclosure.md) for a fuller understanding of how
|
|
this tag works and what it is capable of.
|
|
|
|
### Parent
|
|
`<item>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Node Value
|
|
The node value must be one or more `<podcast:source>` elements that each define a uri where the media file can be downloaded or streamed. A single, optional `<podcast:integrity>` element may also be included
|
|
to allow for file integrity checking.
|
|
|
|
### Attributes
|
|
- **type:** (required) Mime type of the media asset.
|
|
- **length:** (required) Length of the file in bytes.
|
|
- **bitrate:** (optional) Average encoding bitrate of the media asset, expressed in bits per second.
|
|
- **height:** (optional) Height of the media asset for video formats.
|
|
- **lang:** (optional) An [IETF language tag (BCP 47)](https://en.wikipedia.org/wiki/BCP_47) code identifying the language of this media.
|
|
- **title:** (optional) A human-readable string identifying the name of the media asset. Should be limited to 32 characters for UX.
|
|
- **rel:** (optional) Provides a method of offering and/or grouping together different media elements. If not set, or set to "default", the media will be grouped with the enclosure and assumed to be an alternative to the enclosure's encoding/transport. This attribute can and should be the same for items with the same content encoded by different means. Should be limited to 32 characters for UX.
|
|
- **codecs:** (optional) An [RFC 6381](https://tools.ietf.org/html/rfc6381) string specifying the codecs available in this media.
|
|
- **default:** (optional) Boolean specifying whether or not the given media is the same as the file from the enclosure element and should be the preferred media element. The primary reason to set this is to offer alternative transports for the enclosure. If not set, this should be assumed to be false.
|
|
|
|
### Examples
|
|
```xml
|
|
<enclosure url="https://example.com/file-0.mp3" length="43200000" type="audio/mpeg" />
|
|
|
|
<podcast:alternateEnclosure type="audio/mpeg" length="43200000" bitrate="128000" default="true" title="Standard">
|
|
<podcast:source uri="https://example.com/file-0.mp3" />
|
|
<podcast:source uri="ipfs://someRandomMpegFile" />
|
|
</podcast:alternateEnclosure>
|
|
|
|
<podcast:alternateEnclosure type="audio/opus" length="32400000" bitrate="96000" title="High quality">
|
|
<podcast:source uri="https://example.com/file-high.opus" />
|
|
<podcast:source uri="ipfs://someRandomHighBitrateOpusFile" />
|
|
</podcast:alternateEnclosure>
|
|
|
|
<podcast:alternateEnclosure type="audio/aac" length="54000000" bitrate="160000" title="High quality AAC">
|
|
<podcast:source uri="https://example.com/file-proprietary.aac" />
|
|
<podcast:source uri="ipfs://someRandomProprietaryAACFile" />
|
|
</podcast:alternateEnclosure>
|
|
|
|
<podcast:alternateEnclosure type="audio/opus" length="5400000" bitrate="16000" title="Low bandwidth">
|
|
<podcast:source uri="https://example.com/file-low.opus" />
|
|
<podcast:source uri="ipfs://someRandomLowBitrateOpusFile" />
|
|
</podcast:alternateEnclosure>
|
|
```
|
|
|
|
```xml
|
|
<podcast:alternateEnclosure type="audio/mpeg" length="2490970" bitrate="160707.74">
|
|
<podcast:source uri="https://example.com/file-0.mp3" />
|
|
<podcast:source uri="ipfs://QmdwGqd3d2gFPGeJNLLCshdiPert45fMu84552Y4XHTy4y" />
|
|
<podcast:source uri="https://example.com/file-0.torrent" contentType="application/x-bittorrent" />
|
|
<podcast:source uri="http://example.onion/file-0.mp3" />
|
|
</podcast:alternateEnclosure>
|
|
|
|
<podcast:alternateEnclosure type="video/mp4" length="10562995" bitrate="681483.55" height="1080">
|
|
<podcast:source uri="https://example.com/file-1080.mp4" />
|
|
<podcast:source uri="ipfs://QmfQKJcp2xdByEt8mzWr1AJUhwvb9rdWPoacvdq2roDhgh" />
|
|
<podcast:source uri="https://example.com/file-1080.torrent" contentType="application/x-bittorrent" />
|
|
<podcast:source uri="http://example.onion/file-1080.mp4" />
|
|
</podcast:alternateEnclosure>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Source
|
|
`<podcast:source>`<br><br>
|
|
This element defines a uri location for a `<podcast:alternateEnclosure>` media file. It is meant to be used as a child of the `<podcast:alternateEnclosure>` element. At least one `<podcast:source>` element must be
|
|
present within every `<podcast:alternateEnclosure>` element.
|
|
|
|
### Parent
|
|
`<podcast:alternateEnclosure>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Attributes
|
|
- **uri:** (required) This is the uri where the media file resides.
|
|
- **contentType:** (optional) This is a string that declares the mime-type of the file. It is useful if the transport mechanism is different than the file being delivered, as is the case with a torrents.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:alternateEnclosure type="video/mp4" length="7924786" bitrate="511276.52" height="720">
|
|
<podcast:source uri="https://example.com/file-720.mp4" />
|
|
<podcast:source uri="ipfs://QmX33FYehk6ckGQ6g1D9D3FqZPix5JpKstKQKbaS8quUFb" />
|
|
<podcast:source uri="https://example.com/file-720.torrent" contentType="application/x-bittorrent" />
|
|
<podcast:source uri="http://example.onion/file-720.mp4" />
|
|
</podcast:alternateEnclosure>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Integrity
|
|
`<podcast:integrity>`<br><br>
|
|
This element defines a method of verifying integrity of the media given either an [SRI-compliant integrity string](https://www.w3.org/TR/SRI/) (preferred) or a base64 encoded PGP signature. This element is optional within a
|
|
`<podcast:alternateEnclosure>` element. It allows to ensure that the file has not been tampered with.
|
|
|
|
### Parent
|
|
`<podcast:alternateEnclosure>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Attributes
|
|
- **type:** (required) Type of integrity, either "sri" or "pgp-signature".
|
|
- **value:** (required) Value of the sri string or base64 encoded pgp signature.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:alternateEnclosure type="video/mp4" length="7924786" bitrate="511276.52" height="720">
|
|
<podcast:source uri="https://example.com/file-720.mp4" />
|
|
<podcast:source uri="ipfs://QmX33FYehk6ckGQ6g1D9D3FqZPix5JpKstKQKbaS8quUFb" />
|
|
<podcast:integrity type="sri" value="sha384-ExVqijgYHm15PqQqdXfW95x+Rs6C+d6E/ICxyQOeFevnxNLR/wtJNrNYTjIysUBo" />
|
|
</podcast:alternateEnclosure>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Guid
|
|
`<podcast:guid>`<br><br>
|
|
This element is used to declare a unique, global identifier for a podcast. The value is a UUIDv5, and is easily generated from the RSS feed url, with the **protocol scheme and trailing slashes stripped off**, combined with a unique "podcast" namespace which has a UUID of `ead4c236-bf58-58c6-a2c6-a6b28d128cb6`. Tools like [this one](https://www.uuidtools.com/v5) can help generate these values by hand. Or, language libraries like [this one](https://github.com/sporkmonger/uuidtools) in Ruby are widely available.
|
|
|
|
A podcast gets assigned a podcast:guid once in its lifetime using its current feed url (at the time of assignment) as the seed value. That GUID is then meant to follow the podcast from then on, for the duration of its life, even if the feed url changes. This means that when a podcast moves from one hosting platform to another, its podcast:guid should be discovered by the new host and imported into the new platform for inclusion into the feed.
|
|
|
|
Using this pattern, podcasts can maintain a consistent identity across the open RSS ecosystem without a central authority.
|
|
|
|
**Tips:**
|
|
* All podcasts in the Podcast Index have already been assigned a GUID; but if one exists in the RSS feed, that value is canonical.
|
|
* You can programmatically spot a GUID: it is 36 characters long, and contains four hyphen characters.
|
|
* Be aware that Amazon Music also uses separate UUIDv5 identifiers within their podcast directory, which are calculated differently and unrelated to this specification.
|
|
* The following regular expression (regex) will match a GUID:
|
|
```re
|
|
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}`
|
|
```
|
|
|
|
### Parent
|
|
`<channel>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Node Value
|
|
The node value is a UUIDv5 string.
|
|
|
|
### Attributes
|
|
There are no attributes for this tag.
|
|
|
|
### Examples
|
|
Example GUID for feed url `mp3s.nashownotes.com/pc20rss.xml`:
|
|
```xml
|
|
<podcast:guid>917393e3-1b1e-5cef-ace4-edaa54e1f810</podcast:guid>
|
|
```
|
|
|
|
Example GUID for feed url `podnews.net/rss`:
|
|
```xml
|
|
<podcast:guid>9b024349-ccf0-5f69-a609-6b82873eab3c</podcast:guid>
|
|
```
|
|
|
|
### Guid-enabled fast-follow share links
|
|
|
|
The `podcast:guid` value above enables podcasters to produce a link that can share a podcast on a variety of different platforms.
|
|
|
|
The format of the link is `https://(a podcast website link)#fastfollow-(type):(a podcast guid)`
|
|
|
|
`type` is currently `podcast`, but may be extended in future.
|
|
|
|
A working example is https://podnews.net/podcast/i8xe9/listen#fastfollow-podcast:9b024349-ccf0-5f69-a609-6b82873eab3c or the QR code given below.
|
|
|
|
|
|
|
|
When scanned on a mobile phone's camera app, this link will go to the specified podcast website. Behavior of this website is up to the creator: some may use a default homepage, others may sniff the useragent and open a default podcast app on a device. In the working example, above, an iPhone user may be taken to Apple Podcasts; an Android user may be taken to Google Podcasts; and another device will be given a page with a player.
|
|
|
|
When scanned on a QR code reader inside a podcast app, like [CurioCaster](https://curiocaster.com/), the app can parse the `podcast:guid` value from the URL, allowing the podcast to be opened within the application.
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Value
|
|
`<podcast:value>`<br><br>
|
|
This element designates the cryptocurrency or payment layer that will be used, the transport method for transacting the payments, and a suggested amount denominated in the given cryptocurrency.
|
|
|
|
This element can exist at either the `<channel>` or `<item>` level. When it exists at the `<item>` level, it should be treated as an "override" of whatever is defined at the `<channel>` level.
|
|
|
|
This is a complex tag, so implementors are HIGHLY encouraged to read the companion [document](https://github.com/Podcastindex-org/podcast-namespace/blob/main/value/value.md) for a complete understanding of how
|
|
this tag works and what it is capable of.
|
|
|
|
### Parent
|
|
`<channel>` or `<item>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Node Value
|
|
The node value must be one or more `<podcast:valueRecipient>` elements.
|
|
|
|
### Attributes
|
|
- **type:** (required) This is the service slug of the cryptocurrency or protocol layer.
|
|
- **method:** (required) This is the transport mechanism that will be used.
|
|
- **suggested:** (optional) This is an optional suggestion on how much cryptocurrency to send with each payment.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:value
|
|
type="lightning"
|
|
method="keysend"
|
|
suggested="0.00000005000"
|
|
></podcast:value>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Value Recipient
|
|
`<podcast:valueRecipient>`<br><br>
|
|
The `valueRecipient` tag designates various destinations for payments to be sent to during consumption of the enclosed media. Each recipient is considered to receive a "split" of the total payment according to the number of shares given
|
|
in the `split` attribute.
|
|
|
|
This element may only exist within a parent `<podcast:value>` element.
|
|
|
|
There is no limit on how many `valueRecipient` elements can be present in a given `<podcast:value>` element.
|
|
|
|
This is a complex tag, so implementors are HIGHLY encouraged to read the companion [document](https://github.com/Podcastindex-org/podcast-namespace/blob/main/value/value.md) for a complete understanding of how
|
|
this tag works and what it is capable of.
|
|
|
|
### Parent
|
|
`<podcast:value>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Attributes
|
|
- **name** (recommended) A free-form string that designates who or what this recipient is.
|
|
- **customKey** (optional) The name of a custom record key to send along with the payment.
|
|
- **customValue** (optional) A custom value to pass along with the payment. This is considered the value that belongs to the `customKey`.
|
|
- **type** (required) A slug that represents the type of receiving address that will receive the payment.
|
|
- **address** (required) This denotes the receiving address of the payee.
|
|
- **split** (required) The number of shares of the payment this recipient will receive.
|
|
- **fee** (optional) If this attribute is not specified, it is assumed to be false.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:value type="lightning" method="keysend" suggested="0.00000015000">
|
|
<podcast:valueRecipient
|
|
name="Alice (Podcaster)"
|
|
type="node"
|
|
address="02d5c1bf8b940dc9cadca86d1b0a3c37fbe39cee4c7e839e33bef9174531d27f52"
|
|
split="40"
|
|
/>
|
|
<podcast:valueRecipient
|
|
name="Bob (Podcaster)"
|
|
type="node"
|
|
address="032f4ffbbafffbe51726ad3c164a3d0d37ec27bc67b29a159b0f49ae8ac21b8508"
|
|
split="40"
|
|
/>
|
|
<podcast:valueRecipient
|
|
name="Carol (Producer)"
|
|
type="node"
|
|
address="02dd306e68c46681aa21d88a436fb35355a8579dd30201581cefa17cb179fc4c15"
|
|
split="15"
|
|
/>
|
|
<podcast:valueRecipient
|
|
name="Hosting Provider"
|
|
type="node"
|
|
address="03ae9f91a0cb8ff43840e3c322c4c61f019d8c1c3cea15a25cfc425ac605e61a4a"
|
|
split="5"
|
|
fee="true"
|
|
/>
|
|
</podcast:value>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Medium
|
|
`<podcast:medium>`<br><br>
|
|
The `medium` tag tells the an application what the content contained within the feed IS, as opposed to what the content is ABOUT in the case of a category. This allows a podcast app to
|
|
modify it's behavior or UI to give a better experience to the user for this content. For example, if a podcast has `<podcast:medium>music</podcast:medium>` an app may choose to
|
|
reset playback speed to 1x and adjust it's EQ settings to be better for music vs. spoken word.
|
|
|
|
Accepted medium names are curated within a list maintained by the community as new mediums are discovered over time. Newly proposed mediums should require some level of
|
|
justification to be added to this list. One may argue and/or prove use of a new medium even for only one application, should it prove different enough from existing mediums to have meaning.
|
|
|
|
### Parent
|
|
`<channel>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Node Value
|
|
The node value is a string denoting one of the following possible values:
|
|
- `podcast` (default) - Describes a feed for a podcast show. If no `medium` tag is present in the channel, this medium is assumed.
|
|
- `music` - A feed of music organized into an "album" with each item a song within the album.
|
|
- `video` - Like a "podcast" but used in a more visual experience. Something akin to a dedicated video channel like would be found on YouTube.
|
|
- `film` - Specific types of videos with one item per feed. This is different than a `video` medium because the content is considered to be cinematic; like a movie or documentary.
|
|
- `audiobook` - Specific types of audio with one item per feed, or where items represent chapters within the book.
|
|
- `newsletter` - Describes a feed of curated written articles. Newsletter articles now sometimes have an spoken version audio enclosure attached.
|
|
- `blog` - Describes a feed of informally written articles. Similar to `newsletter` but more informal as in a traditional blog platform style.
|
|
|
|
### Examples
|
|
Example use for a "podcast":
|
|
```xml
|
|
<podcast:medium>podcast</podcast:medium>
|
|
```
|
|
|
|
Example use for "music":
|
|
```xml
|
|
<podcast:medium>music</podcast:medium>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Images
|
|
`<podcast:images>`<br><br>
|
|
This tag, when present, allows for specifying many different image sizes in a compact way at either the episode or channel level. The syntax is borrowed from
|
|
the HTML5 [srcset](https://html.spec.whatwg.org/multipage/images.html#srcset-attributes) syntax. It allows for describing multiple image sources with width and
|
|
pixel hints directly in the attribute. Although the HTML5 `srcset` attribute allows relative urls, absolute urls are required in this tag - since the feed url may not represent an appropriate base url for relativization.
|
|
|
|
### Parent
|
|
`<channel>` or `<item>`
|
|
|
|
### Count
|
|
Single
|
|
|
|
### Attributes
|
|
- **srcset** (required) A string that denotes each image url followed by a space and the pixel width, with each one separated by a comma. See the example
|
|
for a clear view of the syntax.
|
|
|
|
### Examples
|
|
Example of specifying four different image sizes:
|
|
```xml
|
|
<podcast:images
|
|
srcset="https://example.com/images/ep1/pci_avatar-massive.jpg 1500w,
|
|
https://example.com/images/ep1/pci_avatar-middle.jpg 600w,
|
|
https://example.com/images/ep1/pci_avatar-small.jpg 300w,
|
|
https://example.com/images/ep1/pci_avatar-tiny.jpg 150w"
|
|
/>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Live Item
|
|
`<podcast:liveItem>`<br><br>
|
|
The `liveItem` tag is used for a feed to deliver a live audio or video stream to podcast apps. It takes the same format as a standard `<item>` episode tag, and all tags that are
|
|
allowed as children of a normal `<item>` are also allowed as children of `<podcast:liveItem>`. Note that "allowed" is not the same as "supported". So, just like a normal `<item>`,
|
|
you cannot depend on all apps to support all tags within `<podcast:liveItem>`, especially when the function of the tag is not obvious. For instance, including an `<itunes:duration>`
|
|
tag in a live item is probably a waste of time since apps will not know what to do with that value in the context of live media.
|
|
|
|
This tag will also make use of the [podping](https://podping.cloud) notification network. A podping notification SHOULD be sent out by the host when the live stream starts, to let
|
|
apps know.
|
|
|
|
### Parent
|
|
`<channel>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Node Value
|
|
All tags that are valid as children of a standard `<item>` tag are also valid as children here.
|
|
|
|
When specifying the audio/video source, the [`<podcast:alternateEnclosure>`](#alternate-enclosure) tag is highly encouraged since it gives the broadest coverage of possible stream types and is
|
|
explicit in it's communication of what transport protocol and media codecs are being used. In addition to [`<podcast:alternateEnclosure>`](#alternate-enclosure), a standard [`<enclosure>`](https://cyber.harvard.edu/rss/rss.html#ltenclosuregtSubelementOfLtitemgt) should also
|
|
be given as a fallback to support podcast apps that don't yet implement [`<podcast:alternateEnclosure>`](#alternate-enclosure). Regardless of which enclosure tag is used, feed owners must be conscious
|
|
of the fact that choosing a non-mainstream streaming protocol/codec will limit the number of apps that can play the content. For that reason, it's highly recommended to use only the two most widely supported
|
|
protocols (mp3 and mp4/h.264) to ensure compatibility with the broadest number of apps on various platforms. Choosing a streaming format that is outside of this narrow list might exclude many
|
|
apps from playing your content. As broader adoption of HLS, Opus, etc. becomes apparent, this recommendation will change to include newer formats.
|
|
|
|
The [`<podcast:contentLink>`](#content-link) tag is also required to be present, to ensure that listeners have a fallback option in case their chosen app cannot play the given content stream directly. In
|
|
most instances this will just be a link to an HTML page that can play the live stream. Such a page can reside on the podcaster's own website, a page provided by their hosting company or a third party
|
|
platform they have chosen to use. Podcasters who live stream to multiple platforms at once can also use the [`<podcast:contentLink>`](#content-link) tag to provide links to those other platforms.
|
|
|
|
A robust, well-written `<podcast:liveItem>` tag will include all three of: [`<podcast:alternateEnclosure>`](#alternate-enclosure), [`<enclosure>`](https://cyber.harvard.edu/rss/rss.html#ltenclosuregtSubelementOfLtitemgt)
|
|
and [`<podcast:contentLink>`](#content-link) to ensure the broadest interopability with podcast apps.
|
|
|
|
The function of `<guid>` within a live item tag is the same as it is within a regular item. If the `<guid>` of a `<podcast:liveItem>` changes, it MUST be considered a new stream by
|
|
podcast apps.
|
|
|
|
### Attributes
|
|
- **status** (required) A string that must be one of `pending`, `live` or `ended`.
|
|
- **start** (required) A string representing an ISO8601 timestamp that denotes the time when the stream is intended to start.
|
|
- **end** (required) A string representing an ISO8601 timestamp that denotes the time when the stream is intended to end.
|
|
|
|
The `start` and `end` attributes denote when the live stream "should" start and end. But, real life dictates that those times might not be adhered to. Apps are therefore encouraged
|
|
not to rely solely on those times as anything more than an approximation. The canonical way to know if a stream has started is with the `status` attribute. If `status` is "live" then
|
|
the stream has started.
|
|
|
|
### Examples
|
|
A complete example:
|
|
```xml
|
|
<podcast:liveItem status="live" start="2021-09-26T07:30:00.000-0600" end="2021-09-26T09:30:00.000-0600">
|
|
<title>Podcasting 2.0 Live Show</title>
|
|
<description>A look into the future of podcasting and how we get to Podcasting 2.0!</description>
|
|
<link>https://example.com/podcast/live</link>
|
|
<guid isPermaLink="true">https://example.com/live</guid>
|
|
<author>John Doe (john@example.com)</author>
|
|
<podcast:images srcset="https://example.com/images/live/pci_avatar-massive.jpg 1500w,
|
|
https://example.com/images/live/pci_avatar-middle.jpg 600w,
|
|
https://example.com/images/live/pci_avatar-small.jpg 300w,
|
|
https://example.com/images/live/pci_avatar-tiny.jpg 150w"
|
|
/>
|
|
<podcast:person href="https://www.podchaser.com/creators/adam-curry-107ZzmWE5f" img="https://example.com/images/adamcurry.jpg">Adam Curry</podcast:person>
|
|
<podcast:person role="guest" href="https://github.com/daveajones/" img="https://example.com/images/davejones.jpg">Dave Jones</podcast:person>
|
|
<podcast:person group="visuals" role="cover art designer" href="https://example.com/artist/beckysmith">Becky Smith</podcast:person>
|
|
<podcast:alternateEnclosure type="audio/mpeg" length="312" default="true">
|
|
<podcast:source uri="https://example.com/pc20/livestream" />
|
|
</podcast:alternateEnclosure>
|
|
<enclosure url="https://example.com/pc20/livestream?format=.mp3" type="audio/mpeg" length="312" />
|
|
<podcast:contentLink href="https://youtube.com/pc20/livestream">YouTube!</podcast:contentLink>
|
|
<podcast:contentLink href="https://twitch.com/pc20/livestream">Twitch!</podcast:contentLink>
|
|
<podcast:contentLink href="https://example.com/html/livestream">Listen Live!</podcast:contentLink>
|
|
</podcast:liveItem>
|
|
```
|
|
|
|
A bare bones example:
|
|
```xml
|
|
<podcast:liveItem status="live" start="2021-09-26T07:30:00.000-0600" end="2021-09-26T09:30:00.000-0600">
|
|
<title>Podcasting 2.0 Live Stream</title>
|
|
<guid>e32b4890-983b-4ce5-8b46-f2d6bc1d8819</guid>
|
|
<enclosure url="https://example.com/pc20/livestream?format=.mp3" type="audio/mpeg" length="312" />
|
|
<podcast:contentLink href="https://example.com/html/livestream">Listen Live!</podcast:contentLink>
|
|
</podcast:liveItem>
|
|
```
|
|
|
|
|
|
|
|
<br><br><br><br><!-- Tag block -->
|
|
## Content Link
|
|
`<podcast:contentLink>`<br><br>
|
|
The `contentLink` tag is used to indicate that the content begin delivered by the parent element can be found at an external location
|
|
instead of, or in addition to, being delivered directly to the tag itself within an app. In most instances it is used as a fallback link for the user
|
|
to use when the app itself can't handle a certain content delivery directly.
|
|
|
|
For instance, perhaps a podcast feed specifies a `<podcast:liveItem>` to deliver a live stream to apps. The feed may also give a `<podcast:contentLink>`
|
|
pointing to YouTube and Twitch versions of the live stream as well, just in case the listener uses an app that doesn't fully support live streaming content.
|
|
|
|
Currently this tag is only indicated for use in the `<podcast:liveItem>` tag. In the future, its use will be expanded.
|
|
|
|
### Parent
|
|
`<podcast:liveItem>`
|
|
|
|
### Count
|
|
Multiple
|
|
|
|
### Node Value
|
|
The node value is a free form string meant to explain to the user where this content link points and/or the nature of it's purpose.
|
|
|
|
### Attributes
|
|
- **href** (required) A string that is the uri pointing to content outside of the application.
|
|
|
|
### Examples
|
|
```xml
|
|
<podcast:contentLink href="https://youtube.com/blahblah/livestream">Live on YouTube!</podcast:contentLink>
|
|
```
|
|
|
|
```xml
|
|
<podcast:contentLink href="https://twitter.com/statuses/somepost">Chat on Twitter!</podcast:contentLink>
|
|
```
|