Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 3.28 KB

File metadata and controls

18 lines (15 loc) · 3.28 KB

# InputSettings

Properties

Name Type Description Notes
url string The URL of the file that Mux should download and use. * For subtitles text tracks, the URL is the location of subtitle/captions file. Mux supports SubRip Text (SRT) and Web Video Text Tracks format for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. [optional]
overlay_settings \MuxPhp\Models\InputSettingsOverlaySettings [optional]
start_time double The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. [optional]
end_time double The time offset in seconds from the beginning of the video, indicating the clip's ending marker. The default value is the duration of the video when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format. [optional]
type string This parameter is required for `text` type tracks. [optional]
text_type string Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, see this blog post. This parameter is required for `text` type tracks. [optional]
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. This parameter is required for text type and subtitles text type track. [optional]
name string The name of the track containing a human-readable description. This value must be unique across all text type and subtitles `text` type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be "English" for subtitles text track with language_code as en. This optional parameter should be used only for `text` type and subtitles `text` type tracks. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value. [optional]
closed_captions bool Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for `text` type and subtitles `text` type tracks. [optional]
passthrough string This optional parameter should be used for `text` type and subtitles `text` type tracks. [optional]

[Back to Model list] [Back to API list] [Back to README]