Struktur LINECALLPARAMS (tapi.h)

Artikel
2023-03-08

Struktur LINECALLPARAMS menjelaskan parameter yang disediakan saat melakukan panggilan menggunakan fungsi lineMakeCall dan TSPI_lineMakeCall . Struktur LINECALLPARAMS juga digunakan sebagai parameter dalam operasi lain, seperti fungsi lineOpen .

Komentar di sebelah kanan blok sintaks menunjukkan nilai default yang digunakan ketika struktur ini tidak disediakan untuk lineMakeCall.

Sintaks

typedef struct linecallparams_tag {
  DWORD          dwTotalSize;
  DWORD          dwBearerMode;
  DWORD          dwMinRate;
  DWORD          dwMaxRate;
  DWORD          dwMediaMode;
  DWORD          dwCallParamFlags;
  DWORD          dwAddressMode;
  DWORD          dwAddressID;
  LINEDIALPARAMS DialParams;
  DWORD          dwOrigAddressSize;
  DWORD          dwOrigAddressOffset;
  DWORD          dwDisplayableAddressSize;
  DWORD          dwDisplayableAddressOffset;
  DWORD          dwCalledPartySize;
  DWORD          dwCalledPartyOffset;
  DWORD          dwCommentSize;
  DWORD          dwCommentOffset;
  DWORD          dwUserUserInfoSize;
  DWORD          dwUserUserInfoOffset;
  DWORD          dwHighLevelCompSize;
  DWORD          dwHighLevelCompOffset;
  DWORD          dwLowLevelCompSize;
  DWORD          dwLowLevelCompOffset;
  DWORD          dwDevSpecificSize;
  DWORD          dwDevSpecificOffset;
  DWORD          dwPredictiveAutoTransferStates;
  DWORD          dwTargetAddressSize;
  DWORD          dwTargetAddressOffset;
  DWORD          dwSendingFlowspecSize;
  DWORD          dwSendingFlowspecOffset;
  DWORD          dwReceivingFlowspecSize;
  DWORD          dwReceivingFlowspecOffset;
  DWORD          dwDeviceClassSize;
  DWORD          dwDeviceClassOffset;
  DWORD          dwDeviceConfigSize;
  DWORD          dwDeviceConfigOffset;
  DWORD          dwCallDataSize;
  DWORD          dwCallDataOffset;
  DWORD          dwNoAnswerTimeout;
  DWORD          dwCallingPartyIDSize;
  DWORD          dwCallingPartyIDOffset;
  DWORD          dwAddressType;
} LINECALLPARAMS, *LPLINECALLPARAMS;

Anggota

dwTotalSize

Ukuran total yang dialokasikan untuk struktur data ini, dalam byte. Ukuran ini harus cukup besar untuk menampung semua bagian tetap dan berukuran bervariasi dari struktur data ini.

dwBearerMode

Mode pembawa untuk panggilan. Anggota ini menggunakan salah satu konstanta LINEBEARERMODE_.

Jika dwBearerMode adalah nol, nilai defaultnya adalah LINEBEARERMODE_VOICE.

dwMinRate

Tingkat data minimum yang diminta untuk aliran data panggilan, dalam bps (bit per detik).

dwMaxRate

Tingkat data maksimum yang diminta untuk aliran data panggilan, dalam bps (bit per detik). Saat melakukan panggilan, penyedia layanan mencoba memberikan tarif tertinggi yang tersedia dalam rentang yang diminta (dwMinRate ke dwMaxRate). Jika tingkat data tertentu diperlukan, dwMinRate dan dwMaxRate harus diatur ke nilai tersebut. Jika aplikasi bekerja paling baik dengan satu tingkat tetapi dapat menurun ke tingkat yang lebih rendah, aplikasi harus menentukan ini sebagai tarif maksimum dan minimum. Jika dwMaxRate adalah nol, nilai defaultnya adalah seperti yang ditentukan oleh anggota dwMaxRate dari struktur LINEDEVCAPS . Ini adalah tingkat maksimum yang didukung oleh perangkat.

