TextReverseConversionGenerator.GetPhonemesAsync(String) Method

Definition

Returns a set of phonemes representing the given input string. This method is primarily intended for use in sorting data in the Japanese language. Phonetic reading is important for Japanese data handling, especially to sort names in proper phonetic order rather than in character code point order.

Proper names in Japanese that sound the same when pronounced can be spelled in different ways in Kanji. The point of sorting by phonemes is to sort all of the different Kanji spellings of a given proper name to be next to each other in a sorted list, rather than sorting them by character code point and having the various spellings not sorting next to each other.

public:
 virtual IAsyncOperation<IVectorView<TextPhoneme ^> ^> ^ GetPhonemesAsync(Platform::String ^ input) = GetPhonemesAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<TextPhoneme>> GetPhonemesAsync(winrt::hstring const& input);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<TextPhoneme>> GetPhonemesAsync(string input);
function getPhonemesAsync(input)
Public Function GetPhonemesAsync (input As String) As IAsyncOperation(Of IReadOnlyList(Of TextPhoneme))

Parameters

input
String

A string containing words in Japanese.

Returns

IAsyncOperation<IVectorView<TextPhoneme>>

IAsyncOperation<IReadOnlyList<TextPhoneme>>

On successful completion of the async operation, a list of TextPhoneme objects representing the input string in phoneme form.

Attributes

Windows requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Remarks

Each TextPhoneme in the result list has the following properties.

  • The DisplayText always matches a segment of the input string.
  • For Japanese input, the ReadingText is the Hiragana-based reading of the display text.
  • If the system cannot generate a reading, then it reports the ReadingText as being the same as the DisplayText.

Applies to