Play audio and video files to remote party

Functions
(int)	- PortSIPSDK::playVideoFileToRemote:aviFile:loop:playAudio:
	Play an AVI file to remote party. More...
(int)	- PortSIPSDK::stopPlayVideoFileToRemote:
	Stop playing video file to remote party. More...
(int)	- PortSIPSDK::playAudioFileToRemote:filename:fileSamplesPerSec:loop:
	Play a wave file to remote party. More...
(int)	- PortSIPSDK::stopPlayAudioFileToRemote:
	Stop playing wave file to remote party. More...
(int)	- PortSIPSDK::playAudioFileToRemoteAsBackground:filename:fileSamplesPerSec:
	Play a wave file to remote party as conversation background sound. More...
(int)	- PortSIPSDK::stopPlayAudioFileToRemoteAsBackground:
	Stop playing a wave file to remote party as conversation background sound. More...
(void)	- PortSIPSDK::audioPlayLoopbackTest:
	Used for the loop back testing against audio device. More...

Detailed Description

Function Documentation

playVideoFileToRemote:aviFile:loop:playAudio:()

- (int) playVideoFileToRemote:		(long)	sessionId
aviFile:		(NSString *)	aviFile
loop:		(BOOL)	loop
playAudio:		(BOOL)	playAudio

Play an AVI file to remote party.

Parameters

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

Returns

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

stopPlayVideoFileToRemote:()

- (int) stopPlayVideoFileToRemote:

(long)

sessionId

Stop playing video file to remote party.

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:filename:fileSamplesPerSec:loop:()

- (int) playAudioFileToRemote:		(long)	sessionId
filename:		(NSString *)	filename
fileSamplesPerSec:		(int)	fileSamplesPerSec
loop:		(BOOL)	loop

Play a wave file to remote party.

Parameters

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

stopPlayAudioFileToRemote:()

- (int) stopPlayAudioFileToRemote:

(long)

sessionId

Stop playing wave file to remote party.

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:filename:fileSamplesPerSec:()

- (int) playAudioFileToRemoteAsBackground:		(long)	sessionId
filename:		(NSString *)	filename
fileSamplesPerSec:		(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 "/test.wav".
fileSamplesPerSec	The sample wave file 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) stopPlayAudioFileToRemoteAsBackground:

(long)

sessionId

Stop playing a 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.

audioPlayLoopbackTest:()

- (void) audioPlayLoopbackTest:

(BOOL)

enable

Used for the loop back testing against audio device.

Parameters

enable

Set to true to start audio look back test, or false to stop.