Prosody ADSI library: API: sm_play_vmwi_fsk

Prototype Definition

int sm_play_vmwi_fsk(struct sm_play_vmwi_fsk *parms)

Parameters

a structure of the following type:

typedef struct sm_play_vmwi_fsk {
	tSMChannelId channel;					/* in */
	tSM_INT do_on_hook;					/* in */
	tSM_INT is_sdmf_message;				/* in */
	tSM_INT is_indicator_on_message;			/* in */
} SM_PLAY_VMWI_FSK;

Description

This function generates a Visual Message Waiting Indicator (VMWI) message. The message is sent in an FSK transmission at 1200 bits per second, using 1200 Hz for mark, 2200 Hz for space, and a power level of -13dBm0.

This function is intended to be used immediately after sm_play_sas_cas() has sent the SAS and CAS portion of the message.

Since this function uses the standard Prosody data communications API to generate the signal, the end of the signal is reported by smdc_line_status() which can be monitored by waiting on the write event.

This function requires the firmware modules asytx, fsktx, outchan, and prefsuf to have been downloaded.

Fields

channel: The channel on which to generate the signal.
do_on_hook: Selects on-hook (non-zero) or off-hook (zero) transmission format. The on-hook format starts with a channel seizure signal (300 bits of 0101...01) and 180 mark bits (11...1), whereas the off-hook format starts with only 80 mark bits.
is_sdmf_message: Selects Single Data Message Format - SDMF - (non-zero) or Multiple Data Message Format - MDMF - (zero).
is_indicator_on_message: Selects whether to generate an indicator-on message (non-zero), or an indicator-off message (zero).

Returns

0 if call completed successfully, otherwise a standard error such as:

ERR_SM_DEVERR - device error

This function is part of the Prosody ADSI library API.