UniMRCP  1.5.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions
mrcp_server.h File Reference

MRCP Server. More...

#include "mrcp_server_types.h"
#include "mrcp_engine_iface.h"
#include "mpf_rtp_descriptor.h"
#include "apt_task.h"

Go to the source code of this file.

Functions

APT_BEGIN_EXTERN_C mrcp_server_tmrcp_server_create (apt_dir_layout_t *dir_layout)
 
apt_bool_t mrcp_server_start (mrcp_server_t *server)
 
apt_bool_t mrcp_server_offline (mrcp_server_t *server)
 
apt_bool_t mrcp_server_online (mrcp_server_t *server)
 
apt_bool_t mrcp_server_shutdown (mrcp_server_t *server)
 
apt_bool_t mrcp_server_destroy (mrcp_server_t *server)
 
apt_bool_t mrcp_server_resource_factory_register (mrcp_server_t *server, mrcp_resource_factory_t *resource_factory)
 
apt_bool_t mrcp_server_engine_register (mrcp_server_t *server, mrcp_engine_t *engine)
 
apt_bool_t mrcp_server_codec_manager_register (mrcp_server_t *server, mpf_codec_manager_t *codec_manager)
 
const mpf_codec_manager_tmrcp_server_codec_manager_get (const mrcp_server_t *server)
 
apt_bool_t mrcp_server_media_engine_register (mrcp_server_t *server, mpf_engine_t *media_engine)
 
apt_bool_t mrcp_server_rtp_factory_register (mrcp_server_t *server, mpf_termination_factory_t *rtp_termination_factory, const char *name)
 
apt_bool_t mrcp_server_rtp_settings_register (mrcp_server_t *server, mpf_rtp_settings_t *rtp_settings, const char *name)
 
apt_bool_t mrcp_server_signaling_agent_register (mrcp_server_t *server, mrcp_sig_agent_t *signaling_agent)
 
apt_bool_t mrcp_server_connection_agent_register (mrcp_server_t *server, mrcp_connection_agent_t *connection_agent)
 
mrcp_server_profile_tmrcp_server_profile_create (const char *id, mrcp_version_e mrcp_version, mrcp_resource_factory_t *resource_factory, mrcp_sig_agent_t *signaling_agent, mrcp_connection_agent_t *connection_agent, mpf_engine_t *media_engine, mpf_termination_factory_t *rtp_factory, mpf_rtp_settings_t *rtp_settings, apr_pool_t *pool)
 
apt_bool_t mrcp_server_profile_register (mrcp_server_t *server, mrcp_server_profile_t *profile, apr_table_t *plugin_map)
 
mrcp_engine_tmrcp_server_engine_load (mrcp_server_t *server, const char *id, const char *path, mrcp_engine_config_t *config)
 
apr_pool_t * mrcp_server_memory_pool_get (const mrcp_server_t *server)
 
mpf_engine_tmrcp_server_media_engine_get (const mrcp_server_t *server, const char *name)
 
mpf_termination_factory_tmrcp_server_rtp_factory_get (const mrcp_server_t *server, const char *name)
 
mpf_rtp_settings_tmrcp_server_rtp_settings_get (const mrcp_server_t *server, const char *name)
 
mrcp_sig_agent_tmrcp_server_signaling_agent_get (const mrcp_server_t *server, const char *name)
 
mrcp_connection_agent_tmrcp_server_connection_agent_get (const mrcp_server_t *server, const char *name)
 
mrcp_server_profile_tmrcp_server_profile_get (const mrcp_server_t *server, const char *name)
 

Detailed Description

MRCP Server.

Function Documentation

const mpf_codec_manager_t* mrcp_server_codec_manager_get ( const mrcp_server_t server)

Get registered codec manager.

Parameters
serverthe MRCP server to get codec manager from
apt_bool_t mrcp_server_codec_manager_register ( mrcp_server_t server,
mpf_codec_manager_t codec_manager 
)

Register codec manager.

Parameters
serverthe MRCP server to set codec manager for
codec_managerthe codec manager to set
mrcp_connection_agent_t* mrcp_server_connection_agent_get ( const mrcp_server_t server,
const char *  name 
)

Get connection agent by name.

Parameters
serverthe MRCP server to get from
namethe name to lookup
apt_bool_t mrcp_server_connection_agent_register ( mrcp_server_t server,
mrcp_connection_agent_t connection_agent 
)

Register MRCP connection agent (MRCPv2 only).

Parameters
serverthe MRCP server to set connection agent for
connection_agentthe connection agent to set
APT_BEGIN_EXTERN_C mrcp_server_t* mrcp_server_create ( apt_dir_layout_t dir_layout)

Create MRCP server instance.

