Mux EE Module Docs

for ExpressionEngine

:player

screenshot
{exp:mux:player}

(formerly :hlsjs or :hlsplayer)

This is a simple tag for a Live and On-Demand Asset player to quickly get running.  It mimics most features in other's iFrame embeds, with a few simple parameters.  Most medium to large deployments should instead use direct integrations with players (see the other player examples).

Additional Live Stream Features Include:

Parameters

Name Description
mux_id Required ID of the live or asset. (required)
dvr yes to enable the dvr stream where viewers can jump back in time during the live stream. Default is no.
start Time the countdown should be counting to. {DATE_ISO8601} required.
end What time the player will show an expired message. {DATE_ISO8601} required.
image URL path. The image to be shown before and after a live stream, or the poster image for Assets. Can be the {thumbnail_url} tag.

The start/end times are just for the viewer's refrence and do not impact the stream being viewed.

Usage

{exp:channel:entries...}

// The Asset or Live field name
{mux_asset}

{exp:mux:player 
    mux_id="{mux_id}"
    dvr="yes"
    start="{entry_date format='{DATE_ISO8601}'}"
    end="{expiration_date format='{DATE_ISO8601}'}"
    image="{thumbnail_url}"
}
{/mux_asset}
{/exp:channel:entries}

Vue 3 is used to display the video player, and may have issues with EE Pro's new front-end editing's use of Vue 2. The plan is to transition away from Vue for this in future releases.