class Rev::CaptionOptions

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 www.rev.com/api/orderspostcaption

Constants

OUTPUT_FILE_FORMATS

All supported output file formats

Attributes

output_file_formats[R]

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

subtitle_languages[R]

Optional, Array of language codes to request foreign language subtitles

Public Class Methods

new(inputs, info = {}) click to toggle source

@param inputs [Array] list of inputs @param info [Hash] of fields to initialize instance. May contain:

- :output_file_formats => String[]
- :subtitle_languages => String[]

@see For language codes refer to www.loc.gov/standards/iso639-2/php/code_list.php

Calls superclass method Rev::InputOptions::new
# 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

Private Instance Methods

options_validation(inputs) click to toggle source
# File lib/rev-api/models/order_request.rb, line 189
def options_validation(inputs)
  inputs.each { |input|
    input.validate_glossary
    input.validate_speakers
  }
end
validate_output_formats(formats) click to toggle source
# File lib/rev-api/models/order_request.rb, line 185
def validate_output_formats(formats)
  formats.nil? || formats.select{|f| !OUTPUT_FILE_FORMATS.has_value?(f) }.empty?
end