textalive-react-api - v0.4.12
    Preparing search index...

    Interface ReactPlayerProps

    interface ReactPlayerProps {
        children?: ReactNode;
        transparent?: boolean;
        onInit(player: IPlayer): void;
        playerFactory(options: PlayerOptions): IPlayer;
    }

    Hierarchy (View Summary)

    Index
    children?: ReactNode

    Child component if any (intended to be used by PlayerOverlay component)

    transparent?: boolean

    Canvas background. When this flag is set, canvas has a completely transparent background, allowing to render background objects.

    • Player callback

      Parameters

      • player: IPlayer

      Returns void

    • Player factory

      Parameters

      • options: PlayerOptions

      Returns IPlayer