One Logo Pool Ball
Machine Learning · IOS API REFERENCE

Speech

Perform speech recognition on live or prerecorded audio, and receive transcriptions, alternative interpretations, and confidence levels of the results.

93 types

305 callable entries

17 skipped

95% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

AnalysisContext

class · iOS 26.0+

AnalysisContext.ContextualStringsTag

struct · iOS 26.0+

AnalysisContext.ContextualStringsTag.RawValue

typealias · iOS 26.0+

AnalysisContext.UserDataTag

struct · iOS 26.0+

AnalysisContext.UserDataTag.RawValue

typealias · iOS 26.0+

AnalyzerInput

struct · iOS 26.0+

AnalyzerInputConverter

class · iOS 27.0+

AssetInputSequenceProvider

class · iOS 27.0+

AssetInstallationRequest

class · iOS 26.0+

AssetInventory

class · iOS 26.0+

AssetInventory.Status

enum · iOS 26.0+

AttributeScopes.SpeechAttributes

struct · iOS 26.0+

AttributeScopes.SpeechAttributes.ConfidenceAttribute

struct · iOS 26.0+

AttributeScopes.SpeechAttributes.ConfidenceAttribute.Value

typealias · iOS 26.0+

AttributeScopes.SpeechAttributes.DecodingConfiguration

typealias · iOS 26.0+

AttributeScopes.SpeechAttributes.EncodingConfiguration

typealias · iOS 26.0+

AttributeScopes.SpeechAttributes.TimeRangeAttribute

struct · iOS 26.0+

AttributeScopes.SpeechAttributes.TimeRangeAttribute.Value

typealias · iOS 26.0+

CaptureInputSequenceProvider

class · iOS 27.0+

DataInsertable

protocol · iOS 17.0+

DictationTranscriber

class · iOS 26.0+

DictationTranscriber.ContentHint

struct · iOS 26.0+

DictationTranscriber.Preset

struct · iOS 26.0+

DictationTranscriber.ReportingOption

enum · iOS 26.0+

DictationTranscriber.ReportingOption.AllCases

typealias · iOS 26.0+

DictationTranscriber.Result

struct · iOS 26.0+

DictationTranscriber.ResultAttributeOption

enum · iOS 26.0+

DictationTranscriber.ResultAttributeOption.AllCases

typealias · iOS 26.0+

DictationTranscriber.Results

typealias · iOS 26.0+

DictationTranscriber.TranscriptionOption

enum · iOS 26.0+

DictationTranscriber.TranscriptionOption.AllCases

typealias · iOS 26.0+

LocaleDependentSpeechModule

protocol · iOS 26.0+

SFAcousticFeature

class · iOS 13.0+

SFCustomLanguageModelData

class · iOS 17.0+

SFCustomLanguageModelData.CompoundTemplate

struct · iOS 17.0+

SFCustomLanguageModelData.CustomPronunciation

struct · iOS 17.0+

SFCustomLanguageModelData.DataInsertableBuilder

struct · iOS 17.0+

SFCustomLanguageModelData.PhraseCount

struct · iOS 17.0+

SFCustomLanguageModelData.PhraseCountGenerator

class · iOS 17.0+

SFCustomLanguageModelData.PhraseCountGenerator.AsyncIterator

typealias · iOS 17.0+

SFCustomLanguageModelData.PhraseCountGenerator.Element

typealias · iOS 17.0+

SFCustomLanguageModelData.PhraseCountGenerator.Iterator

class · iOS 17.0+

SFCustomLanguageModelData.PhraseCountGenerator.Iterator.Element

typealias · iOS 17.0+

SFCustomLanguageModelData.PhraseCountsFromTemplates

struct · iOS 17.0+

SFCustomLanguageModelData.TemplateInsertableBuilder

struct · iOS 17.0+

SFCustomLanguageModelData.TemplatePhraseCountGenerator

class · iOS 17.0+

SFCustomLanguageModelData.TemplatePhraseCountGenerator.Iterator

class · iOS 17.0+

SFCustomLanguageModelData.TemplatePhraseCountGenerator.Iterator.Element

typealias · iOS 17.0+

SFCustomLanguageModelData.TemplatePhraseCountGenerator.Template

struct · iOS 17.0+

SFSpeechAudioBufferRecognitionRequest

class · iOS 10.0+

SFSpeechError

struct · iOS 17.0+

SFSpeechError.Code

enum · iOS 17.0+

SFSpeechLanguageModel

class · iOS 17.0+

SFSpeechLanguageModel.Configuration

class · iOS 17.0+

SFSpeechRecognitionMetadata

class · iOS 14.5+

SFSpeechRecognitionRequest

class · iOS 10.0+

SFSpeechRecognitionResult

class · iOS 10.0+

SFSpeechRecognitionTask

class · iOS 10.0+

SFSpeechRecognitionTaskDelegate

protocol · iOS 10.0+

SFSpeechRecognitionTaskHint

enum · iOS 10.0+

SFSpeechRecognitionTaskState

enum · iOS 10.0+

SFSpeechRecognizer

class · iOS 10.0+

SFSpeechRecognizerAuthorizationStatus

enum · iOS 10.0+

SFSpeechRecognizerDelegate

protocol · iOS 10.0+

SFSpeechURLRecognitionRequest

class · iOS 10.0+

