Functions
useVreoAction
- useVreoAction(): { dispose: () => void; hide: () => void; load: (vreoUnit: VreoUnit, currentTime?: number) => Promise<boolean>; pause: () => void; play: (currentTime?: number) => boolean; show: () => void }
Returns { dispose: () => void; hide: () => void; load: (vreoUnit: VreoUnit, currentTime?: number) => Promise<boolean>; pause: () => void; play: (currentTime?: number) => boolean; show: () => void }
dispose: () => void
hide: () => void
load: (vreoUnit: VreoUnit, currentTime?: number) => Promise<boolean>
- (vreoUnit: VreoUnit, currentTime?: number): Promise<boolean>
Parameters
Optional currentTime: number
Returns Promise<boolean>
pause: () => void
play: (currentTime?: number) => boolean
- (currentTime?: number): boolean
Parameters
Optional currentTime: number
Returns boolean
show: () => void
useVreoEventCallback
- useVreoEventCallback<T>(name: T, callback: VreoKeyframeEvent[T], deps?: DependencyList): void
Type parameters
T: VreoKeyframeEnum | "loaded" | "paused" | "playing" | "unknownKeyframeType" | "ended"
Parameters
name: T
Optional deps: DependencyList
Returns void
useVreoPausedState
- useVreoPausedState(): boolean