Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

app note: document tags used in AWS opensource CNAP impl #94

Merged
merged 2 commits into from
Nov 21, 2024
Merged

app note: document tags used in AWS opensource CNAP impl #94

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85dad58
app note: document tags used in AWS opensource CNAP impl
philipnbbc Nov 18, 2024
b8f8472
Merge branch 'main' into philipn-experimental-tags
philipnbbc Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/appnotes/0003-tag-names.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ The tags below are marked with the following statuses:
* **Proposed**:
* Not yet in common usage, but use should be considered
* ADR where this tag was proposed is stated where available
* **Experimental**:
* Created for an experimental implementation or application
* Tag may never be proposed
* Tag may be proposed in future, possibly with a different name or meaning
* Tag may appear in one or more implementations or versions
* **Deprecated**:
* Tag is deprecated and should no longer be used
* Tag *may* still appear e.g. in old Flow/Source entries
Expand Down Expand Up @@ -162,6 +167,30 @@ Known values:
* `detached`: A C2PA manifest has been copied from this multi-essence Flow into a collected mono-essence data Flow.
The Flow will have the role `c2pa` in the multi-essence Flow's `flow_collection` array.

### hls_segments

Status: **Experimental**

Used in the TAMS demonstration at IBC 2024.

The type is a `number`.
It is used to limit the number of segments presented in the HLS manifest.
Defaults to `150` if the tag is not set.
Use the value `inf` to list all segments.
However, listing all segments may result in the generation of the HLS manifest timing out.

### hls_segment_length

Status: **Experimental**

Used in the TAMS demonstration at IBC 2024.

The type is a `number`.
It is used to calculate the [MEDIA-SEQUENCE](https://datatracker.ietf.org/doc/html/rfc8216#section-4.3.3.2) value in the HLS manifest.
This tag is only used if the [flow_status](#flow_status) tag value is `ingesting`.
The value of this tag should be set to the duration of each segment in the flow (in seconds).
Flows using this feature must therefore have segments of consistant length.

## Known Source Tags

There are currently no known Source Tags.
Loading