public class UserAgentProfile extends Configure
Modifier and Type | Field and Description |
---|---|
int |
accept_time
Automatic answer time in seconds; time<0 corresponds to manual answer mode.
|
boolean |
audio
Whether using audio
|
SocketAddress |
audio_mcast_soaddr
Fixed audio multicast socket address; if defined, it forces the use of this maddr+port for audio session
|
java.lang.String |
auth_passwd
User's passwd used for server authentication.
|
java.lang.String |
auth_realm
User's realm used for server authentication.
|
java.lang.String |
auth_user
User's name used for server authentication.
|
java.lang.String |
bin_rat
RAT command-line executable
|
java.lang.String |
bin_vic
VIC command-line executable
|
static java.lang.String |
buddy_list_file
Absolute path (or complete URI) of the buddy list file where the buddy list is and loaded from (and saved to).
|
NameAddress |
call_to
Automatic call a remote user secified by the 'call_to' value.
|
java.lang.String |
display_name
Display name for the user.
|
boolean |
do_register
Whether registering with the registrar server
|
boolean |
do_unregister
Whether unregistering the contact address
|
boolean |
do_unregister_all
Whether unregistering all contacts beafore registering the contact address
|
int |
expires
Expires time (in seconds).
|
int |
hangup_time
Automatic hangup time (call duartion) in seconds; time<=0 corresponds to manual hangup mode.
|
boolean |
javax_sound_direct_convertion
Whether using explicit external converter (i.e. direct access to an external conversion provider)
instead of that provided by javax.sound.sampled.spi.
|
java.lang.String |
javax_sound_streamer
Alternative javax-sound-based audio streamer (currently just for tests)
|
boolean |
javax_sound_sync
Whether enforcing time synchronization to RTP source stream.
|
long |
keepalive_time
Rate of keep-alive tokens (datagrams) sent toward the outbound proxy
(if present) or toward the registrar server.
|
boolean |
loopback
Whether looping the received media streams back to the sender.
|
java.lang.String |
media_addr
Media address (use it if you want to use a media address different from the via address)
|
MediaDesc[] |
media_descs
Array of media descriptions
|
static java.lang.String |
media_path
Relative path of UA media resources (gif, wav, etc.) within the UA jar file or within the resources folder.
|
boolean |
no_offer
No offer in the invite
|
boolean |
no_prompt
Do not use prompt
|
boolean |
no_system_audio
Do not use system audio
|
boolean |
null_server
Whether running an Null Server, that automatically responds to not-implemented requests.
|
boolean |
options_server
Whether running an Options Server, that automatically responds to OPTIONS requests.
|
java.lang.String |
proxy
Fully qualified domain name (or address) of the proxy server.
|
int |
random_early_drop_rate
Receiver random early drop (RED) rate.
|
int |
re_call_count
Number of successive automatic re-calls; it is used only if call_to!
|
int |
re_call_time
Automatic re-call time in seconds; time<0 corresponds to no auto re-call mode.
|
int |
re_invite_time
Automatic re-inviting time in seconds; time<0 corresponds to no auto re-invite mode.
|
java.lang.String |
recv_file
Audio file to be recorded
|
boolean |
recv_only
Whether playing in receive only mode
|
java.lang.String |
recv_video_file
Video file to be recorded
|
NameAddress |
redirect_to
Redirect incoming call to the secified URI.
|
int |
refuse_time
Response time in seconds; it is the maximum time the user can wait before responding to an incoming call; after such time the call is automatically declined (refused).
|
java.lang.String |
registrar
Fully qualified domain name (or address) of the registrar server.
|
static java.lang.String |
res_path
Absolute path (or complete URI) of the folder containing UA resources.
|
java.lang.String |
send_file
Audio file to be streamed
|
boolean |
send_only
Whether playing in send only mode
|
boolean |
send_tone
Whether playing a test tone in send only mode
|
java.lang.String |
send_video_file
Video file to be streamed
|
boolean |
symmetric_rtp
Whether using symmetric_rtp
|
int |
transfer_time
Automatic call transfer time in seconds; time<0 corresponds to no auto transfer mode.
|
NameAddress |
transfer_to
Transfer calls to the secified URI.
|
java.lang.String |
ua_address
UA address.
|
static java.lang.String |
ua_jar
Absolute path (or complete URI) of the jar archive, where various UA media (gif, wav, etc.) are stored.
|
boolean |
ua_server
Whether running the UAS (User Agent Server), or acting just as UAC (User Agent Client).
|
boolean |
use_jmf_audio
Whether using JMF for audio streaming
|
boolean |
use_jmf_video
Whether using JMF for video streaming
|
boolean |
use_rat
Whether using RAT (Robust Audio Tool) as audio sender/receiver
|
boolean |
use_vic
Whether using VIC (Video Conferencing Tool) as video sender/receiver
|
java.lang.String |
user
User's name.
|
boolean |
video
Whether using video
|
SocketAddress |
video_mcast_soaddr
Fixed video multicast socket address; if defined, it forces the use of this maddr+port for video session
|
Constructor and Description |
---|
UserAgentProfile()
Costructs a void UserAgentProfile
|
UserAgentProfile(java.lang.String file)
Costructs a new UserAgentProfile
|
Modifier and Type | Method and Description |
---|---|
int |
getMediaPort()
Gets the transport port of the first medium.
|
NameAddress |
getUserURI()
Gets the user's AOR (Address Of Record) registered to the registrar server
and used as From URI.
|
protected void |
parseLine(java.lang.String line)
Parses a single line (loaded from the config file)
|
void |
setMediaPort(int media_port)
Sets the transport port for each medium.
|
void |
setMediaPort(int media_port,
int diff)
Sets the transport port for each medium.
|
void |
setUnconfiguredAttributes(SipProvider sip_provider)
Sets server and authentication attributes (if not already done).
|
void |
setUserURI(NameAddress naddr)
Sets the user's AOR (Address Of Record) registered to the registrar server
and used as From URI.
|
protected java.lang.String |
toLines()
Converts the entire object into lines (to be saved into the config file)
|
public java.lang.String display_name
public java.lang.String user
public java.lang.String proxy
If proxy is not defined, the registrar value is used in its place.
If registrar is not defined, the proxy value is used in its place.
public java.lang.String registrar
If registrar is not defined, the proxy value is used in its place.
If proxy is not defined, the registrar value is used in its place.
public java.lang.String ua_address
public java.lang.String auth_user
public java.lang.String auth_realm
public java.lang.String auth_passwd
public static java.lang.String ua_jar
public static java.lang.String res_path
public static java.lang.String media_path
public static java.lang.String buddy_list_file
public boolean do_register
public boolean do_unregister
public boolean do_unregister_all
public int expires
public long keepalive_time
public NameAddress call_to
public int refuse_time
public int accept_time
public int hangup_time
public int transfer_time
public int re_invite_time
public int re_call_time
public int re_call_count
public NameAddress redirect_to
public NameAddress transfer_to
public boolean no_offer
public boolean no_system_audio
public boolean no_prompt
public boolean audio
public boolean video
public boolean loopback
public boolean recv_only
public boolean send_only
public boolean send_tone
public java.lang.String send_file
public java.lang.String recv_file
public java.lang.String send_video_file
public java.lang.String recv_video_file
public java.lang.String media_addr
public boolean symmetric_rtp
public MediaDesc[] media_descs
public boolean use_jmf_audio
public boolean use_jmf_video
public boolean use_rat
public boolean use_vic
public java.lang.String bin_rat
public java.lang.String bin_vic
public boolean ua_server
public boolean options_server
public boolean null_server
public java.lang.String javax_sound_streamer
public boolean javax_sound_direct_convertion
public boolean javax_sound_sync
Note that when using audio capturing, synchronization with the sample rate is implicitely performed by the audio capture device and frames are read at constat bit rate. However, an explicit re-synchronization is suggested in order to let the read() method be non-blocking (in the other case the UA audio performance seems decreasing.
public int random_early_drop_rate
public SocketAddress audio_mcast_soaddr
public SocketAddress video_mcast_soaddr
public UserAgentProfile()
public UserAgentProfile(java.lang.String file)
file
- the name of the configuration filepublic NameAddress getUserURI()
In case of proxy and user parameters have been defined it is formed as "display_name" <sip:user@proxy>, otherwhise the local UA address (obtained by the SipProvider) is used.
public void setUserURI(NameAddress naddr)
It actually sets the display_name, user, and proxy parameters.
If registrar is not defined, the proxy value is used in its place.
naddr
- the user's name address formed by the user's display name (optional) and URIpublic void setUnconfiguredAttributes(SipProvider sip_provider)
Note: this method sets such attributes only if they haven't still been initilized.
sip_provider
- the SIP provider used for initializing these attributespublic void setMediaPort(int media_port)
media_port
- the port number for the first mediumpublic void setMediaPort(int media_port, int diff)
media_port
- the port number for the first mediumdiff
- the incremented value for successive media portspublic int getMediaPort()
protected void parseLine(java.lang.String line)