amsip init and options interface

Data Structures
struct	am_srtp_info

Typedefs
typedef eXosip_tls_credentials_t	am_tls_credentials_t
typedef eXosip_tls_ctx_t	am_tls_ctx_t

Functions
char *	am_option_get_version (void)
int	am_init (const char *name, int debug_level)
int	am_reset (const char *name, int debug_level)
int	am_option_set_log_func (osip_trace_func_t *func, int debug_level)
int	am_option_debug (const char *log_file, int debug_level)
int	am_quit (void)
int	am_option_set_password (const char *realm, const char *login, const char *passwd)
int	am_option_delete_password (const char *realm, const char *login)
int	am_option_set_password_for_username (const char *from_username, const char *realm, const char *login, const char *passwd)
int	am_option_remove_password (void)
int	am_option_load_plugins (const char *directory)
int	am_option_geteventsocket (void)
int	am_option_set_option (int opt, void *arg)
int	am_option_conference_set_audio_option (int conf_id, int opt, void *arg)
int	am_option_conference_set_video_option (int conf_id, int opt, void *arg)
int	am_option_conference_set_screensharing_option (int conf_id, int opt, void *arg)
int	am_option_conference_set_dataevents_option (int conf_id, int opt, void *arg)
int	am_option_find_camera (struct am_camera *camera)
int	am_option_find_video_resolution (struct am_resolution *res)
int	am_option_find_out_sound_card (struct am_sndcard *sndcard)
int	am_option_find_in_sound_card (struct am_sndcard *sndcard)
int	am_option_select_in_sound_card (int card)
int	am_option_select_out_sound_card (int card)
int	am_option_select_in_custom_sound_card (MSSndCard *captcard)
int	am_option_select_out_custom_sound_card (MSSndCard *playcard)
int	am_option_conference_select_in_sound_card (int conf_id, int card)
int	am_option_conference_select_out_sound_card (int conf_id, int card)
int	am_option_conference_select_in_custom_sound_card (int conf_id, MSSndCard *captcard)
int	am_option_conference_select_out_custom_sound_card (int conf_id, MSSndCard *playcard)
int	am_option_select_in_and_out_custom_sound_card (int conf_id, MSSndCard *captcard, MSSndCard *playcard)
int	am_option_set_volume_out_sound_card (int card, int mixer, int percent)
int	am_option_get_volume_out_sound_card (int card, int mixer)
int	am_option_set_volume_in_sound_card (int card, int percent)
int	am_option_get_volume_in_sound_card (int card)
int	am_option_set_mute_out_sound_card (int card, int mixer, int val)
int	am_option_set_mute_in_sound_card (int card, int val)
int	am_option_set_mic_boost (int card, int val)

Detailed Description

Typedef Documentation

am_tls_credentials_t

am_tls_credentials_t

structure used to describe credentials for a client or server consists of a certificate, a corresponding private key and its password

am_tls_ctx_t

am_tls_ctx_t

structure to describe the whole TLS-context for eXosip consists of a certificate, a corresponding private key and its password

Function Documentation

am_option_get_version()

char* am_option_get_version

(

void

)

Get amsip version.

am_init()

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.

am_reset()

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.

am_option_set_log_func()

int am_option_set_log_func	(	osip_trace_func_t *	func,
		int	debug_level
	)

Initialize log facility of library

Parameters

func	Func that will receive sip trace.
debug_level	Debug level for application.

am_option_debug()

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.

am_quit()

int am_quit

(

void

)

Close amsip library & release ressource.

am_option_set_password()

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

Configure amsip to add new SIP realm/login/password entry.

Parameters

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

am_option_delete_password()

int am_option_delete_password	(	const char *	realm,
		const char *	login
	)

Configure amsip to remove a SIP realm/login/password entry.

Parameters

realm	SIP realm on server.
login	SIP login on server.

am_option_set_password_for_username()

int am_option_set_password_for_username	(	const char *	from_username,
		const char *	realm,
		const char *	login,
		const char *	passwd
	)

Configure amsip to add new SIP realm/login/password entry.

Parameters

from_username	SIP username which appears in From headers.
realm	SIP realm on server.
login	SIP login on server.
passwd	SIP password on server.

am_option_remove_password()

int am_option_remove_password

(

void

)

Configure amsip to remove all previous SIP realm/login/password entries.

am_option_load_plugins()

int am_option_load_plugins

(

const char *

directory

)

Configure amsip to read mediastreamer2 plugins from a specific directory.

Parameters

directory

directory on host.

am_option_geteventsocket()

int am_option_geteventsocket

(

void

)

Retreive a socket where data is written when a eXosip_event is available in amsip/eXosip2 fifo.

am_option_set_option()

int am_option_set_option	(	int	opt,
		void *	arg
	)

Configure amsip options.

Parameters

opt	option.
arg	pointer to option value.

am_option_conference_set_audio_option()

int am_option_conference_set_audio_option	(	int	conf_id,
		int	opt,
		void *	arg
	)

Configure amsip audio options.

Parameters

