Namespace: speedread

Methods

---

<static> active()

Determine whether Speed Read is currently active.

Source:

speedread.js

Returns:

Type

boolean

---

<static> faster()

Increase WPM by 25.

Source:

speedread.js

Returns:

Type

number

---

<static> pauseToggle()

Toggle pause/resume while keeping the current token index.

Source:

speedread.js

Returns:

True when the toggle was handled.

Type

boolean

---

<static> slower()

Decrease WPM by 25.

Source:

speedread.js

Returns:

Type

number

---

<static> start( [text])

Start Speed Read from supplied text, selection, or current document.

Parameters:

Name	Type	Argument	Description
text	string	<optional>	Optional raw text to read.

Source:

speedread.js

Returns:

True when playback state was initialized.

Type

boolean

---

<static> startFromSelection()

Start Speed Read from current window selection.

Source:

speedread.js

Returns:

True when selection-based Speed Read started.

Type

boolean

---

<static> stop( [silent])

Stop Speed Read, clear playback state, and hide the overlay.

Parameters:

Name	Type	Argument	Description
silent	boolean	<optional>	Skip status bar cleanup message when true.

Source:

speedread.js

---

<static> toggle()

Toggle Speed Read overlay visibility.

Source:

speedread.js

Returns:

True when Speed Read is active after the toggle.

Type

boolean