> ## 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.

# XGameStreaming (conteúdo da API)

> XGameStreaming

# XGameStreaming

## Inicialização

APIs necessárias para inicializar os recursos de streaming de jogos.

| Função | Descrição |
| :- | :- |
| [XGameStreamingInitialize](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminginitialize.md) | Inicializa as APIs de streaming de jogos. |
| [XGameStreamingUninitialize](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminguninitialize.md) | Cancela a inicialização das APIs de streaming de jogos. |

## Propriedades do cliente

APIs para obter propriedades dos dispositivos de streaming ou do respectivo stream do jogo

### Funções

| Função | Descrição |
| :- | :- |
| [XGameStreamingClientPropertiesChangedCallback](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingclientpropertieschangedcallback.md) | Notificação de quando as propriedades de um dispositivo de streaming são alteradas. |
| [XGameStreamingGetClientIPAddress](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetclientipaddress.md) | **Preterido.** Obtém o endereço IP do cliente de streaming. Em vez disso, use as declarações do token XSTS. |
| [XGameStreamingGetDisplayDetails](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetdisplaydetails.md) | Obtém os detalhes de exibição do cliente de streaming. |
| [XGameStreamingGetSessionId](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetsessionid.md) | Obtém a ID da sessão do cliente de streaming. |
| [XGameStreamingGetStreamPhysicalDimensions](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetstreamphysicaldimensions.md) | Obtém o tamanho físico do stream de vídeo conforme ele está sendo renderizado no momento no cliente de streaming. |
| [XGameStreamingGetTouchBundleVersion](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggettouchbundleversion.md) | Obtém a versão do pacote de adaptação de toque usado no momento no dispositivo especificado. |
| [XGameStreamingGetTouchBundleVersionNameSize](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggettouchbundleversionnamesize.md) | Obtém o tamanho do nome da versão especificado no pacote de adaptação de toque no dispositivo especificado. |
| [XGameStreamingIsTouchInputEnabled](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingistouchinputenabled.md) | Verifica se um cliente enviará entradas de toque para o jogo. |
| [XGameStreamingRegisterClientPropertiesChanged](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingregisterclientpropertieschanged.md) | Registra um retorno de chamada a ser invocado quando qualquer uma das propriedades do dispositivo cliente de streaming for alterada. |
| [XGameStreamingUnregisterClientPropertiesChanged](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingunregisterclientpropertieschanged.md) | Cancela o registro de um XGameStreamingClientPropertiesChangedCallback registrado anteriormente. |

### Enumerações

| Enumeração | Descrição |
| :- | :- |
| [XGameStreamingClientProperty](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/enums/xgamestreamingclientproperty.md) | Propriedades que podem ser consultadas sobre o dispositivo cliente de streaming. |
| [XGameStreamingVideoFlags](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/enums/xgamestreamingvideoflags.md) | Recursos de vídeo disponíveis que podem ser compatíveis com o dispositivo cliente de streaming. |

### Estruturas

| Estruturas | Descrição |
| :- | :- |
| [XGameStreamingDisplayDetails](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/structs/xgamestreamingdisplaydetails.md) | Detalhes sobre a tela do dispositivo cliente de streaming. |

## Estado da conexão

APIs necessárias para gerenciar o estado da conexão dos dispositivos clientes de streaming.

### Funções

| Função | Descrição |
| :- | :- |
| [XGameStreamingConnectionStateChangedCallback](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingconnectionstatechangedcallback.md) | Uma função de retorno de chamada a ser invocada sempre que o estado de um cliente de streaming conectado for alterado. |
| [XGameStreamingGetClientCount](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetclientcount.md) | Número de dispositivos de streaming conectados no momento. |
| [XGameStreamingGetClients](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetclients.md) | Obtém os identificadores de cada cliente conectado no momento. |
| [XGameStreamingGetConnectionState](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetconnectionstate.md) | Obtém o estado atual da conexão para o dispositivo especificado. |
| [XGameStreamingIsStreaming](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingisstreaming.md) | Determina se o jogo está sendo transmitido no momento. |
| [XGameStreamingRegisterConnectionStateChanged](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingregisterconnectionstatechanged.md) | Registra um retorno de chamada a ser invocado quando o estado da conexão de um dispositivo cliente de streaming for alterado. |
| [XGameStreamingUnregisterConnectionStateChanged](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingunregisterconnectionstatechanged.md) | Cancela o registro de um XGameStreamingConnectionStateChangedCallback registrado anteriormente. |

