Skip to content

Conversation

@Apprentice2907
Copy link

In raising this pull request, I confirm the following (please check boxes):

  • I have read and understood the contributors guide.
  • I have checked that another pull request for this purpose does not exist.
  • I have considered, and confirmed that this submission will be valuable to others.
  • I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  • I give this submission freely, and claim no ownership to its content.
  • I have mentioned this change in the changelog.

My familiarity with the project is as follows (check one):

  • I have never used CCExtractor.
  • I have used CCExtractor just a couple of times.
  • I absolutely love CCExtractor, but have not contributed previously.
  • I am an active contributor to CCExtractor.

Description

This pull request documents the existing --timestamp-map command-line option for WebVTT output.

The functionality to enable the X-TIMESTAMP-MAP header already exists in the codebase and is disabled by default.
However, it was not documented in the README, which led to confusion and the long-standing open issue #1127.

What this PR does

  • Documents the --timestamp-map option in the README
  • Explains when the X-TIMESTAMP-MAP header is needed (e.g. HLS workflows)
  • Clarifies default behavior (disabled unless explicitly enabled)

What this PR does NOT do

  • No functional or behavioral changes
  • No new flags added
  • No refactoring of encoder logic

Testing

  • Documentation-only change; no runtime behavior affected

Closes #1127

Copy link
Contributor

@cfsmp3 cfsmp3 left a comment

Choose a reason for hiding this comment

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

Thanks for documenting the --timestamp-map option! The PR description is clear and this addresses issue #1127.

Issue: Unclosed code block

The markdown code block is missing its closing fence:

```bash
ccextractor input.ts --timestamp-map -o output.vtt


### Windows Package Managers

This will break the README rendering. Please add the closing ``` after the example command:

```bash
ccextractor input.ts --timestamp-map -o output.vtt

Windows Package Managers


Once fixed, this is ready to merge.

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.

[Proposal] Adding an option to enable/disable X-TIMESTAMP-MAP in WebVTT

2 participants