Baca dalam bahasa Inggris

Bagikan melalui


API XAudio2

Gambaran umum teknologi API XAudio2.

Untuk mengembangkan API XAudio2, Anda memerlukan header ini:

Untuk panduan pemrograman untuk teknologi ini, lihat:

Kelas

 
CXAPOBase

Implementasi default antarmuka IXAPO.
CXAPOParametersBase

Implementasi default antarmuka IXAPOParameters.

Enumerasi

 
HrtfDirectivityType

Menunjukkan salah satu dari beberapa pola directivitas saham.
HrtfDistanceDecayType

Menunjukkan jenis pembuangkan berbasis jarak yang diterapkan pada suara.
HrtfEnvironment

Menunjukkan salah satu dari beberapa jenis lingkungan stok.
XAPO_BUFFER_FLAGS

Menjelaskan konten buffer stream.
XAUDIO2_FILTER_TYPE

Menunjukkan jenis filter.

Fungsi

 
AddRef

Menambahkan referensi ke objek XAudio2.
BeginProcess

Mengembalikan parameter proses saat ini.
CalcInputFrames

Mengembalikan jumlah bingkai input yang diperlukan untuk menghasilkan jumlah bingkai output yang diberikan.
CalcOutputFrames

Mengembalikan jumlah bingkai output yang akan dihasilkan dari sejumlah bingkai input tertentu.
CommitChanges

Secara atomik menerapkan serangkaian operasi yang ditandai dengan pengidentifikasi tertentu.
CreateFX

Membuat instans efek XAPOFX yang diminta.
CreateHrtfApo

Membuat instans antarmuka IXAPO untuk pemrosesan fungsi transfer terkait kepala (HRTF).
CreateMasteringVoice

Membuat dan mengonfigurasi suara yang menguasai.
CreateSourceVoice

Membuat dan mengonfigurasi suara sumber.
CreateSubmixVoice

Membuat dan mengonfigurasi suara submix.
CXAPOBase

Membuat instans kelas CXAPOBase.
CXAPOParametersBase

Membuat instans kelas CXAPOParametersBase.
DestroyVoice

Menghancurkan suara. Jika perlu, menghentikan suara dan menghapusnya dari grafik XAudio2.
DisableEffect

Menonaktifkan efek pada posisi tertentu dalam rantai efek suara.
Penghentian

Memberi tahu suara XAudio2 bahwa tidak ada lagi buffer yang datang setelah yang terakhir yang saat ini dalam antreannya.
EnableEffect

Memungkinkan efek pada posisi tertentu dalam rantai efek suara.
EndProcess

Memberi tahu CXAPOParametersBase bahwa XAPO telah selesai mengakses parameter proses saat ini.
ExitLoop

Berhenti mengulang suara saat mencapai akhir wilayah perulangan saat ini.
FlushSourceBuffers

Menghapus semua buffer audio yang tertunda dari antrean suara.
GetChannelMask

Mengembalikan masker saluran untuk suara ini.
GetChannelVolumes

Mengembalikan tingkat volume untuk suara, per saluran.
GetEffectParameters

Mengembalikan parameter khusus efek saat ini dari efek tertentu dalam rantai efek suara.
GetEffectState

Mengembalikan status efek yang sedang berjalan pada posisi tertentu dalam rantai efek suara.
GetFilterParameters

Mendapatkan parameter filter suara.
GetFrequencyRatio

Mengembalikan rasio penyesuaian frekuensi suara.
GetOutputFilterParameters

Mengembalikan parameter filter dari salah satu pengiriman suara ini.
GetOutputMatrix

Mendapatkan tingkat volume setiap saluran output akhir untuk suara. Saluran ini dipetakan ke saluran input dari suara tujuan tertentu.
GetParameters

Mendapatkan nilai saat ini untuk parameter khusus efek apa pun.
GetPerformanceData

Mengembalikan detail penggunaan sumber daya saat ini, seperti memori atau penggunaan CPU yang tersedia.
GetRegistrationProperties

Mengembalikan properti pendaftaran XAPO.
GetRegistrationPropertiesInternal

Mengembalikan pointer ke struktur XAPO_REGISTRATION_PROPERTIES yang berisi properti pendaftaran yang dibuat dengan XAPO.
GetState

Mengembalikan data posisi kursor suara saat ini.
GetVoiceDetails

Mengembalikan informasi tentang bendera pembuatan, saluran input, dan laju sampel suara.
GetVolume

Mendapatkan tingkat volume suara keseluruhan saat ini.
Initialize

Melakukan inisialisasi khusus efek apa pun.
IsInputFormatSupported

Kueri jika format input tertentu didukung untuk format output tertentu.
Diblokir