dwMediaMode

Jenis panggilan media yang diharapkan. Anggota ini menggunakan salah satu konstanta LINEMEDIAMODE_.

Jika dwMediaMode adalah nol, nilai defaultnya adalah LINEMEDIAMODE_INTERACTIVEVOICE.

dwCallParamFlags

Kumpulan parameter penyetelan panggilan Boolean. Anggota ini menggunakan satu atau beberapa konstanta LINECALLPARAMFLAGS_.

dwAddressMode

Mode di mana alamat asal ditentukan. Anggota ini menggunakan salah satu konstanta LINEADDRESSMODE_.

Catatan Anggota dwAddressMode tidak dapat LINEADDRESSMODE_ADDRESSID untuk panggilan fungsi lineOpen . Namun, pembatasan ini tidak berlaku untuk lineMakeCall.

dwAddressID

Pengidentifikasi alamat alamat asal jika dwAddressMode diatur ke LINEADDRESSMODE_ADDRESSID. Pengidentifikasi alamat secara permanen dikaitkan dengan alamat; pengidentifikasi tetap konstan di seluruh peningkatan sistem operasi.

DialParams

Parameter putar nomor yang akan digunakan pada panggilan ini, dari jenis LINEDIALPARAMS. Ketika nilai 0 ditentukan untuk bidang ini, nilai default untuk bidang digunakan seperti yang ditunjukkan dalam anggota DefaultDialParams dari struktur LINEDEVCAPS . Jika nilai bukan nol ditentukan untuk bidang yang berada di luar rentang yang ditentukan oleh bidang terkait di MinDialParams dan MaxDialParams dalam struktur LINEDEVCAPS , nilai terdekat dalam rentang yang valid akan digunakan sebagai gantinya.

dwOrigAddressSize

Ukuran bidang alamat asal, dalam byte.

dwOrigAddressOffset

Offset dari awal struktur ke bidang berukuran varian yang menyimpan alamat asal. Format alamat ini tergantung pada anggota dwAddressMode . Ukuran bidang ditentukan oleh dwOrigAddressSize.

dwDisplayableAddressSize

Ukuran string yang dapat ditampilkan termasuk terminator null , dalam byte.

dwDisplayableAddressOffset

String yang dapat ditampilkan yang digunakan untuk tujuan pengelogan. Konten anggota ini direkam dalam dwDisplayableAddressOffset dan dwDisplayableAddressSize anggota pesan LINECALLINFO panggilan. Fungsi lineTranslateAddress mengembalikan informasi yang sesuai untuk ditempatkan di bidang ini di dwDisplayableAddressSize dan dwDisplayableAddressOffset anggota struktur LINETRANSLATEOUTPUT . Ukuran bidang ditentukan oleh dwDisplayableAddressSize.

dwCalledPartySize

Ukuran informasi pihak yang dipanggil, dalam byte.

dwCalledPartyOffset

Offset dari awal struktur ke bidang berukuran varian yang memegang informasi pihak yang disebut. Informasi ini dapat ditentukan oleh aplikasi yang melakukan panggilan dan tersedia dalam struktur informasi panggilan untuk tujuan pengelogan. Format bidang ini adalah dari dwStringFormat, seperti yang ditentukan dalam LINEDEVCAPS. Ukuran bidang ditentukan oleh dwCalledPartySize.

dwCommentSize

Ukuran bidang komentar panggilan, dalam byte.

dwCommentOffset

Offset dari awal struktur ke bidang berukuran varian yang menyimpan komentar tentang panggilan. Informasi ini dapat ditentukan oleh aplikasi yang melakukan panggilan dan tersedia dalam struktur informasi panggilan untuk tujuan pengelogan. Format bidang ini adalah dari dwStringFormat, seperti yang ditentukan dalam LINEDEVCAPS. Ukuran bidang ditentukan oleh dwCommentSize.

