Home.md

Types

• AudioRecorder: An audio recorder implementation that uses AVFoundation audio engine for capturing the input.
• AudioRecorder.AudioRecorderError: Errors thrown by the audio recorder.
• AudioContext: The speech recognition context.
• UserDefaultsCache: A cache implementation that uses UserDefaults as the backing storage.
• Client: A client that implements SpeechClientProtocol on top of Speechly SLU API and an audio recorder.
• Client.SpeechlyClientInitError: Represents different error situations when initializing the SpeechlyClient.
• Entity: A speech entity.
• Entity.ID: A custom ID implementation for SpeechEntity. Since entities have two indices, start and end, this struct encapsulates the two for indexing and sorting purposes.
• GRPCAddress: A gRPC service address.
• GRPCAddress.ParseError: Errors thrown when parsing the address.
• ApiAccessToken: A struct representing an access token returned by Speechly Identity service.
• ApiAccessToken.AuthScope: Token authorisation scopes. They determine which services can be accessed with this token.
• ApiAccessToken.TokenType: Type of token, determines the possible Speechly Apps that are accessible.
• CachingIdentityClient: A client for Speechly Identity gRPC API which provides token caching functionality.
• IdentityClient: A client for Speechly Identity gRPC API.
• IdentityClient.IdentityClientError: Errors returned by the client.
• Intent: A speech intent.
• InvalidSLUState: Possible invalid states of the client, eg. if startContext is called without connecting to API first.
• SluClient: An SluClientProtocol that is implemented on top of public Speechly SLU gRPC API. Uses swift-grpc for handling gRPC streams and connectivity.
• SluConfig: SLU stream configuration describes the audio data sent to the stream. If misconfigured, the recognition stream will not produce any useful results.
• Segment: A segment is a part of a recognition context (or a phrase) which is defined by an intent.
• SpeechlyError: Errors caught by SpeechClientProtocol and dispatched to SpeechClientDelegate.
• Transcript: A speech transcript.
• MicrophoneButtonView
• SpeechBubbleView
• TranscriptView

Protocols

• AudioRecorderProtocol: A protocol for capturing audio data from input sources (microphones).
• AudioRecorderDelegate: Delegate called when audio recorder receives some data or an error, or when it has been stopped.
• CacheProtocol: A protocol for a cache storage.
• Promisable: A protocol that defines methods for making succeeded and failed futures.
• IdentityClientProtocol: Protocol that defines a client for Speechly Identity API.
• SluClientProtocol: A protocol defining a client for Speechly SLU API.
• SluClientDelegate: Delegate called when an SLU client receives messages from the API or catches an error. The intended use of this protocol is with SluClientProtocol.
• SpeechlyProtocol: A speech client protocol.
• SpeechlyDelegate: Delegate called when a speech client handles messages from the API or catches an error.
• MicrophoneButtonDelegate

Global Functions

• makeChannel(addr:​loopCount:​): A function that creates a new gRPC channel for the provided address. It will also create a NIO eventloop group with the specified loop count.
• makeChannel(addr:​group:​): A function that creates a new gRPC channel for the provided address.
• makeTokenCallOptions(token:​): A function that creates new gRPC call options (metadata) that contains an authorisation token.