Mengkueri apakah XAPO dikunci.
IsOutputFormatSupported

Kueri jika format output tertentu didukung untuk format input tertentu.
LockForProcess

Dipanggil oleh XAudio2 untuk mengunci konfigurasi input dan output XAPO yang memungkinkannya melakukan inisialisasi akhir sebelum Proses dipanggil pada utas realtime.
OnBufferEnd

Dipanggil ketika suara selesai memproses buffer.
Mulai Cepat OnBuffer

Dipanggil saat suara akan mulai memproses buffer audio baru.
OnCriticalError

Dipanggil jika terjadi kesalahan sistem penting yang mengharuskan XAudio2 ditutup dan dimulai ulang.
OnLoopEnd

Dipanggil ketika suara mencapai posisi akhir perulangan.
OnProcessingPassEnd

Dipanggil oleh XAudio2 tepat setelah pass pemrosesan audio berakhir.
OnProcessingPassStart

Dipanggil oleh XAudio2 tepat sebelum pass pemrosesan audio dimulai.
OnSetParameters

Dipanggil oleh IXAPOParameters::SetParameters untuk memungkinkan validasi parameter yang ditentukan pengguna.
OnStreamEnd

Dipanggil ketika suara baru saja selesai memutar aliran audio yang berdampingan.
OnVoiceError

Dipanggil ketika kesalahan kritis terjadi selama pemrosesan suara.
OnVoiceProcessingPassEnd

Dipanggil tepat setelah pass pemrosesan untuk suara berakhir.
OnVoiceProcessingPassStart

Dipanggil selama setiap pass pemrosesan untuk setiap suara, tepat sebelum XAudio2 membaca data dari antrean buffer suara.
ParametersChanged

Menunjukkan apakah IXAPOParameters::SetParameters telah dipanggil sejak lulus pemrosesan terakhir.
Proses

Menjalankan kode pemrosesan sinyal digital (DSP) XAPO pada buffer input dan output yang diberikan.
ProcessThru

Dipanggil oleh implementasi IXAPO::P rocess ketika XAPO dinonaktifkan untuk pemrosesan thru.
QueryInterface

Kueri untuk antarmuka COM tertentu pada objek XAudio2.
RegisterForCallbacks

Menambahkan penunjuk IXAudio2EngineCallback ke daftar panggilan balik mesin XAudio2.
Rilis

Merilis referensi ke objek XAudio2.
Atur ulang

Mengatur ulang variabel tergantung pada riwayat bingkai.
ReverbConvertI3DL2ToNative

Fungsi sebaris yang mengonversi parameter I3DL2 (Interactive 3D Audio Rendering Guidelines Level 2.0) ke parameter XAudio2 asli.
SetChannelVolumes

Mengatur tingkat volume untuk suara, per saluran.
SetDebugConfiguration

Mengubah opsi pengelogan debug global untuk XAudio2.
SetEffectChain

Menggantikan rantai efek suara.
SetEffectParameters

Mengatur parameter untuk efek tertentu dalam rantai efek suara.
SetEnvironment

Memilih lingkungan akustik untuk disimulasikan.
SetFilterParameters

Mengatur parameter filter suara.
SetFrequencyRatio

Mengatur rasio penyesuaian frekuensi suara.
SetOutputFilterParameters

Mengatur parameter filter pada salah satu kiriman suara ini.
SetOutputMatrix

Mengatur tingkat volume setiap saluran output akhir untuk suara. Saluran ini dipetakan ke saluran input dari suara tujuan tertentu.
SetOutputVoices

Menunjuk sekumpulan submix baru atau suara yang menguasai untuk menerima output suara.
SetParameters

Mengatur parameter khusus efek.
SetSourceGain

Mengatur nilai perolehan jalur langsung kustom untuk posisi sumber saat ini. Hanya berlaku untuk suara yang dimainkan dengan jenis pembusukan kustom HrtfDistanceDecayType.
SetSourceOrientation

Atur matriks rotasi untuk orientasi sumber, sehubungan dengan sistem koordinat pendengar.
SetSourcePosition

Mengatur posisi suara relatif terhadap pendengar.
SetSourceSampleRate

Mengonfigurasi ulang suara untuk mengonsumsi data sumber pada laju sampel yang berbeda dari laju yang ditentukan saat suara dibuat.
SetVolume

Mengatur tingkat volume keseluruhan untuk suara.
Mulai

Memulai konsumsi dan pemrosesan audio dengan suara. Memberikan hasilnya ke submix atau suara master yang terhubung, atau ke perangkat output.
StartEngine

Memulai utas pemrosesan audio.
Stop

Menghentikan konsumsi audio oleh suara saat ini.
StopEngine

Menghentikan utas pemrosesan audio.
SubmitSourceBuffer