dwUserUserInfoSize

Ukuran informasi pengguna-pengguna termasuk terminator null , dalam byte.

dwUserUserInfoOffset

Offset dari awal struktur ke bidang berukuran varian yang menyimpan informasi pengguna-pengguna. Bidang diskriminator protokol untuk informasi pengguna-pengguna, jika diperlukan, akan muncul sebagai byte pertama dari data yang ditunjukkan oleh dwUserUserInfoOffset, dan harus diperbantukan dalam dwUserUserInfoSize.

dwHighLevelCompSize

Ukuran informasi kompatibilitas tingkat tinggi, dalam byte.

dwHighLevelCompOffset

Offset dari awal struktur ke bidang berukuran varian yang menyimpan informasi kompatibilitas tingkat tinggi. Ukuran bidang ditentukan oleh dwHighLevelCompSize.

dwLowLevelCompSize

Ukuran informasi kompatibilitas tingkat rendah, dalam byte.

dwLowLevelCompOffset

Offset dari awal struktur ke bidang berukuran varian yang menyimpan informasi kompatibilitas tingkat rendah. Ukuran bidang ditentukan oleh dwLowLevelCompSize.

dwDevSpecificSize

Ukuran informasi khusus perangkat, dalam byte.

dwDevSpecificOffset

Offset dari awal struktur ke bidang berukuran varian yang menyimpan informasi khusus perangkat. Ukuran bidang ditentukan oleh dwDevSpecificSize.

dwPredictiveAutoTransferStates

LINECALLSTATE_ konstanta, entri yang menyebabkan panggilan ditransfer secara buta ke alamat target yang ditentukan. Atur ke nol jika transfer otomatis tidak diinginkan.

dwTargetAddressSize

Ukuran string alamat yang dapat dialihkan target termasuk terminator null , dalam byte.

dwTargetAddressOffset

Offset dari awal struktur ke string yang menentukan alamat dialable target (bukan dwAddressID); digunakan dalam kasus tindakan otomatis tertentu. Dalam kasus panggilan prediktif, menentukan alamat panggilan yang akan ditransfer secara otomatis. Ukuran string ditentukan oleh dwTargetAddressSize.

Ini pada dasarnya adalah string yang sama yang akan diteruskan ke lineBlindTransfer jika transfer otomatis tidak digunakan. Atur ke nol jika transfer otomatis tidak diinginkan. Dalam kasus Konferensi Tanpa Penangguhan, menentukan alamat yang harus dihubungi ke panggilan. Dalam kasus Transfer Satu Langkah, menentukan alamat untuk memanggil panggilan konsultasi.

dwSendingFlowspecSize

Ukuran kualitas informasi layanan, dalam byte.

dwSendingFlowspecOffset

Offset dari awal struktur ke struktur FLOWSPEC diikuti oleh data khusus penyedia WinSock, setara dengan apa yang akan disimpan di SendingFlowspec dalam struktur QOS . Menentukan kualitas layanan yang diinginkan dalam arah pengiriman pada panggilan. Bagian khusus penyedia yang mengikuti struktur FLOWSPEC tidak boleh berisi pointer ke blok memori lain, karena TAPI tidak tahu cara membasmi data yang diarahkan oleh pointer privat dan menyampaikannya melalui komunikasi antarproses ke aplikasi. Ukuran bidang ditentukan oleh dwSendingFlowspecSize.

dwReceivingFlowspecSize

Ukuran kualitas informasi layanan, dalam byte.

dwReceivingFlowspecOffset

Offset dari awal struktur ke struktur FLOWSPEC diikuti oleh data khusus penyedia WinSock, setara dengan apa yang akan disimpan di ReceivingFlowspec dalam struktur QOS . Menentukan kualitas layanan yang diinginkan dalam arah penerimaan pada panggilan. Bagian khusus penyedia yang mengikuti struktur FLOWSPEC tidak boleh berisi pointer ke blok memori lain, karena TAPI tidak tahu cara membasmi data yang diarahkan oleh pointer privat dan menyampaikannya melalui komunikasi antarproses ke aplikasi. Ukuran bidang ditentukan oleh dwReceivingFlowspecSize.