### Enumerações

| Enumeração | Descrição |
| :- | :- |
| [XGameStreamingConnectionState](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/enums/xgamestreamingconnectionstate.md) | Estados de conexão de um dispositivo cliente de streaming. |

## Latência

APIs para adaptar a jogabilidade à latência do streaming.

### Funções

| Função | Descrição |
| :- | :- |
| [XGameStreamingGetStreamAddedLatency](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetstreamaddedlatency.md) | Obtém a média recente da latência relacionada ao streaming. |
| [XGameStreamingGetLastFrameDisplayed](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetlastframedisplayed.md) | **Preterido.** Obtém o token do pipeline de quadros do quadro exibido mais recentemente na tela do cliente de streaming. |
| [XGameStreamingGetAssociatedFrame](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetassociatedframe.md) | **Preterido.** Obtém o token do pipeline de quadros de uma leitura de entrada específica. |

## Localização do servidor

APIs para acessar a localização a partir da qual o jogo está sendo transmitido.

### Funções

| Função | Descrição |
| :- | :- |
| [XGameStreamingGetServerLocationName](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetserverlocationname.md) | Obtém a localização do data center do servidor de streaming. |
| [XGameStreamingGetServerLocationNameSize](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetserverlocationnamesize.md) | Obtém o tamanho do nome da localização do data center do servidor de streaming |

## Adaptação de toque

APIs para gerenciar os layouts de controle por toque que serão expostos aos clientes de streaming apropriados.

### Funções

| Função | Descrição |
| :- | :- |
| [XGameStreamingGetGamepadPhysicality](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminggetgamepadphysicality.md) | Obtém o mapeamento de fisicalidade da entrada de uma leitura de gamepad específica. |
| [XGameStreamingHideTouchControls](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminghidetouchcontrols.md) | Solicita que todos os dispositivos clientes de streaming conectados ocultem o layout de toque, caso esteja visível. |
| [XGameStreamingHideTouchControlsOnClient](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminghidetouchcontrolsonclient.md) | Solicita que um dispositivo cliente de streaming especificado oculte o layout de toque, caso esteja visível. |
| [XGameStreamingShowTouchControlLayout](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrollayout.md) | Solicita que todos os dispositivos clientes de streaming conectados mostrem um layout de toque especificado. |
| [XGameStreamingShowTouchControlLayoutOnClient](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrollayoutonclient.md) | Solicita que um dispositivo cliente de streaming conectado especificado mostre um layout de toque especificado. |
| [XGameStreamingShowTouchControlsWithStateUpdate](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrolswithstateupdate.md) | Solicita que todos os dispositivos clientes de streaming conectados atualizem o estado dos controles por toque e, em seguida, mostrem um layout de toque especificado. |
| [XGameStreamingShowTouchControlsWithStateUpdateOnClient](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingshowtouchcontrolswithstateupdateonclient.md) | Solicita que um dispositivo cliente de streaming especificado atualize o estado dos controles por toque e, em seguida, mostre um layout de toque especificado. |
| [XGameStreamingUpdateTouchControlsState](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingupdatetouchcontrolsstate.md) | Atualiza o estado dos controles por toque em todos os dispositivos clientes de streaming conectados. |
| [XGameStreamingUpdateTouchControlsStateOnClient](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingupdatetouchcontrolsstateonclient.md) | Atualiza o estado dos controles por toque em um dispositivo cliente de streaming especificado. |

