Class: Rev::CaptionOptions

Inherits:
InputOptions show all
Defined in:
lib/rev-api/models/order_request.rb

Overview

Caption options. This section contains the input media that must be transferred to our servers using a POST to /inputs, and are referenced using the URIs returned by that call. We also support external links.

See Also:

Constant Summary collapse

OUTPUT_FILE_FORMATS =

All supported output file formats

{
  :subrip => 'SubRip',
  :scc => 'Scc',
  :mcc => 'Mcc',
  :ttml => 'Ttml',
  :qttext => 'QTtext',
  :transcript => 'Transcript',
  :webvtt => 'WebVtt',
  :dfxp => 'Dfxp',
  :cheetahcap => 'CheetahCap'
}

Instance Attribute Summary collapse

Attributes inherited from InputOptions

#inputs

Instance Method Summary collapse

Methods inherited from ApiSerializable

#to_hash, #to_json

Constructor Details

#initialize(inputs, info = {}) ⇒ CaptionOptions

Returns a new instance of CaptionOptions.

Parameters:

  • inputs (Array) —

    list of inputs

  • info (Hash) (defaults to: {}) —

    of fields to initialize instance. May contain:

    • :output_file_formats => String[]

    • :subtitle_languages => String[]

Raises:

  • (ArgumentError)

See Also:

  • language codes refer to http://www.loc.gov/standards/iso639-2/php/code_list.php


177
178
179
180
181
 
# File 'lib/rev-api/models/order_request.rb', line 177

def initialize(inputs, info = {})
  super(inputs, info)
  raise(ArgumentError, "invalid format(s)") unless validate_output_formats(info[:output_file_formats])
  options_validation(inputs)
end

Instance Attribute Details

#output_file_formats ⇒ Object (readonly)

Array of file formats the captions should be delivered as. (Optional, default is SubRip)



154
155
156
 
# File 'lib/rev-api/models/order_request.rb', line 154

def output_file_formats
  @output_file_formats
end

#subtitle_languages ⇒ Object (readonly)

Optional, Array of language codes to request foreign language subtitles



157
158
159
 
# File 'lib/rev-api/models/order_request.rb', line 157

def subtitle_languages
  @subtitle_languages
end