The SetTxIvrDataType API procedure allows the user application to specify the format and rate of the data it will send directly to the phone line.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetTxIvrDataType(
	VoipMediaEngine..::.AUDIO_BANDWIDTH TransmitIvrDataType
)
Visual Basic (Declaration)
Public Function SetTxIvrDataType ( _
	TransmitIvrDataType As VoipMediaEngine..::.AUDIO_BANDWIDTH _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetTxIvrDataType(
	VoipMediaEngine..::.AUDIO_BANDWIDTH TransmitIvrDataType
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetTxIvrDataType(
	VoipMediaEngine..::.AUDIO_BANDWIDTH TransmitIvrDataType
)

Parameters

TransmitIvrDataType
Type: LanScape..::.VoipMediaEngine..::.AUDIO_BANDWIDTH
Specifies the data type (format/rate) the application will send to the transmit IVR interface.
Caution:
This parameter can specify one of the VoipMediaEngine..::.AUDIO_BANDWIDTH 20Ms data types except for Speex. Also, do not specify a 30Ms data type.

Return Value

If the function succeeds, the return value will be SipSuccess.

If the function fails, the return value will be one of the following values as specified by the VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type.

Return ValueDescription
SipCallFailure
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.

(API return value)

SipInvalidHandle
Application software specified an invalid telephony handle in one of the API procedures. This usually indicates memory corruption on the part of application software.

(API return value)

SipBadAudioDataType
Indicates that application software attempted to specify an invalid IVR or Audio Output media data type when calling the OpenRxIvrChannel(VoipMediaEngine, Int32, VoipMediaEngine..::.IVRCALLBACKPROC, Object, Boolean, VoipMediaEngine..::.AUDIO_BANDWIDTH, Int32%, Int32%, Boolean%), SetTxIvrDataType(VoipMediaEngine..::.AUDIO_BANDWIDTH), GetTxIvrSampleBlockSize(VoipMediaEngine..::.AUDIO_BANDWIDTH, Int32%, Int32%, Boolean%), or the SetAudioOutDataType(VoipMediaEngine..::.AUDIO_BANDWIDTH) API procedures. Make sure you specify the appropriate VoipMediaEngine..::.AUDIO_BANDWIDTH parameter when calling these API procedures.

(API return value)

Remarks

None.

See Also