IPtt4 Interface Reference

Inherits IPtt3.

Public Member Functions
HRESULT	StartAudioMessageIntegration ([in] IAudioMessagePlayback *pPlayback, [out, retval] IAudioMessageRecord **ppRecord)
HRESULT	StopAudioMessageIntegration ()
Public Member Functions inherited from IPtt2
HRESULT	BeginMessageEx ([in] SAFEARRAY BSTR Users, [in] BSTR bstrExternalId)
HRESULT	SendCallAlert ([in] IContact *pContact, [in] BSTR bstrText, [in] BSTR bstrExternalId)
HRESULT	ShareImage ([in] IContact *pContact, [in] BSTR bstrText, [in] BSTR bstrExternalId)
HRESULT	GetSoloContact ([out, retval] IContact **ppVal)
HRESULT	UpdateSoloContact ([in] IContact *pContact)
Public Member Functions inherited from IPtt
HRESULT	SignIn ([in] BSTR bstrUsername, [in] BSTR bstrPassword, [in] VARIANT_BOOL bPasswordHash)
HRESULT	SignOut ()
HRESULT	Cancel ()
HRESULT	ShowSettingsDialog ([in] long lParentWindow)
HRESULT	ShowAboutDialog ([in] long lParentWindow)
HRESULT	ShowFeedbackDialog ([in] long lParentWindow)
HRESULT	ShowPasswordWizard ([in] long lParentWindow)
HRESULT	BeginMessage ([in] SAFEARRAY BSTR Users)
HRESULT	EndMessage ()
HRESULT	RepeatLastMessage ()
HRESULT	BeginMessage2 ([in, out] SAFEARRAY BSTR *Users)
HRESULT	UpdateContacts ()
HRESULT	ShowContacts ()
HRESULT	OpenHistory (IContact *pContact)
HRESULT	CloseHistory ()
HRESULT	ExpandContact (IContact *pContact)
HRESULT	SelectContact (IContact *pContact)

Properties
VARIANT_BOOL	Chorus [get, set]
Properties inherited from IPtt3
VARIANT_BOOL	AutoConnect [get, set]
Properties inherited from IPtt
NETWORK_STATUS	NetworkStatus [get]
ONLINE_STATUS	OnlineStatus [get, set]
BSTR	Username [get]
BSTR	Password [get]
IContacts	Contacts [get]
INetwork	Network [get]
ISettings	Settings [get]
IHistory	History ([in] BSTR bstrFilter) [get]
IAudioPlayer	AudioPlayer [get]
ICustomization	Customization [get]
VARIANT_BOOL	VoxActive [get, set]
BSTR	StatusText [get, set]

Detailed Description

IPtt4 interface extends IPtt4 and enables audio integration with third party applications.

Member Function Documentation

StartAudioMessageIntegration()

HRESULT StartAudioMessageIntegration	(	[in] IAudioMessagePlayback *	pPlayback,
		[out, retval] IAudioMessageRecord **	ppRecord
	)

Switch the client to a mode when audio data for incoming messages is passed to a thrird-party app and a thirt-party app supplies the audio data for outgoing messages.

Parameters

pPlayback	An object that will be used to notify a thrid-party app about incoming messages.
ppRecord	Returns an object that will be used to notify the client about outgoing messages.

StopAudioMessageIntegration()

HRESULT StopAudioMessageIntegration

(

)

Exit the audio integration mode.

Property Documentation

Chorus

VARIANT_BOOL Chorus

getsetproperty

Check if Chorus feature is active. All the incoming messages are played live if this feature is on. If this feature is off, incoming messages are played one-by-one

Parameters

pbVal

Return value.

Enable or disable Chorus feature. All the incoming messages are played live if this feature is on. If this feature is off, incoming messages are played one-by-one

Parameters

bVal	New value.