Application notes are informative documents describing the recommended usage of the API. For more information on how we use application notes, see here.
| Application Note Number | Title |
|---|---|
| 0001 | Practical Application of the TAMS Content Model |
| 0002 | Timing in MPEG-TS |
| 0003 | Tags, how to use them, and how we manage them |
| 0004 | When TAMS is a good fit for non-media data. And when it’s not |
| 0005 | Media objects should be independently decodable. Here's why |
| 0006 | Containers and Mappings |
| 0007 | Populating Source Metadata |
| 0008 | Timestamps in TAMS |
| 0009 | Storage label format specification - Superseded by ADR-0032 |
| 0010 | Long-running Sources and Flows |
| 0011 | C2PA provenance across related Sources and Flows |
| 0012 | Using Flow Segment timeranges |
| 0013 | Setting Flow bit rate properties |
| 0014 | Referencing TAMS content in other systems |
| 0015 | Using TAMS in OpenTimelineIO |
| 0016 | Authorisation in TAMS workflows |
| 0017 | When to re-use IDs in TAMS and compatible systems |
| 0018 | Managing Multiple Object Instances |
| 0019 | Methods of implementing retention management |
This repository uses (M)ADR documents to propose significant changes, facilitate discussions and decision making, and to store a record of options that were considered. The following is an index of currently available ADRs. For more information on how we use ADRs, see here.
| ADR Number | Title |
|---|---|
| 0000 | Use Markdown ADRs to record design decisions |
| 0001 | Expand Created-by and Modified-by Metadata |
| 0002 | Add Sources as objects in the API |
| 0003 | Created and Modified Timestamps should be managed internally |
| 0004 | Deletion of Content and IDs |
| 0004a* | Flow and Source References |
| 0005 | Flow Read-Write Permissions |
| 0006 | Flow Update Status |
| 0007 | Use Timerange in Flow Segments |
| 0008 | Move Flow Parameters into a sub-property |
| 0009 | Allow Segments to Overlap |
| 0010 | Add pagination to Flow/Source listing endpoints |
| 0011 | Random Storage Object IDs |
| 0012 | Add collections to flow and source metadata schemas |
| 0013 | Timeline exposed by Flows |
| 0014 | Add an event stream to the TAMS API |
| 0015 | Make FlowSegment get_url expectations clearer |
| 0016 | Add Object Checksums and Filesizes |
| 0017 | Defining the Container Mapping to a Flow |
| 0018 | Restrict direct Source modification |
| 0019 | Rename modified_by properties in Source and Flow schemas to updated_by |
| 0020 | Improving the signalling of the supported API version in implementations |
| 0021 | Options for get_urls labels on Flow Segments |
| 0022 | Definitions for Flow bit rate properties and additional properties |
| 0023 | Add query option to filter Flow Segment get_urls by label |
| 0024 | Source-level Edit |
| 0025 | Options for updating Flow properties |
| 0026 | Updates to the webhook event structures and filters |
| 0027 | Add an objects API endpoint |
| 0028 | Methods to authenticate clients with a TAMS server |
| 0029 | Changes to flow segments to add segments in bulk |
| 0030 | Allow a Flow to reference media objects in other Flows and storage |
| 0031 | Add new flow type to support still images |
| 0032 | Specifying storage backend when requesting storage allocation |
| 0033 | Add created metadata to segments |
| 0034 | Add object_ids option to Flow Storage request |
| 0035 | Fine-grained Authorisation in TAMS Workflows |
| 0036 | Specifying partial segment usage |
| 0037 | Proposal for improvements to the Webhooks endpoints |
| 0038 | Improved Storage Management |
| 0039 | Proposal to remove pre-actions from storage allocation response |
| 0040 | Tag Usability Enhancements |
| 0041 | Requiring explicit frame rates |
| 0042 | Make label Mandatory for Uncontrolled Object Instances |
| 0043 | Signalling retention time |
| 0044 | Signalling timeout periods |
| 0046 | Governance |
* Note: ADR 0004a was the unintended result of a number clash in the early development of TAMS which wasn't caught before publication