React Native THEOplayer SDK
    Preparing search index...

    Interface TextTrackStyle

    The text track style API.

    interface TextTrackStyle {
        backgroundColor: string | undefined;
        edgeColor: string | undefined;
        edgeStyle: EdgeStyle | undefined;
        fontColor: string | undefined;
        fontFamily: string | undefined;
        fontPath: string | undefined;
        fontSize: string | undefined;
        marginBottom: number | undefined;
        marginLeft: number | undefined;
        marginRight: number | undefined;
        marginTop: number | undefined;
        windowColor: string | undefined;
    }
    Index
    backgroundColor edgeColor edgeStyle fontColor fontFamily fontPath fontSize marginBottom marginLeft marginRight marginTop windowColor
    backgroundColor: string | undefined

    The background color for the text track.

    This targets the area directly behind the text.

    <br/> - `red` will set the background color of the text track to red.
    <br/> - `#ff0000` will set the background color of the text track to red.
    <br/> - Available for Web only: `rgba(255,0,0,0.5)` will set the background color of the text track to red, with 50% opacity.
    edgeColor: string | undefined

    The edge color for the text track.

    Android
    edgeStyle: EdgeStyle | undefined

    The edge style of the text, represented by a value from the following list:
    - 'none'
    - 'dropshadow'
    - 'raised'
    - 'depressed'
    - 'uniform'

    fontColor: string | undefined

    The font color for the text track.

    <br/> - `red` will set the color of the text to red.
    <br/> - `#ff0000` will set the color of the text to red.
    <br/> - Available for Web only: `rgba(255,0,0,0.5)` will set the color of the text to red, with 50% opacity.
    fontFamily: string | undefined

    The font family for the text track.

    fontPath: string | undefined

    The path to a font in the Android app/src/main/assets/ folder.

    Only supported on Android.

    fontSize: string | undefined

    The font size for the text track.

    Can be a percentage value such as '50%', '75%', '100%', '150%' or '200%'.

    marginBottom: number | undefined

    The bottom margin of the area where subtitles are being rendered.

    Android
    Web


    - The margin is in number of pixels.

    marginLeft: number | undefined

    The left margin of the area where subtitles are being rendered.


    - The margin is in number of pixels.

    marginRight: number | undefined

    The right margin of the area where subtitles are being rendered.

    Android
    Web


    - The margin is in number of pixels.
    - Useful for pushing the subtitles left, so they don't overlap with the UI.

    marginTop: number | undefined

    The top margin of the area where subtitles are being rendered.


    - The margin is in number of pixels.

    windowColor: string | undefined

    The window color for the text track.

    Android
    Web


    - This targets the area covering the full width of the text track.

    <br/> - `red` will set the background color of the window of the text track to red.
    <br/> - `#ff0000` will set the background color of the window of the text track to red.
    <br/> - Available for Web only: `rgba(255,0,0,0.5)` will set the background color of the window of the text track to red, with 50% opacity.

    Settings
    Member Visibility

    On This Page
    Properties