Método IAudioClient3::GetSharedModeEnginePeriod (audioclient.h)

Retorna o intervalo de periodicidades com suporte pelo mecanismo para o formato de fluxo especificado. A periodicidade do mecanismo é a taxa na qual o mecanismo ativa um cliente de áudio controlado por eventos para transferir dados de áudio de ou para o mecanismo. Os valores retornados dependem das características do cliente de áudio, conforme especificado por meio de uma chamada anterior para IAudioClient2::SetClientProperties.

Sintaxe

HRESULT GetSharedModeEnginePeriod(
  [in]  const WAVEFORMATEX *pFormat,
  [out] UINT32             *pDefaultPeriodInFrames,
  [out] UINT32             *pFundamentalPeriodInFrames,
  [out] UINT32             *pMinPeriodInFrames,
  [out] UINT32             *pMaxPeriodInFrames
);

Parâmetros

[in] pFormat

Tipo: const WAVEFORMATEX*

O formato de fluxo para o qual as periodicidades com suporte são consultadas.

[out] pDefaultPeriodInFrames

Tipo: UINT32*

O período padrão com o qual o mecanismo ativará o cliente para transferir amostras de áudio

[out] pFundamentalPeriodInFrames

Tipo: UINT32*

O período fundamental com o qual o mecanismo ativará o cliente para transferir amostras de áudio. Ao definir a periodicidade do mecanismo de áudio, você deve usar um múltiplo integral desse valor.

[out] pMinPeriodInFrames

Tipo: UINT32*

O período mais curto, em quadros de áudio, com o qual o mecanismo de áudio ativará o cliente para transferir amostras de áudio.

[out] pMaxPeriodInFrames

Tipo: UINT32*

O período mais longo, em quadros de áudio, com o qual o mecanismo de áudio ativará o cliente para transferir amostras de áudio.

Retornar valor

Tipo: HRESULT

Esse método retorna S_OK para indicar que foi concluído com êxito. Caso contrário, ele retornará um código de erro apropriado.

Comentários

Os clientes de áudio solicitam uma periodicidade específica do mecanismo de áudio com o parâmetro PeriodInFrames para IAudioClient3::InitializeSharedAudioStream. O valor de PeriodInFrames deve ser um múltiplo integral do valor retornado no parâmetro pFundamentalPeriodInFrames . PeriodInFrames também deve ser maior ou igual ao valor retornado em pMinPeriodInFrames e menor ou igual ao valor de pMaxPeriodInFrames.

Por exemplo, para um formato de 44100 kHz, GetSharedModeEnginePeriod pode retornar:

• pDefaultPeriodInFrames = 448 quadros (cerca de 10,16 milissegundos)

• pFundamentalPeriodInFrames = 4 quadros (cerca de 0,09 milissegundos)

• pMinPeriodInFrames = 48 quadros (cerca de 1,09 milissegundos)

• pMaxPeriodInFrames = 448 quadros (o mesmo que o padrão)

Os valores permitidos para o parâmetro PeriodInFrames para InitializeSharedAudioStream incluiriam 48 e 448. Eles também incluiriam coisas como 96 e 128.

Eles NÃO incluiriam 4 (que é menor que o valor mínimo permitido) ou 98 (que não é um múltiplo do fundamental) ou 1000 (que é maior que o valor máximo permitido).

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 10 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2016 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	audioclient.h

Confira também

IAudioClient3