The FormatRateConvert API procedure is used to convert the source audio data block type to the destination audio data block type. All format and rate conversions are handled by this API procedure. No other API procedure calls are required to transform audio data from one form to another.

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

Syntax

C#
public VoipMediaEngine..::.FORMAT_RATE_STATUS FormatRateConvert(
	byte[] Src,
	byte[] Dest,
	ref int BytesConverted
)
Visual Basic (Declaration)
Public Function FormatRateConvert ( _
	Src As Byte(), _
	Dest As Byte(), _
	ByRef BytesConverted As Integer _
) As VoipMediaEngine..::.FORMAT_RATE_STATUS
Visual C++
public:
VoipMediaEngine..::.FORMAT_RATE_STATUS FormatRateConvert(
	array<unsigned char>^ Src, 
	array<unsigned char>^ Dest, 
	int% BytesConverted
)
J#
public VoipMediaEngine..::.FORMAT_RATE_STATUS FormatRateConvert(
	byte[] Src,
	byte[] Dest,
	/** @ref */int BytesConverted
)

Parameters

Src
Type: array< System..::.Byte >[]()[]
The sample data block containing the source samples.
Dest
Type: array< System..::.Byte >[]()[]
The sample data block that will contain the converted destination samples.
BytesConverted
Type: System..::.Int32 %
A reference to a variable that will hold the returned number of destination bytes converted. This is the number of sample bytes in the destination buffer.

Return Value

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

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

Return ValueDescription
FORMAT_RATE_UNKNOWN_ERROR
A "catch all" error return value.
FORMAT_RATE_BAD_HANDLE
Bad format/rate converter handle specified.

Remarks

None.

See Also