### Enumerações

| Enumeração | Descrição |
| :- | :- |
| [XGameStreamingGamepadPhysicality](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/enums/xgamestreaminggamepadphysicality.md) | Mapeamento de fisicalidade de todos os botões, direcionais e gatilhos de um Controle Sem Fio XBOX padrão.  Para qualquer botão/direcional/gatilho, a fisicalidade pode ser desconhecida, física, virtual ou ambas. |
| [XGameStreamingTouchControlsStateOperationKind](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/enums/xgamestreamingtouchcontrolsstateoperationkind.md) | Operações que podem ser executadas ao atualizar o estado do layout de controle por toque. |
| [XGameStreamingTouchControlsStateValueKind](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/enums/xgamestreamingtouchcontrolsstatevaluekind.md) | Especifica o tipo do estado associado aos layouts de toque. |

### Estruturas

| Estruturas | Descrição |
| :- | :- |
| [XGameStreamingTouchControlsStateOperation](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/structs/xgamestreamingtouchcontrolsstateoperation.md) | Especifica a operação, o caminho para a variável específica e o valor a ser aplicado. |
| [XGameStreamingTouchControlsStateValue](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/structs/xgamestreamingtouchcontrolsstatevalue.md) | Fornece o tipo e o valor de um elemento específico do estado dos controles por toque. |

## Resolução

APIs para gerenciar a resolução do stream.

### Funções

| Função | Descrição |
| :- | :- |
| [XGameStreamingSetResolution](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreamingsetresolution.md) | Define a resolução do stream de vídeo. |

## Códigos de erro

Os códigos de erro a seguir podem ser retornados pelas APIs XGameStreaming. Para obter uma lista completa, consulte [Códigos de erro](https://docs.xbox.com/pt-BR/reference/errorcodes.md).

| Código | Valor | Descrição |
| - | - | - |
| E\_GAMESTREAMING\_NOT\_INITIALIZED | 0x89245400 | O runtime do XGameStreaming não foi inicializado. Chame [XGameStreamingInitialize](https://docs.xbox.com/pt-BR/reference/system/xgamestreaming/functions/xgamestreaminginitialize.md) antes de chamar outras APIs. |
| E\_GAMESTREAMING\_CLIENT\_NOT\_CONNECTED | 0x89245401 | O cliente especificado não está conectado. |
| E\_GAMESTREAMING\_NO\_DATA | 0x89245402 | Os dados solicitados não estão disponíveis. Os dados podem ficar disponíveis mais tarde. |
| E\_GAMESTREAMING\_NO\_DATACENTER | 0x89245403 | O computador atual não está sendo executado em um data center. |
| E\_GAMESTREAMING\_NOT\_STREAMING\_CONTROLLER | 0x89245404 | A leitura atual não veio de um controle de streaming. |

## Documentação conceitual

* [Chamadas de API com reconhecimento de nuvem](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-am-i-streaming.md)
* [Introdução ao toque](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-getting-started-with-touch.md)
* [Análise detalhada da compensação de latência do streaming de jogos](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-latency-compensation-deep-dive.md)
* [Visão geral da compensação de latência do streaming de jogos](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-latency-compensation-overview.md)
* [Medição de latência do streaming de jogos](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-latency-measurement.md)

## Confira também

[Referência da API do sistema](https://docs.xbox.com/pt-BR/reference/system/gc-reference-system-toc.md)


## Related topics

- [Visão geral da compensação de latência no streaming de jogos](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-latency-compensation-overview.md)
- [Análise detalhada da compensação de latência no streaming de jogos](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-latency-compensation-deep-dive.md)
- [Medição de latência no streaming de jogos](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-latency-measurement.md)
- [Chamadas de API com reconhecimento de nuvem](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-am-i-streaming.md)
- [Introdução ao toque](https://docs.xbox.com/pt-BR/build/core-features/common/game-streaming/game-streaming-getting-started-with-touch.md)
