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',
  :ttml => 'Ttml',
  :qttext => 'QTtext'
}

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.

Raises:

  • (ArgumentError) 


164
165
166
167
 
# File 'lib/rev-api/models/order_request.rb', line 164

def initialize(inputs, info = {})
  super(inputs, info)
  raise(ArgumentError, "invalid format(s)") unless validate_output_formats(info[:output_file_formats])
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