SFTranscription

class · iOS 10.0+

SFTranscriptionSegment

class · iOS 10.0+

SFVoiceAnalytics

class · iOS 13.0+

SpeechAnalyzer

class · iOS 26.0+

SpeechAnalyzer.Options

struct · iOS 26.0+

SpeechAnalyzer.Options.ModelRetention

enum · iOS 26.0+

SpeechAnalyzer.Options.ModelRetention.AllCases

typealias · iOS 26.0+

SpeechDetector

class · iOS 26.0+

SpeechDetector.DetectionOptions

struct · iOS 26.0+

SpeechDetector.Result

struct · iOS 26.0+

SpeechDetector.Results

typealias · iOS 26.0+

SpeechDetector.SensitivityLevel

enum · iOS 26.0+

SpeechDetector.SensitivityLevel.AllCases

typealias · iOS 26.0+

SpeechDetector.SensitivityLevel.RawValue

typealias · iOS 26.0+

SpeechModels

enum · iOS 26.0+

SpeechModule

protocol · iOS 26.0+

SpeechModuleResult

protocol · iOS 26.0+

SpeechTranscriber

class · iOS 26.0+

SpeechTranscriber.Preset

struct · iOS 26.0+

SpeechTranscriber.ReportingOption

enum · iOS 26.0+

SpeechTranscriber.ReportingOption.AllCases

typealias · iOS 26.0+

SpeechTranscriber.Result

struct · iOS 26.0+

SpeechTranscriber.ResultAttributeOption

enum · iOS 26.0+

SpeechTranscriber.ResultAttributeOption.AllCases

typealias · iOS 26.0+

SpeechTranscriber.Results

typealias · iOS 26.0+

SpeechTranscriber.TranscriptionOption

enum · iOS 26.0+

SpeechTranscriber.TranscriptionOption.AllCases

typealias · iOS 26.0+

TemplateInsertable

protocol · iOS 17.0+

Functions and constants

get · iOS 17.0+

SFSpeechErrorDomain

TypeScript
const SFSpeechErrorDomain: string
Swift declaration
let SFSpeechErrorDomain: String
method · iOS 26.0+

rangeOfAudioTimeRangeAttributes

TypeScript
rangeOfAudioTimeRangeAttributes(timeRange: _CoreMedia_CMTimeRange): (SDKHandle) | null
Swift declaration
func rangeOfAudioTimeRangeAttributes(intersecting timeRange: CMTimeRange) -> Range<AttributedString.Index>?

Returns the range of the attributed string that is within the given time range. The method compares the given time range against the ``AttributeScopes/SpeechAttributes/TimeRangeAttribute`` attributes of the string. The time ranges in the string should be in ascending order, but not necessarily contiguous, and the string can include runs without a time range attribute. You can use this method to help update an attributed string that tracks the volatile or finalized results of a ``SpeechTranscriber`` or ``DictationTranscriber`` module. - Parameter timeRange: An audio time range. - Returns: The range of the string's intersecting text, or `nil` if the string has no intersecting text.

Skipped declarations

17 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

AttributeDynamicLookup.subscript(dynamicMember:)

This declaration needs Swift generic type arguments. (no canonical witness for T)

SpeechAnalyzer.init(inputSequence:modules:options:analysisContext:volatileRangeChangedHandler:)

This declaration needs Swift generic type arguments. (no canonical witness for InputSequence)

SpeechAnalyzer.modules

The iOS SDK compiler rejected this binding: actor-isolated property 'modules' can not be referenced from a nonisolated context

SpeechAnalyzer.start(inputSequence:)

This declaration needs Swift generic type arguments. (no canonical witness for InputSequence)

SpeechAnalyzer.analyzeSequence(_:)

This declaration needs Swift generic type arguments. (no canonical witness for InputSequence)

SpeechAnalyzer.cancelAnalysis(before:)

The iOS SDK compiler rejected this binding: call to actor-isolated instance method 'cancelAnalysis(before:)' in a synchronous nonisolated context [#ActorIsolatedCall]

SpeechAnalyzer.volatileRange

The iOS SDK compiler rejected this binding: actor-isolated property 'volatileRange' can not be referenced from a nonisolated context

SpeechAnalyzer.setVolatileRangeChangedHandler(_:)

The iOS SDK compiler rejected this binding: call to actor-isolated instance method 'setVolatileRangeChangedHandler' in a synchronous nonisolated context [#ActorIsolatedCall]

SFCustomLanguageModelData.DataInsertableBuilder.buildBlock(_:)

A variable number of Swift arguments is not supported.

SFCustomLanguageModelData.TemplateInsertableBuilder.buildBlock(_:)

A variable number of Swift arguments is not supported.

SFCustomLanguageModelData.PhraseCountsFromTemplates.init(classes:builder:)

callback cannot propagate synchronous failure

SFCustomLanguageModelData.init(locale:identifier:version:builder:)

callback cannot propagate synchronous failure

SFSpeechURLRecognitionRequest.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

SFSpeechLanguageModel.Configuration.init()

inherited init: cannot prove legal (class declares 3 custom initializers)

protocol implementation LocaleDependentSpeechModule

non-method protocol requirement

protocol implementation SpeechModule

This protocol needs associated types that cannot yet cross the bridge.

protocol implementation SpeechModuleResult

non-method protocol requirement