Settings Architecture

Overview

See also Integrations for mp-core site settings that affect JSON-LD output.

Current Architecture

Extension Configuration (global)

Configured in Admin → Settings → Extension Configuration → mpc_vidply (ext_conf_template.txt):

These apply to every frontend player unless overridden in Fluid/TypoScript.

Site Settings (per site)

Declared by the mpc/mpc-vidply site set (Configuration/Sets/mpc-vidply/settings.definitions.yaml). Editors and integrators change them in Site Management → Sites → your site → Settings → VidPly Player (screen reader announcements are in the Accessibility subcategory); integrators can also write them to config/sites/<id>/settings.yaml or read them in TypoScript as constants.

# config/sites/<id>/settings.yaml
mpcVidply.screenReaderAnnouncements: false
mpcVidply.resumePlayback: true
mpcVidply.embedChrome: provider

# available as TypoScript constants
{$mpcVidply.screenReaderAnnouncements}
{$mpcVidply.resumePlayback}
{$mpcVidply.embedChrome}

Turning the announcements off silences the status messages the player sends to assistive technology (WCAG 4.1.3). Only do that when something else on the page already announces the same state — the player's own notices (help dialog, sign-language drag and resize hints) keep speaking either way, since they are the only feedback for the action that triggered them.

Controls for YouTube and Vimeo (mpcVidply.embedChrome)

Decides who draws the player for YouTube and Vimeo after the visitor has accepted the privacy notice. The privacy overlay itself is the same in both modes — nothing is requested from YouTube or Vimeo before consent.

SoundCloud is not affected: it always uses its own widget (see PrivacyLayer → Switch SoundCloud to Renderer Mode). YouTube's own captions are never shown in vidply mode; add WebVTT files to the media record instead.

The setting is passed to the player as the embedChrome option by PlayerOptionsBuilder. vidply loads the VidPly core for single YouTube and Vimeo items as well (see AssetLoading); provider keeps those pages on the lighter privacy-layer-only path.

Privacy Layer Settings (tx_mpcvidply_privacy_settings)

Site-wide settings for external service privacy layers:

Available for YouTube, Vimeo, and SoundCloud. Supports multilingual content via sys_language_uid. Empty fields fall back to language file translations.

Player Settings (tt_content)

Global settings that apply to entire player instance:

Player Options (Bitmask)

Default: 8 + 64 + 256 = 328

Notes:

• Responsive sizing is always enabled (no toggle).
• Transcript is controlled per media record (tx_mpcvidply_media.enable_transcript). The transcript UI is available if at least one selected item enables it.

Media Item Settings (tx_mpcvidply_media)

Per-item settings specific to each media record:

Best Practices

Extension Configuration (Installation-Wide)

Use for branding and security defaults that should not vary per page:

• Allowed external media domains
• Default dark/light theme and page theme sync
• Custom play icon for privacy overlay and player
• CSS icon mode for design-system integration

Site Settings (Per Site)

Use for policies that differ between the sites of one installation:

• Whether the player announces its state to screen readers
• Whether visitors are offered resume playback by default
• Whether YouTube and Vimeo play inside the VidPly player or in the provider's own player

Privacy Layer Settings (Site-Wide)

Use for settings that should be consistent across all external services:

• Privacy notice texts
• Policy links
• Button labels
• Multilingual translations

Player-Level (Global)

Use for settings that should be consistent across all tracks:

• UI behavior (controls, keyboard)
• Initial state (volume, speed)
• Playlist behavior (auto-advance)

Media-Level (Per-Item)

Use for settings that are specific to content:

• Source files/URLs and slug
• Metadata (title, artist, descriptions, categories)
• Accessibility features (captions, chapters, AD, sign language)
• Visual elements (poster)
• Per-item UI toggles (download, floating player, hide speed/help)

Rationale

This separation provides:

• Consistency - Same privacy layer UX across all external services
• Centralization - Privacy texts managed in one place
• Multilingual - Privacy settings can be translated per language
• Flexibility - Per-item content customization
• Maintainability - Clear distinction between site-wide/global/local settings
• Reusability - Media items work in different contexts

Future Considerations

Potential improvements:

• Per-item caption default (for multilingual content)
• Per-item loop/muted overrides (some playlist track behaviour already exists for speed/help visibility)
• Template overrides for custom use cases

Current architecture is solid and follows TYPO3 best practices.