The GetTxIvrSampleBlockSize API procedure is used by application software to determine the transmit sample block size the phone line requires.

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


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetTxIvrSampleBlockSize(
	VoipMediaEngine..::.AUDIO_BANDWIDTH TransmitIvrDataType,
	ref int SamplesPerIvrBuffer,
	ref int BytesPerIvrBuffer,
	ref bool SamplesInByteArray
Visual Basic (Declaration)
Public Function GetTxIvrSampleBlockSize ( _
	TransmitIvrDataType As VoipMediaEngine..::.AUDIO_BANDWIDTH, _
	ByRef SamplesPerIvrBuffer As Integer, _
	ByRef BytesPerIvrBuffer As Integer, _
	ByRef SamplesInByteArray As Boolean _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetTxIvrSampleBlockSize(
	VoipMediaEngine..::.AUDIO_BANDWIDTH TransmitIvrDataType, 
	int% SamplesPerIvrBuffer, 
	int% BytesPerIvrBuffer, 
	bool% SamplesInByteArray
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetTxIvrSampleBlockSize(
	VoipMediaEngine..::.AUDIO_BANDWIDTH TransmitIvrDataType,
	/** @ref */int SamplesPerIvrBuffer,
	/** @ref */int BytesPerIvrBuffer,
	/** @ref */boolean SamplesInByteArray


Type: LanScape..::.VoipMediaEngine..::.AUDIO_BANDWIDTH
The audio data type the transmit IVR output has been configured to use. This value should be the same as that specified in the call to the SetTxIvrDataType(VoipMediaEngine..::.AUDIO_BANDWIDTH) API procedure.
This parameter can specify one of the VoipMediaEngine..::.AUDIO_BANDWIDTH 20Ms data types except for Speex. Also, do not specify a 30Ms data type.
Type: System..::.Int32 %
A reference to an integer variable that will receive the number of samples per block.
Type: System..::.Int32 %
A reference to an integer variable that will receive the number of bytes per block.
Type: System..::.Boolean %
This parameter will allow application software to easily determine if the media engine is expecting Tx IVR sample block data to be in the form of a byte (8 bit) element buffer or a short (16 bit) element buffer.

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
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)

One of the telephony API procedures was called by application software and was passed a pointer to an invalid memory address. Normally this error will occur when application software passes NULL pointer values to the telephony API. For managed code applications, you should never see this error unless your process space has exhausted memory.

(API return value)

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)

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)



See Also