Skip to content

Commit

Permalink
api: add words to flow segment POSTs related to overlaps
Browse files Browse the repository at this point in the history
Clients should not POST a flow segment that overlaps with existing
segments. This includes segments with equal timerange where the
second POST can be viewed as a modification.
  • Loading branch information
philipnbbc committed Jul 22, 2024
1 parent 3fc05d3 commit 86ade1c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion api/TimeAddressableMediaStore.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1309,9 +1309,14 @@ paths:
- All samples in the object SHOULD be used by the segment.
- The timestamps of each sample in the media object MUST equal its position on the Flow timeline, OR `ts_offset` MUST
be set such that `media_object_ts + ts_offset = segment_ts`
- The timerange of the segment MUST NOT overlap any other segment in the same Flow.
- The timerange of the segment MUST NOT overlap any other segment in the same Flow. The behaviour is
undefined if there is an overlap with existing segments and a store may return a 400 error response.
- The `sample_offset` SHOULD be zero.
If a client needs to modify a Flow segment, e.g. to correct metadata such as the `key_frame_count` or add additional
URLs to `get_urls`, then the client SHOULD first delete the existing segment and then write a new one. The behaviour is
undefined if the segment exists and a store may return a 400 error response.
Clients are expected to decide how to break content into media objects, however those objects SHOULD be large
enough to avoid excessive round trip overheads in the underlying store (_e.g._ of the order of several megabytes)
and where codecs with temporal re-ordering are used, object SHOULD contain complete GOPs or decodable units.
Expand Down

0 comments on commit 86ade1c

Please sign in to comment.