fungsi TSPI_lineGenerateDigits (tspi.h)

Artikel
08/26/2023

Fungsi TSPI_lineGenerateDigits memulai pembuatan digit yang ditentukan pada panggilan yang ditentukan sebagai nada dalam pita menggunakan mode sinyal yang ditentukan. Memanggil fungsi ini saat pembuatan digit atau nada sedang berlangsung membatalkan pembuatan digit atau nada saat ini. Meneruskan nilai NULL untuk lpsDigits tidak menghasilkan digit baru.

Catatan Hanya satu permintaan pembuatan dalam band pada satu waktu (pembuatan nada atau pembuatan digit) yang dapat berlangsung per panggilan.

Sintaks

LONG TSPIAPI TSPI_lineGenerateDigits(
  HDRVCALL hdCall,
  DWORD    dwEndToEndID,
  DWORD    dwDigitMode,
  LPCWSTR  lpszDigits,
  DWORD    dwDuration
);

Parameter

hdCall

Handel ke panggilan tempat pembuatan digit akan dilakukan.

dwEndToEndID

Pengidentifikasi permintaan unik ini harus disimpan oleh penyedia layanan dan diteruskan kembali sebagai dwParam2 ke prosedur LINEEVENT ketika pembuatan digit selesai.

dwDigitMode

Format yang akan digunakan untuk memberi sinyal digit ini. Parameter ini menggunakan satu dan hanya satu konstanta LINEDIGITMODE_.

lpszDigits

Penunjuk ke buffer karakter Unicode yang dihentikan null yang berisi digit yang akan dihasilkan. Koma menyuntikkan penundaan ekstra antara sinyal digit sebelumnya dan berikutnya yang dipisahkannya. Durasi jeda ini ditentukan konfigurasi. Kemampuan perangkat baris menunjukkan durasi ini. Beberapa koma dapat digunakan untuk menyuntikkan jeda yang lebih lama. Digit yang tidak valid diabaikan selama pembuatan, bukan dilaporkan sebagai kesalahan.

dwDuration

Menentukan 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 ke MaxDialParams di LINEDEVCAPS. Jika di luar rentang, nilai aktual ditetapkan oleh penyedia layanan ke nilai terdekat dalam rentang. Parameter ini tidak divalidasi oleh TAPI ketika fungsi ini dipanggil.

Nilai kembali

Mengembalikan nol jika fungsi berhasil atau angka kesalahan jika terjadi kesalahan. Kemungkinan nilai yang dikembalikan adalah sebagai berikut:

LINEERR_INVALCALLHANDLE, LINEERR_NOMEM, LINEERR_INVALCALLSTATE, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALDIGITMODE, LINEERR_OPERATIONFAILED, LINEERR_RESOURCEUNAVAIL, LINEERR_RESOURCEUNAVAIL.

Keterangan

Status panggilan hdCall dapat menjadi status apa pun.

Fungsi TSPI_lineGenerateDigits dianggap telah berhasil diselesaikan ketika pembuatan digit berhasil dimulai; tidak ketika semua digit dihasilkan.

Setelah semua digit dalam lpsDigits dihasilkan, atau setelah pembuatan digit dibatalkan atau dibatalkan, pesan LINE_GENERATE dikirim ke TAPI.

Catatan Hanya satu permintaan pembuatan inband (pembuatan nada atau pembuatan digit) yang diizinkan untuk berlangsung per panggilan. Ini menyiratkan bahwa jika pembuatan digit saat ini sedang berlangsung pada panggilan, memanggil TSPI_lineGenerateDigits atau TSPI_lineGenerateTone membatalkan pembuatan digit. Penyedia layanan harus mengakhiri pembuatan digit apa pun yang sedang berlangsung ketika TSPI_lineGenerateDigits atau TSPI_lineGenerateTone berikutnya dipanggil. Memanggil TSPI_lineGenerateDigits dengan lpszDigits yang diatur ke NULL membatalkan pembuatan digit (atau nada) saat ini.

Fungsi yang sesuai di tingkat TAPI tidak menyertakan parameter formal dwEndToEndID. Pada tingkat tersebut, tidak ada penandaan end-to-end. TAPI menggunakan penandaan end-to-end di tingkat TSPI untuk membedakan satu permintaan TSPI_lineGenerateDigits dari yang lain.