https://github.com/muxinc/hls-subtitles-vexillographer

A simple proxy service which changes subtitles flags in HLS manifests.
https://github.com/muxinc/hls-subtitles-vexillographer

Last synced: 3 months ago
JSON representation

A simple proxy service which changes subtitles flags in HLS manifests.

• Host: GitHub
• URL: https://github.com/muxinc/hls-subtitles-vexillographer
• Owner: muxinc
• License: mit
• Archived: true
• Created: 2020-01-13T15:02:41.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-05T23:11:37.000Z (3 months ago)
• Last Synced: 2024-08-06T01:55:16.481Z (3 months ago)
• Language: Ruby
• Size: 8.79 KB
• Stars: 6
• Watchers: 10
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![HLS Tools](https://banner.mux.dev/HLS%20Vexillographer.svg)

> [!NOTE]

> We routinely archive repositories that were created for blog posts and articles but haven't received an update in a while. That doesn't mean there's anything _wrong_ with the contents of the repo, just that it might be a little dusty.

# HLS subtitles vexillographer

A simple proxy service which manipulates subtitles flags (AUTOSELECT, FORCED, and DEFAULT) in HLS manifests hosted in Mux Video.

See [Example Usage](#example-usage) for more details.

Read the [blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/).

# Dependencies

* Ruby

* Gems: 

  * sinatra

  * httparty

# Deployment

Development (Starts on port 4567, binds to localhost):

```

ruby proxy.rb

```

Production (Starts on port 80, binds to all interfaces):

```

APP_ENV=production ruby proxy.rb

```

# Example Usage

If you use /tears.m3u8 as the path, we’ll serve you our test Tears of Steel manifest, with a single, English language subtitles track, otherwise, you can put any Mux public playback ID before the .m3u8 in the URL and we'll proxy that and return a version of that manifest with the _first_ subtitles track modified.

| URL | Behaviour |

| --- | --- |

| http://localhost:4567/tears.m3u8 | DEFAULT, AUTOSELECT and FORCED will be set to "NO" | 

| http://localhost:4567/tears.m3u8?default=YES&autoselect=YES | DEFAULT, AUTOSELECT will be set to "YES". FORCED will be set to "NO" |

| http://localhost:4567/HDGj01zK01esWsWf9WJj5t5yuXQZJFF6bo.m3u8 | Custom playback ID. DEFAULT, AUTOSELECT and FORCED will be set to "NO" |

# License

[MIT](LICENSE)