Conference functions

Functions
(int)	- PortSIPSDK::createAudioConference
	Create an audio conference. More...
(int)	- PortSIPSDK::createVideoConference:videoWidth:videoHeight:displayLocalVideo:
	Create a video conference. More...
(void)	- PortSIPSDK::destroyConference
	Destroy the existent conference.
(int)	- PortSIPSDK::setConferenceVideoWindow:
	Set the window for a conference that is used to display the received remote video image. More...
(int)	- PortSIPSDK::joinToConference:
	Join a session into existent conference. If the call is in hold, please un-hold first. More...
(int)	- PortSIPSDK::removeFromConference:
	Remove a session from an existent conference. More...

Detailed Description

Function Documentation

createAudioConference()

- (int) createAudioConference

Create an audio conference.

Returns

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

createVideoConference:videoWidth:videoHeight:displayLocalVideo:()

- (int) createVideoConference:		(PortSIPVideoRenderView *)	conferenceVideoWindow
videoWidth:		(int)	videoWidth
videoHeight:		(int)	videoHeight
displayLocalVideo:		(BOOL)	displayLocalVideoInConference

Create a video conference.

Parameters

conferenceVideoWindow	The PortSIPVideoRenderView used for displaying the conference video.
videoWidth	The conference video width.
videoHeight	The conference video height.
displayLocalVideoInConference	Display the local video on video window.

Returns

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

setConferenceVideoWindow:()

- (int) setConferenceVideoWindow:

(PortSIPVideoRenderView *)

conferenceVideoWindow

Set the window for a conference that is used to display the received remote video image.

Parameters

conferenceVideoWindow

The PortSIPVideoRenderView used to display the conference video.

Returns

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

joinToConference:()

- (int) joinToConference:

(long)

sessionId

Join a session into existent conference. If the call is in hold, please un-hold first.

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.

removeFromConference:()

- (int) removeFromConference:

(long)

sessionId

Remove a session from an existent conference.

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.