Options
Menu

textalive-react-api

Index

Variables

Const Check

Check: FC<CheckProps>

Const CheckWidget

CheckWidget: FC<CheckWidgetProps>

Const ColorPicker

ColorPicker: FC<ColorPickerProps>

Const ColorWidget

ColorWidget: FC<ColorWidgetProps>

Const FontFamilyWidget

FontFamilyWidget: FC<FontFamilyWidgetProps>

Const FontsContext

FontsContext: Context<FontInfo[] | null>

Const GraphicsDriverContext

GraphicsDriverContext: Context<GraphicsDriver | null>

Const NativeCheckWidget

NativeCheckWidget: FC<NativeCheckWidgetProps>

Const Overlay

Overlay: FC<OverlayProps>

Const Player

Player: FC<ReactPlayerProps>
deprecated

Use ReactPlayer instead.

Const PlayerContext

PlayerContext: Context<IPlayer | null>

Const PlayerControl

PlayerControl: FC<PlayerControlProps>

Const PlayerOverlay

PlayerOverlay: FC<PlayerOverlayProps>

Const PlayerSeekbar

PlayerSeekbar: FC<PlayerSeekbarProps>

Const PlayerStatus

PlayerStatus: FC

Const PlayerStatusItem

PlayerStatusItem: FC<PlayerStatusItemProps>

Const PlayerWrapper

PlayerWrapper: FC<PlayerWrapperProps>

Const ProfileContext

ProfileContext: Context<UserProfile | null>

Const ProfileProvider

ProfileProvider: FC<ProfileProviderProps>

Const ReactPlayer

ReactPlayer: FC<ReactPlayerProps>

A TextAlive player component loads video materials, generates runtime objects, and renders video frames. It typically uses an EaselJS-based driver to render the actual content in a web browser.

Const Seekbar

Seekbar: FC<SeekbarProps>

A seekbar allows users to seek for a numerical value in the specified range.

Const SelectDropdown

SelectDropdown: FC<SelectDropdownProps>

Const SelectWidget

SelectWidget: FC<SelectWidgetProps>

Const Slider

Slider: FC<SliderProps>

Const SliderWidget

SliderWidget: FC<SliderWidgetProps>

Const Widget

Widget: FC<WidgetProps>

Const Widgets

Widgets: FC<WidgetsProps>

Functions

isJa

  • isJa(profile?: undefined | { language?: undefined | string }): boolean
  • Parameters

    • Optional profile: undefined | { language?: undefined | string }

    Returns boolean

regionalText

  • regionalText(text?: string | RegionalText, ja?: undefined | false | true): string | undefined
  • Parameters

    • Optional text: string | RegionalText
    • Optional ja: undefined | false | true

    Returns string | undefined

useResize

  • useResize<T>(): []
  • Type parameters

    • T: HTMLElement

    Returns []