Skip to main content
Version: 14 Oct 2024

MLVoiceIntentsConfiguration

A Class that will maintain the proper JSON structure needed by the MLVoice API.

Inherits from:
ScriptableObject

Public Methods

string GetJSONString

Return a string of the proper JSON format needed by the Voice Intents API.

public string GetJSONString()

List< string > GetValues

Retrieve a list of the current list of voice commands as a string.

public List< string > GetValues()

Public Attributes

AllVoiceIntents

The final data properly laid out to be assigned to the container that will be sent to the MLVoice API. VoiceCommandsToAdd will automatically be added to this in the proper format. Can also manually add to this list if it is not desired to do this through the editor inspector. This list follows the current structure of the JSONData and is subject to change.


public List< JSONData > AllVoiceIntents;

TypeDescription
List< JSONData >The current structure of the JSON data that will be sent to the MLVoice API. Subject to change.

Details*

Max Voice Intents Supported: 100


AutoAllowAllSystemIntents


public bool AutoAllowAllSystemIntents;


SlotsForVoiceCommands


public List< SlotData > SlotsForVoiceCommands;

TypeDescription
List< SlotData >The Slot Data to be used in the CustomVoiceIntents' value. To use a slot, put the SlotData name between { } inside of the CustomVoiceIntents' value.

SystemCommands


public SystemIntentFlags SystemCommands;

TypeDescription
SystemIntentFlagsThe verbal System Intents currently supported.

VoiceCommandsToAdd

The simplified list of Voice Command data to be filled out in the inspector or manually added to. A unique name field will be created based on the Unique Id provided.


public List< CustomVoiceIntents > VoiceCommandsToAdd;

TypeDescription
List< CustomVoiceIntents >The Simplified Voice Command data needed to add commands from the inspector. The unique name field required in the final JSON will be auto generated based on the unique Id.

Details*

If GetJSONString or GetValues is called, this data will be altered to fit the current proper layout the API needs to function correctly and will be added to AllVoiceIntents, then this list will be cleared as these commands will no longer need to be added.

Max Voice Intents Supported: 100


Public Enums

SystemIntentFlags

The verbal System Intents currently supported.

EnumeratorValueDescription
TakeAPhoto1 << 0
TakeAVideo1 << 1
StopRecording1 << 2
CloseAPPNAME1 << 3
OpenHome1 << 4
OpenAPPNAME1 << 5
Mute1 << 6
Unmute1 << 7
TurnTheVolumeDown1 << 8
SetTheVolumeToNUMBERPercent1 << 9
TurnTheVolumeUp1 << 10
Help1 << 11