fungsi lineGenerateDigits (tapi.h)

Artikel
03/08/2023

Fungsi lineGenerateDigits memulai pembuatan digit yang ditentukan pada panggilan yang ditentukan sebagai nada inband menggunakan mode sinyal yang ditentukan. Memanggil fungsi ini dengan nilai NULL untuk lpszDigits membatalkan pembuatan digit apa pun yang saat ini sedang berlangsung. Memanggil lineGenerateDigits atau lineGenerateTone saat pembuatan digit sedang berlangsung membatalkan pembuatan digit atau pembuatan nada saat ini dan memulai pembuatan digit atau nada yang terakhir ditentukan.

Sintaks

LONG lineGenerateDigits(
  HCALL  hCall,
  DWORD  dwDigitMode,
  LPCSTR lpszDigits,
  DWORD  dwDuration
);

Parameter

hCall

Tangani panggilan. Aplikasi harus menjadi pemilik panggilan. Status panggilan hCall dapat menjadi status apa pun. TAPI tidak memberlakukan persyaratan callstate apa pun, namun beberapa Penyedia Layanan Tapi mungkin mengharuskan hCall berada dalam status LINECALLSTATE_CONNECTED.

dwDigitMode

Format yang akan digunakan untuk memberi sinyal digit ini. Ketahuilah bahwa dwDigitMode hanya dapat memiliki satu set bendera. Parameter ini menggunakan salah satu konstanta LINEDIGITMODE_.

lpszDigits

Penunjuk ke buffer karakter yang dihentikan null yang berisi digit yang akan dihasilkan. Karakter yang valid adalah karakter yang ditentukan untuk konstanta LINEDIGITMODE_ yang disediakan dalam dwDigitModes.

Selain itu, koma (,) juga merupakan karakter yang valid. Koma menyuntikkan penundaan ekstra antara sinyal digit sebelumnya dan berikutnya yang dipisahkannya. Durasi jeda ini ditentukan konfigurasi, dan kemampuan perangkat garis menunjukkan durasi ini. Beberapa koma dapat digunakan untuk menyuntikkan jeda yang lebih lama. Digit yang tidak valid diabaikan selama pembuatan, daripada dilaporkan sebagai kesalahan.

Tanda seru (!) adalah karakter yang valid. Karakter ini menyebabkan operasi "hookflash", seperti yang dijelaskan untuk alamat yang dapat dialabel.

dwDuration

Baik durasi dalam milidetik digit dan pulsa DTMF dan spasi antar digit DTMF. Nilai 0 menggunakan nilai default. Parameter dwDuration harus berada dalam rentang yang ditentukan oleh MinDialParams dan MaxDialParams di LINEDEVCAPS. Jika di luar rentang, nilai aktual diatur ke nilai terdekat dalam rentang.

Mengembalikan nilai

Mengembalikan nol jika permintaan berhasil atau nomor kesalahan negatif jika terjadi kesalahan. Nilai yang mungkin dikembalikan adalah:

LINEERR_INVALCALLHANDLE, LINEERR_NOTOWNER, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALDIGITMODE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_RESOURCEUNAVAIL, LINEERR_NOMEM, LINEERR_UNINITIALIZED.

Keterangan

Fungsi lineGenerateDigits dianggap telah berhasil diselesaikan ketika pembuatan digit telah berhasil dimulai, bukan ketika semua digit telah dihasilkan. Berbeda dengan lineDial, yang memanggil digit dengan cara yang bergantung pada jaringan, lineGenerateDigits menjamin untuk menghasilkan digit sebagai nada inband melalui saluran suara menggunakan DTMF atau pulsa dial hookswitch saat menggunakan pulsa. Fungsi lineGenerateDigits umumnya tidak cocok untuk melakukan panggilan atau memutar nomor. Ini ditujukan untuk sinyal end-to-end melalui panggilan yang dibuat.

Setelah semua digit dalam lpszDigits dibuat, atau setelah pembuatan digit dibatalkan atau dibatalkan, pesan LINE_GENERATE dikirim ke aplikasi.

Hanya satu permintaan pembuatan inband (pembuatan nada atau pembuatan digit) yang diizinkan untuk sedang berlangsung per panggilan di semua aplikasi yang merupakan pemilik panggilan. Pembuatan digit pada panggilan dibatalkan dengan memulai permintaan pembuatan digit lain atau permintaan pembuatan nada. Untuk membatalkan pembuatan digit saat ini, aplikasi dapat memanggil lineGenerateDigits dan menentukan NULL untuk parameter lpszDigits .

Tergantung pada penyedia layanan dan perangkat keras, aplikasi dapat memantau digit yang dihasilkannya sendiri. Jika itu tidak diinginkan, aplikasi dapat menonaktifkan pemantauan digit saat menghasilkan digit.