Skip to content

CreateTrackRequest.md

Latest commit

 

History

History
30 lines (24 loc) · 2.02 KB

CreateTrackRequest.md

File metadata and controls

30 lines (24 loc) · 2.02 KB
Raw

MuxRuby::CreateTrackRequest

Properties

Name Type Description Notes
url String The URL of the file that Mux should download and use. * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should use standard inputs wherever possible. * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports SubRip Text (SRT) and Web Video Text Tracks formats for ingesting Subtitles and Closed Captions.
type String
text_type String
language_code String The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English.
name String The name of the track containing a human-readable description. This value must be unique within each group of `text` or `audio` track types. The HLS manifest will associate the `text` or `audio` track with this value. For example, set the value to "English" for subtitles text track with `language_code` as en-US. If this parameter is not included, Mux will auto-populate a value based on the `language_code` value. [optional]
closed_captions Boolean Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). [optional]
passthrough String Arbitrary user-supplied metadata set for the track either when creating the asset or track. [optional]

Example

require 'mux_ruby'

instance = MuxRuby::CreateTrackRequest.new(
  url: null,
  type: null,
  text_type: null,
  language_code: null,
  name: null,
  closed_captions: null,
  passthrough: null
)