Método IAudioSystemEffectsCustomFormats::GetFormat (audioenginebaseapo.h)

El GetFormat método recupera una representación IAudioMediaType de un formato personalizado.

Sintaxis

HRESULT GetFormat(
  [in]            UINT            nFormat,
  [out, optional] IAudioMediaType **ppFormat
);

Parámetros

[in] nFormat

Especifica el índice de un formato admitido. Este parámetro puede ser cualquier valor del intervalo de cero a uno menor que el valor devuelto de GetFormatCount. Es decir, cualquier valor del intervalo de cero a GetFormatCount( ) - 1.

[out, optional] ppFormat

Especifica un puntero a un puntero a una interfaz IAudioMediaType . Es responsabilidad del autor de la llamada liberar la interfaz IAudioMediaType a la que apunta el parámetro ppFormat .

Valor devuelto

El GetFormat método devuelve S_OK cuando la llamada se realiza correctamente. De lo contrario, devuelve uno de los códigos de error que se muestran en la tabla siguiente.

Código devuelto	Descripción
E_POINTER	Puntero no válido pasado a la función
E_OUTOFMEMORY	No se puede asignar el búfer de devolución
E_INVALIDARG	nFormat está fuera del intervalo

Comentarios

Cuando el sistema de audio llama al GetFormat método , el sAPO crea un objeto de tipo multimedia de audio y devuelve una interfaz IAudioMediaType . La implementación de sAPO puede usar la función de utilidad CreateAudioMediaType para crear el objeto de tipo de medio de audio.

Requisitos

Requisito	Value
Cliente mínimo compatible	Disponible en Windows Vista y versiones posteriores de Windows.
Plataforma de destino	Escritorio
Encabezado	audioenginebaseapo.h (incluya Audioenginebaseapo.h)
IRQL	Todos los niveles.

Consulte también

CreateAudioMediaType

GetFormatCount

IAudioMediaType