Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 4.73 KB

CreateAssetRequest.md

File metadata and controls

61 lines (38 loc) · 4.73 KB

CreateAssetRequest

Properties

Name Type Description Notes
input java.util.List<InputSettings> An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements. [optional]
playbackPolicy java.util.List<PlaybackPolicy> An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: `&quot;public&quot;` (anyone with the playback URL can stream the asset). And `&quot;signed&quot;` (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. [optional]
perTitleEncode Boolean [optional]
passthrough String Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. Max: 255 characters. [optional]
mp4Support Mp4SupportEnum Specify what level of support for mp4 playback. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). MP4 files are not produced for `none` (default). In most cases you should use our default HLS-based streaming playback (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the Download your videos guide for more information. [optional]
normalizeAudio Boolean Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. [optional]
masterAccess MasterAccessEnum Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the Download your videos guide for more information. [optional]
test Boolean Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs. [optional]
maxResolutionTier MaxResolutionTierEnum Max resolution tier can be used to control the maximum `resolution_tier` your asset is encoded, stored, and streamed at. If not set, this defaults to `1080p`. [optional]
encodingTier EncodingTierEnum The encoding tier informs the cost, quality, and available platform features for the asset. By default the `smart` encoding tier is used. See the guide for more details. [optional]

Enum: Mp4SupportEnum

Name Value
NONE "none"
STANDARD "standard"
CAPPED_1080P "capped-1080p"
AUDIO_ONLY "audio-only"
AUDIO_ONLY_CAPPED_1080P "audio-only,capped-1080p"

Enum: MasterAccessEnum

Name Value
NONE "none"
TEMPORARY "temporary"

Enum: MaxResolutionTierEnum

Name Value
_1080P "1080p"
_1440P "1440p"
_2160P "2160p"

Enum: EncodingTierEnum

Name Value
SMART "smart"
BASELINE "baseline"