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.

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

Using flow segment timeranges and related spec updates #97

Merged
merged 9 commits into from
Jan 2, 2025

Conversation

philipnbbc
Copy link
Contributor

Details

This PR adds an Application Note that describes the use of the Flow Segment timerange property. The PR also updates the definitions of the Flow Segment timerange and last_duration properties.

Pivotal Story (if relevant)

Story URL: https://www.pivotaltracker.com/story/show/188581560

Related PRs

Where appropriate. Indicate order to be merged.

Submitter PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • API version has been incremented if necessary
  • ADR status has been updated, and ADR implementation has been recorded
  • Documentation updated (README, etc.)
  • PR added to Pivotal story (if relevant)
  • Follow-up stories added to Pivotal

Reviewer PR Checks

(tick as appropriate)

  • PR completes task/fixes bug
  • Design makes sense, and fits with our current code base
  • Code is easy to follow
  • PR size is sensible
  • Commit history is sensible and tidy

Info on PRs

The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.

@philipnbbc philipnbbc requested a review from a team as a code owner November 28, 2024 10:14
@philipnbbc philipnbbc force-pushed the philipn-flow-segment-timeranges branch from 4c18ac9 to 8d88b77 Compare November 28, 2024 10:15
Copy link
Member

@samdbmg samdbmg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice explanation and diagrams

api/schemas/flow-segment.json Outdated Show resolved Hide resolved
docs/appnotes/0012-using-flow-segment-timeranges.md Outdated Show resolved Hide resolved
docs/appnotes/0012-using-flow-segment-timeranges.md Outdated Show resolved Hide resolved
Define it as a difference between the exclusive end and the last sample
timestamp.
Be specific about when the timerange uses an exclusive (samples have
duration) or inclusive end (samples don't have a duration).
E.g. for 48kHz audio samples with an exclusive timerange end.
@philipnbbc philipnbbc force-pushed the philipn-flow-segment-timeranges branch from 8d88b77 to 8d9b9af Compare January 2, 2025 14:14
@philipnbbc philipnbbc merged commit f2e2b03 into main Jan 2, 2025
5 checks passed
@philipnbbc philipnbbc deleted the philipn-flow-segment-timeranges branch January 2, 2025 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants