SinchDialVoiceRelayOptions

public struct SinchDialVoiceRelayOptions

Options for dialing a Voice Relay endpoint through the Sinch Voice V2 platform.

Voice Relay connects the call to speech-to-text (STT) and text-to-speech (TTS) services through a WebSocket endpoint. A nil optional property is omitted from the dial request and the Voice V2 platform applies its default.

See Voice locales for the available voices and locales.

Warning

Beta API. It is functional, but its signature or behaviour may change in a future release without going through the usual deprecation cycle.

  • Name of the voice used for speech synthesis, for example Emma. Must not be empty.

    Declaration

    Swift

    public var ttsVoice: String

  • BCP 47 language tag used to transcribe inbound audio, for example en-US. Must not be empty.

    Declaration

    Swift

    public var sttLanguage: String

  • Voice V2 service ID to use for the dial. If nil, the project’s default service is used.

    Declaration

    Swift

    public var serviceId: String?

  • Whether callers can interrupt, or barge in on, TTS playback.

    Declaration

    Swift

    public var enableInterruptions: Bool?

  • String key-value pairs to pass with the call. At most 16 headers; each key must be 1 to 255 characters, and each value at most 255 characters. The call will fail immediately in case of invalid headers.

    Declaration

    Swift

    public var callHeaders: [String : Any]?

  • Undocumented

    Declaration

    Swift

    public init(ttsVoice: String,
            sttLanguage: String,
            serviceId: String? = nil,
            enableInterruptions: Bool? = nil,
            callHeaders: [String: Any]? = nil)