Table of Contents

Enum PrismError

Namespace
Refractor
Assembly
Refractor.dll

A prism error code, carried by Error. The numbers are part of prism's ABI and never change.

public enum PrismError

Fields

AlreadyInitialized = 15

The backend was already initialized. Initialize() returns false for it rather than throwing.

AlreadyPaused = 12

Speech is already paused.

BackendEnteredUndefinedState = 20

The backend got into a state it cannot recover from, and should be disposed.

BackendNotAvailable = 16

The backend's engine or screen reader is not available, such as a screen reader that is not running.

IncompatibleAbi = 23

A plugin library was built for a different version of prism's plugin ABI.

Internal = 9

An unexpected error inside prism or the backend. A custom backend that throws an unrecognized exception reports this.

InternalBackendLimitExceeded = 19

The backend allows only so many instances at once, and creating another would pass that limit.

InvalidAudioFormat = 18

The engine produced audio in a format prism cannot use.

InvalidOperation = 14

The operation is not valid in the backend's current state.

InvalidParameter = 2

An argument was not valid.

InvalidUtf8 = 13

Text was not valid UTF-8. Refractor's own strings always are.

LibraryInvalid = 22

A library loaded, but is not a prism plugin.

LibraryLoadFailed = 21

A plugin library could not be loaded.

MemoryFailure = 7

Memory could not be allocated.

NoVoices = 4

The backend has no voices.

NotImplemented = 3

The backend does not support the operation. GetFeatures() says what it does support.

NotInitialized = 1

The backend has not been initialized. Call Initialize() first.

NotPaused = 11

The operation needs paused speech, and speech is not paused.

NotSpeaking = 10

The operation needs speech in progress, and there is none.

Ok = 0

Success. Refractor never throws with it.

RangeOutOfBounds = 8

A value was outside its range, such as a volume, rate or pitch outside [0, 1].

SpeakFailure = 6

The engine failed to speak.

Unknown = 17

An error prism could not identify.

VoiceNotFound = 5

No voice has the index given.