Skip to content

Latest commit

 

History

History
173 lines (121 loc) · 3.69 KB

README.md

File metadata and controls

173 lines (121 loc) · 3.69 KB
Raw

cine.io ruby gem

Build Status

The ruby gem for cine.io.

Installation

Add this line to your application's Gemfile:

gem 'cine_io'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cine_io

Usage

Initialization

require('cine_io')
client = CineIo::Client.new(secretKey: 'YOUR_SECRET_KEY')
client = CineIo::Client.new(secretKey: 'YOUR_SECRET_KEY', masterKey: 'YOUR_MASTER_KEY')

Methods

Projects

To get data about your projects:

project = client.projects.index
# => [CineIo::Project, …]

Project

To get data about your project:

project = client.project.get
# => CineIo::Project

To update your project:

# params:
#   name: 'a helpful project name'
project = client.project.update(params)
# => CineIo::Project

To delete your project:

deleted_date = client.project.destroy
# => Date String

Streams

To get all your streams:

streams = client.streams.index
streams = client.streams.index(name: 'my custom name')
# => [CineIo::Stream, …]

To get a specific stream:

stream = client.streams.get('STREAM_ID')
# => CineIo::Stream

To update a specific stream:

# params:
#   name: 'a helpful stream name'
#  record: true|false (updating a stream from true to false will not delete old stream recordings)
stream = client.streams.update('STREAM_ID', params)
# => CineIo::Stream

To delete a specific stream:

deleted_date = client.streams.destroy('STREAM_ID')
# => Date String

To create a new stream:

# params (optional):
#  name (optional): 'a helpful stream name'
#  record: true|false (default false). record: true will save recordings of all streaming sessions
stream = client.streams.create(params)
# => CineIo::Stream

To fetch the Flash Media Live Encoder profile for a stream:

stream = client.streams.fmle_profile('STREAM_ID')
# => String of profile contents

Stream Recordings

To get all the recordings of stream:

recordings = client.streams.recordings.index('STREAM_ID')
# => [CineIo::StreamRecording, …]

To delete a the recordings of stream:

recordings = client.streams.recordings.delete('STREAM_ID', 'recordingName')
# => Date String

Peer

Identity Signature Generation

identity = "Unique user name to your app"
response = client.peer.generate_identity_signature(identity)
# response looks like {signature: "sha1-hash", timestamp: 1420258111, identity: "Unique user name to your app"}

Usage

Use these api endpoints to fetch the monthly usage for a project or a stream.

Project Usage

options = {:month => new Date, :report => ['bandwidth, 'peer']}
response = client.usage.project(options)
// response looks like {bandwidth: 12345, storage: 54321, month: "month (ISO 8601 format)", secretKey: "YOUR SECRET KEY"}
// bandwidth and storage are represented in bytes

Stream Usage

id = 'STREAM_ID'
options = {:month => new Date, :report => ['bandwidth, 'peer']}
response = client.usage.stream(id, options);
// response looks like {bandwidth: 12345, storage: 54321, month: "month (ISO 8601 format)", secretKey: "YOUR SECRET KEY", id: "STREAM_ID"}
// bandwidth and storage are represented in bytes

Contributing

  1. Fork it
  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 new Pull Request