The StartDtmfGeneratorTone API procedure is used to start the generation of DTMF sample blocks for a specific DTMF tone. The DTMF generator will call the user supplied call back procedure (that was specified by the CallbackProc parameter of the CreateDtmfGenerator(VoipMediaEngine, VoipMediaEngine..::.DTMF_GENERATOR_CALLBACK_PROC, Object) API procedure) when DTMF generator sample blocks are ready.

Once the application receives DTMF generated sample blocks, it can process them as required by the application.

To stop the generation of DTMF sample blocks at any time, call the StopDtmfGeneratorTone()()() API procedure.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700

Syntax

C#
public bool StartDtmfGeneratorTone(
	VoipMediaEngine..::.DTMF_TONE DtmfTone,
	uint DurationMs
)
Visual Basic (Declaration)
Public Function StartDtmfGeneratorTone ( _
	DtmfTone As VoipMediaEngine..::.DTMF_TONE, _
	DurationMs As UInteger _
) As Boolean
Visual C++
public:
bool StartDtmfGeneratorTone(
	VoipMediaEngine..::.DTMF_TONE DtmfTone, 
	unsigned int DurationMs
)
J#
public boolean StartDtmfGeneratorTone(
	VoipMediaEngine..::.DTMF_TONE DtmfTone,
	UInt32 DurationMs
)

Parameters

DtmfTone
Type: LanScape..::.VoipMediaEngine..::.DTMF_TONE
The DTMF tone to generate. For a complete list of valid DTMF tone, see the VoipMediaEngine..::.DTMF_TONE enumeration.
DurationMs
Type: System..::.UInt32
For continuous tone generation, specify a value of 0xFFFFFFFF. In this case, DTMF tone generation will not turn off until application software calls the StopDtmfGeneratorTone()()() API procedure. For "burst type" DTMF generation, simply specify the duration of the DTMF burst. DTMF generation will continue until the specified amount of DTMF tone data has been generated or until the application calls the StopDtmfGeneratorTone()()() API procedure.

Return Value

If the function succeeds, the return value will non zero.

If the function fails, the return value zero. This can occur if an improper DTMF tone is requested or if a duration of zero milliseconds is specified.

Remarks

None.

See Also