amsip init interface
[General purpose API.]

Data Structures
struct	am_audio_stats
struct	am_audio_stats
Functions
int	am_init (const char *name, int debug_level)
int	am_reset (const char *name, int debug_level)
int	am_option_debug (const char *log_file, int debug_level)
int	am_quit (void)
int	am_option_set_user_agent (const char *user_agent)
int	am_option_set_initial_audio_port (int initial_port)
int	am_option_enable_stun_server (const char *stun_server, int use_stun_server)
int	am_option_enable_turn_server (const char *turn_server, int use_turn_server)
int	am_option_set_ipv4_for_gateway (const char *ipv4_for_gateway)
int	am_option_enable_http_proxy (const char *http_proxy, int http_port, const char *sip_proxy, int use_http_proxy)
int	am_option_enable_rport (int enable)
int	am_option_enable_outbound_proxy (char *outbound)
int	am_option_enable_101 (int enable)
int	am_option_enable_sdp_in_ack (int enable)
int	am_option_enable_symmetric_rtp (int enable)
int	am_option_select_in_sound_card (int card)
int	am_option_select_out_sound_card (int card)
int	am_option_enable_echo_canceller (int enable, int frame_size, int tail_length)
int	am_option_set_password (const char *realm, const char *login, const char *passwd)
int	am_option_load_plugins (const char *directory)
int	am_option_set_rate (int rate)

---

Function Documentation

int am_init	(	const char *	name,
		int	debug_level
	)

Initialize amsip library

Parameters:

	name	Text information for logging. (like vendor id)
	debug_level	Debug level for application.

int am_reset	(	const char *	name,
		int	debug_level
	)

Reset amsip library

Parameters:

	name	Text information for logging. (like vendor id)
	debug_level	Debug level for application.

int am_option_debug	(	const char *	log_file,
		int	debug_level
	)

Initialize log facility of library This method MUST be called only ONCE.

Parameters:

	log_file	File name for debugging
	debug_level	Debug level for application.

int am_quit

(

void

)

Close amsip library & release ressource.

int am_option_set_user_agent

(

const char *

user_agent

)

Configure amsip to use User-Agent header value.

Parameters:

user_agent

User-Agent header.

int am_option_set_initial_audio_port

(

int

initial_port

)

Configure amsip to use a specific audio port.

Parameters:

initial_port

initial audio port.

int am_option_enable_stun_server	(	const char *	stun_server,
		int	use_stun_server
	)

Configure amsip to use stun server.

Parameters:

	stun_server	IP of stun server.
	use_stun_server	enable use of stun server

int am_option_enable_turn_server	(	const char *	turn_server,
		int	use_turn_server
	)

Configure amsip to use stun server. INCOMPLETE: the server MUST be actually a STUN server, this options currently ask for enabling STUN connectivity checks and candidates handling in SDP.

Parameters:

	turn_server	IP of stun server.
	use_turn_server	enable use of stun server

int am_option_set_ipv4_for_gateway

(

const char *

ipv4_for_gateway

)

Configure amsip to detect interface with a specific IP to reach. This method will have an impact on the IP put in the Via header, Contact header, and in the SDP connection address.

Parameters:

ipv4_for_gateway

specific IP to reach.

int am_option_enable_http_proxy	(	const char *	http_proxy,
		int	http_port,
		const char *	sip_proxy,
		int	use_http_proxy
	)

Configure amsip to use HTTP tunnel for connection with SIP server.

Parameters:

	http_proxy	IP of HTTP server to use for SIP over HTTP (TCP connection).
	http_port	Port of HTTP server to use for SIP over HTTP
	sip_proxy	SIP proxy to use by HTTP server.
	use_http_proxy	enable use of http proxy

int am_option_enable_rport

(

int

enable

)

Configure amsip to add "rport" parameter.

Parameters:

enable

0: disable 1: enable

int am_option_enable_outbound_proxy

(

char *

outbound

)

Configure amsip to use an outbound proxy (PLEASE DO NOT USE)

Parameters:

outbound

proxy parameter.

int am_option_enable_101

(

int

enable

)

Configure amsip to send 101

Parameters:

enable

0: disable 1: enable

int am_option_enable_sdp_in_ack

(

int

enable

)

Configure amsip to put SDP in ACK

Parameters:

enable

0: disable 1: enable

int am_option_enable_symmetric_rtp

(

int

enable

)

Configure amsip to use symmetric RTP for streaming

Parameters:

enable

0: disable 1: enable

int am_option_select_in_sound_card

(

int

card

)

Configure amsip to use a specific audio card for recording audio

Parameters:

card

-1: default 0 to N: for selecting audio input

int am_option_select_out_sound_card

(

int

card

)

Configure amsip to use a specific audio card for playing audio

Parameters:

card

-1: default 0 to N: for selecting audio output

int am_option_enable_echo_canceller	(	int	enable,
		int	frame_size,
		int	tail_length
	)

Configure amsip to enable or disable echo canceller.

Parameters:

	enable	0 to disable, 1 to enable
	frame_size	frame size for echo canceller (should be 128 or 160)
	tail_length	tail_length for echo canceller (should be 2048 or 4096)

int am_option_set_password	(	const char *	realm,
		const char *	login,
		const char *	passwd
	)

Configure amsip to add new SÏP realm/login/password entry.

Parameters:

	realm	SIP realm on server.
	login	SIP login on server.
	passwd	SIP password on server.

int am_option_load_plugins

(

const char *

directory

)

Configure amsip to read mediastreamer2 plugins from a specific directory.

Parameters:

directory

directory on host.

int am_option_set_rate

(

int

rate

)

Configure amsip to use 16kHz internally and allow wideband codecs.

Parameters:

rate

internal rate to use.

---