libamsip  5.1.0
Data Structures | Functions
amsip init and options interface
General purpose configuration API.

Data Structures

struct  am_srtp_info
struct  am_tls_credentials_t
struct  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

Function Documentation

char* am_option_get_version ( void  )

Get amsip version.

int am_init ( const char *  name,
int  debug_level 
)

Initialize amsip library

Parameters
nameText information for logging. (like vendor id)
debug_levelDebug level for application.
int am_reset ( const char *  name,
int  debug_level 
)

Reset amsip library

Parameters
nameText information for logging. (like vendor id)
debug_levelDebug level for application.
int am_option_set_log_func ( osip_trace_func_t *  func,
int  debug_level 
)

Initialize log facility of library

Parameters
funcFunc that will receive sip trace.
debug_levelDebug 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_fileFile name for debugging
debug_levelDebug level for application.
int am_quit ( void  )

Close amsip library & release ressource.

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
realmSIP realm on server.
loginSIP login on server.
passwdSIP password on server.
int am_option_delete_password ( const char *  realm,
const char *  login 
)

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

Parameters
realmSIP realm on server.
loginSIP login on server.
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_usernameSIP username which appears in From headers.
realmSIP realm on server.
loginSIP login on server.
passwdSIP password on server.
int am_option_remove_password ( void  )

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

int am_option_load_plugins ( const char *  directory)

Configure amsip to read mediastreamer2 plugins from a specific directory.

Parameters
directorydirectory on host.
int am_option_geteventsocket ( void  )

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

int am_option_set_option ( int  opt,
void *  arg 
)

Configure amsip options.

Parameters
optoption.
argpointer to option value.
int am_option_conference_set_audio_option ( int  conf_id,
int  opt,
void *  arg 
)

Configure amsip audio options.

Parameters
conf_idConference room number (below #define AMSIP_CONF_MAX)
optoption.
argpointer to option value.
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_idConference room number (below #define AMSIP_CONF_MAX)
optopt identifier
argpointer to structure holding parameter value
int am_option_conference_set_screensharing_option ( int  conf_id,
int  opt,
void *  arg 
)

Configure screensharing options for amsip.

Parameters
conf_idConference room number (below #define AMSIP_CONF_MAX)
optopt identifier
argpointer to structure holding parameter value
int am_option_conference_set_dataevents_option ( int  conf_id,
int  opt,
void *  arg 
)

Configure dataevents options for amsip.

Parameters
conf_idConference room number (below #define AMSIP_CONF_MAX)
optopt identifier
argpointer to structure holding parameter value
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
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
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
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
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_select_in_custom_sound_card ( MSSndCard *  captcard)

Configure amsip to use a specific audio card for recording audio

Parameters
captcardMSSndCard object pointer
int am_option_select_out_custom_sound_card ( MSSndCard *  playcard)

Configure amsip to use a specific audio card for playing audio

Parameters
playcardMSSndCard object pointer
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_idConference room number (below #define AMSIP_CONF_MAX)
card-1: default 0 to N: for selecting audio input
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_idConference room number (below #define AMSIP_CONF_MAX)
card-1: default 0 to N: for selecting audio output
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_idConference room number (below #define AMSIP_CONF_MAX)
captcardMSSndCard object pointer
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_idConference room number (below #define AMSIP_CONF_MAX)
playcardMSSndCard object pointer
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_idConference room number (below #define AMSIP_CONF_MAX)
captcardMSSndCard object pointer
playcardMSSndCard object pointer
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
mixer0: master, 1: playback
percent0: no volume, 100: maximum volume
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
mixer0: master, 1: playback
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
percent0: no volume, 100: maximum volume
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
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
mixer0: mixer, 1: playback
val0: unmute, 1: mute
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
val0: unmute, 1: mute
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
val0: no change, 1: force enable 2: force disable