Class AutoplayGate

The tap-to-enable overlay; show() / hide() are idempotent.

Index

Constructors

Properties

element container onTap

Accessors

Methods

onGesture show hide dispose

Constructors

constructor

new AutoplayGate(container: () => HTMLElement, onTap: () => void): AutoplayGate
Parameters
- container: () => HTMLElement
- onTap: () => void
Returns AutoplayGate
- Defined in src/audio/autoplay-gate.ts:22

Properties

`Private`element

element: HTMLElement | null = null

`Private` `Readonly`container

container: () => HTMLElement

`Private` `Readonly`onTap

onTap: () => void

Accessors

visible

get visible(): boolean
True while the overlay is on screen.

Returns boolean
- Defined in src/audio/autoplay-gate.ts:28

Methods

`Private` `Readonly`onGesture

onGesture(): void
Returns void
- Defined in src/audio/autoplay-gate.ts:16

show

show(): void
Mount the overlay and arm the one-shot dismissal listeners.

Returns void
- Defined in src/audio/autoplay-gate.ts:33

hide

hide(): void
Remove the overlay (and the listeners, if they have not fired).

Returns void
- Defined in src/audio/autoplay-gate.ts:53

dispose

dispose(): void
Returns void
- Defined in src/audio/autoplay-gate.ts:61