About
The Captions module controls how captions are displayed, edited, and managed across your site. Once enabled, this module lets users display captions on the player, edit captions using the Captions Editor, and manage key settings like character limits and overlap prevention.
You can also require captions before media can be published to ensure accessibility standards are met.
Configure
- Go to your Configuration Management console and click on the Captions module. You can also navigate to it directly using a link: https://{your_KMS_URL}/admin/config/tab/captions
- Configure the following:
- Click Save.
The Captions page displays.
enabled - Set to 'Yes' to enable the module.
allowToggleDisplayOnPlayer - Set to 'Yes' to allow the user to decide whether to display the caption on the player.
allowEditCaptions - Set to 'Yes' to enable the Caption Editor button in the Captions tab.
maxCharsPerLine - Defines the maximum number of characters allowed per caption line in the Captions Editor.
preventSaveOnOverlap - When enabled, prevents users from saving captions in the Captions Editor if there are overlapping timings.
searchPlayerIntegration - Set to 'Yes' to allow caption search results to jump to specific times/languages in the video.
captionsRequired - Set to 'Yes' to make captions required for publishing. Once set to Yes, users will not be able to publish Quiz, Audio, Video media without captions.
