IAudioSystemEffectsCustomFormats::Metode GetFormat (audioenginebaseapo.h)

Artikel
02/26/2024

Metode ini GetFormat mengambil representasi IAudioMediaType dari format kustom.

Sintaks

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

Parameter

[in] nFormat

Menentukan indeks format yang didukung. Parameter ini dapat berupa nilai apa pun dalam rentang dari nol hingga satu kurang dari nilai yang dikembalikan getFormatCount. Dengan kata lain, nilai apa pun dalam rentang dari nol hingga GetFormatCount( ) - 1.

[out, optional] ppFormat

Menentukan penunjuk ke penunjuk ke antarmuka IAudioMediaType . Adalah tanggung jawab pemanggil untuk merilis antarmuka IAudioMediaType yang menjadi titik parameter ppFormat .

Menampilkan nilai

Metode GetFormat mengembalikan S_OK ketika panggilan berhasil. Jika tidak, kode kesalahan akan menampilkan salah satu kode kesalahan yang diperlihatkan dalam tabel berikut.

Menampilkan kode	Deskripsi
E_POINTER	Penunjuk tidak valid diteruskan ke fungsi
E_OUTOFMEMORY	Buffer pengembalian tidak dapat dialokasikan
E_INVALIDARG	nFormat di luar rentang

Keterangan

Saat sistem audio memanggil GetFormat metode , sAPO membuat objek jenis media audio dan mengembalikan antarmuka IAudioMediaType . Implementasi sAPO dapat menggunakan fungsi utilitas CreateAudioMediaType untuk membuat objek jenis media audio.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia di Windows Vista dan versi Windows yang lebih baru.
Target Platform	Desktop
Header	audioenginebaseapo.h (termasuk Audioenginebaseapo.h)
IRQL	Semua tingkatan.

Lihat juga

CreateAudioMediaType

GetFormatCount

IAudioMediaType

Bagikan melalui