kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
Merge remote-tracking branch 'upstream/main' into main
Brian of London
commit
dae2d91051
251
README.md
251
README.md
|
|
@ -9,6 +9,7 @@ will become the framework that the independent podcast community needs to delive
|
|||
Our guiding principles for development of this namespace are the "[Rules for Standards Makers](http://scripting.com/2017/05/09/rulesForStandardsmakers.html)" by Dave Winer.
|
||||
Please read it before contributing if you aren't familiar with it.
|
||||
|
||||
The podcast namespace is part of the larger "Podcasting 2.0" project which exists to bring control of podcasting's protocols back into the hands of the open podcasting community. A good overview can be found here: [Podcasting 2.0](podcasting2.0.md)
|
||||
|
||||
* [Official XMLNS Definition](docs/1.0.md) the official definition of all formalized tags.
|
||||
* List of platforms and apps that currently implement some or all of these tags: [Supporting Platforms and Apps](docs/element-support.md).
|
||||
|
|
@ -26,7 +27,7 @@ Please read it before contributing if you aren't familiar with it.
|
|||
|
||||
**Phase 3** - [Closed] Comment period closed on `6/1/21` and 5 tags were **formalized**.
|
||||
|
||||
**Phase 4** - [Open] As of 6/9/2021, all proposals for phase 4 are welcome. Current tag proposals under consideration are listed here. No closing date is set at this time.
|
||||
**Phase 4** - [Open] Comment period will close on 12/1/21, all proposals for phase 4 are welcome. Current tag proposals under consideration are listed below.
|
||||
|
||||
<br><br>
|
||||
|
||||
|
|
@ -146,11 +147,72 @@ full implementation details.
|
|||
<br>
|
||||
|
||||
|
||||
### <u>Phase 4 (Open for Proposals)</u>
|
||||
## <u>Phase 4 (Closes on 12/1/2021)</u>
|
||||
|
||||
The following tags should be considered purely as work in progress proposals. They should not be relied upon or implemented except for testing purposes and experimentation.
|
||||
|
||||
|
||||
### **\<podcast:liveItem>** - <small>[Discuss](https://github.com/Podcastindex-org/podcast-namespace/issues/212)</small>
|
||||
|
||||
<br>
|
||||
|
||||
<b>
|
||||
|
||||
```xml
|
||||
<podcast:liveItem
|
||||
status="['pending','live','ended'(string)]"
|
||||
start="[ISO8601 time stamp(string)]"
|
||||
end="[ISO8601 time stamp(string)]"
|
||||
>
|
||||
|
||||
</podcast:liveItem>
|
||||
```
|
||||
|
||||
</b>
|
||||
|
||||
Channel
|
||||
|
||||
(optional | multiple)
|
||||
|
||||
This element is used for a feed to deliver a live stream to podcast apps. It takes the same format as a standard `<item>` episode tag, but holds a subset of elements along with
|
||||
some additional new elements that are appropriate for a live stream context. 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 on those times as anything more than a suggestion. The canonical way to know if a
|
||||
stream has started is with the `status` attribute. If `status` is "live" then the stream has started.
|
||||
|
||||
This item 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.
|
||||
|
||||
|
||||
Example:
|
||||
```xml
|
||||
<podcast:liveItem
|
||||
status="live"
|
||||
start="2021-09-26T07:30:00.000-0600"
|
||||
end="2021-09-26T08: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/ep3/pci_avatar-massive.jpg 1500w,
|
||||
https://example.com/images/ep3/pci_avatar-middle.jpg 600w,
|
||||
https://example.com/images/ep3/pci_avatar-small.jpg 300w,
|
||||
https://example.com/images/ep3/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">
|
||||
<podcast:source uri="https://example.com/pc20/livestream" />
|
||||
</podcast:alternateEnclosure>
|
||||
</podcast:liveItem>
|
||||
```
|
||||
|
||||
<br>
|
||||
|
||||
----
|
||||
|
||||
### **\<podcast:recommendations>** - <small>[Discuss](https://github.com/Podcastindex-org/podcast-namespace/issues/205)</small>
|
||||
|
||||
<br>
|
||||
|
|
@ -191,7 +253,192 @@ Example:
|
|||
|
||||
<br>
|
||||
|
||||
----
|
||||
|
||||
### **\<podcast:medium>** - <small>[Discuss](https://github.com/Podcastindex-org/podcast-namespace/issues/263)</small>
|
||||
|
||||
<br>
|
||||
|
||||
<b>
|
||||
|
||||
```xml
|
||||
<podcast:medium>[podcast|music|video|film|audiobook(string)]</podcast:medium>
|
||||
```
|
||||
|
||||
</b>
|
||||
|
||||
Channel
|
||||
|
||||
(optional | single)
|
||||
|
||||
This 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.
|
||||
|
||||
**This list is currently a non-exhaustive proposal and subject to change**
|
||||
|
||||
- `podcast` - Describes a feed for a podcast show.
|
||||
- *Justification*: Nothing new, as this is what all podcasts that exist default to today. 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.
|
||||
- *Justification*: Music has existed as a medium for a very long time and dedicated music applications already exist.
|
||||
- `video` - Like a "podcast" but used in a more visual experience.
|
||||
- *Justification*: Videos add different enough level of user experience to discern them from regular podcasts. Sites like YouTube already exist and prove out the existence of "videos" as a medium.
|
||||
- `film` - Specific types of videos with one item per feed.
|
||||
- *Justification*: While doable, users have come to expect to be able to search for films without directly subscribing to a high level organization of "channels." This allows the application to make
|
||||
beneficial assumptions regarding how to handle an item within a film. Films exist as a medium already with dedicated applications today.
|
||||
- `audiobook` - Specific types of audio with one item per feed.
|
||||
- *Justification*: Similar to a film, users typically search for audiobooks by name without some level of subscription/following. This isn't to say that an application couldn't allow following an "author".
|
||||
for example, but that wouldn't be organized at the channel level. Audiobooks exist as a medium already with dedicated applications today.
|
||||
- `newsletter` - Describes a feed of curated written articles.
|
||||
- *Justification*: Many newsletter publications already have RSS feeds -- this helps explicitly identify them.
|
||||
- `blog` - Describes a feed of informally written articles.
|
||||
- *Justification*: Many blogs already have RSS feeds, perhaps since the dawn of RSS -- this helps explicitly identify them.
|
||||
|
||||
Example use for a "podcast":
|
||||
```xml
|
||||
<podcast:medium>podcast</podcast:medium>
|
||||
```
|
||||
|
||||
Example use for "music":
|
||||
```xml
|
||||
<podcast:medium>music</podcast:medium>
|
||||
```
|
||||
|
||||
<br>
|
||||
|
||||
----
|
||||
|
||||
### **\<podcast:gateway>** - <small>[Discuss](https://github.com/Podcastindex-org/podcast-namespace/issues/281)</small>
|
||||
|
||||
<br>
|
||||
|
||||
<b>
|
||||
|
||||
```xml
|
||||
<podcast:gateway
|
||||
order="[(number)]"
|
||||
>
|
||||
[free form message to listeners(string)]
|
||||
</podcast:gateway>
|
||||
```
|
||||
|
||||
</b>
|
||||
|
||||
Item
|
||||
|
||||
(optional | multiple)
|
||||
|
||||
This tag, when present in an `<item>` indicates that this episode is a so-called "gateway episode". Gateway episodes are episodes that the podcaster (or maybe crowd sourced) thinks
|
||||
represent the best entry point into a long running show. If a podcast has 300 episodes, it might be a good idea to designate 1 or more older episodes as the best place to start.
|
||||
|
||||
The `order` attribute is an unsigned integer that is meant as an ascending listening order. The episode with `order="1"` should be played first, then `order="2"` and so on.
|
||||
|
||||
When podcast apps encounter gateway episodes, it is suggested that they present these episodes (in some form of UI) to the user when the user subscribes or follows the podcast.
|
||||
|
||||
Example of a single gateway:
|
||||
```xml
|
||||
<item>
|
||||
<title>Podcasting 2.0 - How it all Began</title>
|
||||
<description>A look into the future of podcasting and how we get to Podcasting 2.0!</description>
|
||||
<link>https://example.com/pc20/ep1</link>
|
||||
<guid isPermaLink="true">https://example.com/pc20/ep1</guid>
|
||||
<author>John Doe (john@example.com)</author>
|
||||
<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"
|
||||
/>
|
||||
<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>
|
||||
<enclosure url="https://live.example.com/live.mp3" type="audio/mpeg" />
|
||||
<podcast:gateway>Start here!</podcast:gateway>
|
||||
</item>
|
||||
```
|
||||
|
||||
Example of a gateway series:
|
||||
```xml
|
||||
<item>
|
||||
<title>Podcasting 2.0 - How it all Began</title>
|
||||
<description>A look into the future of podcasting and how we get to Podcasting 2.0!</description>
|
||||
<link>https://example.com/pc20/ep1</link>
|
||||
<guid isPermaLink="true">https://example.com/pc20/ep1</guid>
|
||||
<author>John Doe (john@example.com)</author>
|
||||
<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"
|
||||
/>
|
||||
<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>
|
||||
<enclosure url="https://live.example.com/pc20_ep1.mp3" type="audio/mpeg" />
|
||||
<pubDate>Fri, 11 Sep 2020 18:51:09 GMT</pubDate>
|
||||
<podcast:episode>1</podcast:episode>
|
||||
<itunes:episode>1</itunes:episode>
|
||||
<podcast:gateway order="1">Start here!</podcast:gateway>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>Podcasting 2.0 - The tide has turned</title>
|
||||
<description>What a big week. So many important things happened this week. We dive into it all and what it means!</description>
|
||||
<link>https://example.com/pc20/ep45</link>
|
||||
<guid isPermaLink="true">https://example.com/pc20/ep45</guid>
|
||||
<author>John Doe (john@example.com)</author>
|
||||
<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"
|
||||
/>
|
||||
<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>
|
||||
<enclosure url="https://live.example.com/pc20_ep45.mp3" type="audio/mpeg" />
|
||||
<pubDate>Fri, 20 Aug 2021 20:23:55 GMT</pubDate>
|
||||
<podcast:episode>45</podcast:episode>
|
||||
<itunes:episode>45</itunes:episode>
|
||||
<podcast:gateway order="2">We reached a milestone here!</podcast:gateway>
|
||||
</item>
|
||||
```
|
||||
|
||||
----
|
||||
|
||||
### **\<podcast:images>** - <small>[Discuss](https://github.com/Podcastindex-org/podcast-namespace/issues/43)</small>
|
||||
|
||||
<br>
|
||||
|
||||
<b>
|
||||
|
||||
```xml
|
||||
<podcast:images
|
||||
srcset="[image urls with sizing attached(string array)]"
|
||||
/>
|
||||
```
|
||||
|
||||
</b>
|
||||
|
||||
Channel or Item
|
||||
|
||||
(optional | single)
|
||||
|
||||
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.
|
||||
|
||||
Example of a single gateway:
|
||||
```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>
|
||||
|
||||
## Other Proposals
|
||||
|
||||
|
|
|
|||
578
docs/1.0.md
578
docs/1.0.md
|
|
@ -13,20 +13,22 @@ Each tag below exists in the podcast namespace within the specified parent. All
|
|||
|
||||
Anywhere the url of a hyper-text based resource is specified, it must be given as `https:` and not `http:`.
|
||||
|
||||
<br><br>
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Transcript
|
||||
`<podcast: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.
|
||||
|
||||
#### Parent
|
||||
`<item>`
|
||||
Detailed file format information and example files are [here](../transcripts/transcripts.md).
|
||||
|
||||
#### Count
|
||||
Multiple
|
||||
### Parent
|
||||
`<item>`
|
||||
|
||||
#### Attributes
|
||||
### Count
|
||||
Multiple
|
||||
|
||||
### Attributes
|
||||
- **url (required):** URL of the podcast transcript.
|
||||
|
||||
- **type (required):** Mime type of the file such as `text/plain`, `text/html`, `application/srt`, `text/vtt`, `application/json`
|
||||
|
|
@ -35,123 +37,152 @@ Multiple
|
|||
|
||||
- **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
|
||||
`<podcast:transcript url="https://example.com/episode1/transcript.html" type="text/html" />`
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:transcript url="https://example.com/episode1/transcript.html" type="text/html" />
|
||||
```
|
||||
|
||||
`<podcast:transcript url="https://example.com/episode1/transcript.srt" type="text/srt" rel="captions" />`
|
||||
```xml
|
||||
<podcast:transcript url="https://example.com/episode1/transcript.srt" type="text/srt" rel="captions" />
|
||||
```
|
||||
|
||||
`<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.json" type="application/json" language="es" rel="captions" />
|
||||
```
|
||||
|
||||
`<podcast:transcript url="https://example.com/episode1/transcript.vtt" type="text/vtt" />`
|
||||
|
||||
Detailed file format information and example files are [here](../transcripts/transcripts.md).
|
||||
|
||||
<br><br>
|
||||
```xml
|
||||
<podcast:transcript url="https://example.com/episode1/transcript.vtt" type="text/vtt" />
|
||||
```
|
||||
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Locked
|
||||
`<podcast:locked>`
|
||||
`<podcast:locked>`<br><br>
|
||||
This tag may be set to `yes` or `no`. The purpose is to tell other podcast 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>`
|
||||
### Parent
|
||||
`<channel>`
|
||||
|
||||
#### Count
|
||||
Single
|
||||
### Count
|
||||
Single
|
||||
|
||||
#### Attributes
|
||||
### 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
|
||||
`<podcast:locked owner="email@example.com">yes</podcast:locked>`
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:locked owner="email@example.com">yes</podcast:locked>
|
||||
```
|
||||
|
||||
`<podcast:locked owner="email@example.com">no</podcast:locked>`
|
||||
|
||||
<br><br>
|
||||
```xml
|
||||
<podcast:locked owner="email@example.com">no</podcast:locked>
|
||||
```
|
||||
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Funding
|
||||
`<podcast: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>`
|
||||
### Parent
|
||||
`<channel>`
|
||||
|
||||
#### Count
|
||||
Multiple
|
||||
### Count
|
||||
Multiple
|
||||
|
||||
#### Attributes
|
||||
### 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
|
||||
`<podcast:funding url="https://www.example.com/donations">Support the show!</podcast:funding>`
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:funding url="https://www.example.com/donations">Support the show!</podcast:funding>
|
||||
```
|
||||
|
||||
`<podcast:funding url="https://www.example.com/members">Become a member!</podcast:funding>`
|
||||
|
||||
Please do not exceed `128 characters` for the node value or it may be truncated by aggregators.
|
||||
|
||||
<br><br>
|
||||
```xml
|
||||
<podcast:funding url="https://www.example.com/members">Become a member!</podcast:funding>
|
||||
```
|
||||
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Chapters
|
||||
`<podcast:chapters>`
|
||||
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.
|
||||
`<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.
|
||||
|
||||
#### Parent
|
||||
`<item>`
|
||||
### Parent
|
||||
`<item>`
|
||||
|
||||
#### Count
|
||||
Single
|
||||
### Count
|
||||
Single
|
||||
|
||||
#### Attributes
|
||||
### Attributes
|
||||
- **url (required):** The URL where the chapters file is located.
|
||||
- **type (required):** Mime type of file - JSON prefered, 'application/json+chapters'.
|
||||
|
||||
#### Examples
|
||||
`<podcast:chapters url="https://example.com/episode1/chapters.json" type="application/json+chapters" />`
|
||||
|
||||
<br><br>
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:chapters url="https://example.com/episode1/chapters.json" type="application/json+chapters" />
|
||||
```
|
||||
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Soundbite
|
||||
`<podcast:soundbite>`
|
||||
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>` element.
|
||||
`<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>` element.
|
||||
|
||||
#### Parent
|
||||
`<item>`
|
||||
### Parent
|
||||
`<item>`
|
||||
|
||||
#### Count
|
||||
Multiple
|
||||
### Count
|
||||
Multiple
|
||||
|
||||
#### Attributes
|
||||
### 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)
|
||||
- **node value (optional):** Used as free form string from the podcast creator to specify a title for the soundbite (null defaults to episode title)
|
||||
|
||||
#### Examples
|
||||
`<podcast:soundbite startTime="73.0" duration="60.0" />`
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:soundbite startTime="73.0" duration="60.0" />
|
||||
```
|
||||
|
||||
`<podcast:soundbite startTime="1234.5" duration="42.25">Why the Podcast Namespace Matters</podcast:soundbite>`
|
||||
|
||||
Please do not exceed `128 characters` for the node value or it may be truncated by aggregators.
|
||||
|
||||
<br><br>
|
||||
```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>`
|
||||
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/)
|
||||
`<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>`
|
||||
### Parent
|
||||
`<item>` or `<channel>`
|
||||
|
||||
#### Count
|
||||
Multiple
|
||||
### Count
|
||||
Multiple
|
||||
|
||||
#### Node value
|
||||
This is the full name or alias of the person. This value cannot be blank.
|
||||
### 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
|
||||
### 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.
|
||||
|
|
@ -161,139 +192,169 @@ The `role` and `group` attributes are case-insensitive. So, "Host" is the same
|
|||
|
||||
The full taxonomy list is [here](https://github.com/Podcastindex-org/podcast-namespace/blob/main/taxonomy.json) as a json file.
|
||||
|
||||
Please do not exceed `128 characters` for the node value or they may be truncated by aggregators.
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:person href="https://example.com/johnsmith/blog" img="http://example.com/images/johnsmith.jpg">John Smith</podcast:person>
|
||||
```
|
||||
|
||||
#### Examples
|
||||
`<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>
|
||||
```
|
||||
|
||||
`<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>
|
||||
```
|
||||
|
||||
`<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>
|
||||
```
|
||||
|
||||
`<podcast:person group="writing" role="guest" href="https://www.wikipedia/alicebrown" img="http://example.com/images/alicebrown.jpg">Alice Brown</podcast:person>`
|
||||
|
||||
`<podcast:person group="visuals" role="Cover Art Designer" href="https://example.com/artist/beckysmith">Becky Smith</podcast:person>`
|
||||
|
||||
<br><br>
|
||||
```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>`
|
||||
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.
|
||||
`<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>`
|
||||
### Parent
|
||||
`<item>` or `<channel>`
|
||||
|
||||
#### Count
|
||||
Single
|
||||
### 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.
|
||||
### 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
|
||||
### 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")
|
||||
|
||||
Please do not exceed `128 characters` for the node value or it may be truncated by aggregators.
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:location geo="geo:30.2672,97.7431" osm="R113314">Austin, TX</podcast:location>
|
||||
```
|
||||
|
||||
#### Examples
|
||||
`<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>
|
||||
```
|
||||
|
||||
`<podcast:location geo="geo:33.51601,-86.81455" osm="R6930627">Birmingham Civil Rights Museum</podcast:location>`
|
||||
|
||||
`<podcast:location geo="geo:-27.86159,153.3169" osm="W43678282">Dreamworld (Queensland)</podcast:location>`
|
||||
|
||||
Please see the [implementation document](https://github.com/Podcastindex-org/podcast-namespace/blob/main/location/location.md) and the [example feed](https://github.com/Podcastindex-org/podcast-namespace/blob/main/example.xml) for more examples.
|
||||
|
||||
<br><br>
|
||||
```xml
|
||||
<podcast:location geo="geo:-27.86159,153.3169" osm="W43678282">Dreamworld (Queensland)</podcast:location>
|
||||
```
|
||||
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Season
|
||||
`<podcast: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>`
|
||||
### Parent
|
||||
`<item>`
|
||||
|
||||
#### Count
|
||||
Single
|
||||
### Count
|
||||
Single
|
||||
|
||||
#### Node Value
|
||||
The node value is an integer, and represents the season "number". It is required.
|
||||
### Node Value
|
||||
The node value is an integer, and represents the season "number". It is required.
|
||||
|
||||
#### Attributes
|
||||
### 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
|
||||
`<podcast:season>5</podcast:season>`
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:season>5</podcast:season>
|
||||
```
|
||||
|
||||
`<podcast:season name="Race for the Whitehouse 2020">3</podcast:season>`
|
||||
```xml
|
||||
<podcast:season name="Race for the Whitehouse 2020">3</podcast:season>
|
||||
```
|
||||
|
||||
`<podcast:season name="Egyptology: The 19th Century">1</podcast:season>`
|
||||
```xml
|
||||
<podcast:season name="Egyptology: The 19th Century">1</podcast:season>
|
||||
```
|
||||
|
||||
`<podcast:season name="The Yearling - Chapter 3">3</podcast:season>`
|
||||
|
||||
<br><br>
|
||||
```xml
|
||||
<podcast:season name="The Yearling - Chapter 3">3</podcast:season>
|
||||
```
|
||||
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Episode
|
||||
`<podcast: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>`
|
||||
### Parent
|
||||
`<item>`
|
||||
|
||||
#### Count
|
||||
Single
|
||||
### Count
|
||||
Single
|
||||
|
||||
#### Node Value
|
||||
The node value is a decimal number. It is required.
|
||||
### Node Value
|
||||
The node value is a decimal number. It is required.
|
||||
|
||||
#### Attributes
|
||||
### 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.
|
||||
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
|
||||
`<podcast:episode>3</podcast:episode>`
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:episode>3</podcast:episode>
|
||||
```
|
||||
|
||||
`<podcast:episode>315.5</podcast:episode>`
|
||||
```xml
|
||||
<podcast:episode>315.5</podcast:episode>
|
||||
```
|
||||
|
||||
`<podcast:episode display="Ch.3">204</podcast:episode>`
|
||||
```xml
|
||||
<podcast:episode display="Ch.3">204</podcast:episode>
|
||||
```
|
||||
|
||||
`<podcast:episode display="Day 5">9</podcast:episode>`
|
||||
|
||||
<br><br>
|
||||
```xml
|
||||
<podcast:episode display="Day 5">9</podcast:episode>
|
||||
```
|
||||
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Trailer
|
||||
`<podcast: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>` with the extra `pubdate` and `season` attributes added.
|
||||
|
||||
#### Parent
|
||||
`<channel>`
|
||||
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.
|
||||
|
||||
#### Count
|
||||
Multiple
|
||||
### Parent
|
||||
`<channel>`
|
||||
|
||||
#### Node Value
|
||||
The node value is a string, which is the title of the trailer. It is required.
|
||||
### Count
|
||||
Multiple
|
||||
|
||||
#### Attributes
|
||||
### 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 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. 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>`.
|
||||
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
|
||||
|
|
@ -308,53 +369,57 @@ tag when it is published within a new `<item>`.
|
|||
<podcast:season name="Race for the Whitehouse">4</podcast:season>
|
||||
```
|
||||
|
||||
<br><br>
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## License
|
||||
`<podcast: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>`
|
||||
### Parent
|
||||
`<channel>` or `<item>`
|
||||
|
||||
#### Count
|
||||
Single
|
||||
### 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.
|
||||
### 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
|
||||
### 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
|
||||
`<podcast:license>cc-by-4.0</podcast:license>`
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:license>cc-by-4.0</podcast:license>
|
||||
```
|
||||
|
||||
`<podcast:license url="https://example.org/mypodcastlicense/full.pdf">my-podcast-license-v1</podcast:license>`
|
||||
|
||||
<br><br>
|
||||
```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>`
|
||||
`<podcast:alternateEnclosure>`<br><br>
|
||||
This element is meant to provide different versions of, or companion media to the main `<enclosure>` 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>`
|
||||
### Parent
|
||||
`<item>`
|
||||
|
||||
#### Count
|
||||
Multiple
|
||||
### 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
|
||||
### 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
|
||||
### Attributes
|
||||
- **type:** (required) Mime type of the media asset.
|
||||
- **length:** (required) Length of the file in bytes.
|
||||
- **bitrate:** (optional) Encoding bitrate of media asset.
|
||||
|
|
@ -365,7 +430,7 @@ to allow for file integrity checking.
|
|||
- **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
|
||||
### Examples
|
||||
```xml
|
||||
<enclosure url="https://example.com/file-0.mp3" length="43200000" type="audio/mpeg" />
|
||||
|
||||
|
|
@ -406,28 +471,25 @@ to allow for file integrity checking.
|
|||
</podcast:alternateEnclosure>
|
||||
```
|
||||
|
||||
<br><br>
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Source
|
||||
`<podcast: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>`
|
||||
### Parent
|
||||
`<podcast:alternateEnclosure>`
|
||||
|
||||
#### Count
|
||||
Multiple
|
||||
### Count
|
||||
Multiple
|
||||
|
||||
#### Node Value
|
||||
None
|
||||
|
||||
#### Attributes
|
||||
### 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
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:alternateEnclosure type="video/mp4" length="7924786" bitrate="511276.52" height="720">
|
||||
<podcast:source uri="https://example.com/file-720.mp4" />
|
||||
|
|
@ -437,28 +499,25 @@ None
|
|||
</podcast:alternateEnclosure>
|
||||
```
|
||||
|
||||
<br><br>
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Integrity
|
||||
`<podcast: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>`
|
||||
### Parent
|
||||
`<podcast:alternateEnclosure>`
|
||||
|
||||
#### Count
|
||||
Single
|
||||
### Count
|
||||
Single
|
||||
|
||||
#### Node Value
|
||||
None
|
||||
|
||||
#### Attributes
|
||||
### Attributes
|
||||
- **type:** (required) Type of integrity, either "sri" or "pgp-signature".
|
||||
- **value:** (required) Value of the sri string or base64 encoded pgp signature.
|
||||
|
||||
#### Examples
|
||||
### Examples
|
||||
```xml
|
||||
<podcast:alternateEnclosure type="video/mp4" length="7924786" bitrate="511276.52" height="720">
|
||||
<podcast:source uri="https://example.com/file-720.mp4" />
|
||||
|
|
@ -467,11 +526,11 @@ None
|
|||
</podcast:alternateEnclosure>
|
||||
```
|
||||
|
||||
<br><br>
|
||||
|
||||
|
||||
<br><br><br><br><!-- Tag block -->
|
||||
## Guid
|
||||
`<podcast: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.
|
||||
|
|
@ -483,42 +542,137 @@ Using this pattern, podcasts can maintain a consistent identity across the open
|
|||
|
||||
**Tips:** A GUID is 36 characters long. All podcasts in the Podcast Index have already been assigned a GUID; but if one exists in the RSS feed, that value is canonical.
|
||||
|
||||
#### Parent
|
||||
`<channel>`
|
||||
### Parent
|
||||
`<channel>`
|
||||
|
||||
#### Count
|
||||
Single
|
||||
### Count
|
||||
Single
|
||||
|
||||
#### Node Value
|
||||
The node value is a UUIDv5 string.
|
||||
### Node Value
|
||||
The node value is a UUIDv5 string.
|
||||
|
||||
#### Attributes
|
||||
There are no attributes for this tag.
|
||||
### Attributes
|
||||
There are no attributes for this tag.
|
||||
|
||||
#### Examples
|
||||
### 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)`
|
||||
The `podcast:guid` value above enables podcasters to produce a link that can share a podcast on a variety of different platforms.
|
||||
|
||||
`type` is currently `podcast`, but may be extended in future.
|
||||
The format of the link is `https://(a podcast website link)#fastfollow-(type):(a podcast guid)`
|
||||
|
||||
A working example is https://podnews.net/podcast/i8xe9/listen#fastfollow-podcast:9b024349-ccf0-5f69-a609-6b82873eab3c or the QR code given below.
|
||||
`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.
|
||||
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>
|
||||
```
|
||||
|
|
@ -15,6 +15,7 @@ For elements that are included in the official [DTD](https://github.com/Podcasti
|
|||
8. [PodcastGuru](https://twitter.com/podcastguru_app/status/1362902472793223169)
|
||||
9. [Podlove Podcast Publisher](https://github.com/podlove/podlove-publisher/commit/d3ce9d117c57a4c864d982fb5451c3fb6d20bd91)
|
||||
10. [PodServe.fm](https://www.podserve.fm)
|
||||
11. [Omny Studio](https://blog.omnystudio.com/are-transcriptions-the-building-blocks-for-the-future-of-audio-distribution-464e653c2668)
|
||||
|
||||
|
||||
## Locked `<podcast:locked>`
|
||||
|
|
@ -42,6 +43,7 @@ For elements that are included in the official [DTD](https://github.com/Podcasti
|
|||
11. [Hypercatcher](https://hypercatcher.com)
|
||||
12. [Podlove Podcast Publisher](https://github.com/podlove/podlove-publisher/releases/tag/3.3.1)
|
||||
13. [Podcat](https://twitter.com/podlove_org/status/1363586304643133442)
|
||||
14. [RSS.com Podcasting](https://rss.com)
|
||||
|
||||
## Chapters `<podcast:chapters>`
|
||||
1. [Podcast Chapters](https://chaptersapp.com/faq/jsonExport.html)
|
||||
|
|
@ -73,3 +75,6 @@ For elements that are included in the official [DTD](https://github.com/Podcasti
|
|||
1. [Castopod](https://podlibre.org/castopod-supports-the-person-tag/)
|
||||
2. [Podfriend](https://podcastindex.social/@martin/105466202975036473)
|
||||
3. [Podlove Podcast Publisher](https://github.com/podlove/podlove-publisher/commit/08d52424b359569d795d318163b0c697ef623199)
|
||||
|
||||
## GUID `<podcast:guid>`
|
||||
1. [Buzzsprout](https://www.buzzsprout.com)
|
||||
|
|
|
|||
|
|
@ -9,10 +9,10 @@ For all new episodes, we recommended to use
|
|||
* either a permanent URI, e.g. `https://example.com/ep0003`
|
||||
* or a [Universally unique identifier (UUID)](https://en.wikipedia.org/wiki/Universally_unique_identifier) e.g. `7c029615-a810-5214-9342-eee73f58435d`
|
||||
|
||||
The GUID of an episode should never change, even if a new version of the epsiode is being published, otherwise this episode will be duplicated downstream. This also means that
|
||||
The GUID of an episode should never change, even if a new version of the episode is being published, otherwise this episode will be duplicated downstream.
|
||||
|
||||
|
||||
Consumers of podcast feeds should fall back to the enclosure URL or the namespaced UUIDv5 (SHA1 Hash with ns:URL) of the enclosure URL.
|
||||
Consumers of podcast feeds should fall back to the enclosure URL or the namespaced UUIDv5 (SHA1 Hash with ns:URL) of the enclosure URL, if the value is not set – see https://github.com/Podcastindex-org/podcast-namespace/issues/186#issuecomment-932742468 for more details.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
94
example.xml
94
example.xml
|
|
@ -17,6 +17,10 @@
|
|||
<link>https://example.com/show</link>
|
||||
</image>
|
||||
|
||||
<podcast:guid>y0ur-gu1d-g035-h3r3</podcast:guid>
|
||||
|
||||
<podcast:license url="https://example.org/mypodcastlicense/full.pdf">my-podcast-license-v1</podcast:license>
|
||||
|
||||
<podcast:locked owner="podcastowner@example.com">yes</podcast:locked>
|
||||
<podcast:funding url="https://example.com/donate">Support the show!</podcast:funding>
|
||||
|
||||
|
|
@ -28,6 +32,11 @@
|
|||
<itunes:category text="News"/>
|
||||
<itunes:category text="Technology"/>
|
||||
|
||||
<itunes:owner>
|
||||
<itunes:name>John Doe</itunes:name>
|
||||
<itunes:email>johndoe@example.com</itunes:email>
|
||||
</itunes:owner>
|
||||
|
||||
<itunes:image>https://example.com/images/pci_avatar-massive.jpg</itunes:image>
|
||||
|
||||
<podcast:value type="lightning" method="keysend" suggested="0.00000005000">
|
||||
|
|
@ -35,6 +44,8 @@
|
|||
<podcast:valueRecipient name="hosting company" type="node" address="036557ea56b3b86f08be31bcd2557cae8021b0e3a9413f0c0e52625c6696972e57" split="1" />
|
||||
</podcast:value>
|
||||
|
||||
<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>
|
||||
|
||||
<item>
|
||||
<title>Episode 3 - The Future</title>
|
||||
<description><p>A look into the future of podcasting and how we get to Podcasting 2.0!</p></description>
|
||||
|
|
@ -56,7 +67,36 @@
|
|||
<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>
|
||||
<enclosure url="https://mp3s.nashownotes.com/PC20-17-2020-12-25-Final.mp3" length="76606111" type="audio/mpeg"/>
|
||||
|
||||
<enclosure url="https://example.com/file-03.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-03.mp3" />
|
||||
<podcast:source uri="ipfs://someRandomMpegFile03" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:alternateEnclosure type="audio/opus" length="32400000" bitrate="96000" title="High quality">
|
||||
<podcast:source uri="https://example.com/file-high-03.opus" />
|
||||
<podcast:source uri="ipfs://someRandomHighBitrateOpusFile03" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:alternateEnclosure type="audio/aac" length="54000000" bitrate="160000" title="High quality AAC">
|
||||
<podcast:source uri="https://example.com/file-proprietary-03.aac" />
|
||||
<podcast:source uri="ipfs://someRandomProprietaryAACFile03" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:alternateEnclosure type="audio/opus" length="5400000" bitrate="16000" title="Low bandwidth">
|
||||
<podcast:source uri="https://example.com/file-low-03.opus" />
|
||||
<podcast:source uri="ipfs://someRandomLowBitrateOpusFile03" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:value type="lightning" method="keysend" suggested="0.00000005000">
|
||||
<podcast:valueRecipient name="podcaster" type="node" address="036557ea56b3b86f08be31bcd2557cae8021b0e3a9413f0c0e52625c6696972e57" split="49" />
|
||||
<podcast:valueRecipient name="hosting company" type="node" address="036557ea56b3b86f08be31bcd2557cae8021b0e3a9413f0c0e52625c6696972e57" split="1" />
|
||||
<podcast:valueRecipient name="Gigi (Guest)" type="node" address="02e12fea95f576a680ec1938b7ed98ef0855eadeced493566877d404e404bfbf52" split="50" />
|
||||
</podcast:value>
|
||||
|
||||
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
|
@ -80,7 +120,34 @@
|
|||
<podcast:person href="https://en.wikipedia.org/wiki/Adam_Curry" img="http://example.com/images/adamcurry.jpg">Adam Curry</podcast:person>
|
||||
<podcast:person role="guest" href="https://example.com/blog/daveajones/" img="http://example.com/images/davejones.jpg">Dave Jones</podcast:person>
|
||||
<podcast:person group="visuals" role="cover art designer" href="https://example.com/artist/marcusbrown">Marcus Brown</podcast:person>
|
||||
<enclosure url="https://mp3s.nashownotes.com/PC20-16-2020-12-18-Final.mp3" length="67080717" type="audio/mpeg"/>
|
||||
|
||||
<enclosure url="https://example.com/file-02.mp3" length="43113000" type="audio/mpeg" />
|
||||
|
||||
<podcast:alternateEnclosure type="audio/mpeg" length="43200000" bitrate="128000" default="true" title="Standard">
|
||||
<podcast:source uri="https://example.com/file-02.mp3" />
|
||||
<podcast:source uri="ipfs://someRandomMpegFile02" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:alternateEnclosure type="audio/opus" length="32400000" bitrate="96000" title="High quality">
|
||||
<podcast:source uri="https://example.com/file-high-02.opus" />
|
||||
<podcast:source uri="ipfs://someRandomHighBitrateOpusFile02" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:alternateEnclosure type="audio/aac" length="54000000" bitrate="160000" title="High quality AAC">
|
||||
<podcast:source uri="https://example.com/file-proprietary-02.aac" />
|
||||
<podcast:source uri="ipfs://someRandomProprietaryAACFile02" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:alternateEnclosure type="audio/opus" length="5400000" bitrate="16000" title="Low bandwidth">
|
||||
<podcast:source uri="https://example.com/file-low-02.opus" />
|
||||
<podcast:source uri="ipfs://someRandomLowBitrateOpusFile02" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:value type="lightning" method="keysend" suggested="0.00000005000">
|
||||
<podcast:valueRecipient name="podcaster" type="node" address="036557ea56b3b86f08be31bcd2557cae8021b0e3a9413f0c0e52625c6696972e57" split="49" />
|
||||
<podcast:valueRecipient name="hosting company" type="node" address="036557ea56b3b86f08be31bcd2557cae8021b0e3a9413f0c0e52625c6696972e57" split="1" />
|
||||
<podcast:valueRecipient name="Paul Itoi (Guest)" type="node" address="03a9a8d953fe747d0dd94dd3c567ddc58451101e987e2d2bf7a4d1e10a2c89ff38" split="50" />
|
||||
</podcast:value>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
|
@ -104,7 +171,28 @@
|
|||
<podcast:person href="https://curry.com" img="http://example.com/images/adamcurry.jpg">Adam Curry</podcast:person>
|
||||
<podcast:person role="guest" href="https://www.imdb.com/name/nm0427852888/" img="http://example.com/images/davejones.jpg">Dave Jones</podcast:person>
|
||||
<podcast:person group="visuals" role="cover art designer" href="https://example.com/artist/jebickmorton">Jebick Morton</podcast:person>
|
||||
<enclosure url="https://mp3s.nashownotes.com/PC20-15-2020-12-11-Final.mp3" length="71234813" type="audio/mpeg"/>
|
||||
|
||||
<enclosure url="https://example.com/file-01.mp3" length="43111403" type="audio/mpeg" />
|
||||
|
||||
<podcast:alternateEnclosure type="audio/mpeg" length="43203200" bitrate="128000" default="true" title="Standard">
|
||||
<podcast:source uri="https://example.com/file-01.mp3" />
|
||||
<podcast:source uri="ipfs://someRandomMpegFile01" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:alternateEnclosure type="audio/opus" length="32406000" bitrate="96000" title="High quality">
|
||||
<podcast:source uri="https://example.com/file-high-01.opus" />
|
||||
<podcast:source uri="ipfs://someRandomHighBitrateOpusFile01" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:alternateEnclosure type="audio/aac" length="5400300" bitrate="160000" title="High quality AAC">
|
||||
<podcast:source uri="https://example.com/file-proprietary-01.aac" />
|
||||
<podcast:source uri="ipfs://someRandomProprietaryAACFile01" />
|
||||
</podcast:alternateEnclosure>
|
||||
|
||||
<podcast:alternateEnclosure type="audio/opus" length="5042000" bitrate="16000" title="Low bandwidth">
|
||||
<podcast:source uri="https://example.com/file-low-01.opus" />
|
||||
<podcast:source uri="ipfs://someRandomLowBitrateOpusFile01" />
|
||||
</podcast:alternateEnclosure>
|
||||
</item>
|
||||
</channel>
|
||||
</rss>
|
||||
|
|
|
|||
|
|
@ -14,6 +14,8 @@ Stated eloquently, the aim of Podcasting 2.0 is this:
|
|||
> --Tom Rossi [Tom Rossi](https://podcastindex.social/@tomrossi7/105839063781381384)
|
||||
|
||||
|
||||
<br>
|
||||
|
||||
Closed ecosystems can not innovate any better or faster than open systems. We should know this by now. The open world of RSS based podcasting can not only
|
||||
keep pace with closed systems, it can exceed them easily. Podcasting 2.0 is simply the technological expression of this idea. We can make a better podcasting
|
||||
experience for listeners than they can get behind any walled garden - no matter how high or expensive those walls are.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# The "podcast:recommendations" Specification
|
||||
|
||||
<small>Version 1.1 by Benjamin Bellamy - 2021.08.11</small>
|
||||
<small>Version 1.0 by Benjamin Bellamy - 2021.08.31</small>
|
||||
|
||||
<br>
|
||||
|
||||
|
|
@ -11,10 +11,11 @@ That comes with a huge drawback: finding and being found can be harsh.
|
|||
Podcast creators struggle to be found while podcast listeners struggle to find content.
|
||||
Several platforms are now implementing recommendation engines, but these features are expensive and unattainable for small players. Moreover they are slowly creating closed silos and removing power from content creators.
|
||||
This specification is about giving control to content creators on the content they want to recommend, and at the same time providing a free recommendation system to all players.
|
||||
- Version 1.1 adds:
|
||||
- Adding:
|
||||
- `GUID` support for channel element,
|
||||
- a `reason` tag that explains why a specefic recommendation was included,
|
||||
- a `medium-type` tag so that this can work with any feed, including non-podcast media, an element with no URL.
|
||||
- a `motive` tag that explains why a specific recommendation was included,
|
||||
- a `medium` tag so that this can work with any feed, including non-podcast medium. (See \<podcast:medium> for more information.)
|
||||
|
||||
All this was heavily inspired by all the work previously done by the Fellowship of the PodcastIndex on the chapters and soundbite tags. May they be thanked for it.
|
||||
GO PODCASTING!!!
|
||||
|
||||
|
|
@ -72,7 +73,7 @@ The "recommendation" object takes this basic form:
|
|||
|
||||
```json
|
||||
{
|
||||
"type": "page",
|
||||
"linkType": "generic",
|
||||
"title": "History of podcasting",
|
||||
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png",
|
||||
"url": "https://en.wikipedia.org/wiki/History_of_podcasting"
|
||||
|
|
@ -81,21 +82,41 @@ The "recommendation" object takes this basic form:
|
|||
|
||||
There are 4 required attributes:
|
||||
|
||||
- `type` (required - string) The type of this recommended content (*"page"*, *"feed"*, *"item"*, *"text"*).
|
||||
- `media-kind` (required - string) The media kind. It can be `podcast`, `audiobook`, `music`, `video`, `image`, `text`, `html`
|
||||
- `linkType` (required - string) The link type of this recommended content, it can be:
|
||||
- 'generic',
|
||||
- 'feed',
|
||||
- 'feed-item',
|
||||
- 'none'
|
||||
- `medium` (required - string) The medium type. It can be:
|
||||
- `podcast`,
|
||||
- `audiobook`,
|
||||
- `music`,
|
||||
- `video`,
|
||||
- `film`,
|
||||
- `image`,
|
||||
- `text`,
|
||||
- `html`
|
||||
- `title` (required - string) The title for this recommended content.
|
||||
|
||||
#### Optional Attributes:
|
||||
|
||||
- `url` (optional - string) The URL for this recommended content. If recommended content type is *"feed"* this is the home page of the podcast. If recommended content type is *"item"* this is the enclosure URL.
|
||||
- `url` (optional - string) The URL for this recommended content. If recommended content type is *"feed"* this is the home page of the podcast/medium. If recommended content type is *"feed-item"* this is the enclosure URL.
|
||||
- `image` (optional - string) The image URL for this recommended content. Image must have a 1:1 ratio (square).
|
||||
- `displayStartTime` (optional - float) The start time (in seconds) that tells when this recommended content should start being displayed. If `displayStartTime` is omitted, recommendation will be displayed from the beginning. Applies only when called from an *Item* (not from the *Channel*).
|
||||
- `displayDuration` (optional - float) The duration (in seconds) that tells when this recommended content should stop being displayed. If `displayDuration` is omitted, recommendation will be displayed until the end. Applies only when called from an *Item* (not from the *Channel*).
|
||||
- `feed` (optional - string) The RSS URL of this recommended content. Applies to *"feed"*, *"item"* types.
|
||||
- `guid` (optional - string) The GUID of this recommended content. Applies to *"feed"* and *"item"* types.
|
||||
- `startTime` (optional - float) The start time (in seconds) of this recommended content. Applies to *"item"* type only.
|
||||
- `duration` (optional - float) The duration (in seconds) of this recommended content. Applies to *"item"* type only.
|
||||
- `motive` (optional - string) The reason why this content is recommended. It can be `additional content`, `acknowledgment`, `thanking`, `advertising`, `audience exchange`, `similar content`, `also liked by the audience`, `made by the same team`, `do you want to know more`
|
||||
- `feed` (optional - string) The RSS URL of this recommended content. Applies to *"feed"*, *"feed-item"* types.
|
||||
- `guid` (optional - string) The GUID of this recommended content. Applies to *"feed"* and *"feed-item"* types.
|
||||
- `startTime` (optional - float) The start time (in seconds) of this recommended content. Applies to *"feed-item"* type only.
|
||||
- `duration` (optional - float) The duration (in seconds) of this recommended content. Applies to *"feed-item"* type only.
|
||||
- `motive` (optional - string) The reason why this content is recommended. It can be:
|
||||
- `references` (content that was used when creating this podcast, similar to the Wikipedia References paragraph),
|
||||
- `additional content` (content that provides extra information),
|
||||
- `acknowledgment` (thanking people),
|
||||
- `advertising` (sponsored content),
|
||||
- `audience exchange` (exchanging audiences between podcasts),
|
||||
- `content-based recommendation` (content related thanks to semantic indexation),
|
||||
- `audience-based recommendation` (people who liked this also liked…),
|
||||
- `made by the same people` (the creators of this podcast also made that…)
|
||||
- `relevance` (optional - float) The relevance of this recommended content regarding this Channel or Item. Number must be in [0…1]. 0 is for irrelevant content, 1 is for contents that match perfectly.
|
||||
|
||||
## Basic example
|
||||
|
|
@ -108,22 +129,22 @@ Here is what a very basic recommendations file may look like:
|
|||
"recommendations":
|
||||
[
|
||||
{
|
||||
"type": "text",
|
||||
"media-kind": "text",
|
||||
"linkType": "none",
|
||||
"medium": "text",
|
||||
"title": "Eat five vegetables every day.",
|
||||
"motive": "advertising"
|
||||
},
|
||||
{
|
||||
"type": "page",
|
||||
"media-kind": "html",
|
||||
"linkType": "generic",
|
||||
"medium": "html",
|
||||
"title": "History of podcasting",
|
||||
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png",
|
||||
"url": "https://en.wikipedia.org/wiki/History_of_podcasting",
|
||||
"motive": "do you want to know more"
|
||||
"motive": "additional content"
|
||||
},
|
||||
{
|
||||
"type": "feed",
|
||||
"media-kind": "podcast",
|
||||
"linkType": "feed",
|
||||
"medium": "podcast",
|
||||
"title": "Podcasting 2.0",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
"url": "https://podcastindex.org/podcast/920666",
|
||||
|
|
@ -131,8 +152,8 @@ Here is what a very basic recommendations file may look like:
|
|||
"motive": "audience exchange"
|
||||
},
|
||||
{
|
||||
"type": "item",
|
||||
"media-kind": "podcast",
|
||||
"linkType": "item",
|
||||
"medium": "podcast",
|
||||
"title": "Episode 26: Manning Battlestations",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
"url": "https://mp3s.nashownotes.com/PC20-26-2021-02-26-Final.mp3",
|
||||
|
|
@ -140,8 +161,8 @@ Here is what a very basic recommendations file may look like:
|
|||
"guid": "PC2026"
|
||||
},
|
||||
{
|
||||
"type": "item",
|
||||
"media-kind": "podcast",
|
||||
"linkType": "item",
|
||||
"medium": "podcast",
|
||||
"title": "GO PODCASTING!!!",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
"url": "https://mp3s.nashownotes.com/PC20-26-2021-02-26-Final.mp3",
|
||||
|
|
@ -165,27 +186,27 @@ Here is what a very basic recommendations file may look like:
|
|||
"recommendations":
|
||||
[
|
||||
{
|
||||
"type": "text",
|
||||
"media-kind": "text",
|
||||
"linkType": "none",
|
||||
"medium": "text",
|
||||
"title": "Eat five vegetables every day.",
|
||||
"motive": "advertising"
|
||||
},
|
||||
{
|
||||
"displayStartTime": 0.0,
|
||||
"displayDuration": 120.0,
|
||||
"type": "page",
|
||||
"media-kind": "html",
|
||||
"linkType": "generic",
|
||||
"medium": "html",
|
||||
"title": "History of podcasting",
|
||||
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png",
|
||||
"url": "https://en.wikipedia.org/wiki/History_of_podcasting",
|
||||
"motive": "do you want to know more",
|
||||
"motive": "additional content",
|
||||
"relevance": 0.8
|
||||
},
|
||||
{
|
||||
"displayStartTime": 120.50,
|
||||
"displayDuration": 60.0,
|
||||
"type": "feed",
|
||||
"media-kind": "podcast",
|
||||
"linkType": "feed",
|
||||
"medium": "podcast",
|
||||
"title": "Podcasting 2.0",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
"url": "https://podcastindex.org/podcast/920666",
|
||||
|
|
@ -196,8 +217,8 @@ Here is what a very basic recommendations file may look like:
|
|||
{
|
||||
"displayStartTime": 240.60,
|
||||
"displayDuration": 180.0,
|
||||
"type": "item",
|
||||
"media-kind": "podcast",
|
||||
"linkType": "feed-item",
|
||||
"medium": "podcast",
|
||||
"title": "Episode 26: Manning Battlestations",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
"url": "https://mp3s.nashownotes.com/PC20-26-2021-02-26-Final.mp3",
|
||||
|
|
@ -208,8 +229,8 @@ Here is what a very basic recommendations file may look like:
|
|||
{
|
||||
"displayStartTime": 3600.10,
|
||||
"displayDuration": 60.0,
|
||||
"type": "item",
|
||||
"media-kind": "podcast",
|
||||
"linkType": "item",
|
||||
"medium": "podcast",
|
||||
"title": "GO PODCASTING!!!",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
"url": "https://mp3s.nashownotes.com/PC20-26-2021-02-26-Final.mp3",
|
||||
|
|
@ -217,7 +238,7 @@ Here is what a very basic recommendations file may look like:
|
|||
"guid": "PC2026",
|
||||
"startTime": 4737.0,
|
||||
"duration": 5.0,
|
||||
"motive": "do you want to know more",
|
||||
"motive": "additional content",
|
||||
"relevance": 0.9
|
||||
}
|
||||
]
|
||||
|
|
|
|||
|
|
@ -1,51 +1,51 @@
|
|||
acast
|
||||
amazon
|
||||
anchor
|
||||
apple
|
||||
audioboom
|
||||
backtracks
|
||||
acast.com
|
||||
amazon.com
|
||||
anchor.fm
|
||||
apple.com
|
||||
audioboom.com
|
||||
backtracks.fm
|
||||
bitcoin
|
||||
blubrry
|
||||
buzzsprout
|
||||
captivate
|
||||
castos
|
||||
fireside
|
||||
fyyd
|
||||
google
|
||||
hypercatcher
|
||||
libsyn
|
||||
blubrry.com
|
||||
buzzsprout.com
|
||||
captivate.com
|
||||
castos.com
|
||||
fireside.fm
|
||||
fyyd.de
|
||||
google.com
|
||||
hypercatcher.com
|
||||
libsyn.com
|
||||
mastodon
|
||||
megafono
|
||||
megaphone
|
||||
omnystudio
|
||||
overcast
|
||||
paypal
|
||||
pinecast
|
||||
podbean
|
||||
podcastaddict
|
||||
podcastguru
|
||||
podcastindex
|
||||
megafono.host
|
||||
megaphone.fm
|
||||
omnystudio.com
|
||||
overcast.fm
|
||||
paypal.com
|
||||
pinecast.com
|
||||
podbean.com
|
||||
podcastaddict.com
|
||||
podcastguru.io
|
||||
podcastindex.org
|
||||
podcasts.com
|
||||
podchaser
|
||||
podcloud
|
||||
podfriend
|
||||
podiant
|
||||
podigee
|
||||
podnews
|
||||
podomatic
|
||||
podserve
|
||||
podverse
|
||||
redcircle
|
||||
relayfm
|
||||
resonate
|
||||
podchaser.com
|
||||
podcloud.fr
|
||||
podfriend.com
|
||||
podiant.co
|
||||
podigee.com
|
||||
podnews.com
|
||||
podomatic.com
|
||||
podserve.fm
|
||||
podverse.fm
|
||||
redcircle.com
|
||||
relay.fm
|
||||
resonaterecordings.com
|
||||
rss.com
|
||||
shoutengine
|
||||
simplecast
|
||||
slack
|
||||
soundcloud
|
||||
spotify
|
||||
spreaker
|
||||
transistor
|
||||
twitter
|
||||
whooshkaa
|
||||
zencast
|
||||
shoutengine.com
|
||||
simplecast.com
|
||||
slack.com
|
||||
soundcloud.com
|
||||
spotify.com
|
||||
spreaker.fm
|
||||
transistor.fm
|
||||
twitter.com
|
||||
whooshkaa.com
|
||||
zencast.com
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# The "podcast:value" Specification
|
||||
|
||||
<small>Version 1.3 by Dave Jones - 2021.02.25</small>
|
||||
<small>Version 1.4 by [Dave Jones](https://github.com/daveajones) - with [Gigi](https://github.com/dergigi), [Evan Feenstra](https://github.com/evanfeenstra) & [Paul Itoi](https://github.com/pitoi)</small><br>
|
||||
<small>September 1st, 2021</small>
|
||||
|
||||
<br>
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue