Skip to content

Commit 46a7c5d

Browse files
committed
docs: add timestamp synchronization best practices and HLS documentation
- Add best practices section emphasizing fixing timestamps at source in Final Cut Pro - Document --clip-offset as fallback option with wildcard support - Add HLS segmented output documentation with manifest file details
1 parent 5adbc24 commit 46a7c5d

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,31 @@ Now that you have an export, run `tcx2webvtt` with the `--fcp` option:
4242
```sh
4343
tcx2webvtt --fcp 'My Project Export.fcpxmld' my-workout.tcx > my-track.vtt
4444
```
45+
46+
#### Best Practices for Timestamp Synchronization
47+
48+
For the most reliable synchronization, ensure that the "Content Created" timestamps in your Final Cut Pro project match the actual recording times of your workout clips. This creates a canonical source of timing that makes your project reproducible and easier to maintain.
49+
50+
If you cannot modify the source project timestamps, use the `--clip-offset` option as a fallback to correct timing discrepancies:
51+
52+
```sh
53+
tcx2webvtt --fcp project.fcpxmld --clip-offset GX010163,2.5 workout.tcx
54+
```
55+
56+
You can also apply the same offset to all clips using the wildcard `*`:
57+
58+
```sh
59+
tcx2webvtt --fcp project.fcpxmld --clip-offset '*,-1.0' workout.tcx
60+
```
61+
62+
However, fixing timestamps at the source (in Final Cut Pro) is preferred over applying corrections downstream, as it ensures consistency across all exports and eliminates the need for manual offset calculations.
63+
64+
### HTTP Live Streaming
65+
66+
For streaming applications or web players that require segmented media, use the `--hls` option to generate segmented WebVTT output:
67+
68+
```sh
69+
tcx2webvtt --hls ./output-directory my-workout.tcx
70+
```
71+
72+
This creates multiple `.vtt` files and an `index.m3u8` manifest file in the specified directory, each segment containing workout data for a specific time range. This format is compatible with HLS video streams.

0 commit comments

Comments
 (0)