Methods

SIP SDK methods

Description

SIP SDK methods

Initialize - Initialize SIP SDK
WebInitialize - Initialize SIP SDK with encrypted parameters
Shutdown - Shutdown SIP SDK
Register - Register with SIP proxy
UnRegister - Un-register from SIP proxy
Connect - Make call to remote participant
Disconnect - Disconnect active call or reject incoming
AcceptCall - Accept incoming call
TransferCall - Blind (unattended) transfer active call to given destination
RedirectCall - Consultative (attended) transfer active call to the target call
Hold - Place call on hold
Unhold - Take call off hold
EnableKeepAlive - Enable Keep-Alive signaling
DisableKeepAlive - Disable Keep-Alive signaling
EnableSTUN - Enable STUN
DisableSTUN - Disable STUN
EnableTURN - Enable TURN
DisableTURN - Disable TURN
SendDTMF - Send DTMF signal
StartPlaying - Start playing file
StartPlayingAtLine - Start playing file at given line
StopPlaying - Stop playing file
StopPlayingAtLine - Stop playing file at given line
StartRecording - Record call to file
StopRecording - Stop recording call to file
GetOutDevName - Get name for output device at position index
GetInDevName - Get name for input device at position index
GetCaptureDevName - Get name for video capture device at position index
SetLicenseKey - Set license key
SetWebLicense - Set Web license key
EncryptSipSettings - Encrypt SIP settings
SendPagerMessage - Send pager message to the destination URI
PostPagerMessage - Post pager message to the destination URI asynchronously
ConferenceJoin - Add call to conference
ConferenceRemove - Remove call from conference
SelectAllVoiceCodecs - Select all voice codecs
SelectVoiceCodec - Select voice codec
DeselectAllVoiceCodecs - De-select all voice codecs
DeselectVoiceCodec - De-select voice codec
GetVoiceCodecName - Get voice codec name
SelectAllVideoCodecs - Select all video codecs
SelectVideoCodec - Select video codec
DeselectAllVideoCodecs - De-select all video codecs
DeselectVideoCodec - De-select video codec
GetVideoCodecName - Get video codec name
StoreConfiguration - Store SIP SDK configuration
LoadConfiguration - Load SIP SDK configuration
AddAdditionalDNSServer - Add additional DNS server that will be attempted to be discovered
AddSipAccount - Add new SIP account
RemoveSipAccount - Remove current SIP account
GetSipAccountIndex - Get index of SIP account
SetAudioCodecIndex - Set audio codec index
SetVideoCodecIndex - Set video codec index
StartVideo - Start sending video
StopVideo - Stop sending video
GetCaptureDevName - Get name of video capture device
URLGetDisplayName - Parse display name from SIP URI
URLGetUserName - Parse user name from SIP URI
URLGetHost - Parse host name from SIP URI
URLGetPort - Parse port number from SIP URI
URLGetAOR - Parse AOR from SIP URI

Name	Description
Initialize Method	Initialize SIP SDK
WebInitialize Method	Initialize SIP SDK with encrypted parameters
Shutdown Method	Shutdown SIP SDK
Register Method	Register with SIP proxy
UnRegister Method	Un-register from SIP proxy
Connect Method	Make call to remote participant
Disconnect Method	Disconnect active call or reject incoming
AcceptCall Method	Accept incoming call
TransferCall Method	Blind (unattended) transfer active call to given destination
RedirectCall Method	Consultative (attended) transfer active call to the target call
Hold Method	Place call on hold
Unhold Method	Take call off hold
EnableKeepAlive Method	Enable Keep-Alive signaling
DisableKeepAlive Method	Disable Keep-Alive signaling
EnableSTUN Method	Enable STUN
DisableSTUN Method	Disable STUN
EnableTURN Method	Enable TURN
DisableTURN Method	Disable TURN
SendDTMF Method	Send DTMF signal
StartPlaying Method	Start playing file
StartPlayingAtLine Method	Start playing file at given line
StopPlaying Method	Stop playing file
StopPlayingAtLine Method	Stop playing file at given line
StartRecording Method	Record call to file
StopRecording Method	Stop recording call to file
GetOutDevName Method	Get name for output device at position index
GetInDevName Method	Get name for input device at position index
SetLicenseKey Method	This method is used to set license key (fullversion)
SetWebLicense Method	This method is used to set license key (fullversion) for website usage.
EncryptSipSettings Method	This method is used to encrypt SIP settings for WebInitialize.
SendPagerMessage Method	Send pager message to the destination URI
PostPagerMessage Method	Post pager message to the destination URI asynchronously
ConferenceJoin Method	Add call to conference
ConferenceRemove Method	Remove call from conference
SelectAllVoiceCodecs Method	Select all voice codecs
SelectVoiceCodec Method	Select voice codec
DeselectAllVoiceCodecs Method	De-select all voice codecs
DeselectVoiceCodec Method	De-select voice codec
GetVoiceCodecName Method	Get voice codec name
StoreConfiguration Method	Store SIP SDK configuration
LoadConfiguration Method	Load SIP SDK configuration
AddAdditionalDNSServer Method	Add additional DNS server that will be attempted to be discovered
URLGetDisplayName Method	Parse display name from SIP URI
URLGetUserName Method	Parse user name from SIP URI
URLGetHost Method	Parse host name from SIP URI
URLGetPort Method	Parse port number from SIP URI
URLGetAOR Method	Parse AOR from SIP URI
GetCaptureDevName Method	Get name for video capture device at position index
SelectAllVideoCodecs Method	Select all video codecs
SelectVideoCodec Method	Select video codec
DeselectAllVideoCodecs Method	De-select all video codecs
DeselectVideoCodec Method	De-select video codec
GetVideoCodecName Method	Get video codec name
AddSipAccount Method	Add new SIP account
RemoveSipAccount Method	Remove current SIP account
GetSipAccountIndex Method	Get index of SIP account
SetAudioCodecIndex Method	Set audio codec index
SetVideoCodecIndex Method	Set video codec index
StartVideo Method	Start sending video
StopVideo Method	Stop sending video

Links

Reference, Topics, See Also

Home

What do you think about this topic? Send feedback!