PortSIP Namespace Reference

Classes
class	PortSIP_Errors
class	PortSIPLib
interface	SIPCallbackEvents

Enumerations
enum	AUDIOCODEC_TYPE : int {   AUDIOCODEC_NONE = -1, AUDIOCODEC_TYPE.AUDIOCODEC_G729 = 18, AUDIOCODEC_TYPE.AUDIOCODEC_PCMA = 8, AUDIOCODEC_TYPE.AUDIOCODEC_PCMU = 0,   AUDIOCODEC_TYPE.AUDIOCODEC_GSM = 3, AUDIOCODEC_TYPE.AUDIOCODEC_G722 = 9, AUDIOCODEC_TYPE.AUDIOCODEC_ILBC = 97, AUDIOCODEC_TYPE.AUDIOCODEC_AMR = 98,   AUDIOCODEC_TYPE.AUDIOCODEC_AMRWB = 99, AUDIOCODEC_TYPE.AUDIOCODEC_SPEEX = 100, AUDIOCODEC_TYPE.AUDIOCODEC_SPEEXWB = 102, AUDIOCODEC_TYPE.AUDIOCODEC_ISACWB = 103,   AUDIOCODEC_TYPE.AUDIOCODEC_ISACSWB = 104, AUDIOCODEC_TYPE.AUDIOCODEC_G7221 = 121, AUDIOCODEC_TYPE.AUDIOCODEC_OPUS = 105, AUDIOCODEC_TYPE.AUDIOCODEC_DTMF = 101 }
	Audio codec type. More...
enum	VIDEOCODEC_TYPE : int {   VIDEOCODEC_TYPE.VIDEO_CODE_NONE = -1, VIDEOCODEC_TYPE.VIDEO_CODEC_I420 = 113, VIDEOCODEC_TYPE.VIDEO_CODEC_H263 = 34, VIDEOCODEC_TYPE.VIDEO_CODEC_H263_1998 = 115,   VIDEOCODEC_TYPE.VIDEO_CODEC_H264 = 125, VIDEOCODEC_TYPE.VIDEO_CODEC_VP8 = 120, VIDEOCODEC_TYPE.VIDEO_CODEC_VP9 = 122 }
	Video codec type. More...
enum	AUDIO_RECORDING_FILEFORMAT : int { AUDIO_RECORDING_FILEFORMAT.FILEFORMAT_WAVE = 1, AUDIO_RECORDING_FILEFORMAT.FILEFORMAT_AMR }
	The audio record file format. More...
enum	RECORD_MODE : int { RECORD_MODE.RECORD_NONE = 0, RECORD_MODE.RECORD_RECV = 1, RECORD_MODE.RECORD_SEND, RECORD_MODE.RECORD_BOTH }
	The audio/Video record mode. More...
enum	CALLBACK_SESSION_ID : int { PORTSIP_LOCAL_MIX_ID = -1, PORTSIP_REMOTE_MIX_ID = -2 }
enum	AUDIOSTREAM_CALLBACK_MODE : int { AUDIOSTREAM_NONE = 0, AUDIOSTREAM_CALLBACK_MODE.AUDIOSTREAM_LOCAL_PER_CHANNEL, AUDIOSTREAM_CALLBACK_MODE.AUDIOSTREAM_REMOTE_PER_CHANNEL, AUDIOSTREAM_CALLBACK_MODE.AUDIOSTREAM_BOTH }
	The audio stream callback mode. More...
enum	VIDEOSTREAM_CALLBACK_MODE : int { VIDEOSTREAM_CALLBACK_MODE.VIDEOSTREAM_NONE = 0, VIDEOSTREAM_CALLBACK_MODE.VIDEOSTREAM_LOCAL, VIDEOSTREAM_CALLBACK_MODE.VIDEOSTREAM_REMOTE, VIDEOSTREAM_CALLBACK_MODE.VIDEOSTREAM_BOTH }
	The video stream callback mode. More...
