The StopPhoneLineRecording procedure allows application software to stop phone line recording. The media engine will stop sending recorded sample blocks to the application (if applicable) and close the record sample file (if applicable).

If the application specified that the wave file format is to be used for recorded phone line audio, the wave file will be created when this API procedure is called. Until this API procedure is called, all recorded audio resides in a data file using raw PCM samples. The wave file will also be created as soon as the call terminates.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE StopPhoneLineRecording(
	int PhoneLine
)
Visual Basic (Declaration)
Public Function StopPhoneLineRecording ( _
	PhoneLine As Integer _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE StopPhoneLineRecording(
	int PhoneLine
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE StopPhoneLineRecording(
	int PhoneLine
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line that will have call recording enabled.

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)

SipBadPhoneLine
Application software called a telephony API procedure and specified an invalid phone line. Phone lines are numbered starting from zero. This error is most commonly returned when attempting to access phone lines in excess of the max number of lines supported by the telephony engine.

(API return value)

SipCallRecordNotEnabled
The media engine must be instantiated with call recording enabled before application software can call any of the phone line record API procedures. See the EnablePhoneLineRecording value of the VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS structure.

(API return value)

SipCallRecordAlreadyStopped
Application software called the StopPhoneLineRecording(Int32) API procedure and call recording was already stopped.

(API return value)

Remarks

None.

See Also