[PR #2065] Document existing --timestamp-map option for WebVTT output

## 📋 Pull Request Information **Original PR:** https://github.com/CCExtractor/ccextractor/pull/2065 **Author:** [@Apprentice2907](https://github.com/Apprentice2907) **Created:** 1/27/2026 **Status:** 🔄 Open **Base:** `master` ← **Head:** `docs/timestamp-map-docs` --- ### 📝 Commits (1) - [`94c9bd9`](https://github.com/CCExtractor/ccextractor/commit/94c9bd918a883172ce53663d37fc342a06ebfcd5) Document existing --timestamp-map option for WebVTT output ### 📊 Changes **1 file changed** (+16 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+16 -0) </details> ### 📄 Description  **In raising this pull request, I confirm the following (please check boxes):** - [x] I have read and understood the [contributors guide](https://github.com/CCExtractor/ccextractor/blob/master/.github/CONTRIBUTING.md). - [x] I have checked that another pull request for this purpose does not exist. - [x] I have considered, and confirmed that this submission will be valuable to others. - [x] I accept that this submission may not be used, and the pull request closed at the will of the maintainer. - [x] I give this submission freely, and claim no ownership to its content. - [ ] **I have mentioned this change in the [changelog](https://github.com/CCExtractor/ccextractor/blob/master/docs/CHANGES.TXT).** **My familiarity with the project is as follows (check one):** - [ ] I have never used CCExtractor. - [x] 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 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

claunia commented

2026-01-29 17:24:23 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/CCExtractor/ccextractor/pull/2065
Author: @Apprentice2907
Created: 1/27/2026
Status: 🔄 Open

Base: master ← Head: docs/timestamp-map-docs

📝 Commits (1)

94c9bd9 Document existing --timestamp-map option for WebVTT output

📊 Changes

1 file changed (+16 additions, -0 deletions)

View changed files

📝 README.md (+16 -0)

📄 Description

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

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

claunia added the pull-request label 2026-01-29 17:24:23 +00:00

[PR #2065] Document existing --timestamp-map option for WebVTT output #2877