Enums

enum	NETWORK_STATUS { NSOFFLINE = 0, NSONLINE = 1, NSSIGNINGIN = 2, NSSIGNINGOUT = 3 }
enum	ONLINE_STATUS {   OSOFFLINE = 0, OSAVAILABLE = 1, OSBUSY = 2, OSAWAY = 3,   OSHEADPHONES = 4, OSCONNECTING = 5, OSSTANDBY = 6, OSUNKNOWN = 7 }
enum	CLIENT_ERROR {   CL_NoError = 0, CL_UnknownError = 1, CL_InvalidCredentials, CL_ExistingUsername,   CL_InvalidUsername, CL_EmptyUsername, CL_ExistingChannelName, CL_SignInServerError,   CL_SignInServerUnavailable, CL_SuperNodeError, CL_OldVersion, CL_NetworkSuspended,   CL_Reconnecting, CL_Kicked, CL_SignUpServerError, CL_SignUpServerUnavailable,   CL_SignUpDailyRateExceeded, CL_SignUpWeeklyRateExceeded, CL_SignUpMonthlyRateExceeded, CL_AddContactOffline,   CL_AddContactError, CL_AddContactExists, CL_ChannelNotFound, CL_ChangePwdOffline,   CL_ChangePwdInvalidPassword, CL_NoPermission, CL_ProxyUnavailable, CL_ProxyAuthError,   CL_SignInCancelled, CL_LicenseError, CL_LicenseExpired, CL_WrongNetwork,   CL_ContactListError, CL_NoConnection, CL_ConnectionLost, CL_Pending,   CL_Cancelled, CL_BruteForce, CL_Banned, CL_TlsRequired }
enum	CONTACT_TYPE { CTUSER = 0, CTGROUP = 1, CTCHANNEL = 2 }
enum	MESSAGE_TYPE {   MTAUDIO = 0, MTALERT = 1, MTIMAGE = 2, MTLOCATION = 3,   MTTEXT = 4 }
enum	SETTING_ID {   ST_VERSION = 0, ST_WRITE_LOG = 1, ST_CHORUS_MODE = 2, ST_AUD_DEV_PLAYBACK = 10,   ST_AUD_DEV_RECORDING = 11, ST_AUD_PLAYBACK_VOLUME = 12, ST_AUD_RECORDING_VOLUME = 13, ST_AUD_PLAYBACK_AMPL = 14,   ST_AUD_RECORDING_AMPL = 15, ST_AUD_NOISE_SUPP = 16 , ST_VOX_ENABLE = 40, ST_VOX_ACTIVATION = 41,   ST_VOX_DEACTIVATION = 42, ST_VOX_TRIGGER_TIME = 43, ST_VOX_RELAX_TIME = 44, ST_VOX_SAVE_STATE = 45,   ST_CTRL_PTT_KEYCODE = 50, ST_CTRL_LOCK_KEYCODE = 51, ST_CTRL_REPLAY_KEYCODE = 52, ST_CTRL_SWITCH_CHORUS = 53,   ST_CTRL_WAKE_SOUND = 54, ST_CTRL_INC_SOUND = 55, ST_CTRL_CTS_SOUND = 56, ST_CTRL_INC_OVER_SOUND = 57,   ST_CTRL_ERROR_SOUND = 58, ST_CTRL_OUT_OVER_SOUND = 59, ST_CTRL_ALERT_SOUND = 60, ST_CTRL_IMAGE_SOUND = 61,   ST_NTW_NO_TLS = 70, ST_NTW_TCP_ONLY = 71, ST_NTW_RLKA = 72, ST_NTW_SNKA = 73,   ST_NTW_USE_PROXY = 74, ST_NTW_PROXY_TYPE = 75, ST_NTW_PROXY_SERVER = 76, ST_NTW_USE_PROXY_AUTH = 77,   ST_NTW_PROXY_UNAME = 78, ST_NTW_PROXY_PWD = 79, ST_CDC_PACKETS = 90, ST_CDC_QUALITY = 91,   ST_CDC_COMPLEXITY = 92, ST_CDC_PACKET_LOSS_RATE = 93, ST_CDC_ENABLE_VBR = 94 }

Detailed Description

Enumeration Type Documentation

NETWORK_STATUS

enum NETWORK_STATUS

Network signed-in status.

Enumerator
NSOFFLINE	Offline.
NSONLINE	Signed in.
NSSIGNINGIN	Signing in.
NSSIGNINGOUT	Signing out.

ONLINE_STATUS

enum ONLINE_STATUS

Online status.

Enumerator
OSOFFLINE	Offline.
OSAVAILABLE	Available.
OSBUSY	Busy.
OSAWAY	Away.
OSHEADPHONES	Headphones.
OSCONNECTING	Connecting. Only reported for channels.
OSSTANDBY	Disconnected now, can receive offline message.
OSUNKNOWN	Contact deleted.

CLIENT_ERROR

enum CLIENT_ERROR

Client errors.

Enumerator
CL_NoError	Ok.
CL_UnknownError	Unknown error.
CL_InvalidCredentials	Invalid credentials.
CL_ExistingUsername	Existing username.
CL_InvalidUsername	Invalid username.
CL_EmptyUsername	Empty username.
CL_ExistingChannelName	Specified name already in use.
CL_SignInServerError	Sign in server error.
CL_SignInServerUnavailable	Sign in server unavailable.
CL_SuperNodeError	Supernode error.
CL_OldVersion	Old version.
CL_NetworkSuspended	Network suspended.
CL_Reconnecting	Reconnecting.
CL_Kicked	Kicked.
CL_SignUpServerError	Sign up server error.
CL_SignUpServerUnavailable	Sign up server unavailable.
CL_SignUpDailyRateExceeded	Not used in business version.
CL_SignUpWeeklyRateExceeded	Not used in business version.
CL_SignUpMonthlyRateExceeded	Not used in business version.
CL_AddContactOffline	Add contact offline.
CL_AddContactError	Add contact error.
CL_AddContactExists	Add contact exists.
CL_ChannelNotFound	Channel not found.
CL_ChangePwdOffline	Change password: offline.
CL_ChangePwdInvalidPassword	Change password: invalid password.
CL_NoPermission	Permission denied.
CL_ProxyUnavailable	Proxy unavailable.
CL_ProxyAuthError	Proxy authorization error.
CL_SignInCancelled	Sign in cancelled.
CL_LicenseError	License error.
CL_LicenseExpired	License expired.
CL_WrongNetwork	Wrong network.
CL_ContactListError	Contact list error.
CL_NoConnection	No connection.
CL_ConnectionLost	Connection lost.
CL_Pending	Action pending.
CL_Cancelled	Action cancelled.
CL_BruteForce	Too many bad login attempts.
CL_Banned	Not used in business version.
CL_TlsRequired	Can't establish secure connection.

CONTACT_TYPE

enum CONTACT_TYPE

Contact type.

Enumerator
CTUSER	User.
CTGROUP	Group.
CTCHANNEL	Channel.

MESSAGE_TYPE

enum MESSAGE_TYPE

Message type.

Enumerator
MTAUDIO	Audio.
MTALERT	Call alert
MTIMAGE	Shared image
MTLOCATION	Shared location
MTTEXT	Text message

SETTING_ID

enum SETTING_ID

Setting ids.

