Declared in STMediaParams_doc.h

Overview

This struct describes the parameters for a speech recognition task.

A STSRTask object can be created as follows:

let stSRTask = STSRTask()

Tasks

  •   taskID

    The ID of the speech recognition task. This ID is provided by the client. Client will receive this ID with all event notifications and callbacks associated with speech recognition using this task. Default: nil.

           property
  •   taskHint

    Apple SR only. This parameter contains the speech recognition hint as defined in STTaskHint. Default: STTaskHint:SRHINT_UNSPECIFIED.

           property
  •   reportPartialResults

    Enables or disables reporting partial results to the client. Default: false.

           property
  •   autoPunctuate

    Enables or disables auto punctuation of recognized text. Default: false.

           property
  •   contextualStringsList

    This parameter contains the contextual strings list and optional phonetic map to enable for speech recognition. Contextual phare list usually contains phrases that contain unknown words. Default: nil. Example of contextual phrase list: “meemzee”,“wake up dahna”,etc.

           property

Properties

autoPunctuate

var autoPunctuate: Bool = false

Discussion

Enables or disables auto punctuation of recognized text. Default: false.

Declared In

STMediaParams_doc.h

contextualStringsList

var contextualStringsList: [String: String]?

Discussion

This parameter contains the contextual strings list and optional phonetic map to enable for speech recognition. Contextual phare list usually contains phrases that contain unknown words. Default: nil. Example of contextual phrase list: “meemzee”,“wake up dahna”,etc.

Declared In

STMediaParams_doc.h

reportPartialResults

var reportPartialResults: Bool = false

Discussion

Enables or disables reporting partial results to the client. Default: false.

Declared In

STMediaParams_doc.h

taskHint

var taskHint: STSRTaskHint = STSRTaskHint.SRHINT_UNSPECIFIED

Discussion

Apple SR only. This parameter contains the speech recognition hint as defined in STTaskHint. Default: STTaskHint:SRHINT_UNSPECIFIED.

Declared In

STMediaParams_doc.h

taskID

var taskID: String?

Discussion

The ID of the speech recognition task. This ID is provided by the client. Client will receive this ID with all event notifications and callbacks associated with speech recognition using this task. Default: nil.

Declared In

STMediaParams_doc.h