IClientLineMgrPub3 Interface Reference

import "CLMgrPub.idl";

Inheritance diagram for IClientLineMgrPub3:

Public Member Functions
HRESULT	PubCreateConference ([in] long iConferenceLine)
HRESULT	PubJoinAllToConference ([in] BOOL bCreateConference)
HRESULT	PubConferenceRunning ([out] BOOL *pbConferenceRunning)
HRESULT	PubGetConferenceLine ([out] IClientLinePub **ppIClientLine, [out] long *piLineNumber)
HRESULT	PubJoinLineToConference ([in] long iLine)
HRESULT	PubPlaySoundFile ([in] BSTR sFileName, [in] BOOL bPlayLoop, [in] int iLoopInterval)
HRESULT	PubStopPlaySoundFile ()
HRESULT	PubPlayToRtp ([in] BSTR sFullPath, [in] BOOL bLoop, [in] DWORD dwPause)
HRESULT	PubStopPlayToRtp ()
HRESULT	PubRecordFromRtp ([in] BSTR sFullPath, [in] BOOL bAppend, [in] BOOL bAddLocalSounds)
HRESULT	PubStopRecordFromRtp ()

Detailed Description

Line manager interface Handles connection to server and selection of lines,

Use this interface from C++ clients

Member Function Documentation

PubConferenceRunning()

HRESULT IClientLineMgrPub3::PubConferenceRunning

(

[out] BOOL *

pbConferenceRunning

)

Conference established or in creation? State returned in pbConferenceRunning

PubCreateConference()

HRESULT IClientLineMgrPub3::PubCreateConference

(

[in] long

iConferenceLine

)

Create new conference If iConferenceLine == -1, active line or first line on hold will become conference line. Otherwise iConferenceLine indicicates the line that will become the conference line The chosen line must be active or on hold.

PubGetConferenceLine()

HRESULT IClientLineMgrPub3::PubGetConferenceLine	(	[out] IClientLinePub **	ppIClientLine,
		[out] long *	piLineNumber )

Get index (zero based) of and pointer to conference line; returns S_FALSE if no conference running

PubJoinAllToConference()

HRESULT IClientLineMgrPub3::PubJoinAllToConference

(

[in] BOOL

bCreateConference

)

Add all active and onhold lines to a conference. If bCreateConference==TRUE, a new conference will be created if there is currently no conference

PubJoinLineToConference()

HRESULT IClientLineMgrPub3::PubJoinLineToConference

(

[in] long

iLine

)

Add requested line (zero based index) to running conference

PubPlaySoundFile()

HRESULT IClientLineMgrPub3::PubPlaySoundFile	(	[in] BSTR	sFileName,
		[in] BOOL	bPlayLoop,
		[in] int	iLoopInterval )

Play soundfile using our mediastreaming The file will be heared locally and remote (if in a phone call and voice connection is established, so not on hold) sFileName: full path of the file to be played bPlayLoop: if TRUE, the file will be played repeatedly iLoopInterval: time interval (Seconds) between loops; ignored if bPlayLoop==FALSE

PubPlayToRtp()

HRESULT IClientLineMgrPub3::PubPlayToRtp	(	[in] BSTR	sFullPath,
		[in] BOOL	bLoop,
		[in] DWORD	dwPause )

Play soundfile using our mediastreaming The file will be heared only remote (if in a phone call and voice connection is established, so not on hold) The function may be called any time, it is not related to a certain connection or line. If lines are switched, the playback will proceed.

sFullPath: Full file name bLoop: if TRUE, the file is played in loop, otherwise it is played once dwPause: if playing in loop, this parameter gives the pause beween loops, milliseconds

PubRecordFromRtp()

HRESULT IClientLineMgrPub3::PubRecordFromRtp	(	[in] BSTR	sFullPath,
		[in] BOOL	bAppend,
		[in] BOOL	bAddLocalSounds )

Record the incoming voice (RTP) stream of an active connection. The local (own) voice stream is not recorded. Only local sounds (dial tone, alerting, etc.) can be recorded as well. The function may be called any time, it is not related to a certain connection or line. If lines are switched, the recording will proceed.

sFullPath: Full file name bAppend: if TRUE, the file is appended; otherwise the file is overwritten if it exists bAddLocalSounds: if TRUE, local notification sounds are recorded too; otherwise only the RTP stream is recorded

PubStopPlaySoundFile()

HRESULT IClientLineMgrPub3::PubStopPlaySoundFile

(

)

Stop Play soundfile Stop playback of currently played sound file

PubStopPlayToRtp()

HRESULT IClientLineMgrPub3::PubStopPlayToRtp

(

)

Stop playing soundfile towards RTP

PubStopRecordFromRtp()

HRESULT IClientLineMgrPub3::PubStopRecordFromRtp

(

)

Stop recording RTP stream to soundfile

---

The documentation for this interface was generated from the following file:

• CLMgrPub.idl