> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XSpeechToTextBeginHypothesisString

> XSpeechToTextBeginHypothesisString

# XSpeechToTextBeginHypothesisString

Inicia uma hipótese e exibe a cadeia de caracteres dela em uma sobreposição de texto.

<a id="syntaxSection" />

## Sintaxe

```cpp theme={null}
HRESULT XSpeechToTextBeginHypothesisString(  
         const char* speakerName,  
         const char* content,  
         XSpeechToTextType type,  
         uint32_t* hypothesisId  
)  
```

<a id="parametersSection" />

### Parâmetros

*speakerName*   \_In\_z\_\
Tipo: char\*

O nome do locutor a ser exibido com a cadeia de caracteres da hipótese.

*content*   \_In\_z\_\
Tipo: char\*

A cadeia de caracteres inicial da hipótese.

*type*   \_In\_\
Tipo: [XSpeechToTextType](/pt-BR/reference/system/xaccessibility/enums/xspeechtotexttype)

O tipo de origem da cadeia de caracteres da hipótese.

*hypothesisId*   \_Out\_\
Tipo: uint32\_t\*

A ID da hipótese.

<a id="retvalSection" />

### Valor retornado

Tipo: HRESULT

HRESULT de êxito ou código de erro.

<a id="remarksSection" />

## Comentários

Uma hipótese é uma estimativa do que um locutor está dizendo, normalmente produzida por um reconhecedor de fala enquanto o locutor está no meio de uma frase. A API de sobreposição de conversão de fala em texto pode exibir uma cadeia de caracteres de hipótese sobre uma superfície do jogo.

A API de sobreposição de conversão de fala em texto também dá suporte a texto digitado. O parâmetro *type* identifica a origem da cadeia de caracteres da hipótese.

O aplicativo é responsável por reter o valor de *hypothesisId* até que a hipótese seja finalizada ou cancelada.

Para atualizar uma cadeia de caracteres de hipótese na sobreposição, use [XSpeechToTextUpdateHypothesisString](/pt-BR/reference/system/xaccessibility/functions/xspeechtotextupdatehypothesisstring).

Para cancelar uma hipótese e removê-la da sobreposição, use [XSpeechToTextCancelHypothesisString](/pt-BR/reference/system/xaccessibility/functions/xspeechtotextcancelhypothesisstring).

Para finalizar uma hipótese, use [XSpeechToTextFinalizeHypothesisString](/pt-BR/reference/system/xaccessibility/functions/xspeechtotextfinalizehypothesisstring).

Em algumas plataformas, a cadeia de caracteres da hipótese não é exibida até que o aplicativo chame `XSpeechToTextFinalizeHypothesisString`. A menos que a hipótese seja cancelada, seu aplicativo deve sempre chamar `XSpeechToTextFinalizeHypothesisString` para garantir que a cadeia de caracteres seja exibida.

O exemplo de código a seguir mostra um aplicativo criando uma hipótese, atualizando-a e, em seguida, finalizando-a.

```cpp theme={null}
void RowanHypothesisSample() 
{ 
    UINT32 hypothesisId; 
    XSpeechToTextBeginHypothesisString("Rowan", "I am typing some text.", XSpeechToTextType::Text, &hypothesisId); 
 
    // Some time passes. 
 
    XSpeechToTextUpdateHypothesisString(hypothesisId, "I am still typing some text."); 
 
    // Some time passes. 
 
    XSpeechToTextFinalizeHypothesisString(hypothesisId, "I typed some text. I am done typing."); 
} 
```

O exemplo de código a seguir mostra um aplicativo criando uma hipótese, atualizando-a e, em seguida, cancelando-a.

```cpp theme={null}
void QuincyHypothesisSample() 
{ 
    UINT32 hypothesisId; 
    XSpeechToTextBeginHypothesisString("Quincy", "I am speaking some text.", XSpeechToTextType::Voice, &hypothesisId); 
 
    // Some time passes. 
 
    XSpeechToTextUpdateHypothesisString(hypothesisId, "I am still speaking some text."); 
 
    // Some time passes. 
 
    XSpeechToTextCancelHypothesisString(hypothesisId); 
} 
```

<a id="requirementsSection" />

## Requisitos

**Cabeçalho:** XAccessibility.h

**Biblioteca:** xgameruntime.lib

**Plataformas com suporte:** Windows, consoles da família XBOX One e consoles XBOX Series

<a id="seealsoSection" />

## Confira também

[XAccessibility](/pt-BR/reference/system/xaccessibility/xaccessibility_members)


## Related topics

- [XSpeechToTextCancelHypothesisString](/pt-BR/reference/system/xaccessibility/functions/xspeechtotextcancelhypothesisstring.md)
- [XSpeechToTextUpdateHypothesisString](/pt-BR/reference/system/xaccessibility/functions/xspeechtotextupdatehypothesisstring.md)
- [XSpeechToTextFinalizeHypothesisString](/pt-BR/reference/system/xaccessibility/functions/xspeechtotextfinalizehypothesisstring.md)
- [XAccessibility](/pt-BR/reference/system/xaccessibility/xaccessibility_members.md)
- [Wrappers de API C# do Unity para o GDK](/pt-BR/build/gdk-and-engines/unity/unity-api-wrappers.md)