Home > @magiclane/maps-sdk > SdkSettings > setVoiceByPath

SdkSettings.setVoiceByPath() method

Set the current voice by specifying the absolute path to the voice file.

Signature:

static setVoiceByPath(path: string, language?: Language): GemError;

Parameters

Parameter

Type

Description

path

string

The absolute path to the voice file.

language

Language

(Optional) The desired voice language. Used only in the case of TTS computer voice for accurate match in the underlying OS support

Returns:

GemError

GemError.success on success, otherwise see GemError for other values.

Exceptions

An exception if it fails.