PortSIP VoIP SDK Manual for Windows  16.2
PortSIP features our newest, supported, quality-assured VoIP SDK used by Several hundred companies around the world for easy VoIP application develop and quality-assured code.
Functions
Conference functions

Functions

Int32 PortSIP.PortSIPLib.createAudioConference ()
 Create an audio conference. It will be failed if the existent conference is not ended yet. More...
 
Int32 PortSIP.PortSIPLib.createVideoConference (IntPtr conferenceVideoWindow, Int32 width, Int32 height, Boolean displayLocalVideoInConference)
 Create a video conference. It will be failed if the existent conference is not ended yet. More...
 
void PortSIP.PortSIPLib.destroyConference ()
 End the existent conference.
 
Int32 PortSIP.PortSIPLib.setConferenceVideoWindow (IntPtr videoWindow)
 Set the window for a conference that is used to display the received remote video image. More...
 
Int32 PortSIP.PortSIPLib.joinToConference (Int32 sessionId)
 Join a session into existent conference. If the call is in hold, it will be un-hold automatically. More...
 
Int32 PortSIP.PortSIPLib.removeFromConference (Int32 sessionId)
 Remove a session from an existent conference. More...
 

Detailed Description

Function Documentation

◆ createAudioConference()

Int32 PortSIP.PortSIPLib.createAudioConference ( )

Create an audio conference. It will be failed if the existent conference is not ended yet.

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

◆ createVideoConference()

Int32 PortSIP.PortSIPLib.createVideoConference ( IntPtr  conferenceVideoWindow,
Int32  width,
Int32  height,
Boolean  displayLocalVideoInConference 
)

Create a video conference. It will be failed if the existent conference is not ended yet.

Parameters
conferenceVideoWindowThe UIView used to display the conference video.
videoResolutionThe conference video resolution.
displayLocalVideoInConferenceDisplay the local video on video window or not.
Returns
If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

◆ setConferenceVideoWindow()

Int32 PortSIP.PortSIPLib.setConferenceVideoWindow ( IntPtr  videoWindow)

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

Parameters
videoWindowThe UIView 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()

Int32 PortSIP.PortSIPLib.joinToConference ( Int32  sessionId)

Join a session into existent conference. If the call is in hold, it will be un-hold automatically.

Parameters
sessionIdSession 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()

Int32 PortSIP.PortSIPLib.removeFromConference ( Int32  sessionId)

Remove a session from an existent conference.

Parameters
sessionIdSession 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.