From 1f88b835ae9cb87ee2e4bbd89f12f63009dc2371 Mon Sep 17 00:00:00 2001 From: Dave Jones Date: Thu, 20 Jan 2022 10:37:36 -0600 Subject: [PATCH] tweak --- docs/1.0.md | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/1.0.md b/docs/1.0.md index 1940c60..7066470 100644 --- a/docs/1.0.md +++ b/docs/1.0.md @@ -757,26 +757,13 @@ Example of specifying four different image sizes: ## Live Item ``

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 `` episode tag, and all tags that are -allowed inside of a normal `` tag are also allowed as children of ``. - -The [``](#alternate-enclosure) tag is highly encouraged over the use of `` since it gives the broadest coverage of possible stream types and is -much more explicit in it's definition of what transport protocol and media codecs are being used. If [``](#alternate-enclosure) cannot be used, `` can be used as a fallback, -however feed owners must limit the stream to using 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 for `` outside of this narrow list will exclude many apps from playing your content. - -The `` tag is also highly encouraged to ensure that listeners have a fallback option in case their chosen app cannot play the given content stream directly. Podcasters -who live stream to multiple platforms at once can also use the `` tag to provide links to those various platforms. - -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. +allowed inside of a normal `` tag are also allowed as children of ``. Note that "allowed" is not the same as "supported". So, just like a normal `` +you cannot depend on all apps to support all tags within ``, especially when the context of the tag is not obvious. For instance, including an `` +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. -The function of `` within a live item tag is the same as it is within a regular item. If the `` of a `` changes, it MUST be considered a new stream by -podcast apps. - ### Parent   `` @@ -785,14 +772,29 @@ podcast apps. ### Node Value All tags that are valid inside of a standard `` tag are also valid here. The [``](#alternate-enclosure) tag has robust support for specifying streaming content -in a myriad of ways and is highly encouraged over the use of `` where possible. A `` tag is also highly encouraged as a fallback for apps to display when +in a myriad of ways and is highly encouraged over the use of `` where possible. A `` tag is also required to be present as a fallback for apps to display/launch when they cannot play the content directly. +The [``](#alternate-enclosure) tag is highly encouraged over the use of `` since it gives the broadest coverage of possible stream types and is +much more explicit in it's definition of what transport protocol and media codecs are being used. If [``](#alternate-enclosure) cannot be used, `` can be used as a fallback, +however feed owners must limit the stream to using 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 for `` outside of this narrow list will exclude many apps from playing your content. + +The [``](#content-link) tag is also required to ensure that listeners have a fallback option in case their chosen app cannot play the given content stream directly. Podcasters +who live stream to multiple platforms at once can also use the `` tag to provide links to those various platforms. + +The function of `` within a live item tag is the same as it is within a regular item. If the `` of a `` 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