Método IAudioSystemEffectsCustomFormats::GetFormat (audioenginebaseapo.h)
O GetFormat
método recupera uma representação IAudioMediaType de um formato personalizado.
Sintaxe
HRESULT GetFormat(
[in] UINT nFormat,
[out, optional] IAudioMediaType **ppFormat
);
Parâmetros
[in] nFormat
Especifica o índice de um formato com suporte. Esse parâmetro pode ser qualquer valor no intervalo de zero a um menor que o valor retornado de GetFormatCount. Em outras palavras, qualquer valor no intervalo de zero a GetFormatCount( ) – 1.
[out, optional] ppFormat
Especifica um ponteiro para um ponteiro para uma interface IAudioMediaType . É responsabilidade do chamador liberar a interface IAudioMediaType para a qual o parâmetro ppFormat aponta.
Retornar valor
O GetFormat
método retorna S_OK quando a chamada é bem-sucedida. Caso contrário, ele retornará um dos códigos de erro mostrados na tabela a seguir.
Código de retorno | Descrição |
---|---|
|
Ponteiro inválido passado para a função |
|
O buffer de retorno não pode ser alocado |
|
nFormat está fora do intervalo |
Comentários
Quando o sistema de áudio chama o GetFormat
método , o sAPO cria um objeto de tipo de mídia de áudio e retorna uma interface IAudioMediaType . A implementação do sAPO pode usar a função de utilitário CreateAudioMediaType para criar o objeto de tipo de mídia de áudio.
Requisitos
Requisito | Valor |
---|---|
Cliente mínimo com suporte | Disponível no Windows Vista e versões posteriores do Windows. |
Plataforma de Destino | Área de Trabalho |
Cabeçalho | audioenginebaseapo.h (inclua Audioenginebaseapo.h) |
IRQL | Todos os níveis. |