Play audio and video file to remote functions

Functions
int	com.portsip.PortSipSdk.playVideoFileToRemote (long sessionId, String aviFile, boolean loop, boolean playAudio)
int	com.portsip.PortSipSdk.stopPlayVideoFileToRemote (long sessionId)
int	com.portsip.PortSipSdk.playAudioFileToRemote (long sessionId, String filename, int fileSamplesPerSec, boolean loop)
int	com.portsip.PortSipSdk.stopPlayAudioFileToRemote (long sessionId)
int	com.portsip.PortSipSdk.playAudioFileToRemoteAsBackground (long sessionId, String filename, int fileSamplesPerSec)
int	com.portsip.PortSipSdk.stopPlayAudioFileToRemoteAsBackground (long sessionId)
void	com.portsip.PortSipSdk.audioPlayLoopbackTest (boolean enable)

Detailed Description

Function Documentation

playVideoFileToRemote()

int com.portsip.PortSipSdk.playVideoFileToRemote	(	long	sessionId,
		String	aviFile,
		boolean	loop,
		boolean	playAudio
	)

Play an AVI file to remote party.

Parameters

sessionId	Session ID of the call.
aviFile	The full filepath, such as "/mnt/sdcard/test.avi".
loop	Set to false to stop playing video file when it is ended, or true to play it repeatedly.
playAudio	If set to true, audio and video will be played together; or false to play the video only.

Returns

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

stopPlayVideoFileToRemote()

int com.portsip.PortSipSdk.stopPlayVideoFileToRemote

(

long

sessionId

)

Stop play 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.

playAudioFileToRemote()

int com.portsip.PortSipSdk.playAudioFileToRemote	(	long	sessionId,
		String	filename,
		int	fileSamplesPerSec,
		boolean	loop
	)

Play a wave file to remote party.

Parameters

sessionId	Session ID of the call.
filename	The full filepath, such as "/mnt/sdcard/test.wav".
fileSamplesPerSec	The wave file sample in seconds. It could 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.

stopPlayAudioFileToRemote()

int com.portsip.PortSipSdk.stopPlayAudioFileToRemote

(

long

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.

playAudioFileToRemoteAsBackground()

int com.portsip.PortSipSdk.playAudioFileToRemoteAsBackground	(	long	sessionId,
		String	filename,
		int	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 "/mnt/sdcard/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.

stopPlayAudioFileToRemoteAsBackground()

int com.portsip.PortSipSdk.stopPlayAudioFileToRemoteAsBackground

(

long

sessionId

)

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

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.

audioPlayLoopbackTest()

void com.portsip.PortSipSdk.audioPlayLoopbackTest

(

boolean

enable

)

Used for testing loopback for the audio device.

Parameters

enable

Set to true to start testing audio loopback test; or set to false to stop.