Functions
Int32	PortSIP.PortSIPLib.playVideoFileToRemote (Int32 sessionId, String fileName, Boolean loop, Boolean playAudio)
	Play an AVI file to remote party. More...

Int32	PortSIP.PortSIPLib.stopPlayVideoFileToRemote (Int32 sessionId)
	Stop playing video file to remote side. More...

Int32	PortSIP.PortSIPLib.playAudioFileToRemote (Int32 sessionId, String fileName, Int32 fileSamplesPerSec, Boolean loop)
	Play a wave file to remote party. More...

Int32	PortSIP.PortSIPLib.stopPlayAudioFileToRemote (Int32 sessionId)
	Stop playing wave file to remote side. More...

Int32	PortSIP.PortSIPLib.playAudioFileToRemoteAsBackground (Int32 sessionId, String fileName, Int32 fileSamplesPerSec)
	Play a wave file to remote party as conversation background sound. More...

Int32	PortSIP.PortSIPLib.stopPlayAudioFileToRemoteAsBackground (Int32 sessionId)
	Stop playing wave file to remote party as conversation background sound. More...

Detailed Description

Function Documentation

Int32 PortSIP.PortSIPLib.playVideoFileToRemote	(	Int32	sessionId,
		String	fileName,
		Boolean	loop,
		Boolean	playAudio
	)

Play an AVI file to remote party.

Parameters

sessionId	Session ID of the call.
fileName	The full file path, such as "c:\\test.avi".
loop	Set to false to stop playing video file when it is ended, or true to play it repeatedly.
playAudio	If it's set to true, audio and video will be played together; if false, only video will be played.

Returns: If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

Int32 PortSIP.PortSIPLib.stopPlayVideoFileToRemote ( Int32 sessionId )

Stop playing video file to remote side.

Parameters

sessionId Session ID of the call.

Returns: If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

Int32 PortSIP.PortSIPLib.playAudioFileToRemote	(	Int32	sessionId,
		String	fileName,
		Int32	fileSamplesPerSec,
		Boolean	loop
	)

Play a wave file to remote party.

Parameters

sessionId	Session ID of the call.
fileName	The full filepath, such as "c:\\test.wav".
fileSamplesPerSec	The wave file sample in seconds. It should be 8000, 16000 or 32000.
loop	Set to false to stop playing audio file when it is ended, or true to play it repeatedly.

Returns: If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

Int32 PortSIP.PortSIPLib.stopPlayAudioFileToRemote ( Int32 sessionId )

Stop playing wave file to remote side.

Parameters

sessionId Session ID of the call.

Returns: If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

Int32 PortSIP.PortSIPLib.playAudioFileToRemoteAsBackground	(	Int32	sessionId,
		String	fileName,
		Int32	fileSamplesPerSec
	)

Play a wave file to remote party as conversation background sound.

Parameters

sessionId	Session ID of the call.
fileName	The full filepath, such as "c:\\test.wav".
fileSamplesPerSec	The wave file sample in seconds. It should be 8000, 16000 or 32000.

Returns: If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

Int32 PortSIP.PortSIPLib.stopPlayAudioFileToRemoteAsBackground ( Int32 sessionId )

Stop playing wave file to remote party as conversation background sound.

Parameters

sessionId Session ID of the call.

Returns: If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.