Table of Contents

Class PrismNative

Namespace
Refractor.Interop
Assembly
Refractor.dll

The prism C API, one to one. Prism and the types around it wrap it safely.

public static class PrismNative
Inheritance
PrismNative
Inherited Members

Fields

ConfigVersion

PRISM_CONFIG_VERSION, the Version this prism expects.

public const byte ConfigVersion = 4

Field Value

byte

ErrorCount

PRISM_ERROR_COUNT, the number of PrismError codes.

public const int ErrorCount = 24

Field Value

int

FeatureMaxBit

PRISM_BACKEND_FEATURE_MAX_BIT, the highest feature bit prism reserves.

public const ulong FeatureMaxBit = 9223372036854775808

Field Value

ulong

Library

The library name every import above loads: prism.dll, libprism.dylib or libprism.so.

public const string Library = "prism"

Field Value

string

PluginAbiVersion

PRISM_PLUGIN_ABI_VERSION, the plugin ABI this prism loads.

public const ulong PluginAbiVersion = 1

Field Value

ulong

PluginEntryPoint

The function a prism plugin library exports for prism to find its backends.

public const string PluginEntryPoint = "prism_plugin_query"

Field Value

string

Methods

AvailabilityAutoPowerSupported()

Calls prism_availability_auto_power_supported.

public static bool AvailabilityAutoPowerSupported()

Returns

bool

AvailabilityPollPause(PrismContext*)

Calls prism_availability_poll_pause.

public static extern void AvailabilityPollPause(PrismContext* context)

Parameters

context PrismContext*

AvailabilityPollResume(PrismContext*)

Calls prism_availability_poll_resume.

public static extern void AvailabilityPollResume(PrismContext* context)

Parameters

context PrismContext*

BackendBraille(PrismBackend*, byte*)

Calls prism_backend_braille.

public static extern PrismError BackendBraille(PrismBackend* backend, byte* text)

Parameters

backend PrismBackend*
text byte*

Returns

PrismError

BackendCountVoices(PrismBackend*, nuint*)

Calls prism_backend_count_voices.

public static extern PrismError BackendCountVoices(PrismBackend* backend, nuint* count)

Parameters

backend PrismBackend*
count nuint*

Returns

PrismError

BackendFree(PrismBackend*)

Calls prism_backend_free.

public static extern void BackendFree(PrismBackend* backend)

Parameters

backend PrismBackend*

BackendGetBitDepth(PrismBackend*, nuint*)

Calls prism_backend_get_bit_depth.

public static extern PrismError BackendGetBitDepth(PrismBackend* backend, nuint* bitDepth)

Parameters

backend PrismBackend*
bitDepth nuint*

Returns

PrismError

BackendGetChannels(PrismBackend*, nuint*)

Calls prism_backend_get_channels.

public static extern PrismError BackendGetChannels(PrismBackend* backend, nuint* channels)

Parameters

backend PrismBackend*
channels nuint*

Returns

PrismError

BackendGetFeatures(PrismBackend*)

Calls prism_backend_get_features.

public static extern ulong BackendGetFeatures(PrismBackend* backend)

Parameters

backend PrismBackend*

Returns

ulong

BackendGetPitch(PrismBackend*, float*)

Calls prism_backend_get_pitch.

public static extern PrismError BackendGetPitch(PrismBackend* backend, float* pitch)

Parameters

backend PrismBackend*
pitch float*

Returns

PrismError

BackendGetRate(PrismBackend*, float*)

Calls prism_backend_get_rate.

public static extern PrismError BackendGetRate(PrismBackend* backend, float* rate)

Parameters

backend PrismBackend*
rate float*

Returns

PrismError

BackendGetSampleRate(PrismBackend*, nuint*)

Calls prism_backend_get_sample_rate.

public static extern PrismError BackendGetSampleRate(PrismBackend* backend, nuint* sampleRate)

Parameters

backend PrismBackend*
sampleRate nuint*

Returns

PrismError

BackendGetVoice(PrismBackend*, nuint*)

Calls prism_backend_get_voice.

public static extern PrismError BackendGetVoice(PrismBackend* backend, nuint* voiceId)

Parameters

backend PrismBackend*
voiceId nuint*

Returns

PrismError

BackendGetVoiceLanguage(PrismBackend*, nuint, byte**)

Calls prism_backend_get_voice_language.

public static extern PrismError BackendGetVoiceLanguage(PrismBackend* backend, nuint voiceId, byte** language)

Parameters

backend PrismBackend*
voiceId nuint
language byte**

Returns

PrismError

BackendGetVoiceName(PrismBackend*, nuint, byte**)

Calls prism_backend_get_voice_name.

public static extern PrismError BackendGetVoiceName(PrismBackend* backend, nuint voiceId, byte** name)

Parameters

backend PrismBackend*
voiceId nuint
name byte**

Returns

PrismError

BackendGetVolume(PrismBackend*, float*)

Calls prism_backend_get_volume.

