mobileMic module

Package:

@dragon-speech-sdk/types

Type Aliases

MobileMicEvents	Mobile mic events.
PairingStatusChangedDetail	Pairing status changed event.
RemoteButtonKeyName	Represents the valid key name for remote button action. The key sent by the mobile microphone app to trigger action.
RemoteClientEventOccurredDetail	Remote client event. The content is what was received from the remote client.
SeparatedClientPairingEventMap	Client microphone pairing event map.
SeparatedClientPairingEventType	Client microphone pairing event type

Functions

sendKeyEvent(RemoteButtonKeyName, boolean)	Sends a key event (button press/release) to the remote client.
sendRemoteClientEvent(string)	Sends an event to the remote client.
startPairing()	Starts the mobile mic pairing process.
stopPairing()	Stops the mobile mic pairing process.
switchClientType(undefined | ClientType, PreferredMicrophone)	Switches the client type for the mobile microphone feature.

Variables

events	The listener only EventTarget for mobile mic events.
RemoteButtonKeyNames	Represents the valid key names for remote button actions. These correspond to keys sent by the mobile microphone app to trigger actions.

Function Details

sendKeyEvent(RemoteButtonKeyName, boolean)

Sends a key event (button press/release) to the remote client.

function sendKeyEvent(keyName: RemoteButtonKeyName, isKeyDown?: boolean)

Parameters

keyName

RemoteButtonKeyName

The name of the key that was pressed or released.

isKeyDown

boolean

Whether the key is currently pressed down.

Remarks

The key name should be one of the supported keys defined in RemoteButtonKeyName.

sendRemoteClientEvent(string)

Sends an event to the remote client.

function sendRemoteClientEvent(data: string)

Parameters

data

string

The data to send to the remote client.

Remarks

The Dragon Copilot SDK won't process the event content, it just passes it to the remote client as-is. This is useful for sending application-specific data to the remote client.

startPairing()

Starts the mobile mic pairing process.

function startPairing(): Promise<void>

Returns

Promise<void>

stopPairing()

Stops the mobile mic pairing process.

function stopPairing(): Promise<void>

Returns

Promise<void>

switchClientType(undefined | ClientType, PreferredMicrophone)

Switches the client type for the mobile microphone feature.

function switchClientType(clientType: undefined | ClientType, preferredMicrophone?: PreferredMicrophone): Promise<void>

Parameters

clientType

undefined | ClientType

The new client type to switch to.

preferredMicrophone

PreferredMicrophone

The preferred microphone to use.

Returns

Promise<void>

Remarks

You can switch the client between "non-mobile-mic" mode (undefined) and "mobile-mic" mode (VuiForm/Audio).

Variable Details

events

The listener only EventTarget for mobile mic events.

events: DragonEventTarget<MobileMicEvents>

Type

DragonEventTarget<MobileMicEvents>

RemoteButtonKeyNames

Represents the valid key names for remote button actions. These correspond to keys sent by the mobile microphone app to trigger actions.

RemoteButtonKeyNames: Readonly<{ EnterSelect: "ENTER_SELECT", F1A: "F1_A", F2B: "F2_B", F3C: "F3_C", F4D: "F4_D", Forward: "FORWARD", Play: "PLAY", Record: "RECORD", Rewind: "REWIND", TabBackward: "TAB_BACKWARD", TabForward: "TAB_FORWARD", Transcribe: "TRANSCRIBE" }>

Type

Readonly<{ EnterSelect: "ENTER_SELECT", F1A: "F1_A", F2B: "F2_B", F3C: "F3_C", F4D: "F4_D", Forward: "FORWARD", Play: "PLAY", Record: "RECORD", Rewind: "REWIND", TabBackward: "TAB_BACKWARD", TabForward: "TAB_FORWARD", Transcribe: "TRANSCRIBE" }>