SubtitleSettingsContext

This file provides a context for managing the subtitle settings.

Interfaces

SubtitleSettingsContextType

Defined in: src/contexts/SubtitleSettingsContext.tsx:31

SubtitleSettingsContextType Shape of the Subtitle Settings Context

Properties

Property	Type	Defined in
resetSubtitleStyle	() => void	src/contexts/SubtitleSettingsContext.tsx:34
setSubtitleStyle	(style) => void	src/contexts/SubtitleSettingsContext.tsx:33
subtitleStyle	SubtitleStyle	src/contexts/SubtitleSettingsContext.tsx:32

---

SubtitleStyle

Defined in: src/contexts/SubtitleSettingsContext.tsx:18

The shape of the subtitle style settings.

Properties

Property	Type	Defined in
backgroundColor	string	src/contexts/SubtitleSettingsContext.tsx:21
backgroundOpacity	number	src/contexts/SubtitleSettingsContext.tsx:22
fontColor	string	src/contexts/SubtitleSettingsContext.tsx:20
fontSize	number	src/contexts/SubtitleSettingsContext.tsx:19
position	number	src/contexts/SubtitleSettingsContext.tsx:24
textShadow	string	src/contexts/SubtitleSettingsContext.tsx:23

Functions

SubtitleSettingsProvider()

function SubtitleSettingsProvider(props): Element;

Defined in: src/contexts/SubtitleSettingsContext.tsx:56

A provider for the SubtitleSettingsContext.

Parameters

Parameter	Type	Description
props	{ children: ReactNode; }	The props for the component.
props.children	ReactNode	-

Returns

Element

The SubtitleSettingsProvider component.

---

useSubtitleSettings()

function useSubtitleSettings(): SubtitleSettingsContextType;

Defined in: src/contexts/SubtitleSettingsContext.tsx:100

A hook for using the SubtitleSettingsContext.

Returns

SubtitleSettingsContextType

The SubtitleSettingsContext.