whisper_kit library
Classes
- ABTesting
- A/B testing manager.
- AccessibilityTemplate
- Accessibility app template.
- AdaptiveConfig
- Adaptive processing configuration.
- AdaptiveProcessor
- Adaptive processing utilities.
- ApiAuth
- API authentication configuration.
-
ApiResponse<
T> - API response wrapper.
- Assignment
- User's assigned variant for an experiment.
- AudioChunk
- Chunked audio file for processing large files.
- AudioPreprocessorPlugin
- Audio preprocessor plugin interface.
- AudioWaveform
- A simple audio waveform visualization.
- AutoUpdateConfig
- Auto-update configuration.
- BackgroundConfig
- Background task configuration.
- BackgroundHandler
- Abstract background handler interface.
- BackgroundResult
- Background task result.
- BackgroundTranscription
- Background transcription manager.
- BatchOptions
- Batch transcription options.
- BatchProgress
- Batch transcription progress information.
- BatchTranscriber
- Batch transcription processor.
- BatchTranscriptionResult
- Result of a single batch item transcription.
- BenchmarkComparison
- Benchmark comparison utility.
- Benchmarker
- Performance benchmarker.
- BenchmarkResult
- Benchmark result.
- CachedTranscription
- Cached transcription entry.
- CancellationToken
- A token that can be used to cancel long-running operations.
- CancellationTokenSource
- A cancellation token source that manages a cancellation token.
- CloudFile
- Cloud file metadata.
- CloudStorageManager
- Cloud storage manager for handling remote audio files.
- CloudStorageProvider
- Abstract cloud storage interface.
- CrashReport
- Crash report data.
- CrashReporter
- Abstract crash reporter interface.
- CrashReporting
- Crash reporting manager.
- CustomModel
- Custom model configuration.
- DeviceCapabilities
- Device capability detection for adaptive processing.
- DeviceCompatibility
- Device compatibility information.
- DiarizationConfig
- Diarization configuration.
- DiarizationProvider
- Abstract diarization provider interface.
- DiarizationResult
- Diarization result.
- DownloadProgress
- Download progress info.
- Experiment
- Experiment definition.
- FeatureFlagConfig
- Feature flag configuration.
- FeatureFlags
- Feature flags manager.
- FileSizeThresholds
- File size thresholds.
- FirebaseHelpers
- Firebase helper utilities.
- FirebaseStorageConfig
- Firebase Storage configuration.
- FirebaseTranscription
- Firebase transcription record.
- FirebaseTranscriptionService
- Abstract Firebase service interface.
- FirestoreConfig
- Firebase Firestore configuration.
- InMemoryCrashReporter
- In-memory crash reporter for testing/debugging.
- InMemoryTranscriptionDatabase
- In-memory implementation for testing.
- IntegrationTestUtils
- Integration test utilities.
- LanguageDetectionResult
- Language detection result.
- LanguageLearningTemplate
- Language learning app template.
- LanguageSelector
- A language selector dropdown.
- LargeFileConfig
- Large file processing configuration.
- LargeFileHandler
- Large file handler utilities.
- MeetingAppTemplate
- Meeting transcription app template.
- MeetingSpeakerEntry
- Meeting speaker entry.
- MemoryConfig
- Memory optimization configuration.
- MemoryInfo
- Memory usage information.
- MemoryLeakDetector
- Memory leak detector.
- MemoryLeakResult
- Memory leak detection result.
- MemoryOptimizer
- Memory optimization utilities.
- MockModelInfo
- Test utilities for model mocking.
- MockTranscriptionBuilder
- Mock transcription response builder.
- ModelBenchmark
- Model benchmark for comparing different Whisper models.
- ModelDownloadProgress
- A progress indicator for model downloads.
- ModelInfo
- Information about a Whisper model.
- ModelLoader
- Model loader for custom models.
- ModelRecommendation
- Model selection recommendations based on device capabilities.
- ModelSecurity
- Model security utilities.
- ModelUpdateManager
- Model update manager.
- ModelUpdateSource
- Abstract interface for update source.
- ModelValidationResult
- Model validation result.
- ModelVerificationResult
- Model verification result.
- ModelVersion
- Model version information.
- OpenAICompatibleClient
- OpenAI-compatible API client.
- PerformanceProfiler
- Performance profiler for tracking operation times.
- PluginRegistry
- Plugin registry for managing plugins.
- PostProcessorPlugin
- Post-processor plugin interface.
- PrivacyOptions
- Privacy-focused processing options.
- ProgressInfo
- Represents the current progress of an operation.
- QueuedResult
- Result of a queued transcription.
- QueuedTranscription
- A queued transcription item.
- RecordButton
- A button widget for recording with visual feedback.
- RecordingResult
- Result from stopping audio recording.
- ResourceCleanup
- Resource cleanup utilities.
- RestApiConfig
- REST API client configuration.
- SecureCleanup
- Temporary file cleanup utilities.
- SecureLoadingOptions
- Secure loading options.
- SecureLoadResult
- Secure loading result.
- SecureModelLoader
- Secure model loader.
- SimpleDiarization
- Simple rule-based diarization (placeholder).
- Speaker
- A detected speaker.
- SpeakerSegment
- A segment attributed to a speaker.
- StorageInfo
- Storage information for model management.
- StressTestConfig
- Stress test configuration.
- StressTester
- Stress tester for WhisperKit.
- StressTestResult
- Stress test result.
- Telemetry
- Telemetry manager for collecting usage data.
- TelemetryEvent
- A telemetry event.
- TelemetryProvider
- Abstract telemetry provider interface.
- TestAudioGenerator
- Test audio file generator.
- TestTimeout
- Test timeout wrapper.
- TextFormatterPlugin
- Text formatter plugin interface.
- ThreadingConfig
- Threading configuration for optimized processing.
- TimestampedSegment
- A segment with word-level timestamps.
- TimestampedWord
- A word with timing information.
- TimestampUtils
- Timestamp precision utilities.
- TranscribeRequest
- TranscribeRequestDto
- TranscriptionApiClient
- Abstract REST API client interface.
- TranscriptionApiRequest
- Transcription API request.
- TranscriptionApiResponse
- Transcription API response.
- TranscriptionAssertions
- Assertions for transcription testing.
- TranscriptionBenchmarkConfig
- Transcription benchmark configuration.
- TranscriptionCache
- Simple file-based transcription cache.
- TranscriptionDatabase
- Abstract database interface for transcription storage.
- TranscriptionDisplay
- A widget that displays transcription text with segments highlighted.
- TranscriptionExporter
- Transcription exporter for converting results to various formats.
- TranscriptionQuery
- Query options for searching transcriptions.
- TranscriptionQueue
- Transcription queue manager with priority support.
- TranscriptionRecord
- Stored transcription record.
- TranscriptionSegmentRecord
- Segment record for database storage.
- TranslationConfig
- Translation configuration options.
- TranslationPostProcessor
- Translation post-processor for improving output quality.
- TranslationResult
- Translation result with metadata.
- TrustedSource
- Trusted model source.
- TrustedSources
- Pre-defined trusted sources.
- UpdateCheckResult
- Model update check result.
- Variant
- Experiment variant.
- VersionRequest
- VoiceNoteAppTemplate
- Voice note app template component.
- WebSocketConfig
- WebSocket connection configuration.
- WebSocketHandler
- Abstract WebSocket handler interface.
- WebSocketMessage
- WebSocket message.
- WebSocketTranscriptionClient
- WebSocket transcription client.
- Whisper
- Entry point of whisper_kit
- WhisperKitPlatform
- Singleton access to WhisperKit platform features.
- WhisperKitPlugin
- Base interface for all WhisperKit plugins.
- WhisperLanguages
- Supported languages in Whisper.
- WhisperTranscribeResponse
- WhisperTranscribeSegment
- WhisperVersionResponse
Enums
- BackgroundState
- Background processing state.
- CloudProvider
- Cloud storage provider types.
- ErrorSeverity
- Error severity levels.
- ExportFormat
- Supported export formats.
- Feature
- Feature flag definitions.
- FileSizeCategory
- File size category.
- HttpMethod
- HTTP method types.
- PermissionStatus
- Permission status for microphone and storage access.
- ProgressOperation
- Types of operations that can report progress.
- QueueItemStatus
- Queue item status.
- TelemetryEventType
- Telemetry event types.
- TranscriptionPreset
- Preset configurations for different transcription use cases.
- TranscriptionPriority
- Priority levels for transcription queue items.
- WebSocketMessageType
- WebSocket message types.
- WhisperModel
- Available whisper models
Extensions
- BatchTranscriptionExtension on Whisper
- Extension on Whisper for batch transcription.
-
CancellationTokenFutureExtension
on Future<
T> - Extension methods for using cancellation tokens with Futures.
- ExportFormatExtension on ExportFormat
- Extension for export format file extensions.
- FeatureFlagsExtension on Feature
- Convenience extension for checking features.
- ProgressCallbackExtension on SimpleProgressCallback
- Extension to convert between callback types.
- ProgressInfoCallbackExtension on ProgressCallback
- Extension to convert ProgressCallback to SimpleProgressCallback for downloads.
- TimestampExtension on WhisperTranscribeResponse
- Extension on WhisperTranscribeResponse for timestamp utilities.
- TranscriptionExportExtension on WhisperTranscribeResponse
- Extension on WhisperTranscribeResponse for easy export.
- TranscriptionPresetExtension on TranscriptionPreset
- Extension methods for TranscriptionPreset.
- TranslationRequestExtension on TranscribeRequest
- Helper extension for creating translation requests.
Typedefs
-
BackgroundCallback
= Future<
String?> Function(String taskId) - Background task callback.
- ProgressCallback = void Function(ProgressInfo progress)
- Callback type for progress updates.
- SimpleProgressCallback = void Function(int received, int total)
- Callback type for simple progress updates (received, total bytes).
Exceptions / Errors
- AudioException
- Exception thrown when audio operations fail.
- ModelException
- Exception thrown when model operations fail.
- OperationCancelledException
- Exception thrown when an operation is cancelled.
- PermissionException
- Exception thrown when permissions are denied or unavailable.
- PluginException
- Exception thrown by plugin operations.
- TestTimeoutException
- Test timeout exception.
- TranscriptionException
- Exception thrown when transcription fails.
- WhisperKitException
- Base exception for all Whisper Kit errors.