Menambahkan buffer audio baru ke antrean suara.
UnlockForProcess

Membatalkan alokasi variabel yang dialokasikan dengan metode LockForProcess.
UnregisterForCallbacks

Menghapus pointer IXAudio2EngineCallback dari daftar panggilan balik mesin XAudio2.
ValidateFormatDefault

Memverifikasi bahwa format audio termasuk dalam rentang default yang didukung.
ValidateFormatPair

Memverifikasi bahwa konfigurasi pasangan format input dan output didukung oleh XAPO.
X3DAudioCalculate

Menghitung pengaturan DSP sehubungan dengan parameter 3D.
X3DAudioInitialize

Mengatur semua konstanta audio 3D global.
XAPOAlloc

Makro alokasi memori yang digunakan oleh metode IXAPO yang harus mengalokasikan struktur berukuran arbitrer yang kemudian dikembalikan ke aplikasi.
XAPOFree

Makro yang digunakan untuk mengosongkan memori yang dialokasikan dengan makro XAPOAlloc.
XAudio2AmplitudeRatioToDecibels

Fungsi sebaris yang mengonversi nilai rasio amplitude menjadi nilai desibel.
XAudio2Buat

Membuat objek XAudio2 baru dan mengembalikan penunjuk ke antarmuka IXAudio2-nya.
XAudio2CreateReverb

Membuat objek pemrosesan audio gaung baru (APO), dan mengembalikan penunjuk ke objek tersebut.
XAudio2CreateVolumeMeter

Membuat objek pemrosesan audio meter volume baru (APO) dan mengembalikan penunjuk ke objek tersebut.
XAudio2CutoffFrequencyToOnePoleCoefficient

Fungsi sebaris yang mengonversi dari frekuensi cutoff filter yang dinyatakan dalam hertz ke koefisien filter yang digunakan dengan anggota Frekuensi struktur XAUDIO2_FILTER_PARAMETERS.
XAudio2CutoffFrequencyToRadians

Fungsi sebaris yang mengonversi dari frekuensi cutoff filter yang dinyatakan dalam hertz ke nilai frekuensi radian yang digunakan dalam anggota Frekuensi dari struktur XAUDIO2_FILTER_PARAMETERS.
XAudio2DecibelsToAmplitudeRatio

Fungsi sebaris yang mengonversi nilai desibel menjadi nilai rasio amplitude.
XAudio2FrequencyRatioToSemitones

Fungsi sebaris yang mengonversi nilai rasio frekuensi menjadi nilai semitone.
XAudio2RadiansToCutoffFrequency

Fungsi sebaris yang mengonversi dari frekuensi radian yang digunakan dalam XAUDIO2_FILTER_PARAMETERS kembali ke frekuensi absolut dalam hertz.
XAudio2SemitonesToFrequencyRatio

Fungsi sebaris yang mengonversi nilai semitone menjadi nilai rasio frekuensi.

Antarmuka

 
IXAPO

Antarmuka untuk Objek Pemrosesan Audio yang digunakan dalam rantai efek XAudio2.
IXAPOHrtfParameters

Antarmuka yang digunakan untuk mengatur parameter yang mengontrol bagaimana fungsi transfer terkait kepala (HRTF) diterapkan ke suara.
IXAPOParameters

Antarmuka opsional yang memungkinkan XAPO menggunakan parameter khusus efek.
IXAudio2

IXAudio2 adalah antarmuka untuk objek XAudio2 yang mengelola semua status mesin audio, utas pemrosesan audio, grafik suara, dan sebagainya.
IXAudio2EngineCallback

Antarmuka IXAudio2EngineCallback berisi metode yang memberi tahu klien ketika peristiwa tertentu terjadi di mesin IXAudio2.
IXAudio2MasteringVoice

Suara master digunakan untuk mewakili perangkat output audio.
IXAudio2SourceVoice

Gunakan suara sumber untuk mengirimkan data audio ke alur pemrosesan XAudio2.
IXAudio2SubmixVoice

Suara submix digunakan terutama untuk peningkatan performa dan pemrosesan efek.
IXAudio2Voice

IXAudio2Voice mewakili antarmuka dasar tempat IXAudio2SourceVoice, IXAudio2SubmixVoice dan IXAudio2MasteringVoice diturunkan. Metode yang tercantum di bawah ini umum untuk semua subkelas suara.
IXAudio2VoiceCallback

Antarmuka IXAudio2VoiceCallback berisi metode yang memberi tahu klien ketika peristiwa tertentu terjadi di IXAudio2SourceVoice tertentu.

Struktur

 
FXECHO_INITDATA

Parameter inisialisasi untuk digunakan dengan FXECHO XAPOFX.
FXECHO_PARAMETERS

