Expand description
Raw C-compatible contracts for Vesper Plugin Platform.
Plugin authors should depend on player-plugin, not this crate. This crate
intentionally exposes raw pointers and function tables for the generated
native boundary and the checked host loader.
Modules§
- status
- Stable plugin status values.
Structs§
- Vesper
Audio Processor - Vesper
Benchmark Sink - Vesper
Byte Slice - Host-owned bytes borrowed for one synchronous ABI call.
- Vesper
Frame Processor - Vesper
Interface Descriptor - Host-initialized result for root interface enumeration.
- Vesper
Interface Header - Header prefix shared by every typed interface table.
- Vesper
Interface Id - Canonical UUID bytes identifying a typed plugin interface.
- Vesper
Json Out - Host-initialized output carrying one plugin-owned JSON document.
- Vesper
Native Decoder - Vesper
Native Frame Out - Host-initialized output for a native frame receive operation.
- Vesper
Open Session Out - Host-initialized output for a session open operation.
- Vesper
Owned Bytes - Plugin-owned bytes released through
VesperPluginRoot::free_bytes. - Vesper
Packet Out - Host-initialized output for a borrowed packet lease.
- Vesper
PcmFrame Out - Host-initialized output for decoded PCM bytes.
- Vesper
Pipeline Event Hook - Vesper
Plugin Root - Stable native root returned by
vesper_plugin_entry. - Vesper
Post Download Processor - Vesper
Progress Callbacks - Host callbacks borrowed for one synchronous processing call.
- Vesper
Source Normalizer Packet - Vesper
Source Normalizer Resource
Constants§
- AUDIO_
PROCESSOR_ INTERFACE_ ID - BENCHMARK_
SINK_ INTERFACE_ ID - FRAME_
PROCESSOR_ INTERFACE_ ID - NATIVE_
DECODER_ INTERFACE_ ID - PIPELINE_
EVENT_ HOOK_ INTERFACE_ ID - POST_
DOWNLOAD_ PROCESSOR_ INTERFACE_ ID - SOURCE_
NORMALIZER_ PACKET_ INTERFACE_ ID - SOURCE_
NORMALIZER_ RESOURCE_ INTERFACE_ ID - VESPER_
AUDIO_ PROCESSOR_ REQUIRED_ SIZE - VESPER_
BENCHMARK_ SINK_ REQUIRED_ SIZE - VESPER_
FRAME_ PROCESSOR_ REQUIRED_ SIZE - VESPER_
INTERFACE_ MAJOR - VESPER_
INTERFACE_ MINOR - VESPER_
MAX_ CAPABILITY_ INSTANCE_ ID_ BYTES - Maximum UTF-8 byte length of a capability instance identity.
- VESPER_
MAX_ INTERFACES_ PER_ PLUGIN - Maximum number of interfaces exposed by one root.
- VESPER_
MAX_ LEASES_ PER_ SESSION - Maximum number of concurrently retained leases in one session.
- VESPER_
MAX_ OWNED_ BYTES - Maximum size accepted for one plugin-owned ABI allocation.
- VESPER_
MAX_ PACKET_ BYTES - Maximum size accepted for one borrowed source-normalizer packet payload.
- VESPER_
MAX_ PCM_ BYTES - Maximum size accepted for one borrowed PCM frame payload.
- VESPER_
MAX_ PLUGIN_ ID_ BYTES - Maximum UTF-8 byte length of a reverse-DNS plugin identity.
- VESPER_
MAX_ PLUGIN_ NAME_ BYTES - Maximum UTF-8 byte length of a human-readable plugin name.
- VESPER_
MAX_ SESSIONS_ PER_ INTERFACE - Maximum number of concurrently registered sessions per interface instance.
- VESPER_
NATIVE_ DECODER_ REQUIRED_ SIZE - VESPER_
PIPELINE_ EVENT_ HOOK_ REQUIRED_ SIZE - VESPER_
PLUGIN_ ABI_ MAJOR - Root ABI major implemented by this crate.
- VESPER_
PLUGIN_ ABI_ MINOR - Root ABI minor implemented by this crate.
- VESPER_
PLUGIN_ ENTRY_ SYMBOL - NUL-terminated native entry symbol exported by every native plugin.
- VESPER_
PLUGIN_ ENTRY_ SYMBOL_ NAME - Human-readable native entry symbol without the terminating NUL byte.
- VESPER_
POST_ DOWNLOAD_ PROCESSOR_ REQUIRED_ SIZE - VESPER_
RELEASE_ DISCARDED - VESPER_
RELEASE_ PRESENTED - VESPER_
SOURCE_ NORMALIZER_ PACKET_ REQUIRED_ SIZE - VESPER_
SOURCE_ NORMALIZER_ RESOURCE_ REQUIRED_ SIZE
Functions§
- abi_
contains - abi_
size - Returns the ABI size field for a concrete
repr(C)type.
Type Aliases§
- Vesper
GetJson Fn - Vesper
Json Call Fn - Vesper
Lease Id - Vesper
Open Session Fn - Vesper
Plugin Entry Point - Native plugin entry point signature.
- Vesper
Session Id - Vesper
Session Operation Fn - Vesper
Status - Raw status returned across the native ABI.