Returns
the created server instance
apt_bool_t mrcp_server_destroy ( mrcp_server_t server)

Destroy MRCP server.

Parameters
serverthe MRCP server to destroy
mrcp_engine_t* mrcp_server_engine_load ( mrcp_server_t server,
const char *  id,
const char *  path,
mrcp_engine_config_t config 
)

Load MRCP engine as a plugin.

Parameters
serverthe MRCP server to use
idthe identifier of the plugin
paththe path to the plugin to load
configthe config of the engine
apt_bool_t mrcp_server_engine_register ( mrcp_server_t server,
mrcp_engine_t engine 
)

Register MRCP engine.

Parameters
serverthe MRCP server to set engine for
enginethe engine to set
mpf_engine_t* mrcp_server_media_engine_get ( const mrcp_server_t server,
const char *  name 
)

Get media engine by name.

Parameters
serverthe MRCP server to get media engine from
namethe name of the media engine to lookup
apt_bool_t mrcp_server_media_engine_register ( mrcp_server_t server,
mpf_engine_t media_engine 
)

Register media engine.

Parameters
serverthe MRCP server to set media engine for
media_enginethe media engine to set
apr_pool_t* mrcp_server_memory_pool_get ( const mrcp_server_t server)

Get memory pool.

Parameters
serverthe MRCP server to get memory pool from
apt_bool_t mrcp_server_offline ( mrcp_server_t server)

Take server offline.

Parameters
serverthe MRCP server to take offline
apt_bool_t mrcp_server_online ( mrcp_server_t server)

Bring server online.

Parameters
serverthe MRCP server to bring online
mrcp_server_profile_t* mrcp_server_profile_create ( const char *  id,
mrcp_version_e  mrcp_version,
mrcp_resource_factory_t resource_factory,
mrcp_sig_agent_t signaling_agent,
mrcp_connection_agent_t connection_agent,
mpf_engine_t media_engine,
mpf_termination_factory_t rtp_factory,
mpf_rtp_settings_t rtp_settings,
apr_pool_t *  pool 
)

Create MRCP profile

mrcp_server_profile_t* mrcp_server_profile_get ( const mrcp_server_t server,
const char *  name 
)

Get profile by name.

Parameters
serverthe MRCP client to get from
namethe name to lookup
apt_bool_t mrcp_server_profile_register ( mrcp_server_t server,
mrcp_server_profile_t profile,
apr_table_t *  plugin_map 
)

Register MRCP profile.

Parameters
serverthe MRCP server to set profile for
profilethe profile to set
plugin_mapthe map of engines (plugins)
apt_bool_t mrcp_server_resource_factory_register ( mrcp_server_t server,
mrcp_resource_factory_t resource_factory 
)

Register MRCP resource factory.

Parameters
serverthe MRCP server to set resource factory for
resource_factorythe resource factory to set
mpf_termination_factory_t* mrcp_server_rtp_factory_get ( const mrcp_server_t server,
const char *  name 
)

Get RTP termination factory by name.

Parameters
serverthe MRCP server to get from
namethe name to lookup
apt_bool_t mrcp_server_rtp_factory_register ( mrcp_server_t server,
mpf_termination_factory_t rtp_termination_factory,
const char *  name 
)

Register RTP termination factory.

Parameters
serverthe MRCP server to set termination factory for
rtp_termination_factorythe termination factory
namethe name of the factory
mpf_rtp_settings_t* mrcp_server_rtp_settings_get ( const mrcp_server_t server,
const char *  name 
)

Get RTP settings by name

Parameters
serverthe MRCP server to get from
namethe name to lookup
apt_bool_t mrcp_server_rtp_settings_register ( mrcp_server_t server,
mpf_rtp_settings_t rtp_settings,
const char *  name 
)

Register RTP settings.

Parameters
serverthe MRCP server to set RTP settings for
rtp_settingsthe settings to set
namethe name of the settings
apt_bool_t mrcp_server_shutdown ( mrcp_server_t server)

Shutdown message processing loop.

Parameters
serverthe MRCP server to shutdown
mrcp_sig_agent_t* mrcp_server_signaling_agent_get ( const mrcp_server_t server,
const char *  name 
)

Get signaling agent by name.

Parameters
serverthe MRCP server to get from
namethe name to lookup
apt_bool_t mrcp_server_signaling_agent_register ( mrcp_server_t server,
mrcp_sig_agent_t signaling_agent 
)

Register MRCP signaling agent.

Parameters
serverthe MRCP server to set signaling agent for
signaling_agentthe signaling agent to set
apt_bool_t mrcp_server_start ( mrcp_server_t server)

Start message processing loop.

Parameters
serverthe MRCP server to start
Returns
the created server instance