Telestream Cloud Flip Ruby SDK

This library provides a low-level interface to the REST API of Telestream Cloud, the online video encoding service.

Getting Started

Initialize client

require 'telestream_cloud/flip'

TelestreamCloud::Flip.configure do |config|
  config.api_key['X-Api-Key'] = '[API KEY]'
end

client = TelestreamCloud::Flip::FlipApi.new

Upload video to Flip service

factory_id = '...'
uploader = TelestreamCloud::Flip::Uploader.new(
  client,
  factory_id: factory_id,
  file: '/path/to/file.mp4',
  extra_files: {
    subtitles: '/path/to/subtitles'
  }
)

video_id = uploader.upload

Create video from source URL

factory_id = '...'
client.create_video(factory_id, source_url: 'http://url/to/file.mp4')

Documentation for API Endpoints

All URIs are relative to https://api.cloud.telestream.net/flip/3.1

Class Method HTTP request Description
TelestreamCloud::Flip::FlipApi cancel_encoding POST /encodings/id/cancel.json Cancels an Encoding.
TelestreamCloud::Flip::FlipApi copy_profile POST /profiles/id/copy.json Copies a given Profile
TelestreamCloud::Flip::FlipApi create_encoding POST /encodings.json Creates an Encoding
TelestreamCloud::Flip::FlipApi create_factory POST /factories.json Creates a new factory
TelestreamCloud::Flip::FlipApi create_profile POST /profiles.json Creates a Profile
TelestreamCloud::Flip::FlipApi create_video POST /videos.json Creates a Video from a provided source_url.
TelestreamCloud::Flip::FlipApi create_workorder POST /workorders.json Creates a Workorder.
TelestreamCloud::Flip::FlipApi delete_encoding DELETE /encodings/id.json Deletes an Encoding from both Telestream Cloud and your storage. Returns an information whether the operation was successful.
TelestreamCloud::Flip::FlipApi delete_profile DELETE /profiles/id.json Deletes a given Profile
TelestreamCloud::Flip::FlipApi delete_video DELETE /videos/id.json Deletes a Video object.
TelestreamCloud::Flip::FlipApi delete_video_source DELETE /videos/id/source.json Delete a video's source file.
TelestreamCloud::Flip::FlipApi encoding GET /encodings/id.json Returns an Encoding object.
TelestreamCloud::Flip::FlipApi encodings GET /encodings.json Returns a list of Encoding objects
TelestreamCloud::Flip::FlipApi encodings_count GET /encodings/count.json Returns a number of Encoding objects created using a given factory.
TelestreamCloud::Flip::FlipApi factories GET /factories.json Returns a collection of Factory objects.
TelestreamCloud::Flip::FlipApi factory GET /factories/id.json Returns a Factory object.
TelestreamCloud::Flip::FlipApi notifications GET /notifications.json Returns a Factory's notification settings.
TelestreamCloud::Flip::FlipApi profile GET /profiles/id_or_name.json Returns a Profile object.
TelestreamCloud::Flip::FlipApi profile_encodings GET /profiles/id_or_name/encodings.json Returns a list of Encodings that belong to a Profile.
TelestreamCloud::Flip::FlipApi profiles GET /profiles.json Returns a collection of Profile objects.
TelestreamCloud::Flip::FlipApi queued_videos GET /videos/queued.json Returns a collection of Video objects queued for encoding.
TelestreamCloud::Flip::FlipApi resubmit_video POST /videos/resubmit.json Resubmits a video to encode.
TelestreamCloud::Flip::FlipApi retry_encoding POST /encodings/id/retry.json Retries a failed encoding.
TelestreamCloud::Flip::FlipApi signed_encoding_url GET /encodings/id/signed-url.json Returns a signed url pointing to an Encoding.
TelestreamCloud::Flip::FlipApi signed_encoding_urls GET /encodings/id/signed-urls.json Returns a list of signed urls pointing to an Encoding's outputs.
TelestreamCloud::Flip::FlipApi signed_video_url GET /videos/id/signed-url.json Returns a signed url pointing to a Video.
TelestreamCloud::Flip::FlipApi toggle_factory_sync POST /factories/id/sync.json Toggles synchronisation settings.
TelestreamCloud::Flip::FlipApi update_encoding PUT /encodings/id.json Updates an Encoding
TelestreamCloud::Flip::FlipApi update_factory PATCH /factories/id.json Updates a Factory's settings. Returns a Factory object.
TelestreamCloud::Flip::FlipApi update_notifications PUT /notifications.json Updates a Factory's notification settings.
TelestreamCloud::Flip::FlipApi update_profile PUT /profiles/id.json Updates a given Profile
TelestreamCloud::Flip::FlipApi upload_video POST /videos/upload.json Creates an upload session.
TelestreamCloud::Flip::FlipApi video GET /videos/id.json Returns a Video object.
TelestreamCloud::Flip::FlipApi video_encodings GET /videos/id/encodings.json Returns a list of Encodings that belong to a Video.
TelestreamCloud::Flip::FlipApi video_metadata GET /videos/id/metadata.json Returns a Video's metadata
TelestreamCloud::Flip::FlipApi videos GET /videos.json Returns a collection of Video objects.
TelestreamCloud::Flip::FlipApi workflows GET /workflows.json Returns a collection of Workflows that belong to a Factory.

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: X-Api-Key
  • Location: HTTP header