conf_id	Conference room number (below #define AMSIP_CONF_MAX)
opt	option.
arg	pointer to option value.

am_option_conference_set_video_option()

int am_option_conference_set_video_option	(	int	conf_id,
		int	opt,
		void *	arg
	)

Configure video options for amsip. Current options are: AM_OPTION_WEBCAM_FPS AM_OPTION_FORCE_ENCODER_FPS

Parameters

conf_id	Conference room number (below #define AMSIP_CONF_MAX)
opt	opt identifier
arg	pointer to structure holding parameter value

am_option_conference_set_screensharing_option()

int am_option_conference_set_screensharing_option	(	int	conf_id,
		int	opt,
		void *	arg
	)

Configure screensharing options for amsip.

Parameters

conf_id	Conference room number (below #define AMSIP_CONF_MAX)
opt	opt identifier
arg	pointer to structure holding parameter value

am_option_conference_set_dataevents_option()

int am_option_conference_set_dataevents_option	(	int	conf_id,
		int	opt,
		void *	arg
	)

Configure dataevents options for amsip.

Parameters

conf_id	Conference room number (below #define AMSIP_CONF_MAX)
opt	opt identifier
arg	pointer to structure holding parameter value

am_option_find_camera()

int am_option_find_camera

(

struct am_camera *

camera

)

Retreive camera name from id number: camera.card = 0; am_option_find_camera(&camera);

Parameters

camera

-1: "Static Image" and 0 to N: for selecting camera device

am_option_find_video_resolution()

int am_option_find_video_resolution

(

struct am_resolution *

res

)

Retreive resolution from id number: THIS IS NOT IMPLEMENTED IN AMSIP SDK (Available under other engine.) res.id = 0; am_option_find_video_resolution(&res);

Parameters

res	-1: default 0 to N: for selecting resolution for selected camera

am_option_find_out_sound_card()

int am_option_find_out_sound_card

(

struct am_sndcard *

sndcard

)

Retreive card name from id number: sndcard.card = 0; am_option_find_out_sound_card(&sndcard);

Parameters

sndcard

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

am_option_find_in_sound_card()

int am_option_find_in_sound_card

(

struct am_sndcard *

sndcard

)

Retreive card name from id number: sndcard.card = 0; am_option_find_in_sound_card(&sndcard);

Parameters

sndcard

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

am_option_select_in_sound_card()

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

am_option_select_out_sound_card()

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

am_option_select_in_custom_sound_card()

int am_option_select_in_custom_sound_card

(

MSSndCard *

captcard

)

Configure amsip to use a specific audio card for recording audio

Parameters

captcard

MSSndCard object pointer

am_option_select_out_custom_sound_card()

int am_option_select_out_custom_sound_card

(

MSSndCard *

playcard

)

Configure amsip to use a specific audio card for playing audio

Parameters

playcard

MSSndCard object pointer

am_option_conference_select_in_sound_card()

int am_option_conference_select_in_sound_card	(	int	conf_id,
		int	card
	)

Configure amsip to use a specific audio card for recording audio

Parameters

conf_id	Conference room number (below #define AMSIP_CONF_MAX)
card	-1: default 0 to N: for selecting audio input

am_option_conference_select_out_sound_card()

int am_option_conference_select_out_sound_card	(	int	conf_id,
		int	card
	)

Configure amsip to use a specific audio card for playing audio

Parameters

conf_id	Conference room number (below #define AMSIP_CONF_MAX)
card	-1: default 0 to N: for selecting audio output

am_option_conference_select_in_custom_sound_card()

int am_option_conference_select_in_custom_sound_card	(	int	conf_id,
		MSSndCard *	captcard
	)

Configure amsip to use a specific audio card for recording audio

Parameters

conf_id	Conference room number (below #define AMSIP_CONF_MAX)
captcard	MSSndCard object pointer

am_option_conference_select_out_custom_sound_card()

int am_option_conference_select_out_custom_sound_card	(	int	conf_id,
		MSSndCard *	playcard
	)

Configure amsip to use a specific audio card for playing audio

Parameters

conf_id	Conference room number (below #define AMSIP_CONF_MAX)
playcard	MSSndCard object pointer

am_option_select_in_and_out_custom_sound_card()

int am_option_select_in_and_out_custom_sound_card	(	int	conf_id,
		MSSndCard *	captcard,
		MSSndCard *	playcard
	)

Configure amsip to use a specific audio card for playing and recording audio

Parameters

conf_id	Conference room number (below #define AMSIP_CONF_MAX)
captcard	MSSndCard object pointer
playcard	MSSndCard object pointer

am_option_set_volume_out_sound_card()

int am_option_set_volume_out_sound_card	(	int	card,
		int	mixer,
		int	percent
	)

Configure amsip to set volume of playback card

Parameters

card	-1: default 0 to N: for selecting audio output
mixer	0: master, 1: playback
percent	0: no volume, 100: maximum volume

am_option_get_volume_out_sound_card()

int am_option_get_volume_out_sound_card	(	int	card,
		int	mixer
	)

Configure amsip to get volume of playback card

Parameters

card	-1: default 0 to N: for selecting audio output
mixer	0: master, 1: playback

am_option_set_volume_in_sound_card()

int am_option_set_volume_in_sound_card	(	int	card,
		int	percent
	)

Configure amsip to set volume of capture card

Parameters

card	-1: default 0 to N: for selecting audio input
percent	0: no volume, 100: maximum volume

am_option_get_volume_in_sound_card()

int am_option_get_volume_in_sound_card

(

int

card

)

Configure amsip to get volume of capture card

Parameters

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

am_option_set_mute_out_sound_card()

int am_option_set_mute_out_sound_card	(	int	card,
		int	mixer,
		int	val
	)

Configure amsip to mute/unmute playback card

Parameters

card	-1: default 0 to N: for selecting audio output
mixer	0: mixer, 1: playback
val	0: unmute, 1: mute

am_option_set_mute_in_sound_card()

int am_option_set_mute_in_sound_card	(	int	card,
		int	val
	)

Configure amsip to mute/unmute capture card

Parameters

card	-1: default 0 to N: for selecting audio output
val	0: unmute, 1: mute

am_option_set_mic_boost()

int am_option_set_mic_boost	(	int	card,
		int	val
	)

Configure amsip to configure MIC boost. THIS IS NOT IMPLEMENTED IN AMSIP SDK (Available under other engine.)

Parameters

card	-1: default 0 to N: for selecting audio output
val	0: no change, 1: force enable 2: force disable