Mux Element Properties

This documentation covers all available element properties. View MUX documentation asset properties.

Complete Variable Reference

Query-Only Variables (for filtering assets)

These variables can only be used in queries to filter MuxAsset elements, not accessed as properties on individual assets.

Basic Asset Properties

• asset_id - Filter by Mux asset ID
• asset_status - Filter by processing status
• aspect_ratio - Filter by aspect ratio
• duration - Filter by duration in seconds
• is_live - Filter by live stream status

Upload and Processing Properties

• upload_id - Filter by upload ID
• created_at - Filter by creation date
• ingest_type - Filter by ingest type

Playback and Rendition Properties

• playback_ids - Filter by playback IDs
• mp4_support - Filter by MP4 support status Depreciated
• static_renditions - Filter by static renditions

Quality and Resolution Properties

• max_stored_resolution - Filter by maximum stored resolution
• max_stored_frame_rate - Filter by maximum stored frame rate
• resolution_tier - Filter by resolution tier
• max_resolution_tier - Filter by maximum resolution tier

Custom Data Properties

• passthrough - Filter by passthrough data
• meta - Filter by metadata
• errors - Filter by error status

Track Properties (Query-Only)

• trackType - Filter by track type
• trackMaxWidth - Filter by track maximum width
• trackMaxHeight - Filter by track maximum height
• trackMaxFrameRate - Filter by track maximum frame rate
• trackDuration - Filter by track duration
• trackPrimary - Filter by primary track status
• trackMaxChannels - Filter by track maximum channels
• trackTextType - Filter by text track type
• trackTextSource - Filter by text track source
• trackStatus - Filter by track status
• trackName - Filter by track name
• trackLanguageCode - Filter by track language code
• trackId - Filter by track ID

Metadata Properties (Query-Only)

• metaTitle - Filter by metadata title
• metaExternalId - Filter by metadata external ID
• metaCreatorId - Filter by metadata creator ID

Folder and Volume Properties

• folderId - Filter by folder ID
• includeSubfolders - Include assets from subfolders
• folderPath - Filter by folder path
• volumeId - Filter by volume ID

Standard Element Query Methods

• id - Filter by element ID
• offset - Offset results
• limit - Limit number of results
• orderBy - Order results

Example Usage:

{# Access basic properties #}
{{ asset.assetId }}
{{ asset.duration }}
{{ asset.aspectRatio }}
{{ asset.isLive }}

{# Access track information #}
{% for track in asset.tracks %}
    {{ track.type }} - {{ track.name }}
{% endfor %}

{# Access playback id #}
{{ asset.playback_ids[0].id }}

{# Access metadata #}
{{ asset.meta.title }}
{{ asset.meta.creatorId }}

{# Check if asset is ready #}
{% if asset.assetStatus == 'ready' %}
    {# Asset is ready for playback #}
{% endif %}

Static Renditions

"Highest" is mutually exclusive with specific resolutions. To switch types (e.g. Highest to 1080p), first uncheck and save to delete, then select the new resolution and save again. Note static renditions will not upscale.

{% set muxAsset = craft.mux.one() %}

{# For usecured assets #}
{% if muxAsset.static_renditions|length %}
    <a href="https://stream.mux.com/{{ muxAsset.playback_ids[0].id }}/{{ muxAsset.static_renditions.files[0].name }}?download={{ muxAsset.title }} download target="_blank">Download Video/Audio</a>
{% endif %}

{# For secured playback assets #}
{% if muxAsset.securePlayback %}
    {% set videoToken = muxAsset.getSecurePlaybackJWT(keyID, 'v') %}
    {% if muxAsset.static_renditions|length %}
        <a href="https://stream.mux.com/{{ muxAsset.playback_ids[0].id }}/{{ muxAsset.static_renditions.files[0].name }}?download={{ muxAsset.title }}&token={{ videoToken }}" download target="_blank">Download Video/Audio</a>
    {% endif %}
{% endif %}

{# For multiple static renditions #}
{% if muxAsset.static_renditions|length %}
{% for file in muxAsset.static_renditions.files %}
    <a href="https://stream.mux.com/{{ muxAsset.playback_ids[0].id }}/{{ file.name }}?download={{ muxAsset.title }} download target="_blank">Download Video/Audio ({{ file.resolution }})</a>
{% endif %}

Methods

getPlaybackId string

{# Returns the first playback_id in the playback_ids property array #}
{% set muxAsset = craft.mux.one() %}
{% set playbackId = muxAsset.getPlaybackId() %}

securePlayback boolean

{% set muxAsset = craft.mux.one() %}
{% if muxAsset.securePlayback %}{% endif %}

signedKeys array

{% set muxAsset = craft.mux.one() %}
{% set signedKeys = muxAsset.signedKey %}

getSecurePlaybackJWT(signedKey, mediaType, options) string

• signedKey: Mux Signed Key
• mediaType: v = video, t = thumbnail, g = gif, s = storyboard
• options: ["time" => 10, "width" => 640, "fit_mode" => "smartcrop"]

{% set muxAsset = craft.mux.one() %}
{% set signedKeys = muxAsset.getSecurePlaybackJWT(signedKey, mediaType, options) %}