Installation

The Caption Customization assemblies are available in the v1.3.1 vsix download and later. Newer versions of this assembly may be available in the source code repository and not yet published in the vsix so if you'd like to use the latest version, please
visit the "Source Code" tab linked above.

Assemblies

The Caption Customization assemblies are used to provide user-customization to closed captions for video in the Player Framework.

All of the plug-ins on Windows 8.1 have the same API properties and events:

Events

OnLoadCaptionSettings event is called when the plug-in is initialized and gives the app an opportunity to retrieve caption settings from a location other than local storage.

OnSaveCaptionSettings event is called when the user changes properties in the settings pane and gives the app an opportunity to save caption settings to a location other than local storage.

Properties

Label the label of the caption settings pane (default is "Caption Settings")

SettingsCommandId the internal command Id of the caption settings pane (default is "CaptionSettings")

SettingsCommandIndex the index that the Caption Settings will be added to the settings list (default is to be added to the end)

SettingsFlyoutStyle the style of the SettingsFlyout that can be used to customize the appearance of the caption settings pane. The style can be set inline or it can be referenced as a StaticResource:
<Style TargetType="SettingsFlyout"/>

Font Selection

The Caption Customization plug-ins allow the user to select a generic font families. The font families in the plug-ins have been selected to best match the user interface styles of Windows and Windows Phone but developers can override those styles with application
settings: