Properties

SIP SDK properties

Description

SIP SDK properties

LastError - Last error description
IsPlaying - Indicates whether WAV file is being played on active phone line
PhoneLine - Active phone line index
MaxPhoneLines - Total count of phone lines
RegisterExpiration - Expiration period for registration
UDPPort - UDP port
TCPPort - TCP port
ForwardURI - Forward URI
NATKeepAlive - Keep-Alive interval for NAT traversal
RtpPortStart - Starting port for inbound RTP traffic
OutDevNum - Number of output devices available
InDevNum - Number of input devices available
DndEnabled - Enable/Disable DND (Do Not Disturb)
OutputDeviceName - Name for output device
InputDeviceName - Name for input device
IsInitialized - True if SIP SDK was successfully initialized
PlayRingtone - Enable/Disable playing ring tones
AGC - Enable/Disable AGC (Automatic Gain Control)
AEC - Enable/Disable AEC (Acoustic Echo Cancellation)
NoiseReduction - Enable/Disable Noise Reduction
EchoTail - Length (in ms) of the echo canceling filter (also known as tail length)
SpeakerVolume - Speaker volume (0..100)
MicrophoneVolume - Microphone volume (0..100)
SpeakerMuted - Speaker mute state
MicrophoneMuted - Microphone mute state
SpeakerEnergy - Volume from speaker volume meter (0-100)
MicrophoneEnergy - Volume from microphone volume meter (0-100)
VoiceCodecCount - Count of voice codecs
VideoCodecCount - Count of video codecs
CallState - Call state at given line
RemoteURI - Remote URI at given line
LineResponseCode - SIP response code (if available)
LineResponseText - SIP response text (if available)
RegistrationResponseCode - SIP response code (if available)
RegistrationResponseText - SIP response text (if available)
LogEnabled - Enable/Disable logging
DisplayName - Display name
UserID - User ID
LoginID - Authentication ID
Password - Password
Realm - Realm for which the login ID and password are valid. Empty for automatic realm
RegistrationProxy - SIP registration proxy
OutboundProxy - Outbound-Proxy
SipAccountCount - Count of SIP accounts
ActiveSipAccount - Active SIP account
AcceptLanguage - Accept Language used in SIP messages
NegotiatedCodecName - Negotiated codec name
LocalIPsCount - Number of local IPs found by the system
LocalIP - Local IP address
NetworkAdapter - Network adapter name
Identity - Information about the UAC originating the request
RingtoneFile - Default ring/alert tone audio file
CameraInUse - Indicates whether camera is used by other application
PreviewWindow - Video preview window
OutputWindow - Video output window
VideoMaxBitrate - Max video bitrate
VideoFrameSize - Video frame size
AutoStartSendingVideo - Automatically start sending video
CaptureDevNum - Number of video capture devices
CaptureDeviceName - Selected video capture device

Name	Description
LastError Property	Last error description
IsPlaying Property	Indicates whether WAV file is being played on active phone line
PhoneLine Property	Active phone line index
MaxPhoneLines Property	Total count of phone lines
RegisterExpiration Property	Expiration period for registration in seconds
UDPPort Property	UDP port
TCPPort Property	TCP port
ForwardURI Property	Forward URI
NATKeepAlive Property	Keep-Alive interval for NAT traversal, in seconds
RtpPortStart Property	Starting port for inbound RTP traffic
OutDevNum Property	Number of output devices available
InDevNum Property	Number of input devices available
DndEnabled Property	Enable/Disable DND (Do Not Disturb)
OutputDeviceName Property	Name for output device
InputDeviceName Property	Name for input device
IsInitialized Property	True if SIP SDK was successfully initialized
PlayRingtone Property	Enable/Disable playing ring tones
AGC Property	Enable/Disable AGC (Automatic Gain Control)
AEC Property	Enable/Disable AEC (Acoustic Echo Cancellation)
NoiseReduction Property	Enable/Disable Noise Reduction
EchoTail Property	Length (in ms) of the echo canceling filter (also known as tail length)
SpeakerVolume Property	Speaker volume (0..100)
MicrophoneVolume Property	Microphone volume (0..100)
SpeakerMuted Property	Speaker mute state
MicrophoneMuted Property	Microphone mute state
SpeakerEnergy Property	Volume from speaker volume meter (0-100)
MicrophoneEnergy Property	Volume from microphone volume meter (0-100)
VoiceCodecCount Property	Count of voice codecs
CallState Property	Call state at given line
RemoteURI Property	Remote URI at given line
LineResponseCode Property	SIP response code (if available)
LineResponseText Property	SIP response text (if available)
RegistrationResponseCode Property	SIP response code (if available)
RegistrationResponseText Property	SIP response text (if available)
LogEnabled Property	Enable/Disable logging
DisplayName Property	Display name
UserID Property	User ID
LoginID Property	Authentication ID
Password Property	Password
Realm Property	Realm for which the login ID and password are valid. Empty for automatic realm
RegistrationProxy Property	SIP registration proxy
OutboundProxy Property	Outbound proxy
AcceptLanguage Property	Accept Language used in SIP messages
NegotiatedCodecName Property	Negotiated codec name
NegotiatedPayloadType Property	Negotiated payload type
LocalIPsCount Property	Number of local IPs found by the system
LocalIP Property	Local IP address
NetworkAdapter Property	Network adapter name
Identity Property	Information about the UAC originating the request
RingtoneFile Property	Default ring/alert tone audio file
VideoCodecCount Property	Count of video codecs
CameraInUse Property	Indicates whether camera is used by other application
PreviewWindow Property	Video preview window
OutputWindow Property	Video output window
CaptureDevNum Property	Number of video capture devices
CaptureDeviceName Property	Selected video capture device
SipAccountCount Property	SIP account count
ActiveSipAccount Property	Active SIP account
VideoFrameSize Property	Video frame size
VideoMaxBitrate Property	Max video bitrate
AutoStartSendingVideo Property	Automatically start sending video

Links

Reference, Topics, See Also

Home

What do you think about this topic? Send feedback!