Parameter untuk digunakan dengan FXECHO XAPOFX.
FXEQ_PARAMETERS

Parameter untuk digunakan dengan FXEQ XAPO.
FXMASTERINGLIMITER_PARAMETERS

Parameter untuk digunakan dengan FXMasteringLimiter XAPO.
FXREVERB_PARAMETERS

Parameter untuk digunakan dengan FXReverb XAPO.
HrtfApoInit

Menentukan parameter yang digunakan untuk menginisialisasi audio spasial HRTF.
HrtfDirectivity

Deskriptor pola directivitas dasar. Menjelaskan jenis directivitas yang diterapkan pada suara.
HrtfDirectivityCardioid

Menjelaskan pola directivitas kardioid.
HrtfDirectivityCone

Menjelaskan directivitas kerucut.
HrtfDistanceDecay

Menjelaskan perilaku pembatas berbasis jarak.
HrtfOrientation

Menunjukkan orientasi objek directivitas HRTF.
HrtfPosition

Mewakili posisi dalam ruang 3D, menggunakan sistem koordinat dengan tangan kanan.
X3DAUDIO_CONE

Menentukan arah untuk pemancar non-LFE satu saluran dengan menskalakan perilaku DSP sehubungan dengan orientasi pemancar.
X3DAUDIO_DISTANCE_CURVE

Mendefinisikan kurva sepotong eksplisit yang terdiri dari segmen linier, langsung mendefinisikan perilaku DSP sehubungan dengan jarak yang dinormalisasi.
X3DAUDIO_DISTANCE_CURVE_POINT

Menentukan pengaturan DSP pada jarak yang dinormalisasi tertentu.
X3DAUDIO_DSP_SETTINGS

Menerima hasil dari panggilan ke X3DAudioCalculate.
X3DAUDIO_EMITTER

Menentukan sumber audio 3D satu titik atau beberapa titik yang digunakan dengan jumlah saluran suara arbitrer.
X3DAUDIO_LISTENER

Mendefinisikan titik penerimaan audio 3D.
XAPO_LOCKFORPROCESS_PARAMETERS

Menentukan parameter buffer aliran yang tetap konstan saat XAPO dikunci. Digunakan dengan metode IXAPO::LockForProcess.
XAPO_PROCESS_BUFFER_PARAMETERS

Menentukan parameter buffer aliran yang dapat berubah dari satu panggilan ke panggilan berikutnya. Digunakan dengan metode Proses.
XAPO_REGISTRATION_PROPERTIES

Menjelaskan karakteristik umum XAPO. Digunakan dengan IXAPO::GetRegistrationProperties, CXAPOParametersBase::CXAPOParametersBase, dan CXAPOBase::CXAPOBase.
XAUDIO2_BUFFER

Mewakili buffer data audio, digunakan dengan IXAudio2SourceVoice::SubmitSourceBuffer.
XAUDIO2_BUFFER_WMA

Digunakan dengan IXAudio2SourceVoice::SubmitSourceBuffer saat mengirimkan data xWMA.
XAUDIO2_DEBUG_CONFIGURATION

Berisi konfigurasi debug global baru untuk XAudio2. Digunakan dengan fungsi SetDebugConfiguration.
XAUDIO2_EFFECT_CHAIN

Mendefinisikan rantai efek.
XAUDIO2_EFFECT_DESCRIPTOR

Berisi informasi tentang XAPO untuk digunakan dalam rantai efek.
XAUDIO2_FILTER_PARAMETERS

Menentukan parameter filter untuk suara sumber.
XAUDIO2_PERFORMANCE_DATA

Berisi informasi performa. (XAUDIO2_PERFORMANCE_DATA)
XAUDIO2_SEND_DESCRIPTOR

Menentukan suara tujuan yang merupakan target pengiriman dari suara lain dan menentukan apakah filter harus digunakan.
XAUDIO2_VOICE_DETAILS

Berisi informasi tentang bendera pembuatan, saluran input, dan laju sampel suara.
XAUDIO2_VOICE_SENDS

Menentukan sekumpulan suara untuk menerima data dari satu suara output.
XAUDIO2_VOICE_STATE

Mengembalikan data status suara dan posisi kursor saat ini.
XAUDIO2FX_REVERB_I3DL2_PARAMETERS

Menjelaskan parameter I3DL2 (Interactive 3D Audio Rendering Guidelines Level 2.0) untuk digunakan dalam fungsi ReverbConvertI3DL2ToNative.
XAUDIO2FX_REVERB_PARAMETERS

Menjelaskan parameter untuk digunakan dalam APO reverb.
XAUDIO2FX_VOLUMEMETER_LEVELS

Menjelaskan parameter untuk digunakan dengan APO meter volume.