SpeechSynthesizer.TrySetDefaultVoiceAsync(VoiceInformation) Method

Definition

Asynchronously attempts to set the voice used for speech synthesis on an IoT device.

Note

This method is available only in Embedded mode.

public:
 static IAsyncOperation<bool> ^ TrySetDefaultVoiceAsync(VoiceInformation ^ voice);
/// [Windows.Foundation.Metadata.RemoteAsync]
 static IAsyncOperation<bool> TrySetDefaultVoiceAsync(VoiceInformation const& voice);
[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<bool> TrySetDefaultVoiceAsync(VoiceInformation voice);
function trySetDefaultVoiceAsync(voice)
Public Shared Function TrySetDefaultVoiceAsync (voice As VoiceInformation) As IAsyncOperation(Of Boolean)

Parameters

voice
VoiceInformation

One of the installed speech synthesis engines (voices).

Returns

IAsyncOperation<Boolean>

IAsyncOperation<bool>

An asynchronous operation that returns true if the set operation was a success. Otherwise, returns false.

Attributes

Windows requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

Your app must declare the systemManagement capability, which lets apps access basic system administration privileges including locale, timezone, shut down, and reboot.

The systemManagement capability must include the iot namespace when you declare it in your app's package manifest.

<Capabilities><iot:Capability Name="systemManagement"/></Capabilities>

Use Windows.Globalization.ApplicationLanguages.Languages to get the ranked list of current runtime language values preferred by the user.

Applies to

See also