Class PrismNative
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
ErrorCount
PRISM_ERROR_COUNT, the number of PrismError codes.
public const int ErrorCount = 24
Field Value
FeatureMaxBit
PRISM_BACKEND_FEATURE_MAX_BIT, the highest feature bit prism reserves.
public const ulong FeatureMaxBit = 9223372036854775808
Field Value
Library
The library name every import above loads: prism.dll, libprism.dylib or libprism.so.
public const string Library = "prism"
Field Value
PluginAbiVersion
PRISM_PLUGIN_ABI_VERSION, the plugin ABI this prism loads.
public const ulong PluginAbiVersion = 1
Field Value
PluginEntryPoint
The function a prism plugin library exports for prism to find its backends.
public const string PluginEntryPoint = "prism_plugin_query"
Field Value
Methods
AvailabilityAutoPowerSupported()
Calls prism_availability_auto_power_supported.
public static bool AvailabilityAutoPowerSupported()
Returns
AvailabilityPollPause(PrismContext*)
Calls prism_availability_poll_pause.
public static extern void AvailabilityPollPause(PrismContext* context)
Parameters
contextPrismContext*
AvailabilityPollResume(PrismContext*)
Calls prism_availability_poll_resume.
public static extern void AvailabilityPollResume(PrismContext* context)
Parameters
contextPrismContext*
BackendBraille(PrismBackend*, byte*)
Calls prism_backend_braille.
public static extern PrismError BackendBraille(PrismBackend* backend, byte* text)
Parameters
backendPrismBackend*textbyte*
Returns
BackendCountVoices(PrismBackend*, nuint*)
Calls prism_backend_count_voices.
public static extern PrismError BackendCountVoices(PrismBackend* backend, nuint* count)
Parameters
backendPrismBackend*countnuint*
Returns
BackendFree(PrismBackend*)
Calls prism_backend_free.
public static extern void BackendFree(PrismBackend* backend)
Parameters
backendPrismBackend*
BackendGetBitDepth(PrismBackend*, nuint*)
Calls prism_backend_get_bit_depth.
public static extern PrismError BackendGetBitDepth(PrismBackend* backend, nuint* bitDepth)
Parameters
backendPrismBackend*bitDepthnuint*
Returns
BackendGetChannels(PrismBackend*, nuint*)
Calls prism_backend_get_channels.
public static extern PrismError BackendGetChannels(PrismBackend* backend, nuint* channels)
Parameters
backendPrismBackend*channelsnuint*
Returns
BackendGetFeatures(PrismBackend*)
Calls prism_backend_get_features.
public static extern ulong BackendGetFeatures(PrismBackend* backend)
Parameters
backendPrismBackend*
Returns
BackendGetPitch(PrismBackend*, float*)
Calls prism_backend_get_pitch.
public static extern PrismError BackendGetPitch(PrismBackend* backend, float* pitch)
Parameters
backendPrismBackend*pitchfloat*
Returns
BackendGetRate(PrismBackend*, float*)
Calls prism_backend_get_rate.
public static extern PrismError BackendGetRate(PrismBackend* backend, float* rate)
Parameters
backendPrismBackend*ratefloat*
Returns
BackendGetSampleRate(PrismBackend*, nuint*)
Calls prism_backend_get_sample_rate.
public static extern PrismError BackendGetSampleRate(PrismBackend* backend, nuint* sampleRate)
Parameters
backendPrismBackend*sampleRatenuint*
Returns
BackendGetVoice(PrismBackend*, nuint*)
Calls prism_backend_get_voice.
public static extern PrismError BackendGetVoice(PrismBackend* backend, nuint* voiceId)
Parameters
backendPrismBackend*voiceIdnuint*
Returns
BackendGetVoiceLanguage(PrismBackend*, nuint, byte**)
Calls prism_backend_get_voice_language.
public static extern PrismError BackendGetVoiceLanguage(PrismBackend* backend, nuint voiceId, byte** language)
Parameters
backendPrismBackend*voiceIdnuintlanguagebyte**
Returns
BackendGetVoiceName(PrismBackend*, nuint, byte**)
Calls prism_backend_get_voice_name.
public static extern PrismError BackendGetVoiceName(PrismBackend* backend, nuint voiceId, byte** name)
Parameters
backendPrismBackend*voiceIdnuintnamebyte**
Returns
BackendGetVolume(PrismBackend*, float*)
Calls prism_backend_get_volume.
public static extern PrismError BackendGetVolume(PrismBackend* backend, float* volume)
Parameters
backendPrismBackend*volumefloat*
Returns
BackendInitialize(PrismBackend*)
Calls prism_backend_initialize.
public static extern PrismError BackendInitialize(PrismBackend* backend)
Parameters
backendPrismBackend*
Returns
BackendIsSpeaking(PrismBackend*, byte*)
Calls prism_backend_is_speaking.
public static extern PrismError BackendIsSpeaking(PrismBackend* backend, byte* speaking)
Parameters
backendPrismBackend*speakingbyte*
Returns
BackendName(PrismBackend*)
Calls prism_backend_name.
public static extern byte* BackendName(PrismBackend* backend)
Parameters
backendPrismBackend*
Returns
- byte*
BackendOutput(PrismBackend*, byte*, bool)
Calls prism_backend_output.
public static PrismError BackendOutput(PrismBackend* backend, byte* text, bool interrupt)
Parameters
backendPrismBackend*textbyte*interruptbool
Returns
BackendPause(PrismBackend*)
Calls prism_backend_pause.
public static extern PrismError BackendPause(PrismBackend* backend)
Parameters
backendPrismBackend*
Returns
BackendRefreshVoices(PrismBackend*)
Calls prism_backend_refresh_voices.
public static extern PrismError BackendRefreshVoices(PrismBackend* backend)
Parameters
backendPrismBackend*
Returns
BackendResume(PrismBackend*)
Calls prism_backend_resume.
public static extern PrismError BackendResume(PrismBackend* backend)
Parameters
backendPrismBackend*
Returns
BackendSetPitch(PrismBackend*, float)
Calls prism_backend_set_pitch.
public static extern PrismError BackendSetPitch(PrismBackend* backend, float pitch)
Parameters
backendPrismBackend*pitchfloat
Returns
BackendSetRate(PrismBackend*, float)
Calls prism_backend_set_rate.
public static extern PrismError BackendSetRate(PrismBackend* backend, float rate)
Parameters
backendPrismBackend*ratefloat
Returns
BackendSetVoice(PrismBackend*, nuint)
Calls prism_backend_set_voice.
public static extern PrismError BackendSetVoice(PrismBackend* backend, nuint voiceId)
Parameters
backendPrismBackend*voiceIdnuint
Returns
BackendSetVolume(PrismBackend*, float)
Calls prism_backend_set_volume.
public static extern PrismError BackendSetVolume(PrismBackend* backend, float volume)
Parameters
backendPrismBackend*volumefloat
Returns
BackendSpeak(PrismBackend*, byte*, bool)
Calls prism_backend_speak.
public static PrismError BackendSpeak(PrismBackend* backend, byte* text, bool interrupt)
Parameters
backendPrismBackend*textbyte*interruptbool
Returns
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
backendPrismBackend*textbyte*callbackdelegate* unmanaged[Cdecl]<void*, float*, nuint, nuint, nuint, void>userdatavoid*
Returns
BackendStop(PrismBackend*)
Calls prism_backend_stop.
public static extern PrismError BackendStop(PrismBackend* backend)
Parameters
backendPrismBackend*
Returns
ConfigInit()
Calls prism_config_init.
public static extern PrismConfig ConfigInit()
Returns
ErrorString(PrismError)
Calls prism_error_string.
public static extern byte* ErrorString(PrismError error)
Parameters
errorPrismError
Returns
- byte*
Init(PrismConfig*)
Calls prism_init.
public static extern PrismContext* Init(PrismConfig* config)
Parameters
configPrismConfig*
Returns
Log(LogLevel, byte*, byte*)
Calls prism_log.
public static extern void Log(LogLevel level, byte* source, byte* message)
Parameters
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
contextPrismContext*idulong
Returns
RegistryAcquireBest(PrismContext*)
Calls prism_registry_acquire_best.
public static extern PrismBackend* RegistryAcquireBest(PrismContext* context)
Parameters
contextPrismContext*
Returns
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
builderPrismRegistryBuilder*namebyte*priorityintfeaturesulongvtablePrismBackendVTable*userdatavoid*userdataFreedelegate* unmanaged[Cdecl]<void*, void>idulong*
Returns
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
builderPrismRegistryBuilder*pathbyte*priorityOverrideintcountnuint*
Returns
RegistryBuilderFree(PrismRegistryBuilder*)
Calls prism_registry_builder_free.
public static extern void RegistryBuilderFree(PrismRegistryBuilder* builder)
Parameters
builderPrismRegistryBuilder*
RegistryBuilderNew()
Calls prism_registry_builder_new.
public static extern PrismRegistryBuilder* RegistryBuilderNew()
Returns
RegistryCount(PrismContext*)
Calls prism_registry_count.
public static extern nuint RegistryCount(PrismContext* context)
Parameters
contextPrismContext*
Returns
RegistryCreate(PrismContext*, ulong)
Calls prism_registry_create.
public static extern PrismBackend* RegistryCreate(PrismContext* context, ulong id)
Parameters
contextPrismContext*idulong
Returns
RegistryCreateBest(PrismContext*)
Calls prism_registry_create_best.
public static extern PrismBackend* RegistryCreateBest(PrismContext* context)
Parameters
contextPrismContext*
Returns
RegistryExists(PrismContext*, ulong)
Calls prism_registry_exists.
public static bool RegistryExists(PrismContext* context, ulong id)
Parameters
contextPrismContext*idulong
Returns
RegistryFreeze(PrismRegistryBuilder*)
Calls prism_registry_freeze.
public static extern PrismRegistry* RegistryFreeze(PrismRegistryBuilder* builder)
Parameters
builderPrismRegistryBuilder*
Returns
RegistryGet(PrismContext*, ulong)
Calls prism_registry_get.
public static extern PrismBackend* RegistryGet(PrismContext* context, ulong id)
Parameters
contextPrismContext*idulong
Returns
RegistryId(PrismContext*, byte*)
Calls prism_registry_id.
public static extern ulong RegistryId(PrismContext* context, byte* name)
Parameters
contextPrismContext*namebyte*
Returns
RegistryIdAt(PrismContext*, nuint)
Calls prism_registry_id_at.
public static extern ulong RegistryIdAt(PrismContext* context, nuint index)
Parameters
contextPrismContext*indexnuint
Returns
RegistryName(PrismContext*, ulong)
Calls prism_registry_name.
public static extern byte* RegistryName(PrismContext* context, ulong id)
Parameters
contextPrismContext*idulong
Returns
- byte*
RegistryPriority(PrismContext*, ulong)
Calls prism_registry_priority.
public static extern int RegistryPriority(PrismContext* context, ulong id)
Parameters
contextPrismContext*idulong
Returns
RegistryRelease(PrismRegistry*)
Calls prism_registry_release.
public static extern void RegistryRelease(PrismRegistry* registry)
Parameters
registryPrismRegistry*
RegistryRetain(PrismRegistry*)
Calls prism_registry_retain.
public static extern PrismRegistry* RegistryRetain(PrismRegistry* registry)
Parameters
registryPrismRegistry*
Returns
SetLogHandler(PrismLogHandler)
Calls prism_set_log_handler.
public static extern PrismLogHandler SetLogHandler(PrismLogHandler handler)
Parameters
handlerPrismLogHandler
Returns
SetLogLevel(LogLevel)
Calls prism_set_log_level.
public static extern LogLevel SetLogLevel(LogLevel level)
Parameters
levelLogLevel
Returns
Shutdown(PrismContext*)
Calls prism_shutdown.
public static extern void Shutdown(PrismContext* context)
Parameters
contextPrismContext*
Version()
Calls prism_version.
public static extern uint Version()
Returns
VersionString()
Calls prism_version_string.
public static extern byte* VersionString()
Returns
- byte*