Skip to content

Latest commit

 

History

History
173 lines (116 loc) · 5.67 KB

Client.md

File metadata and controls

173 lines (116 loc) · 5.67 KB
Raw

Client

A client that implements SpeechClientProtocol on top of Speechly SLU API and an audio recorder.

public class Client

The client handles both the audio and the API streams, as well as API authentication, caching access tokens and dispatching data to delegate.

The client is ready to use once initialised.

Inheritance

AudioRecorderDelegate, SluClientDelegate, SpeechlyProtocol

Initializers

init(appId:projectId:prepareOnInit:identityAddr:sluAddr:eventLoopGroup:delegateDispatchQueue:)

Creates a new SpeechClient.

public convenience init(appId: UUID? = nil, projectId: UUID? = nil, prepareOnInit: Bool = true, identityAddr: String = "grpc+tls://api.speechly.com", sluAddr: String = "grpc+tls://api.speechly.com", eventLoopGroup: EventLoopGroup = PlatformSupport.makeEventLoopGroup(loopCount: 1), delegateDispatchQueue: DispatchQueue = DispatchQueue(label: "com.speechly.Client.delegateQueue")) throws

Parameters

  • appId: Speechly application identifier. Eiither appId or projectId is needed.
  • projectId: Speechly projectt identifier. Eiither appId or projectId is needed.
  • prepareOnInit: Whether the client should prepare on initialisation. Preparing means initialising the audio stack and fetching the authentication token for the API.
  • identityAddr: The address of Speechly Identity gRPC service. Defaults to Speechly public API endpoint.
  • sluAddr: The address of Speechly SLU gRPC service. Defaults to Speechly public API endpoint.
  • eventLoopGroup: SwiftNIO event loop group to use.
  • delegateDispatchQueue: DispatchQueue to use for dispatching calls to the delegate.

init(appId:projectId:prepareOnInit:sluClient:identityClient:cache:audioRecorder:delegateDispatchQueue:)

Creates a new SpeechClient.

public init(appId: UUID? = nil, projectId: UUID? = nil, prepareOnInit: Bool, sluClient: SluClientProtocol, identityClient: IdentityClientProtocol, cache: CacheProtocol, audioRecorder: AudioRecorderProtocol, delegateDispatchQueue: DispatchQueue) throws

Parameters

  • appId: Speechly application identifier. Eiither appId or projectId is needed.
  • projectId: Speechly projectt identifier. Eiither appId or projectId is needed.
  • prepareOnInit: Whether the client should prepare on initialisation. Preparing means initialising the audio stack and fetching the authentication token for the API.
  • sluClient: An implementation of a client for Speechly SLU API.
  • identityClient: An implementation of a client for Speechly Identity API.
  • cache: An implementation of a cache protocol.
  • audioRecorder: An implementaion of an audio recorder.
  • delegateDispatchQueue: DispatchQueue to use for dispatching calls to the delegate.

Properties

delegate

var delegate: SpeechlyDelegate?

Methods

audioRecorderDidStop(_:)

public func audioRecorderDidStop(_: AudioRecorderProtocol)

audioRecorderDidReceiveData(_:audioData:)

public func audioRecorderDidReceiveData(_: AudioRecorderProtocol, audioData: Data)

audioRecorderDidCatchError(_:error:)

public func audioRecorderDidCatchError(_: AudioRecorderProtocol, error: Error)

sluClientDidCatchError(_:error:)

public func sluClientDidCatchError(_ sluClient: SluClientProtocol, error: Error)

sluClientDidStopStream(_:status:)

public func sluClientDidStopStream(_ sluClient: SluClientProtocol, status: GRPCStatus)

sluClientDidReceiveContextStart(_:contextId:)

public func sluClientDidReceiveContextStart(_ sluClient: SluClientProtocol, contextId: String)

sluClientDidReceiveContextStop(_:contextId:)

public func sluClientDidReceiveContextStop(_ sluClient: SluClientProtocol, contextId: String)

sluClientDidReceiveTentativeTranscript(_:contextId:segmentId:transcript:)

public func sluClientDidReceiveTentativeTranscript(_ sluClient: SluClientProtocol, contextId: String, segmentId: Int, transcript: SluClientDelegate.TentativeTranscript)

sluClientDidReceiveTentativeEntities(_:contextId:segmentId:entities:)

public func sluClientDidReceiveTentativeEntities(_ sluClient: SluClientProtocol, contextId: String, segmentId: Int, entities: SluClientDelegate.TentativeEntities)

sluClientDidReceiveTentativeIntent(_:contextId:segmentId:intent:)

public func sluClientDidReceiveTentativeIntent(_ sluClient: SluClientProtocol, contextId: String, segmentId: Int, intent: SluClientDelegate.TentativeIntent)

sluClientDidReceiveTranscript(_:contextId:segmentId:transcript:)

public func sluClientDidReceiveTranscript(_ sluClient: SluClientProtocol, contextId: String, segmentId: Int, transcript: SluClientDelegate.Transcript)

sluClientDidReceiveEntity(_:contextId:segmentId:entity:)

public func sluClientDidReceiveEntity(_ sluClient: SluClientProtocol, contextId: String, segmentId: Int, entity: SluClientDelegate.Entity)

sluClientDidReceiveIntent(_:contextId:segmentId:intent:)

public func sluClientDidReceiveIntent(_ sluClient: SluClientProtocol, contextId: String, segmentId: Int, intent: SluClientDelegate.Intent)

sluClientDidReceiveSegmentEnd(_:contextId:segmentId:)

public func sluClientDidReceiveSegmentEnd(_ sluClient: SluClientProtocol, contextId: String, segmentId: Int)

startContext(appId:)

public func startContext(appId: String? = nil)

stopContext()

public func stopContext()

suspend()

public func suspend()

resume()

public func resume() throws