dwDeviceClassSize

Ukuran string kelas perangkat termasuk terminator null , dalam byte.

dwDeviceClassOffset

Offset dari awal struktur ke string yang dihentikan null yang menunjukkan kelas perangkat perangkat yang konfigurasinya ditentukan dalam DeviceConfig. String kelas perangkat yang valid sama dengan yang ditentukan untuk fungsi lineGetID . Ukuran string ditentukan oleh dwDeviceClassSize.

dwDeviceConfigSize

Ukuran data konfigurasi perangkat, dalam byte.

dwDeviceConfigOffset

Offset dari awal struktur ke struktur data konfigurasi buram. Nilai ini dikembalikan di anggota dwStringSize dalam struktur VARSTRING yang dikembalikan oleh lineGetDevConfig. Jika ukurannya nol, konfigurasi perangkat default akan digunakan. Ini memungkinkan aplikasi untuk mengatur konfigurasi perangkat sebelum panggilan dimulai. Ukuran bidang ditentukan oleh dwDeviceConfigSize.

dwCallDataSize

Ukuran data panggilan yang dapat diatur aplikasi, dalam byte.

dwCallDataOffset

Offset dari awal struktur ke data panggilan yang dapat diatur aplikasi untuk awalnya dilampirkan ke panggilan. Ukuran bidang ditentukan oleh dwCallDataSize.

dwNoAnswerTimeout

Jumlah detik, setelah selesainya panggilan, bahwa panggilan harus diizinkan untuk menunggu di status PROCEEDING atau RINGBACK, sebelum secara otomatis ditinggalkan oleh penyedia layanan dengan LINECALLSTATE_DISCONNECTED dan LINEDISCONNECTMODE_NOANSWER. Nilai 0 menunjukkan bahwa aplikasi tidak menginginkan pengabaian panggilan otomatis.

dwCallingPartyIDSize

Ukuran string ID pihak panggilan termasuk terminator null , dalam byte, termasuk karakter null-terminating.

dwCallingPartyIDOffset

Offset dari awal struktur ke string yang dihentikan null yang menentukan identitas pihak yang melakukan panggilan. Jika konten pengidentifikasi dapat diterima dan jalur tersedia, penyedia layanan meneruskan pengidentifikasi bersama dengan pihak yang dipanggil untuk menunjukkan identitas pihak pemanggil. Ukuran bidang ditentukan oleh dwCallingPartyIDSize.

dwAddressType

Jenis alamat yang digunakan untuk panggilan. Anggota struktur ini hanya tersedia jika versi TAPI yang dinegosiasikan adalah 3.0 atau lebih tinggi.

Keterangan

Ekstensi khusus perangkat harus menggunakan area berukuran devSpecific (dwDevSpecificSize dan dwDevSpecificOffset) dari struktur data ini.

Struktur ini digunakan sebagai parameter untuk lineMakeCall saat menyiapkan panggilan. Bidangnya memungkinkan aplikasi untuk menentukan kualitas layanan yang diminta dari jaringan serta berbagai parameter penyiapan panggilan ISDN. Jika tidak ada struktur LINECALLPARAMS yang disediakan ke lineMakeCall, panggilan tingkat suara POTS default diminta dengan nilai default yang tercantum di atas.

Catatan Bidang DialParams melalui dwDevSpecificOffset diabaikan ketika parameter lpCallParams ditentukan dengan fungsi lineOpen .

Anggota dwPredictiveAutoTransferStates melalui dwCallingPartyIDOffset hanya tersedia untuk aplikasi yang membuka perangkat baris dengan versi API 2.0 atau yang lebih baru.