enum	PORTSIP_LOG_LEVEL : int {   PORTSIP_LOG_NONE = -1, PORTSIP_LOG_ERROR = 1, PORTSIP_LOG_WARNING = 2, PORTSIP_LOG_INFO = 3,   PORTSIP_LOG_DEBUG = 4 }
	Log level.
enum	SRTP_POLICY : int { SRTP_POLICY.SRTP_POLICY_NONE = 0, SRTP_POLICY.SRTP_POLICY_FORCE, SRTP_POLICY.SRTP_POLICY_PREFER }
	SRTP Policy. More...
enum	TRANSPORT_TYPE : int { TRANSPORT_TYPE.TRANSPORT_UDP = 0, TRANSPORT_TYPE.TRANSPORT_TLS, TRANSPORT_TYPE.TRANSPORT_TCP, TRANSPORT_TYPE.TRANSPORT_PERS }
	Transport for SIP signaling. More...
enum	SESSION_REFRESH_MODE : int { SESSION_REFRESH_MODE.SESSION_REFERESH_UAC = 0, SESSION_REFRESH_MODE.SESSION_REFERESH_UAS }
	The session refreshment by UAC or UAS. More...
enum	DTMF_METHOD { DTMF_METHOD.DTMF_RFC2833 = 0, DTMF_METHOD.DTMF_INFO = 1 }
	send DTMF tone with two methods More...
enum	EC_MODES {   EC_NONE = 0, EC_DEFAULT = 1, EC_CONFERENCE = 2, EC_AEC = 3,   EC_AECM_1 = 4, EC_AECM_2 = 5, EC_AECM_3 = 6, EC_AECM_4 = 7 }
	type of Echo Control
enum	AGC_MODES {   AGC_NONE = 0, AGC_DEFAULT, AGC_ADAPTIVE_ANALOG, AGC_ADAPTIVE_DIGITAL,   AGC_FIXED_DIGITAL }
	type of Automatic Gain Control
enum	NS_MODES {   NS_NONE = 0, NS_DEFAULT, NS_Conference, NS_LOW_SUPPRESSION,   NS_MODERATE_SUPPRESSION, NS_HIGH_SUPPRESSION, NS_VERY_HIGH_SUPPRESSION }
	type of Noise Suppression

Detailed Description

PortSIP The PortSIP VoIP SDK namespace

Enumeration Type Documentation

AUDIOCODEC_TYPE

enum PortSIP.AUDIOCODEC_TYPE : int

strong

Audio codec type.

Enumerator
AUDIOCODEC_G729	G729 8KHZ 8kbit/s.
AUDIOCODEC_PCMA	PCMA/G711 A-law 8KHZ 64kbit/s.
AUDIOCODEC_PCMU	PCMU/G711 μ-law 8KHZ 64kbit/s.
AUDIOCODEC_GSM	GSM 8KHZ 13kbit/s.
AUDIOCODEC_G722	G722 16KHZ 64kbit/s.
AUDIOCODEC_ILBC	iLBC 8KHZ 30ms-13kbit/s 20 ms-15kbit/s
AUDIOCODEC_AMR	Adaptive Multi-Rate (AMR) 8KHZ (4.75,5.15,5.90,6.70,7.40,7.95,10.20,12.20)kbit/s.
AUDIOCODEC_AMRWB	Adaptive Multi-Rate Wideband (AMR-WB)16KHZ (6.60,8.85,12.65,14.25,15.85,18.25,19.85,23.05,23.85)kbit/s.
AUDIOCODEC_SPEEX	SPEEX 8KHZ (2-24)kbit/s.
AUDIOCODEC_SPEEXWB	SPEEX 16KHZ (4-42)kbit/s.
AUDIOCODEC_ISACWB	internet Speech Audio Codec(iSAC) 16KHZ (32-54)kbit/s
AUDIOCODEC_ISACSWB	internet Speech Audio Codec(iSAC) 16KHZ (32-160)kbit/s
AUDIOCODEC_G7221	G722.1 16KHZ (16,24,32)kbit/s.
AUDIOCODEC_OPUS	OPUS 48KHZ 32kbit/s.
AUDIOCODEC_DTMF	DTMF RFC 2833.

