https://github.com/kickstarter/caption_crunch

Parsers for WebVTT and other subtitle files
https://github.com/kickstarter/caption_crunch

Last synced: about 1 year ago
JSON representation

Parsers for WebVTT and other subtitle files

• Host: GitHub
• URL: https://github.com/kickstarter/caption_crunch
• Owner: kickstarter
• License: mit
• Created: 2015-03-02T22:24:19.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-08-27T19:31:46.000Z (almost 11 years ago)
• Last Synced: 2025-04-30T04:48:43.104Z (about 1 year ago)
• Language: Ruby
• Homepage:
• Size: 215 KB
• Stars: 19
• Watchers: 163
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CaptionCrunch

[![Gem Version](https://badge.fury.io/rb/caption_crunch.svg)](http://badge.fury.io/rb/caption_crunch) [![Circle CI](https://circleci.com/gh/kickstarter/caption_crunch/tree/master.svg?style=shield)](https://circleci.com/gh/kickstarter/caption_crunch/tree/master) [![Code Climate](https://codeclimate.com/github/kickstarter/caption_crunch/badges/gpa.svg)](https://codeclimate.com/github/kickstarter/caption_crunch)

Praise @noopkat for the name.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'caption_crunch'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install caption_crunch

## Usage

```ruby

require 'caption_crunch'

track = CaptionCrunch.parse(File.new('sample.vtt')) # returns a CaptionCrunch::Track instance

# or

track = CaptionCrunch.parse('WEBVTT')

# track.cues is an array of CaptionCrunch::Cue instances

track.cues.first.start_time

track.cues.first.end_time

track.cues.first.payload

```

## Contributing

1. Fork it ( https://github.com/kickstarter/caption_crunch/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request