public static extern PrismError BackendGetVolume(PrismBackend* backend, float* volume)

Parameters

backend PrismBackend*
volume float*

Returns

PrismError

BackendInitialize(PrismBackend*)

Calls prism_backend_initialize.

public static extern PrismError BackendInitialize(PrismBackend* backend)

Parameters

backend PrismBackend*

Returns

PrismError

BackendIsSpeaking(PrismBackend*, byte*)

Calls prism_backend_is_speaking.

public static extern PrismError BackendIsSpeaking(PrismBackend* backend, byte* speaking)

Parameters

backend PrismBackend*
speaking byte*

Returns

PrismError

BackendName(PrismBackend*)

Calls prism_backend_name.

public static extern byte* BackendName(PrismBackend* backend)

Parameters

backend PrismBackend*

Returns

byte*

BackendOutput(PrismBackend*, byte*, bool)

Calls prism_backend_output.

public static PrismError BackendOutput(PrismBackend* backend, byte* text, bool interrupt)

Parameters

backend PrismBackend*
text byte*
interrupt bool

Returns

PrismError

BackendPause(PrismBackend*)

Calls prism_backend_pause.

public static extern PrismError BackendPause(PrismBackend* backend)

Parameters

backend PrismBackend*

Returns

PrismError

BackendRefreshVoices(PrismBackend*)

Calls prism_backend_refresh_voices.

public static extern PrismError BackendRefreshVoices(PrismBackend* backend)

Parameters

backend PrismBackend*

Returns

PrismError

BackendResume(PrismBackend*)

Calls prism_backend_resume.

public static extern PrismError BackendResume(PrismBackend* backend)

Parameters

backend PrismBackend*

Returns

PrismError

BackendSetPitch(PrismBackend*, float)

Calls prism_backend_set_pitch.

public static extern PrismError BackendSetPitch(PrismBackend* backend, float pitch)

Parameters

backend PrismBackend*
pitch float

Returns

PrismError

BackendSetRate(PrismBackend*, float)

Calls prism_backend_set_rate.

public static extern PrismError BackendSetRate(PrismBackend* backend, float rate)

Parameters

backend PrismBackend*
rate float

Returns

PrismError

BackendSetVoice(PrismBackend*, nuint)

Calls prism_backend_set_voice.

public static extern PrismError BackendSetVoice(PrismBackend* backend, nuint voiceId)

Parameters

backend PrismBackend*
voiceId nuint

Returns

PrismError

BackendSetVolume(PrismBackend*, float)

Calls prism_backend_set_volume.

public static extern PrismError BackendSetVolume(PrismBackend* backend, float volume)

Parameters

backend PrismBackend*
volume float

Returns

PrismError

BackendSpeak(PrismBackend*, byte*, bool)

Calls prism_backend_speak.

public static PrismError BackendSpeak(PrismBackend* backend, byte* text, bool interrupt)

Parameters

backend PrismBackend*
text byte*
interrupt bool

Returns

PrismError

BackendSpeakToMemory(PrismBackend*, byte*, delegate* unmanaged[Cdecl]<void*, float*, nuint, nuint, nuint, void>, void*)

Calls prism_backend_speak_to_memory.

public static extern PrismError BackendSpeakToMemory(PrismBackend* backend, byte* text, delegate* unmanaged[Cdecl]<void*, float*, nuint, nuint, nuint, void> callback, void* userdata)

Parameters

backend PrismBackend*
text byte*
callback delegate* unmanaged[Cdecl]<void*, float*, nuint, nuint, nuint, void>
userdata void*

Returns

PrismError

BackendStop(PrismBackend*)

Calls prism_backend_stop.

public static extern PrismError BackendStop(PrismBackend* backend)

Parameters

backend PrismBackend*

Returns

PrismError

ConfigInit()

Calls prism_config_init.

public static extern PrismConfig ConfigInit()

Returns

PrismConfig

ErrorString(PrismError)

Calls prism_error_string.

public static extern byte* ErrorString(PrismError error)

Parameters

error PrismError

Returns

byte*

Init(PrismConfig*)

Calls prism_init.

public static extern PrismContext* Init(PrismConfig* config)

Parameters

config PrismConfig*

Returns

PrismContext*

Log(LogLevel, byte*, byte*)

Calls prism_log.

public static extern void Log(LogLevel level, byte* source, byte* message)

Parameters

level LogLevel
source byte*
message byte*

LogFlush()

Calls prism_log_flush.

public static extern void LogFlush()

LogShutdown()

Calls prism_log_shutdown.

public static extern void LogShutdown()

RegistryAcquire(PrismContext*, ulong)

Calls prism_registry_acquire.

public static extern PrismBackend* RegistryAcquire(PrismContext* context, ulong id)

Parameters

context PrismContext*
id ulong

Returns

PrismBackend*

RegistryAcquireBest(PrismContext*)

Calls prism_registry_acquire_best.

public static extern PrismBackend* RegistryAcquireBest(PrismContext* context)

Parameters

