Metodo IAudioSystemEffectsCustomFormats::GetFormat (audioenginebaseapo.h)

Il GetFormat metodo recupera una rappresentazione IAudioMediaType di un formato personalizzato.

Sintassi

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

Parametri

[in] nFormat

Specifica l'indice di un formato supportato. Questo parametro può essere qualsiasi valore nell'intervallo da zero a uno minore del valore restituito di GetFormatCount. In altre parole, qualsiasi valore nell'intervallo da zero a GetFormatCount( ) - 1.

[out, optional] ppFormat

Specifica un puntatore a un puntatore a un'interfaccia IAudioMediaType . È responsabilità del chiamante rilasciare l'interfaccia IAudioMediaType a cui punta il parametro ppFormat .

Valore restituito

Il GetFormat metodo restituisce S_OK quando la chiamata ha esito positivo. In caso contrario, restituisce uno dei codici di errore illustrati nella tabella seguente.

Codice restituito	Descrizione
E_POINTER	Puntatore non valido passato alla funzione
E_OUTOFMEMORY	Impossibile allocare il buffer restituito
E_INVALIDARG	nFormat non è compreso nell'intervallo

Commenti

Quando il sistema audio chiama il GetFormat metodo, sAPO crea un oggetto tipo di supporto audio e restituisce un'interfaccia IAudioMediaType . L'implementazione sAPO può usare la funzione di utilità CreateAudioMediaType per creare l'oggetto tipo di supporto audio.

Requisiti

Requisito	Valore
Client minimo supportato	Disponibile in Windows Vista e versioni successive di Windows.
Piattaforma di destinazione	Desktop
Intestazione	audioenginebaseapo.h (includere Audioenginebaseapo.h)
IRQL	Tutti i livelli.

Vedi anche

CreateAudioMediaType

GetFormatCount

IAudioMediaType