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

# XSpeechToTextBeginHypothesisString

> XSpeechToTextBeginHypothesisString

# XSpeechToTextBeginHypothesisString

Inicia una hipótesis y muestra su cadena en una superposición de texto.

## Sintaxis

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

### Parámetros

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

El nombre del hablante que se mostrará con la cadena de hipótesis.

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

La cadena de hipótesis inicial.

*type*   \_In\_\
Tipo: [XSpeechToTextType](https://docs.xbox.com/es/reference/system/xaccessibility/enums/xspeechtotexttype.md)

El tipo de origen de la cadena de hipótesis.

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

El identificador de la hipótesis.

### Valor devuelto

Tipo: HRESULT

HRESULT de operación correcta o código de error.

## Comentarios

Una hipótesis es una suposición de lo que está diciendo un hablante, generalmente producida por un reconocedor de voz mientras el hablante está a mitad de frase. La API de superposición de voz a texto puede mostrar una cadena de hipótesis sobre una superficie del juego.

La API de superposición de voz a texto también admite texto escrito. El parámetro *type* identifica el origen de la cadena de hipótesis.

La aplicación es responsable de conservar el valor de *hypothesisId* hasta que la hipótesis se finalice o se cancele.

Para actualizar una cadena de hipótesis en la superposición, use [XSpeechToTextUpdateHypothesisString](https://docs.xbox.com/es/reference/system/xaccessibility/functions/xspeechtotextupdatehypothesisstring.md).

Para cancelar una hipótesis y quitarla de la superposición, use [XSpeechToTextCancelHypothesisString](https://docs.xbox.com/es/reference/system/xaccessibility/functions/xspeechtotextcancelhypothesisstring.md).

Para finalizar una hipótesis, use [XSpeechToTextFinalizeHypothesisString](https://docs.xbox.com/es/reference/system/xaccessibility/functions/xspeechtotextfinalizehypothesisstring.md).

En algunas plataformas, la cadena de hipótesis no se muestra hasta que la aplicación llama a `XSpeechToTextFinalizeHypothesisString`. A menos que la hipótesis se cancele, la aplicación siempre debe llamar a `XSpeechToTextFinalizeHypothesisString` para asegurarse de que la cadena se muestre.

En el ejemplo de código siguiente se muestra una aplicación que crea una hipótesis, la actualiza y luego la finaliza.

```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."); 
} 
```

En el ejemplo de código siguiente se muestra una aplicación que crea una hipótesis, la actualiza y luego la cancela.

```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); 
} 
```

## Requisitos

**Encabezado:** XAccessibility.h

**Biblioteca:** xgameruntime.lib

**Plataformas compatibles:** Windows, consolas de la familia XBOX One y consolas XBOX Series

## Consulte también

[XAccessibility](https://docs.xbox.com/es/reference/system/xaccessibility/xaccessibility_members.md)


## Related topics

- [XSpeechToTextCancelHypothesisString](https://docs.xbox.com/es/reference/system/xaccessibility/functions/xspeechtotextcancelhypothesisstring.md)
- [XSpeechToTextUpdateHypothesisString](https://docs.xbox.com/es/reference/system/xaccessibility/functions/xspeechtotextupdatehypothesisstring.md)
- [XSpeechToTextFinalizeHypothesisString](https://docs.xbox.com/es/reference/system/xaccessibility/functions/xspeechtotextfinalizehypothesisstring.md)
- [XAccessibility (contenido de la API)](https://docs.xbox.com/es/reference/system/xaccessibility/xaccessibility_members.md)
- [Uso de contenedores de C# para las API del GDK en el proyecto de Unity](https://docs.xbox.com/es/build/gdk-and-engines/unity/unity-api-wrappers.md)