context PrismContext*

Returns

PrismBackend*

RegistryBuilderAddBackend(PrismRegistryBuilder*, byte*, int, ulong, PrismBackendVTable*, void*, delegate* unmanaged[Cdecl]<void*, void>, ulong*)

Calls prism_registry_builder_add_backend.

public static extern PrismError RegistryBuilderAddBackend(PrismRegistryBuilder* builder, byte* name, int priority, ulong features, PrismBackendVTable* vtable, void* userdata, delegate* unmanaged[Cdecl]<void*, void> userdataFree, ulong* id)

Parameters

builder PrismRegistryBuilder*
name byte*
priority int
features ulong
vtable PrismBackendVTable*
userdata void*
userdataFree delegate* unmanaged[Cdecl]<void*, void>
id ulong*

Returns

PrismError

RegistryBuilderAddLibrary(PrismRegistryBuilder*, byte*, int, nuint*)

Calls prism_registry_builder_add_library.

public static extern PrismError RegistryBuilderAddLibrary(PrismRegistryBuilder* builder, byte* path, int priorityOverride, nuint* count)

Parameters

builder PrismRegistryBuilder*
path byte*
priorityOverride int
count nuint*

Returns

PrismError

RegistryBuilderFree(PrismRegistryBuilder*)

Calls prism_registry_builder_free.

public static extern void RegistryBuilderFree(PrismRegistryBuilder* builder)

Parameters

builder PrismRegistryBuilder*

RegistryBuilderNew()

Calls prism_registry_builder_new.

public static extern PrismRegistryBuilder* RegistryBuilderNew()

Returns

PrismRegistryBuilder*

RegistryCount(PrismContext*)

Calls prism_registry_count.

public static extern nuint RegistryCount(PrismContext* context)

Parameters

context PrismContext*

Returns

nuint

RegistryCreate(PrismContext*, ulong)

Calls prism_registry_create.

public static extern PrismBackend* RegistryCreate(PrismContext* context, ulong id)

Parameters

context PrismContext*
id ulong

Returns

PrismBackend*

RegistryCreateBest(PrismContext*)

Calls prism_registry_create_best.

public static extern PrismBackend* RegistryCreateBest(PrismContext* context)

Parameters

context PrismContext*

Returns

PrismBackend*

RegistryExists(PrismContext*, ulong)

Calls prism_registry_exists.

public static bool RegistryExists(PrismContext* context, ulong id)

Parameters

context PrismContext*
id ulong

Returns

bool

RegistryFreeze(PrismRegistryBuilder*)

Calls prism_registry_freeze.

public static extern PrismRegistry* RegistryFreeze(PrismRegistryBuilder* builder)

Parameters

builder PrismRegistryBuilder*

Returns

PrismRegistry*

RegistryGet(PrismContext*, ulong)

Calls prism_registry_get.

public static extern PrismBackend* RegistryGet(PrismContext* context, ulong id)

Parameters

context PrismContext*
id ulong

Returns

PrismBackend*

RegistryId(PrismContext*, byte*)

Calls prism_registry_id.

public static extern ulong RegistryId(PrismContext* context, byte* name)

Parameters

context PrismContext*
name byte*

Returns

ulong

RegistryIdAt(PrismContext*, nuint)

Calls prism_registry_id_at.

public static extern ulong RegistryIdAt(PrismContext* context, nuint index)

Parameters

context PrismContext*
index nuint

Returns

ulong

RegistryName(PrismContext*, ulong)

Calls prism_registry_name.

public static extern byte* RegistryName(PrismContext* context, ulong id)

Parameters

context PrismContext*
id ulong

Returns

byte*

RegistryPriority(PrismContext*, ulong)

Calls prism_registry_priority.

public static extern int RegistryPriority(PrismContext* context, ulong id)

Parameters

context PrismContext*
id ulong

Returns

int

RegistryRelease(PrismRegistry*)

Calls prism_registry_release.

public static extern void RegistryRelease(PrismRegistry* registry)

Parameters

registry PrismRegistry*

RegistryRetain(PrismRegistry*)

Calls prism_registry_retain.

public static extern PrismRegistry* RegistryRetain(PrismRegistry* registry)

Parameters

registry PrismRegistry*

Returns

PrismRegistry*

SetLogHandler(PrismLogHandler)

Calls prism_set_log_handler.

public static extern PrismLogHandler SetLogHandler(PrismLogHandler handler)

Parameters

handler PrismLogHandler

Returns

PrismLogHandler

SetLogLevel(LogLevel)

Calls prism_set_log_level.

public static extern LogLevel SetLogLevel(LogLevel level)

Parameters

level LogLevel

Returns

LogLevel

Shutdown(PrismContext*)

Calls prism_shutdown.

public static extern void Shutdown(PrismContext* context)

Parameters

context PrismContext*

Version()

Calls prism_version.

public static extern uint Version()

Returns

uint

VersionString()

Calls prism_version_string.

public static extern byte* VersionString()

Returns

byte*