Configuration

You can customise Video Picker’s settings using a PHP configuration file. This is optional: each setting has a default, so you only need to include the values you want to change.

To override a setting, create video-picker.php in your Craft project’s /config directory and return an array of setting names and values. For example, the following will show 24 videos per page in the explorer:

<?php

return [
    'videosPerPage' => 24,
];

All other settings keep their defaults. Add any further settings you want to change to the same array. The options below explain the available settings and their defaults.

Values in config/video-picker.php override the corresponding values saved in the control panel. To manage a setting through the control panel again, remove its override from the file.

Environment Overrides

Craft can apply different settings to each environment. Use * for shared values and a key matching CRAFT_ENVIRONMENT for an environment-specific override. For example:

<?php

return [
    '*' => [
        'videosPerPage' => 12,
    ],
    'dev' => [
        'videosPerPage' => 24,
    ],
];

This replaces the simple array above. The dev values apply only when CRAFT_ENVIRONMENT is dev; other environments use the shared values. Merge your own overrides into the appropriate array.

Configuration Options

Restrict Embed Hosts in Production

Generic embed helpers fetch metadata from the supplied URL on your server. If URLs can originate from editors or other untrusted input, set embedAllowedDomains to the providers your site supports. Include every hostname that may appear before or after a provider redirect.

return [
    'embedAllowedDomains' => [
        'youtube.com',
        'youtu.be',
        'vimeo.com',
    ],
];

Test pasted URLs from every supported provider after enabling the allowlist. A rejected URL produces an error result from getEmbedData(). Follow the generic embed example to check it before outputting a player.

OAuth Source Credentials

Supply OAuth client credentials in config/video-picker.php when you want to preconfigure OAuth sources. The key for each item must match the source handle. Keep secrets in environment variables rather than committing them to project config. Credential-based sources are configured in the Control Panel because their API tokens are not stored in project config.

<?php

use craft\helpers\App;

return [
    '*' => [
        'sources' => [
            'vimeo' => [
                'enabled' => true,
                'clientId' => App::env('VIMEO_CLIENT_ID'),
                'clientSecret' => App::env('VIMEO_CLIENT_SECRET'),

                // Add in any additional OAuth scopes
                'scopes' => [
                    'video_files',
                ],

                // Add in any additional OAuth authorization options, used when redirecting
                // to the provider to start the OAuth authorization process
                'authorizationOptions' => [
                    'extra' => 'value',
                ],
            ],
            'youTube' => [
                'clientId' => App::env('YOUTUBE_CLIENT_ID'),
                'clientSecret' => App::env('YOUTUBE_CLIENT_SECRET'),
            ],
        ],
    ],
];

Control Panel

Visit Settings → Video Picker to manage General Settings, cache durations under Cache Settings, and image quality and allowed domains under Embed Settings. The advanced client, header and detector arrays can only be set in the configuration file.