Skip to content

Latest commit

 

History

History
125 lines (86 loc) · 6.46 KB

Asset.md

File metadata and controls

125 lines (86 loc) · 6.46 KB

Asset

Properties

Name Type Description Notes
id String Unique identifier for the Asset. Max 255 characters. [optional]
createdAt String Time the Asset was created, defined as a Unix timestamp (seconds since epoch). [optional]
status StatusEnum The status of the asset. [optional]
duration Double The duration of the asset in seconds (max duration for a single asset is 12 hours). [optional]
maxStoredResolution MaxStoredResolutionEnum This field is deprecated. Please use `resolution_tier` instead. The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. [optional]
resolutionTier ResolutionTierEnum The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset. [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]
maxStoredFrameRate Double The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined. [optional]
aspectRatio String The aspect ratio of the asset in the form of `width:height`, for example `16:9`. [optional]
playbackIds java.util.List<PlaybackID> An array of Playback ID objects. Use these to create HLS playback URLs. See Play your videos for more details. [optional]
tracks java.util.List<Track> The individual media tracks that make up an asset. [optional]
errors AssetErrors [optional]
perTitleEncode Boolean [optional]
uploadId String Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload. [optional]
isLive Boolean Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream. [optional]
passthrough String Arbitrary user-supplied metadata set for the asset. Max 255 characters. [optional]
liveStreamId String Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. [optional]
master AssetMaster [optional]
masterAccess MasterAccessEnum [optional]
mp4Support Mp4SupportEnum [optional]
sourceAssetId String Asset Identifier of the video used as the source for creating the clip. [optional]
normalizeAudio Boolean Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. [optional]
staticRenditions AssetStaticRenditions [optional]
recordingTimes java.util.List<AssetRecordingTimes> An array of individual live stream recording sessions. A recording session is created on each encoder connection during the live stream. Additionally any time slate media is inserted during brief interruptions in the live stream media or times when the live streaming software disconnects, a recording session representing the slate media will be added with a &quot;slate&quot; type. [optional]
nonStandardInputReasons AssetNonStandardInputReasons [optional]
test Boolean True means this live stream is a test asset. 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 assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs. [optional]
ingestType IngestTypeEnum The type of ingest used to create the asset. [optional]

Enum: StatusEnum

Name Value
PREPARING "preparing"
READY "ready"
ERRORED "errored"

Enum: MaxStoredResolutionEnum

Name Value
AUDIO_ONLY "Audio only"
SD "SD"
HD "HD"
FHD "FHD"
UHD "UHD"

Enum: ResolutionTierEnum

Name Value
AUDIO_ONLY "audio-only"
_720P "720p"
_1080P "1080p"
_1440P "1440p"
_2160P "2160p"

Enum: MaxResolutionTierEnum

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

Enum: EncodingTierEnum

Name Value
SMART "smart"
BASELINE "baseline"

Enum: MasterAccessEnum

Name Value
TEMPORARY "temporary"
NONE "none"

Enum: Mp4SupportEnum

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

Enum: IngestTypeEnum

Name Value
ON_DEMAND_URL "on_demand_url"
ON_DEMAND_DIRECT_UPLOAD "on_demand_direct_upload"
ON_DEMAND_CLIP "on_demand_clip"
LIVE_RTMP "live_rtmp"
LIVE_SRT "live_srt"