Nuance Translator SDK

• NSString *parameterType

  The type of data you provided.if none provided, the default will be taken from the customer config file.

  Default value: text

  Allowed values:"text","ssml"

• BOOL statistics

  Whether or not to return statistics on the command's performance:"true","false"

  Default value: false

• NSString *voice

  The voice in which speech synthesis is to be done. if none provided, the default will be taken from your customer config file. Note this parameter works only with the type "text".

  Default value: "Carol"

• NSString *speechDetector

  The speech detector to be used for voice activity detection. If none provided, the default will be taken from your customer config file.

  Default value: legacy

  Allowed values: "legacy", "adaptive"

• int beginNoiseSampleFrames

  The number of frames taken at the start of recognition to assess the environment's noise level. If none provided, the default will be taken from your customer config file.

  Default value: 10

  Size range: 1..231-1

• double voiceThreshold

  The amount of energy require for a frame to be considered 'voiced', as a factor of the background noise level. If none provided, the default will be taken from your customer config file.
  Default value: 4.0
  Size range: -263..263-1

• int startOfSpeechVoicedFrames

  Of the most recent startOfSpeechHistoryFrames, the number of 'voiced' frames required to assess that user has started speaking. If none provided, the default will be taken from your customer config file.
  Default value: 7
  Size range: -231..231-1

• int startOfSpeechHistoryFrames

  The number of historical frames to use when assessing that the user has started speaking. If none provided, the default will be taken from your customer config file.
  Default value: 15
  Size range: -231..231-1

• int endOfSpeechVoicedFrames

  Of the most recent endOfSpeechHistoryFrames, the number of 'voiced' frames which will indicate the user has not finished speaking. If none provided, the default will be taken from your customer config file.
  Default value: 5
  Size range: -231..231-1

• int endOfSpeechHistoryFrames

  The number of historical frames to use when assessing that the user has finished speaking. If none provided, the default will be taken from your customer config file.
  Default value: 50
  Size range: -231..231-1

• BOOL considerNegativeRatios

  Whether or not to consider negative ratios when assessing speech activity. If none provided, the default will be taken from your customer config file.
  Default value: false

• BOOL stopOnEndOfSpeech

  Whether or not to perform end-point detection. If none provided, the default will be taken from your customer config file.
  Default value: true

• BOOL wordStream

  Whether or not to send intermediate recognition results. If none provided, the default will be taken from your customer config file.
  Default value: true

• NSArray *activeDynamicVocabularySets

  The list of dynamic vocabulary (defined by their ids) to activate for this speech recognition command. NOTE: Do not upload more then 500 entries as this may have a noticeable performance degradation

• int startOfSpeechTimeoutSeconds

  How long to wait for start-of-speech before the server cancels a recognition, in seconds. Not applicable if endPointDetection is false. Use 0 (zero) for no limit.
  Default value: 5
  Size range: 0..231-1

• int utteranceMaxTimeSeconds

  The maximum allowed time for an utterance, in seconds. When endPointDetection is true, this time begins when start-of-speech is detected. Use 0 (zero) for no limit.
  Default value: 30
  Size range: 0..231-1

• BOOL statistics

  Whether or not to return statistics on the command's performance.
  Default value: true

• BOOL isNoiseLevelRequired

  The specific background noise level energy values to use for speech detection
  Default value: false

• NSString * speechSynthesisCodec

  The codec to be used during speech synthesis. If none provided, the default will be taken from your customer config file.
  Default value: pcm_16_8k
  Allowed values: "pcm_16_8k", "pcm_16_16k", "opus_nb", "opus_wb", "ulaw"

• NSString * speechRecognitionCodec

  The codec to be used during speech recognition. If none provided, the default will be taken from your customer config file.
  Default value: pcm_16_8k
  Allowed values: "pcm_16_8k", "pcm_16_16k", "opus_nb", "opus_wb"

• NSString * clientUserId

  String defined by the client application to identify itself.
  Default value: ""

