pixa_plugins library
Plugin authoring contracts, descriptors, and registry APIs.
Classes
- PixaBytePayload
- Payload returned by fetchers, decoders, processors, and cache stores.
- PixaCacheHit
- Cache hit.
- PixaCacheKeyContributorDescriptor
- Cache-key extension descriptor.
- PixaCacheLookup
- Cache lookup result.
- PixaCacheMiss
- Cache miss.
- PixaCacheStore
- Cache-store execution contract.
- PixaCacheStoreCapabilities
- Capabilities required from a production Pixa cache store.
- PixaCacheStoreDescriptor
- Encoded cache store extension descriptor.
- PixaCacheWriteContext
- Cache write context.
- PixaCallbackObserver
- Observer that forwards events to a callback.
- PixaCancellationSignal
- Cancellation view passed to plugin handlers.
- PixaCompiledRoutePlan
- Immutable route and capability plan compiled from a registry.
- PixaControllerHook
- Controller lifecycle hook base class for plugins.
- PixaDartCacheStoreDescriptor
- Cache-store descriptor with an explicit Dart plugin handler.
- PixaDartDecoderDescriptor
- Decoder descriptor with an explicit Dart plugin handler.
- PixaDartFetcherDescriptor
- Fetcher descriptor with an explicit Dart plugin handler.
- PixaDartProcessorDescriptor
- Processor descriptor with an explicit Dart plugin handler.
- PixaDebugPanelDescriptor
- Debug panel extension descriptor.
- PixaDecoder
- Decoder execution contract.
- PixaDecoderCapabilities
- Production capability contract for one decoder adapter.
- PixaDecoderDescriptor
- Decoder extension descriptor.
- PixaDecoderSignature
- Bounded static signature route for a decoder adapter.
- PixaEvent
- Structured event emitted by Pixa.
- PixaExecutionContext
- Immutable execution context shared by plugin handlers.
- PixaFetcher
- Fetcher execution contract.
- PixaFetcherDescriptor
- Fetcher extension descriptor.
- PixaLogObserver
- Observer that formats redacted single-line logs for local debugging.
- PixaManualCancellationSignal
- Simple cancellation signal for tests and non-runtime plugin handlers.
- PixaObserver
- Observer interface for request, cache, scheduler, runtime, and failure events.
- PixaObserverSamplingPolicy
- Observer sampling policy for high-frequency event streams.
- PixaPlatformCacheStoreDescriptor
- Cache-store descriptor backed by a Flutter platform plugin boundary.
- PixaPlatformContract
- Stable contract for a Flutter platform-channel backed plugin handler.
- PixaPlatformDecoderDescriptor
- Decoder descriptor backed by a Flutter platform plugin boundary.
- PixaPlatformDescriptor
- Descriptor that executes through a Flutter platform plugin boundary.
- PixaPlatformFetcherDescriptor
- Fetcher descriptor backed by a Flutter platform plugin boundary.
- PixaPlatformProcessorDescriptor
- Processor descriptor backed by a Flutter platform plugin boundary.
- PixaPlugin
- Pixa plugin contract.
- PixaPluginIntegrationCandidate
- Candidate integration path exposed by a pub plugin package.
- PixaPluginIntegrationSelection
- Selected adaptive integration recorded during registry setup.
- PixaProcessor
- Processor execution contract.
- PixaProcessorContext
- Processor-specific execution context.
- PixaProcessorDescriptor
- Processor extension descriptor.
- PixaRegistry
-
Mutable plugin registration surface used during
Pixa.configure. - PixaRegistryArchitectureSnapshot
- Aggregated registry shape used by validation, debug tools and build hooks.
- PixaRegistryHandler
- Shared plugin handler contract.
- PixaRequestSnapshot
- Redacted request payload safe for observers, logs, and debug panels.
- PixaRuntimeCacheStoreDescriptor
- Descriptor for Pixa's built-in Rust-backed image cache store.
- PixaRuntimeContract
- Stable runtime ABI contract used by plugin implementations.
- PixaRuntimeDescriptor
- Descriptor that executes through the runtime ABI.
- PixaRuntimeVideoFrameBackendDescriptor
- Runtime ABI video-frame backend descriptor.
- PixaScheduler
- Scheduler execution contract for plugin-provided queues.
- PixaVersionConstraint
- Small semver-compatible constraint used to avoid depending on pub_semver.
- PixaVideoFrameBackendCapabilities
- Production capability contract for a video-frame backend.
- PixaVideoFrameBackendDescriptor
- Explicit video-frame fetcher descriptor.
Enums
- PixaCacheStoreEngine
- Cache-store implementation engine.
- PixaHostPlatform
- Host platforms supported by platform-channel plugin descriptors.
- PixaPayloadKind
- Encoded bytes returned by fetchers, decoders, processors, and cache stores.
- PixaPluginExecutionKind
- Execution layer used by a plugin descriptor.
- PixaPluginIntegrationMode
- Integration shape selected for an adaptive pub plugin.
- PixaRuntimeDeployment
- Runtime ABI deployment mode for a plugin module.
- PixaVideoFrameOutputKind
- Payload shape produced by a video-frame backend.
Constants
- pixaCacheStoreDescriptorId → const String
- Default cache-store descriptor id for the core Rust-backed store.
- pixaCacheStoreNamespace → const String
- Default namespace for the core Rust-backed store descriptor.
Typedefs
- PixaPluginIntegrationRegistrar = void Function(PixaRegistry registry)
- Registers one selected adaptive plugin candidate.
- PixaProgressSink = void Function(PixaProgress progress)
- Emits pipeline progress from plugin handlers.