The GetAudioOutSampleBlockSize API procedure is used by application software to determine the sample block size the audio output requires.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetAudioOutSampleBlockSize(
	ref int SamplesPerAudioOutBuffer,
	ref int BytesPerAudioOutBuffer,
	ref bool SamplesInByteArray
)
Visual Basic (Declaration)
Public Function GetAudioOutSampleBlockSize ( _
	ByRef SamplesPerAudioOutBuffer As Integer, _
	ByRef BytesPerAudioOutBuffer As Integer, _
	ByRef SamplesInByteArray As Boolean _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetAudioOutSampleBlockSize(
	int% SamplesPerAudioOutBuffer, 
	int% BytesPerAudioOutBuffer, 
	bool% SamplesInByteArray
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetAudioOutSampleBlockSize(
	/** @ref */int SamplesPerAudioOutBuffer,
	/** @ref */int BytesPerAudioOutBuffer,
	/** @ref */boolean SamplesInByteArray
)

Parameters

SamplesPerAudioOutBuffer
Type: System..::.Int32 %
A reference to an integer variable that will receive the number of samples per audio output block.
BytesPerAudioOutBuffer
Type: System..::.Int32 %
A reference to an integer variable that will receive the number of bytes per audio output block.
SamplesInByteArray
Type: System..::.Boolean %
A reference to an bool variable that indicates that the audio out samples use byte (8 bit) or short (16 bit) samples.

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)

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

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)

SipNoAudioOutType
The application attempted to obtain the audio output sample block size by calling the GetAudioOutSampleBlockSize(Int32%, Int32%, Boolean%) API procedure. Before calling the GetAudioOutSampleBlockSize(Int32%, Int32%, Boolean%) API procedure, you must first set the data type for the specified audio output line by calling the SetAudioOutDataType(VoipMediaEngine..::.AUDIO_BANDWIDTH) API procedure.

(API return value)

Remarks

None.

See Also