Cielo24 is a service for creating video captions and transcripts. This library interacts with the Cielo24 API to submit and retrieve captions. Cielo24 API documentation is available here.
This is currently an incomplete implementation fo the Cielo24 API to solve my personal needs. Feel free to send a pull request if you want to complete more of the API.
Add this line to your application's Gemfile:
gem 'cielo24'
And then execute:
$ bundle
Or install it yourself as:
$ gem install cielo24
The Cielo24 team recommend password based authentication, so to configure your username and password:
Cielo24::Client.configure({username: "user", password: "somepass"})
Alternatively, you can login with your username and API key:
Cielo24::Client.configure({username: "user", securekey: "api_key"})
You may also authenticate through the Cielo24 sandbox with the following settings (use your own sandbox username and password):
Cielo24::Client.configure(username: "username", password: "password",
uri: "https://sandbox.cielo24.com", verify_mode: OpenSSL::SSL::VERIFY_NONE)
client = Cielo24::Client.new
job_id = client.create_job("Test Job")
client.add_media(job_id, "http://test.com/my-media.mp4")
task_id = client.perform_transcription(job_id)
Captioning defaults to professional fidelity and standard priority.
client.task_complete?(task_id)
data = client.get_caption(job_id)
format = "DFXP" # Defaults to "SRT"
options = {:remove_sound_references => true} # add as many or as few options as you like
data = client.get_caption(job_id, format, options)
data = client.get_transcript(job_id)
options = {:remove_sound_references => true}
data = client.get_transcript(job_id, options)
json_data = client.job_info(job_id)
json_data = client.task_status(task_id)
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request