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"

Include dependency graph for mrcp_server.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
APT_BEGIN_EXTERN_C mrcp_server_t *	mrcp_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_t *	mrcp_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_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)
apt_bool_t	mrcp_server_profile_register (mrcp_server_t *server, mrcp_server_profile_t *profile, apr_hash_t *resource_engine_map)
mrcp_engine_t *	mrcp_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)
mrcp_engine_t *	mrcp_server_engine_get (const mrcp_server_t *server, const char *name)
mpf_engine_t *	mrcp_server_media_engine_get (const mrcp_server_t *server, const char *name)
mpf_termination_factory_t *	mrcp_server_rtp_factory_get (const mrcp_server_t *server, const char *name)
mpf_rtp_settings_t *	mrcp_server_rtp_settings_get (const mrcp_server_t *server, const char *name)
mrcp_sig_agent_t *	mrcp_server_signaling_agent_get (const mrcp_server_t *server, const char *name)
mrcp_connection_agent_t *	mrcp_server_connection_agent_get (const mrcp_server_t *server, const char *name)
mrcp_server_profile_t *	mrcp_server_profile_get (const mrcp_server_t *server, const char *name)

Detailed Description

MRCP Server.

Function Documentation

mrcp_server_codec_manager_get()

const mpf_codec_manager_t* mrcp_server_codec_manager_get

(

const mrcp_server_t *

server

)

Get registered codec manager.

Parameters

server

the MRCP server to get codec manager from

mrcp_server_codec_manager_register()

apt_bool_t mrcp_server_codec_manager_register	(	mrcp_server_t *	server,
		mpf_codec_manager_t *	codec_manager
	)

Register codec manager.

Parameters

server	the MRCP server to set codec manager for
codec_manager	the codec manager to set

mrcp_server_connection_agent_get()

mrcp_connection_agent_t* mrcp_server_connection_agent_get	(	const mrcp_server_t *	server,
		const char *	name
	)

Get connection agent by name.

Parameters

server	the MRCP server to get from
name	the name to lookup

mrcp_server_connection_agent_register()

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

server	the MRCP server to set connection agent for
connection_agent	the connection agent to set

mrcp_server_create()

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

mrcp_server_destroy()

apt_bool_t mrcp_server_destroy

(

mrcp_server_t *

server

)

Destroy MRCP server.

Parameters

server

the MRCP server to destroy

mrcp_server_engine_get()

mrcp_engine_t* mrcp_server_engine_get	(	const mrcp_server_t *	server,
		const char *	name
	)

Get MRCP engine by name.

Parameters

server	the MRCP server to get media engine from
name	the name of the media engine to lookup

mrcp_server_engine_load()

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

server	the MRCP server to use
id	the identifier of the plugin
path	the path to the plugin to load
config	the config of the engine

mrcp_server_engine_register()

apt_bool_t mrcp_server_engine_register	(	mrcp_server_t *	server,
		mrcp_engine_t *	engine
	)

Register MRCP engine.

Parameters

server	the MRCP server to set engine for
engine	the engine to set

mrcp_server_media_engine_get()

mpf_engine_t* mrcp_server_media_engine_get	(	const mrcp_server_t *	server,
		const char *	name
	)

Get media engine by name.

Parameters

server	the MRCP server to get media engine from
name	the name of the media engine to lookup

mrcp_server_media_engine_register()

apt_bool_t mrcp_server_media_engine_register	(	mrcp_server_t *	server,
		mpf_engine_t *	media_engine
	)

Register media engine.

Parameters

server	the MRCP server to set media engine for
media_engine	the media engine to set

mrcp_server_memory_pool_get()

apr_pool_t* mrcp_server_memory_pool_get

(

const mrcp_server_t *

server

)

Get memory pool.

Parameters

server

the MRCP server to get memory pool from

mrcp_server_offline()

apt_bool_t mrcp_server_offline

(

mrcp_server_t *

server

)

Take server offline.

Parameters

server

the MRCP server to take offline

mrcp_server_online()

apt_bool_t mrcp_server_online

(

mrcp_server_t *

server

)

Bring server online.

Parameters

server

the MRCP server to bring online

mrcp_server_profile_create()

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_get()

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

Get profile by name.

Parameters

server	the MRCP client to get from
name	the name to lookup

mrcp_server_profile_register()

apt_bool_t mrcp_server_profile_register	(	mrcp_server_t *	server,
		mrcp_server_profile_t *	profile,
		apr_hash_t *	resource_engine_map
	)

Register MRCP profile.

Parameters

server	the MRCP server to set profile for
profile	the profile to set
resource_engine_map	the map of resource ids and engine settings (resource id -> mrcp_engine_settings_t*)

mrcp_server_resource_factory_register()

apt_bool_t mrcp_server_resource_factory_register	(	mrcp_server_t *	server,
		mrcp_resource_factory_t *	resource_factory
	)

Register MRCP resource factory.

Parameters

server	the MRCP server to set resource factory for
resource_factory	the resource factory to set

mrcp_server_rtp_factory_get()

mpf_termination_factory_t* mrcp_server_rtp_factory_get	(	const mrcp_server_t *	server,
		const char *	name
	)

Get RTP termination factory by name.

Parameters

server	the MRCP server to get from
name	the name to lookup

mrcp_server_rtp_factory_register()

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

server	the MRCP server to set termination factory for
rtp_termination_factory	the termination factory
name	the name of the factory

mrcp_server_rtp_settings_get()

mpf_rtp_settings_t* mrcp_server_rtp_settings_get	(	const mrcp_server_t *	server,
		const char *	name
	)

Get RTP settings by name

Parameters

server	the MRCP server to get from
name	the name to lookup

mrcp_server_rtp_settings_register()

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

server	the MRCP server to set RTP settings for
rtp_settings	the settings to set
name	the name of the settings

mrcp_server_shutdown()

apt_bool_t mrcp_server_shutdown

(

mrcp_server_t *

server

)

Shutdown message processing loop.

Parameters

server

the MRCP server to shutdown

mrcp_server_signaling_agent_get()

mrcp_sig_agent_t* mrcp_server_signaling_agent_get	(	const mrcp_server_t *	server,
		const char *	name
	)

Get signaling agent by name.

Parameters

server	the MRCP server to get from
name	the name to lookup

mrcp_server_signaling_agent_register()

apt_bool_t mrcp_server_signaling_agent_register	(	mrcp_server_t *	server,
		mrcp_sig_agent_t *	signaling_agent
	)

Register MRCP signaling agent.

Parameters

server	the MRCP server to set signaling agent for
signaling_agent	the signaling agent to set

mrcp_server_start()

apt_bool_t mrcp_server_start

(

mrcp_server_t *

server

)

Start message processing loop.

Parameters

server

the MRCP server to start

Returns

the created server instance