Método IAMStreamConfig::GetFormat (strmif.h)

[O recurso associado a esta página, DirectShow, é um recurso herdado. Ele foi substituído por MediaPlayer, IMFMediaEngine e Captura de Áudio/Vídeo na Media Foundation. Esses recursos foram otimizados para Windows 10 e Windows 11. A Microsoft recomenda fortemente que o novo código use MediaPlayer, IMFMediaEngine e Captura de Áudio/Vídeo no Media Foundation em vez de DirectShow, quando possível. A Microsoft sugere que o código existente que usa as APIs herdadas seja reescrito para usar as novas APIs, se possível.]

O GetFormat método recupera o formato de saída atual ou preferencial.

Sintaxe

HRESULT GetFormat(
  [out] AM_MEDIA_TYPE **ppmt
);

Parâmetros

[out] ppmt

Endereço de um ponteiro para uma estrutura AM_MEDIA_TYPE .

Retornar valor

Retorna um valor HRESULT . Os possíveis valores incluem os seguintes.

Código de retorno Descrição
S_OK
Êxito.
E_OUTOFMEMORY
Memória insuficiente.
E_POINTER
Valor do ponteiro NULL .
VFW_E_NOT_CONNECTED
O pino de entrada não está conectado.

Comentários

Se o pino estiver conectado, esse método retornará o formato que o pino está usando no momento. Caso contrário, o método retorna o formato preferencial do pino para a próxima conexão de pino. Se você já tiver chamado o método IAMStreamConfig::SetFormat para definir o formato, GetFormat retornará o mesmo formato. Caso contrário, ele retorna o primeiro formato na lista de formatos preferenciais do pin, conforme determinado pelo método IPin::EnumMediaTypes .

O método aloca a memória para a estrutura AM_MEDIA_TYPE , preenche a estrutura e a retorna no parâmetro pmt . O chamador deve liberar a memória, incluindo o bloco de formato. Você pode usar a função auxiliar DeleteMediaType na biblioteca de classes base.

Em alguns filtros de compactação, o método falhará se o pin de entrada do filtro não estiver conectado.

Exemplos

C++
IAMStreamConfig *pConfig = NULL;
// Query the output pin for IAMStreamConfig (not shown).
AM_MEDIA_TYPE *pmt = NULL;
hr = pConfig->GetFormat(&pmt);
if (SUCCEEDED(hr))
{
    /* Examine the media type for any information you need. */
    DeleteMediaType(pmt);
}
pConfig->Release();

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho strmif.h (inclua Dshow.h)
Biblioteca Strmiids.lib

Confira também

Códigos de erro e êxito

IAMStreamConfig Interface