VIDEOCODEC_TYPE

enum PortSIP.VIDEOCODEC_TYPE : int

strong

Video codec type.

Enumerator
VIDEO_CODE_NONE	Do not use Video codec.
VIDEO_CODEC_I420	I420/YUV420 Raw Video format. Used with startRecord only.
VIDEO_CODEC_H263	H263 video codec.
VIDEO_CODEC_H263_1998	H263+/H263 1998 video codec.
VIDEO_CODEC_H264	H264 video codec.
VIDEO_CODEC_VP8	VP8 video codec.
VIDEO_CODEC_VP9	VP9 video codec.

AUDIO_RECORDING_FILEFORMAT

enum PortSIP.AUDIO_RECORDING_FILEFORMAT : int

strong

The audio record file format.

Enumerator
FILEFORMAT_WAVE	The record audio file is in WAVE format.
FILEFORMAT_AMR	The record audio file is in AMR format - all voice data are compressed by AMR codec.

RECORD_MODE

enum PortSIP.RECORD_MODE : int

strong

The audio/Video record mode.

Enumerator
RECORD_NONE	Not Record.
RECORD_RECV	Only record the received data.
RECORD_SEND	Only record the sent data.
RECORD_BOTH	Record both received and sent data.

AUDIOSTREAM_CALLBACK_MODE

enum PortSIP.AUDIOSTREAM_CALLBACK_MODE : int

strong

The audio stream callback mode.

Enumerator
AUDIOSTREAM_LOCAL_PER_CHANNEL	Callback the audio stream from microphone for one channel based on the session ID.
AUDIOSTREAM_REMOTE_PER_CHANNEL	Callback the received audio stream for one channel based on the session ID.
AUDIOSTREAM_BOTH	Callback both of local and remote audio stream for one channel based on the session ID.

VIDEOSTREAM_CALLBACK_MODE

enum PortSIP.VIDEOSTREAM_CALLBACK_MODE : int

strong

The video stream callback mode.

Enumerator
VIDEOSTREAM_NONE	Disable video stream callback.
VIDEOSTREAM_LOCAL	Local video stream callback.
VIDEOSTREAM_REMOTE	Remote video stream callback.
VIDEOSTREAM_BOTH	Both of local and remote video stream callback.

SRTP_POLICY

enum PortSIP.SRTP_POLICY : int

strong

SRTP Policy.

Enumerator
SRTP_POLICY_NONE	Do not use SRTP. The SDK can receive the encrypted call(SRTP) and unencrypted call both, but can't place outgoing encrypted call.
SRTP_POLICY_FORCE	All calls must use SRTP. The SDK allows to receive encrypted call and place outgoing encrypted call only.
SRTP_POLICY_PREFER	Top priority for using SRTP. The SDK allows to receive encrypted and decrypted call, and to place outgoing encrypted call and unencrypted call.

TRANSPORT_TYPE

enum PortSIP.TRANSPORT_TYPE : int

strong

Transport for SIP signaling.

Enumerator
TRANSPORT_UDP	UDP Transport.
TRANSPORT_TLS	Tls Transport.
TRANSPORT_TCP	TCP Transport.
TRANSPORT_PERS	PERS is the PortSIP private transport for anti SIP blocking. It must be used with the PERS Server http://www.portsip.com/pers.html.

SESSION_REFRESH_MODE

enum PortSIP.SESSION_REFRESH_MODE : int

strong

The session refreshment by UAC or UAS.

Enumerator
SESSION_REFERESH_UAC	The session refreshment by UAC.
SESSION_REFERESH_UAS	The session refreshment by UAS.

DTMF_METHOD

enum PortSIP.DTMF_METHOD

strong

send DTMF tone with two methods

Enumerator
DTMF_RFC2833	Send DTMF tone with RFC 2833. Recommended.
DTMF_INFO	Send DTMF tone with SIP INFO.