Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrews54757 committed Jan 26, 2024
1 parent 56d738c commit c9439f1
Showing 1 changed file with 12 additions and 18 deletions.
30 changes: 12 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,33 @@

# FastStream

Tired of having to wait while videos buffer? This extension will replace videos on websites with a custom player that is designed to play with minimal buffering.
Tired of having to wait while videos buffer? Frustrated by a website's lack of accessibility features? This extension will replace videos on websites with a custom accessible video player designed for your convenience.

1. Take advantage of automatic fragmentation and parallel requests for up to 6x faster download speeds.
2. As you watch, pre-download the video to instantly save the video (and subtitles) as an mp4 file at the push of a button.
1. Automatic fragmentation and parallel requests for up to 6x faster download speeds. Watch videos without interruptions by predownloading the video in the background.
2. Advanced subtitling features include: built-in OpenSubtitles support to find subtitles when they are not given, customizeable subtitle appearance to fit your needs, and an intuitive subtitle syncing tool to adjust subtitle timings on the fly.
3. Adjustable audio dynamics (equalizer, compressor, mixer, volume booster), and video settings (brightness, contrast, hue, LMS daltonization for color blindness) for your unique audiovisual preferences.
4. 20+ remappable keybinds and accessible tool buttons for easy control of the player.
5. Available in multiple languages! Translated into Spanish and Japanese by the FastStream community. Support for more languages is coming soon!

The player currently supports:
- MP4 videos
- HLS streams
- DASH streams
- Youtube (download not supported on Chrome unless manually installed)

Player features:
- OpenSubtitles support so you can search for subtitles directly from the player.
- Subtitle offset controls to correct bad subtitle timings within the player
- Precise video previews when hovering over the timeline.
- Helpful (remappable) keybinds such as: Right Alt to hide player, Z to undo seek, <> to skip 2 seconds.
- Adjustable video brightness, contrast, saturation, hue, and more
- Adjustable volume, up to 300% volume boost
- Configurable audio dynamics: Has audio mixer, equalizer, and compressor tool built in
- Youtube (download not supported on Chrome unless manually installed, see Github)

Should you like binging shows, the player also comes equipped with a custom video analysis system that runs in the background to identify intro/outro sequences based on repetitive scenes. Once they have been identified, you can skip them easily by pressing S.

To use the player, simply:
1. Go to any website you want with a video and toggle the extension on. Any video it detects will be automatically replaced with the new player.
1. Go to any website you want with a video and toggle the extension on. Any video it detects will be automatically replaced with the FastStream player.
2. Alternatively, you can also simply click on or navigate to a stream manifest file (m3u8/mpd) to begin playing.
3. Drag and drop files to the player to begin playing. Navigate to a new tab and press the extension icon to go to the player.
3. Navigate to a new tab and press the extension icon to go to the player. Play sources detected on other tabs through the Sources Browser. You can also drag and drop video files from your computer.

Notes:
- Livestreams are not supported. They will not be supported in the near future.
- This player will not function with DRM protected content. This is intended.
- This player will not function with DRM protected content. This is intended. Please be mindful of how you use this tool. FastStream should not be used to infringe copyright.
- This player is still a work-in-progress. Please report any bugs to the Github issue tracker here: https://github.com/Andrews54757/FastStream/issues
- This extension does not collect telemetry of any kind. Nor does it require additional resources from the internet to function. It will work fully offline. Feel free to browse the codebase on Github.
- We take accessibility seriously. If you need accommodations not available in the current version, please contact us and we will work on it ASAP.
- For your privacy, this extension does not collect telemetry. Nor does it require additional resources from the internet to function. It will work fully offline. Feel free to browse the codebase on Github.
- We take accessibiliy seriously. If you need accommodations not available in the current version, please contact us and we will work on it ASAP. Also, please feel free to submit feature requests or suggestions on the Github issue tracker!

## Browser compatibility
Tested using Chrome and Firefox. Other chromium based browsers (such as Edge) will also likely work. Exception: FastStream will NOT work using Brave Browser due to [brave/brave-browser#30854](https://github.com/brave/brave-browser/issues/30854)
Expand Down

0 comments on commit c9439f1

Please sign in to comment.