Options
All
  • Public
  • Public/Protected
  • All
Menu

Module react

Index

Interfaces

Variables

Functions

Variables

VreoProvider

VreoProvider: React.FC<VreoProviderProps> = ...

Functions

useVreoAction

  • useVreoAction(): { dispose: () => void; hide: () => void; load: (vreoUnit: VreoUnit, currentTime?: number) => Promise<boolean>; pause: () => void; play: () => boolean; show: () => void }

  • Returns { dispose: () => void; hide: () => void; load: (vreoUnit: VreoUnit, currentTime?: number) => Promise<boolean>; pause: () => void; play: () => boolean; show: () => void }

    • dispose: () => void
        • (): void

        • Returns void

    • hide: () => void
        • (): void

        • Returns void

    • load: (vreoUnit: VreoUnit, currentTime?: number) => Promise<boolean>
        • (vreoUnit: VreoUnit, currentTime?: number): Promise<boolean>

        • Parameters

          • vreoUnit: VreoUnit
          • Optional currentTime: number

          Returns Promise<boolean>

    • pause: () => void
        • (): void

        • Returns void

    • play: () => boolean
        • (): boolean

        • Returns boolean

    • show: () => void
        • (): void

        • Returns void

useVreoEventCallback

  • useVreoEventCallback<T>(name: T, callback: VreoKeyframeEvent[T], deps?: DependencyList): void

useVreoPausedState

  • useVreoPausedState(): boolean