Enumerator
ST_VERSION	Get module version (String, readonly)
ST_WRITE_LOG	"WriteLog" Write diagnostic log (Boolean)
ST_CHORUS_MODE	"EnablePolyphony" Audio mix mode (Boolean)
ST_AUD_DEV_PLAYBACK	"PlaybackDevice" Audio playback device id (String)
ST_AUD_DEV_RECORDING	"RecordingDevice" Audio recording device id (String)
ST_AUD_PLAYBACK_VOLUME	Playback audio device volume (integer, [0..100]).
ST_AUD_RECORDING_VOLUME	Recording audio device volume (integer, [0..100]).
ST_AUD_PLAYBACK_AMPL	"PlaybackAmplifierGain" Playback audio device amplification value (integer, [-20..20]dB).
ST_AUD_RECORDING_AMPL	"RecordAmplifierGain" Recording audio device amplification value (integer, [-20..20]dB).
ST_AUD_NOISE_SUPP	"Denoise" Noise supression (Boolean).
ST_VOX_ENABLE	"VoxEnabled" Enable VOX (Boolean)
ST_VOX_ACTIVATION	"ActivationThreshold" Activation threshold (Integer, [-80..0]dB)
ST_VOX_DEACTIVATION	"DeactivationThreshold" De-activation threshold (Integer, [-80..0]dB)
ST_VOX_TRIGGER_TIME	"TriggerTime" Trigger time (Integer, ms)
ST_VOX_RELAX_TIME	"RelaxationTime" Relaxation time (Integer, ms)
ST_VOX_SAVE_STATE	"SaveVoxState" Save VOX contact between sessions (Boolean)
ST_CTRL_PTT_KEYCODE	"HotKeySpeak" Push-to-talk (Integer,keycode)
ST_CTRL_LOCK_KEYCODE	"HotKeyLock" Handsfree (Integer,keycode)
ST_CTRL_REPLAY_KEYCODE	"HotKeyReplay" Repeat last message (Integer,keycode)
ST_CTRL_SWITCH_CHORUS	"HotKeyChorus" Switch mixing (Integer,keycode)
ST_CTRL_WAKE_SOUND	"WakeFromIdleSoundPath" New conversation alert (String,path)
ST_CTRL_INC_SOUND	"IncomingTransmissionSoundPath" Incoming message alert (String,path)
ST_CTRL_CTS_SOUND	"CTSSoundPath" Clear to send alert (String,path)
ST_CTRL_INC_OVER_SOUND	"OverSoundPath" Incoming message ended alert (String,path)
ST_CTRL_ERROR_SOUND	"ErrorSoundPath" Connection error alert (String,path)
ST_CTRL_OUT_OVER_SOUND	"PttUpSoundPath" Outgoing message ended alert (String,path)
ST_CTRL_ALERT_SOUND	"CallAlertSoundPath" Call alert (String,path)
ST_CTRL_IMAGE_SOUND	"SharedImageSoundPath" Shared image alert (String,path)
ST_NTW_NO_TLS	"DisableTls" Disable TLS (Boolean)
ST_NTW_TCP_ONLY	"UseOnlyTcp" Use only TCP connection (Boolean)
ST_NTW_RLKA	"UdpKeepAlive" UDP keep-alive period (Integer,ms)
ST_NTW_SNKA	"KeepAlive" Keep-alive period (Integer,ms)
ST_NTW_USE_PROXY	"ProxyEnable" Use proxy server (Boolean)
ST_NTW_PROXY_TYPE	"ProxyType" Use HTTP(S) or SOCKS5 proxy server (String, HTTP(S) or SOCKS5)
ST_NTW_PROXY_SERVER	"ProxyServer" Proxy server and port (String,'ip:port')
ST_NTW_USE_PROXY_AUTH	"ProxyEnableAuth" Turn on proxy authentication (Boolean)
ST_NTW_PROXY_UNAME	"ProxyAuthUsername" Turn on proxy authentication (Boolean)
ST_NTW_PROXY_PWD	"ProxyAuthPassword" Turn on proxy authentication (Boolean)
ST_CDC_PACKETS	"CodecPacketsPerSecond" Codec packets per second (Integer,[5, 50])
ST_CDC_QUALITY	"CodecQuality" Codec quality (Integer,[0, 10])
ST_CDC_COMPLEXITY	"CodecComplexity" Codec Complexity (Integer,[0, 10])
ST_CDC_PACKET_LOSS_RATE	"CodecPacketLossRate" Codec packet loss rate (Integer,[0, 100])
ST_CDC_ENABLE_VBR	"CodecEnableVbr" Enable VBR (Boolean)