public class SIPConfig
extends java.lang.Object
Constructor and Description |
---|
SIPConfig(long handle)
Constructor storing the pointer/address to the underlying native object
|
Modifier and Type | Method and Description |
---|---|
java.util.List<HeaderField> |
additionalHeaders()
Gets a list with SIP Header fields to be added to a set of SIP Request Methods
Adds a list of header fields with its value to the list of custom headers to be added to each SIP request specified
in @p HeaderField::Method, made by this SIP user.
|
void |
additionalHeaders(java.util.List<HeaderField> value)
Sets a list with SIP Header fields to be added to a set of SIP Request Methods
Adds a list of header fields with its value to the list of custom headers to be added to each SIP request specified
in @p HeaderField::Method, made by this SIP user.
|
java.lang.String |
authUsername()
Gets the user name used for SIP authentication
The user name to be used when responding to a SIP authentication challenge.
|
void |
authUsername(java.lang.String value)
Changes the user name used for SIP authentication
Changes the user name to be used when responding to a SIP authentication challenge.
|
int |
callAutoRejectTimeout()
Gets the auto reject timeout for incoming calls
Configures the auto reject timeout for incoming calls in case no action is applied to them (either answer or reject).
|
void |
callAutoRejectTimeout(int value)
Sets the auto reject timeout for incoming calls
Configures the auto reject timeout for incoming calls in case no action is applied to them (either answer or reject).
|
java.lang.String |
callerID()
Gets the Caller ID used as display name part in the address of record
|
void |
callerID(java.lang.String value)
Configures the Caller ID used as display name part in the address of record
|
boolean |
connectionPersistence()
Configures connection persistence for a user
Enables or disables the connection persistence option for a user (ENABLED by default).
|
void |
connectionPersistence(boolean value)
Configures connection persistence for a user
Enables or disables the connection persistence option for a user (ENABLED by default).
|
java.lang.String |
domain()
Gets the user domain
This is the domain part of the address of record.
|
void |
domain(java.lang.String value)
Sets the user domain
This is the domain part of the address of record.
|
boolean |
enableMediasec()
Gets whether always to force the use of the mediasec
Require the use of the "mediasec" draft specification.
|
void |
enableMediasec(boolean value)
Sets whether always to force the use of the mediasec
Require the use of the "mediasec" draft specification.
|
boolean |
enablePreconditions()
Gets the use of call's preconditions framework as described in RFC 3312
The preconditions are used to negotiate network resources needed for a call before it starts ringing.
|
void |
enablePreconditions(boolean value)
Sets the use of call's preconditions framework as described in RFC 3312
The preconditions are used to negotiate network resources needed for a call before it starts ringing.
|
boolean |
enablePrivacy()
Gets the use of Privacy mechanism as described in RFC 3323
Whether the user's identity is revealed in the SIP URIs or anonymous one is used.
|
void |
enablePrivacy(boolean value)
Sets the use of Privacy mechanism as described in RFC 3323
Set whether the user's identity to be revealed in the SIP URIs or anonymous one to be used.
|
boolean |
enableSRTP()
Gets the use of user's SRTP
|
void |
enableSRTP(boolean value)
Sets the use of user's SRTP
|
boolean |
enableVideoFMTP()
Gets video FMTP support
|
void |
enableVideoFMTP(boolean value)
Sets video FMTP support
This will take effect in calls created/received after the setting has changed.
|
protected void |
finalize()
Ensures the underlying native object destruction
|
long |
handle()
Gets the pointer/address to the underlying native object
|
boolean |
headerDump()
Gets the use of SIP Header dumps for SIP Calls and Registration event
Enable or disable the SIP header fields dump for SIP calls and registration events for the specified user.
|
void |
headerDump(boolean value)
Sets the use of SIP Header dumps for SIP Calls and Registration event
Enable or disable the SIP header fields dump for SIP calls and registration events for the specified user.
|
boolean |
isEqual(SIPConfig comp)
Compares the current configuration with the given one
|
int |
keepAlive()
Gets the keepalive interval for SIP accounts
The keepalive is a SIP packet sent over the signaling socket containing only a new line (CRLF).
|
void |
keepAlive(int value)
Sets the keepalive interval for SIP accounts
The keepalive is a SIP packet sent over the signaling socket containing only a new line (CRLF).
|
MSRPConfig |
msrp()
Gets the MSRP configuration
|
void |
msrp(MSRPConfig value)
Sets the MSRP configuration
|
java.lang.String |
outboundProxy()
Gets the configured SIP Outbound Proxy to be used
The outbound proxy is a normal SIP proxy.
|
void |
outboundProxy(java.lang.String value)
Sets the SIP Outbound Proxy to be used
The outbound proxy is a normal SIP proxy.
|
PushConfig |
push()
Gets the Push configuration
|
void |
push(PushConfig value)
Sets the Push configuration
|
RPortType |
rPort()
Gets the use of rport for SIP users
Used to discover the public address and port in case there is a NAT between the user and the server.
|
void |
rPort(RPortType value)
Sets the use of rport for SIP users
Used to discover the public address and port in case there is a NAT between the user and the server.
|
RTCPFeedbackType |
rtcpFeedback()
Gets the RTCP Feedback support
The purpose of RTCP Feedback is to provide quick inbound status reporting for media streams, error correction
and resilience against packet losses.
|
void |
rtcpFeedback(RTCPFeedbackType value)
Sets the RTCP Feedback support
The purpose of RTCP Feedback is to provide quick inbound status reporting for media streams, error correction
and resilience against packet losses.
|
RTPCollisionResolutionType |
rtpCollisionResolution()
Gets the desired RTP collision resolution
|
void |
rtpCollisionResolution(RTPCollisionResolutionType value)
Sets the desired RTP collision resolution
|
int |
sessionTimerExpiry()
Changes the session timer expiry according to RFC 4028.
|
void |
sessionTimerExpiry(int value)
Changes the session timer expiry according to RFC 4028.
|
SessionTimerModeType |
sessionTimerMode()
Changes the session timers setting according to RFC 4028.
|
void |
sessionTimerMode(SessionTimerModeType value)
Changes the session timers setting according to RFC 4028.
|
java.lang.String |
sipInstance()
Gets the configured RFC2141 URN for SIP registrations
Gets the configures the SIP instance URN used for SIP outbound (RFC 5626).
|
void |
sipInstance(java.lang.String value)
Configures RFC2141 URN for SIP registrations
Configures the SIP instance URN used for SIP outbound (RFC 5626).
|
StunConfig |
stun()
Gets the STUN configuration
|
void |
stun(StunConfig value)
Sets the STUN configuration
|
TransportType |
transport()
Gets the selected SIP transport
|
void |
transport(TransportType value)
Selects the SIP transport to be used
|
boolean |
useOutboundProxy()
Gets the use of SIP Outbound as described in RFC 5626
Enables or disables RFC 5626 for SIP users.
|
void |
useOutboundProxy(boolean value)
Configures the use of SIP Outbound as described in RFC 5626
Enables or disables RFC 5626 for SIP users.
|
ZRTPConfig |
zrtp()
Gets the ZRTP configuration
|
void |
zrtp(ZRTPConfig value)
Sets the ZRTP configuration
|
public SIPConfig(long handle)
handle
- Pointer/address to the underlying native objectpublic long handle()
protected void finalize()
finalize
in class java.lang.Object
public java.lang.String domain()
public void domain(java.lang.String value)
value
- The user's SIP Domain to be usedpublic boolean useOutboundProxy()
public void useOutboundProxy(boolean value)
value
- public java.lang.String outboundProxy()
public void outboundProxy(java.lang.String value)
value
- The SIP Outbound Proxy to be usedpublic java.lang.String sipInstance()
userSipInstance
public void sipInstance(java.lang.String value)
value
- The RFC 2141 URN to be used in RFC 5626 (SIP outbound)userSipInstance
public TransportType transport()
TransportType
public void transport(TransportType value)
value
- The signalling protocol to select (UDP, TCP, TLS)TransportType
public java.lang.String authUsername()
public void authUsername(java.lang.String value)
value
- The new user name to use for authenticationpublic java.lang.String callerID()
public void callerID(java.lang.String value)
value
- The CallerID to be usedpublic RPortType rPort()
RPortType
public void rPort(RPortType value)
value
- RPortType
public boolean enableSRTP()
public void enableSRTP(boolean value)
value
- public boolean enablePreconditions()
public void enablePreconditions(boolean value)
value
- public boolean enableVideoFMTP()
public void enableVideoFMTP(boolean value)
value
- public RTCPFeedbackType rtcpFeedback()
RTCPFeedbackType
public void rtcpFeedback(RTCPFeedbackType value)
value
- RTCPFeedbackType
public StunConfig stun()
StunConfig
public void stun(StunConfig value)
value
- STUN configurationStunConfig
public MSRPConfig msrp()
MSRPConfig
public void msrp(MSRPConfig value)
value
- MSRP configurationMSRPConfig
public ZRTPConfig zrtp()
ZRTPConfig
public void zrtp(ZRTPConfig value)
value
- ZRTP configurationZRTPConfig
public PushConfig push()
PushConfig
public void push(PushConfig value)
value
- Push configurationPushConfig
public boolean enablePrivacy()
public void enablePrivacy(boolean value)
value
- public int keepAlive()
public void keepAlive(int value)
value
- Keepalive setting in seconds
public boolean headerDump()
public void headerDump(boolean value)
value
- public java.util.List<HeaderField> additionalHeaders()
HeaderField
public void additionalHeaders(java.util.List<HeaderField> value)
value
- The list with additional SIP headersHeaderField
public int callAutoRejectTimeout()
public void callAutoRejectTimeout(int value)
value
- The timeout in seconds. 0 turns this feature off (default: 120 seconds)public boolean connectionPersistence()
public void connectionPersistence(boolean value)
value
- public RTPCollisionResolutionType rtpCollisionResolution()
RTPCollisionResolutionType
public void rtpCollisionResolution(RTPCollisionResolutionType value)
value
- The desired collision resolution (default: RTPCollisionResolutionType::Moderate)RTPCollisionResolutionType
public SessionTimerModeType sessionTimerMode()
sessionTimerExpiry
public void sessionTimerMode(SessionTimerModeType value)
value
- The desired Session Timer Mode (default: SessionTimerModeType::Disabled)sessionTimerExpiry
public int sessionTimerExpiry()
sessionTimerMode
public void sessionTimerExpiry(int value)
value
- Session expiration in seconds, if sessionTimerMode is not sessionTimerModeType::Disabled. Must be >= 90s.sessionTimerMode
public boolean enableMediasec()
public void enableMediasec(boolean value)
value
- public boolean isEqual(SIPConfig comp)
comp
- SIP configuration to be compared