Configuration

The addon config will be published to config/mux.php on installation. Read on for details on each available config option.

Credentials

The required Mux API credentials. Learn more about Connecting Mux.

return [
    /*
    |--------------------------------------------------------------------------
    | Credentials
    |--------------------------------------------------------------------------
    */

    'credentials' => [

        'token_id' => env('MUX_TOKEN_ID'), 

        'token_secret' => env('MUX_TOKEN_SECRET'), 

    ]
];

Signing Keys

Signing keys are used to create secure playback urls. Required if the playback policy of your videos is set to signed. Learn more about Secure Playback.

The expiration setting accepts either ints for seconds, a human duration string like 1 hour and 2 days, or an ISO date interval like P3M for 3 months.

return [
    /*
    |--------------------------------------------------------------------------
    | Signing keys
    |--------------------------------------------------------------------------
    */

    'signing_key' => [

        'key_id' => env('MUX_SIGNING_KEY_ID'), 

        'private_key' => env('MUX_SIGNING_PRIVATE_KEY'), 

        'expiration' => env('MUX_SIGNED_URL_EXPIRATION', '72 hours'), 

    ]
];

Mirror Field Settings

Configure the behavior of assets mirrored to Mux through the Mirror fieldtype. The enabled flag turns mirroring on or off globally. The sync_meta flag controls whether Mux metadata is updated whenever the asset is updated in Statamic. Turn it off to only set the metadata once on creation.

return [
    /*
    |--------------------------------------------------------------------------
    | Mirror Local Video Assets to Mux
    |--------------------------------------------------------------------------
    */

    'mirror' => [

        'enabled' => env('MUX_MIRROR_ENABLED', true), 

        'sync_meta' => true, 

    ],

];

Test Mode

Mux offers a test mode for evaluating their service without incurring charges for storage or streaming. All videos uploaded in test mode are watermarked and deleted after 24 hours. This is recommended during initial setup and on development machines.

return [
    /*
    |--------------------------------------------------------------------------
    | Test Mode
    |--------------------------------------------------------------------------
    */

    'test_mode' => env('MUX_TEST_MODE', false), 
    
];

Video Quality

Mux offers three quality levels. Learn more at Choosing Video Quality.

• basic for apps with simpler needs that need to save on bandwidth & cost
• plus for conistently high quality output, but incurs encoding cost
• premium for premium high-detail content like sports broadcasts

return [
    /*
    |--------------------------------------------------------------------------
    | Video Quality
    |--------------------------------------------------------------------------
    */

    'video_quality' => env('MUX_VIDEO_QUALITY', 'plus'), 

];

You can set this to null to use the default quality setting of your Mux account if you have defined one in the Default Video Quality Settings of your Mux account dashboard.

Playback Policy

Videos uploaded to Mux can restrict access by requiring signed playback urls. Learn more about Setting Up Secure Playback.

return [
    /*
    |--------------------------------------------------------------------------
    | Playback Policy
    |--------------------------------------------------------------------------
    */

    'playback_policy' => env('MUX_PLAYBACK_POLICY', 'public'), 

];

Playback Modifiers

Change the default playback behavior of video streams received from Mux. Applies to any videos or players rendered using the built-in Antlers tags. Learn more in the Mux docs on Modifying Playback Behavior.

return [
    /*
    |--------------------------------------------------------------------------
    | Playback Modifiers
    |--------------------------------------------------------------------------
    */

    'playback_modifiers' => [

        'min_resolution' => '720p', 

        'max_resolution' => '1440p', 

    ],

];

Storage Optimization

Define how the addon handles original video files. In most cases, you'll want to stick with the default behavior and keep the original video files around to ensure long-term independence from any one video provider.

If you need to save storage space on the server, you can configure the addon to replace video files with a smaller placeholder version. This will store a short 10s clip of the video for previewing in the backend, but will require Mux for streaming and downloading the full video.

Any videos shorter than the defined placeholder length will keep the original.

Note that this feature requires a queue worker to be running, as the video processing can take some time depending on the file size.

    /*
    |--------------------------------------------------------------------------
    | Optimize Storage
    |--------------------------------------------------------------------------
    */

    'storage' => [

        'store_placeholders' => true, 

        'placeholder_length' => 10, 

    ],

Queue Driver

Define the queue driver to be used for uploads and other long-running requests to Mux. Leave it empty to use the default queue settings of your app.

return [
    /*
    |--------------------------------------------------------------------------
    | Queue Driver
    |--------------------------------------------------------------------------
    */

    'queue' => [

        'connection' => env('MUX_QUEUE_CONNECTION', null), 

        'queue' => env('MUX_QUEUE', null), 

    ],
];

Logging

Configure the output and verbosity of the addon's logs.

For troubleshooting uploads and getting insight into the processing of video files, you can increase the log level to debug temporarily. Make sure to set it back to notice or warning in production to avoid excessive log output.

The addon creates its own log channel, writing to storage/logs/mux.log and rotating biweekly. You can customize the log channel by either defining a mux channel of your own in config/logging.php or telling the addon to use a different channel entirely.

return [
    /*
    |--------------------------------------------------------------------------
    | Logging
    |--------------------------------------------------------------------------
    */

    'logging' => [

        'enabled' => env('MUX_LOG_ENABLED', true),

        'channel' => env('MUX_LOG_CHANNEL', 'mux'), 

        'level' => env('MUX_LOG_LEVEL', env('LOG_LEVEL', 'debug')), 

    ],
];