• NSString * clientDeviceId

  String defined by the client application to identify the device.
  Default value: ""

• NSString * clientSessionId

  String defined by the client application to identify its session.
  Default value: ""

• NSString * clientOsName

  String defined by the client application to identify the OS it runs on.
  Default value: "iOS"

• NSString * clientOsVersion
  Default value:"<device version>"

  String defined by the client application to identify the OS it runs on.

• - (void) addRecognitionResponseDelegage:(id_Nonnull)delegate;

  NinaMobileRecognitionResponseDelegate events are fired to let Application know the various state of speech interpretation

  -(void) recognitionNoMatch

  -(void) recognitionNoInput

  -(void) recognitionCancelled

  -(void) recognitionIntermediateResponseAvailable:(NSString* _Nullable) text

  -(void) recognitionFinalTranscriptionResponseAvailable:(NSString* _Nullable) text

• - (void) addRecorderProgressDelegage:(id_Nonnull)delegate

  MMFAudioProgressNotificationDelegateevents are fired to let Application know the various state of Recorder

  -(void) recognitionStarted

  -(void) recognitionStartOfSpeechDetected

  -(void) recognitionEndOfSpeechDetected

  -(void) recognitionStopped

  -(void) recognitionEnergyDetected:(float)energy

• - (void) addTTSPlaybackDelegage:(id_Nonnull)delegate

  MMFTTSPlayBackNotificationDelegateevents are fired to let Application know the various TTS playback state

  -(void) playbackStarted

  -(void) playbackStopped

  -(void) playbacksCompleted

  -(void) errorDuringPlayback:(NSError*_Nullable) error

• - (void) removeRecognitionResponseDelegate:(id_Nonnull)delegate

• - (void) removeRecorderProgressDelegate:(id_Nonnull)delegate

• - (void) removeTTSPlaybackDelegate:(id_Nonnull)delegate

• -(void) startListeningAndDoRecognition

  SDK will start listening to the speech input, Listeners from the above section will be fired to notify the app about the various state of the recognition

• -(void) stopListening;

  SDK stop listening to the speech,recognitionFinalTranscriptionResponseAvailable event will be fired with the final recognized text if any

• -(void) cancelListening;

  SDK cancel listening to the speech.

• -(void) startPlaybackOf:(NSString * _Nullable)inputText;

  SDK request for a TTS play back with the given string input. playbacksCompleted event will be fired when all queued prompts has finished playing.

• -(void)stopPlayback;

  SDK trys to cancel the prompt providely there is a prompt being played or queued.

• -(Boolean) isPlaying;

  Check TTS state with the Translator SDK.

• -(Boolean) isRecording;

  Check Recording state with the Translator SDK.

	
	     let serverConfiguration = NinaServerConfiguration.init()
        serverConfiguration.applicationKey = a == 0 ? "companyName_appName" : "NuancePS_PizzaAU"
        serverConfiguration.verificationCode = "5796d9e101d5355f5dbf95a3681f6ca5317fd9e96e5ffacac5e1305361a4eb1c"
        serverConfiguration.gateWayAddress = a == 0 ?"webapi-demo.nuance.mobi": "n4a-webapi.nuance.mobi" // webapi-demo.nuance.mobi // cobra-webapi.nuance.mobi
        serverConfiguration.gateWayPath = "webapi-platform/websocket"
        serverConfiguration.gateWayPort = "443"
        serverConfiguration.gateWayScheme = "wss"
        vc.setNinaServerConfigurationProperties(properties: serverConfiguration)

        let ninaSetting = NinaSetting.init()
        ninaSetting.sessionValues.speechRecognitionCodec = "pcm_16_16k"
        ninaSetting.sessionValues.speechSynthesisCodec = "pcm_16_16k"
        ninaSetting.synthesisValues.voice = a == 0 ? "Tom" : "Nathan"
        ninaSetting.synthesisValues.parameterType = "ssml"
        ninaSetting.serverTimeOut = 1.0

        
        vc.setNinaSettingProperties(properties: ninaSetting)