The OpenAudioOutChannel API procedure is the first API procedure that must be called before attempting to stream user defined audio data to the telephony engine for playback.

Audio outputs can only be opened once. That is, calling this API procedure more than one time per audio output will result in an error.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE OpenAudioOutChannel(
	VoipMediaEngine MediaEngine,
	int AudioOutLine
)
Visual Basic (Declaration)
Public Function OpenAudioOutChannel ( _
	MediaEngine As VoipMediaEngine, _
	AudioOutLine As Integer _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE OpenAudioOutChannel(
	VoipMediaEngine^ MediaEngine, 
	int AudioOutLine
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE OpenAudioOutChannel(
	VoipMediaEngine MediaEngine,
	int AudioOutLine
)

Parameters

MediaEngine
Type: LanScape..::.VoipMediaEngine
An instance of the media engine.
AudioOutLine
Type: System..::.Int32
The zero based audio output line to access. At the present time, a maximum of 8 audio outputs are available. Therefore valid audio out line numbers are from 0 to 7.

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)

SipBadAudioOutLine
The application attempted to open an audio output line that is invalid. For further information, see the OpenAudioOutChannel(VoipMediaEngine, Int32) API procedure.

(API return value)

SipAudioOutAlreadyOpened
Indicates that application software attempted to open an audio output channel that is already open. Audio output channels can only be opened once.

(API return value)

Remarks

None.

See Also