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'), 

    ]
];

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.

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

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

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'), 

];

Video Quality

Mux offers two quality levels: plus for high visual quality and basic for apps with simpler quality needs to save on bandwidth and encoding cost. Learn more about Choosing Video Quality.

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 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', 
    ],

];

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), 

    ],
];