mrcp_client.h File Reference

MRCP Client. More...

#include "mrcp_client_types.h"
#include "mpf_rtp_descriptor.h"
#include "apt_task.h"

Include dependency graph for mrcp_client.h:

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

Go to the source code of this file.

Functions
mrcp_client_t *	mrcp_client_create (apt_dir_layout_t *dir_layout)
void	mrcp_client_async_start_set (mrcp_client_t *client, mrcp_client_handler_f handler)
apt_bool_t	mrcp_client_start (mrcp_client_t *client)
apt_bool_t	mrcp_client_shutdown (mrcp_client_t *client)
apt_bool_t	mrcp_client_destroy (mrcp_client_t *client)
apt_bool_t	mrcp_client_resource_factory_register (mrcp_client_t *client, mrcp_resource_factory_t *resource_factory)
apt_bool_t	mrcp_client_codec_manager_register (mrcp_client_t *client, mpf_codec_manager_t *codec_manager)
const mpf_codec_manager_t *	mrcp_client_codec_manager_get (const mrcp_client_t *client)
apt_bool_t	mrcp_client_media_engine_register (mrcp_client_t *client, mpf_engine_t *media_engine)
apt_bool_t	mrcp_client_rtp_factory_register (mrcp_client_t *client, mpf_termination_factory_t *rtp_termination_factory, const char *name)
apt_bool_t	mrcp_client_rtp_settings_register (mrcp_client_t *client, mpf_rtp_settings_t *rtp_settings, const char *name)
apt_bool_t	mrcp_client_signaling_agent_register (mrcp_client_t *client, mrcp_sig_agent_t *signaling_agent)
apt_bool_t	mrcp_client_signaling_settings_register (mrcp_client_t *client, mrcp_sig_settings_t *signaling_settings, const char *name)
apt_bool_t	mrcp_client_connection_agent_register (mrcp_client_t *client, mrcp_connection_agent_t *connection_agent)
mrcp_client_profile_t *	mrcp_client_profile_create (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, mrcp_sig_settings_t *signaling_settings, apr_pool_t *pool)
mrcp_client_profile_t *	mrcp_client_profile_create_ex (mrcp_version_e mrcp_version, mrcp_resource_factory_t *resource_factory, mrcp_sa_factory_t *sa_factory, mrcp_ca_factory_t *ca_factory, mpf_engine_factory_t *mpf_factory, mpf_termination_factory_t *rtp_factory, mpf_rtp_settings_t *rtp_settings, mrcp_sig_settings_t *signaling_settings, apr_pool_t *pool)
void	mrcp_client_profile_tag_set (mrcp_client_profile_t *profile, const char *tag)
apt_bool_t	mrcp_client_profile_register (mrcp_client_t *client, mrcp_client_profile_t *profile, const char *name)
apt_bool_t	mrcp_client_application_register (mrcp_client_t *client, mrcp_application_t *application, const char *name)
apr_pool_t *	mrcp_client_memory_pool_get (const mrcp_client_t *client)
mpf_engine_t *	mrcp_client_media_engine_get (const mrcp_client_t *client, const char *name)
mpf_termination_factory_t *	mrcp_client_rtp_factory_get (const mrcp_client_t *client, const char *name)
mpf_rtp_settings_t *	mrcp_client_rtp_settings_get (const mrcp_client_t *client, const char *name)
mrcp_sig_agent_t *	mrcp_client_signaling_agent_get (const mrcp_client_t *client, const char *name)
mrcp_sig_settings_t *	mrcp_client_signaling_settings_get (const mrcp_client_t *client, const char *name)
mrcp_connection_agent_t *	mrcp_client_connection_agent_get (const mrcp_client_t *client, const char *name)
mrcp_client_profile_t *	mrcp_client_profile_get (const mrcp_client_t *client, const char *name)
apt_bool_t	mrcp_client_profiles_get (const mrcp_client_t *client, mrcp_client_profile_t *profiles[], apr_size_t *count, const char *tag)
apt_dir_layout_t *	mrcp_client_dir_layout_get (const mrcp_client_t *client)

Variables
APT_BEGIN_EXTERN_C typedef void(*	mrcp_client_handler_f )(apt_bool_t status)

Detailed Description

MRCP Client.

Function Documentation

mrcp_client_application_register()

apt_bool_t mrcp_client_application_register	(	mrcp_client_t *	client,
		mrcp_application_t *	application,
		const char *	name
	)

Register MRCP application.

Parameters

client	the MRCP client to set application for
application	the application to set
name	the name of the application

mrcp_client_async_start_set()

void mrcp_client_async_start_set	(	mrcp_client_t *	client,
		mrcp_client_handler_f	handler
	)

Set asynchronous start mode.

Parameters

client	the MRCP client to set mode for
handler	the event handler to signal start completion

mrcp_client_codec_manager_get()

const mpf_codec_manager_t* mrcp_client_codec_manager_get

(

const mrcp_client_t *

client

)

Get registered codec manager.

Parameters

client

the MRCP client to get codec manager from

mrcp_client_codec_manager_register()

apt_bool_t mrcp_client_codec_manager_register	(	mrcp_client_t *	client,
		mpf_codec_manager_t *	codec_manager
	)

Register codec manager.

Parameters

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

mrcp_client_connection_agent_get()

mrcp_connection_agent_t* mrcp_client_connection_agent_get	(	const mrcp_client_t *	client,
		const char *	name
	)

Get connection agent by name.

Parameters

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

mrcp_client_connection_agent_register()

apt_bool_t mrcp_client_connection_agent_register	(	mrcp_client_t *	client,
		mrcp_connection_agent_t *	connection_agent
	)

Register MRCP connection agent (MRCPv2 only).

Parameters

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

mrcp_client_create()

mrcp_client_t* mrcp_client_create

(

apt_dir_layout_t *

dir_layout

)

Create MRCP client instance.

Returns

the created client instance

mrcp_client_destroy()

apt_bool_t mrcp_client_destroy

(

mrcp_client_t *

client

)

Destroy MRCP client.

Parameters

client

the MRCP client to destroy

mrcp_client_dir_layout_get()

apt_dir_layout_t* mrcp_client_dir_layout_get

(

const mrcp_client_t *

client

)

Get directory layout.

Parameters

client

the MRCP client to get from

mrcp_client_media_engine_get()

mpf_engine_t* mrcp_client_media_engine_get	(	const mrcp_client_t *	client,
		const char *	name
	)

Get media engine by name.

Parameters

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

mrcp_client_media_engine_register()

apt_bool_t mrcp_client_media_engine_register	(	mrcp_client_t *	client,
		mpf_engine_t *	media_engine
	)

Register media engine.

Parameters

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

mrcp_client_memory_pool_get()

apr_pool_t* mrcp_client_memory_pool_get

(

const mrcp_client_t *

client

)

Get memory pool.

Parameters

client

the MRCP client to get memory pool from

mrcp_client_profile_create()

mrcp_client_profile_t* mrcp_client_profile_create	(	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,
		mrcp_sig_settings_t *	signaling_settings,
		apr_pool_t *	pool
	)

Create MRCP profile

mrcp_client_profile_create_ex()

mrcp_client_profile_t* mrcp_client_profile_create_ex	(	mrcp_version_e	mrcp_version,
		mrcp_resource_factory_t *	resource_factory,
		mrcp_sa_factory_t *	sa_factory,
		mrcp_ca_factory_t *	ca_factory,
		mpf_engine_factory_t *	mpf_factory,
		mpf_termination_factory_t *	rtp_factory,
		mpf_rtp_settings_t *	rtp_settings,
		mrcp_sig_settings_t *	signaling_settings,
		apr_pool_t *	pool
	)

Create MRCP profile (extended version)

mrcp_client_profile_get()

mrcp_client_profile_t* mrcp_client_profile_get	(	const mrcp_client_t *	client,
		const char *	name
	)

Get profile by name.

Parameters

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

mrcp_client_profile_register()

apt_bool_t mrcp_client_profile_register	(	mrcp_client_t *	client,
		mrcp_client_profile_t *	profile,
		const char *	name
	)

Register MRCP profile.

Parameters

client	the MRCP client to set profile for
profile	the profile to set
name	the name of the profile

mrcp_client_profile_tag_set()

void mrcp_client_profile_tag_set	(	mrcp_client_profile_t *	profile,
		const char *	tag
	)

Set a tag to the profile.

Parameters

profile	the profile to set a tag for
tag	the tag to set

mrcp_client_profiles_get()

apt_bool_t mrcp_client_profiles_get	(	const mrcp_client_t *	client,
		mrcp_client_profile_t *	profiles[],
		apr_size_t *	count,
		const char *	tag
	)

Get available profiles.

Parameters

client	the MRCP client to get the profile from
profiles	the array of profiles to be filled in
count	the max number of profiles on entry; and the number of profiles filled in on exit
tag	the tag to be used as a filter (no filter is specified if tag is NULL)

Returns

FALSE if the provided max number of profiles is less than the actual number of profiles

mrcp_client_resource_factory_register()

apt_bool_t mrcp_client_resource_factory_register	(	mrcp_client_t *	client,
		mrcp_resource_factory_t *	resource_factory
	)

Register MRCP resource factory.

Parameters

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

mrcp_client_rtp_factory_get()

mpf_termination_factory_t* mrcp_client_rtp_factory_get	(	const mrcp_client_t *	client,
		const char *	name
	)

Get RTP termination factory by name.

Parameters

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

mrcp_client_rtp_factory_register()

apt_bool_t mrcp_client_rtp_factory_register	(	mrcp_client_t *	client,
		mpf_termination_factory_t *	rtp_termination_factory,
		const char *	name
	)

Register RTP termination factory.

Parameters

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

mrcp_client_rtp_settings_get()

mpf_rtp_settings_t* mrcp_client_rtp_settings_get	(	const mrcp_client_t *	client,
		const char *	name
	)

Get RTP settings by name

Parameters

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

mrcp_client_rtp_settings_register()

apt_bool_t mrcp_client_rtp_settings_register	(	mrcp_client_t *	client,
		mpf_rtp_settings_t *	rtp_settings,
		const char *	name
	)

Register RTP settings.

Parameters

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

mrcp_client_shutdown()

apt_bool_t mrcp_client_shutdown

(

mrcp_client_t *

client

)

Shutdown message processing loop.

Parameters

client

the MRCP client to shutdown

mrcp_client_signaling_agent_get()

mrcp_sig_agent_t* mrcp_client_signaling_agent_get	(	const mrcp_client_t *	client,
		const char *	name
	)

Get signaling agent by name.

Parameters

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

mrcp_client_signaling_agent_register()

apt_bool_t mrcp_client_signaling_agent_register	(	mrcp_client_t *	client,
		mrcp_sig_agent_t *	signaling_agent
	)

Register MRCP signaling agent.

Parameters

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

mrcp_client_signaling_settings_get()

mrcp_sig_settings_t* mrcp_client_signaling_settings_get	(	const mrcp_client_t *	client,
		const char *	name
	)

Get signaling settings by name.

Parameters

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

mrcp_client_signaling_settings_register()

apt_bool_t mrcp_client_signaling_settings_register	(	mrcp_client_t *	client,
		mrcp_sig_settings_t *	signaling_settings,
		const char *	name
	)

Register MRCP signaling settings.

Parameters

client	the MRCP client to set signaling settings for
signaling_settings	the signaling settings to set
name	the name of the agent

mrcp_client_start()

apt_bool_t mrcp_client_start

(

mrcp_client_t *

client

)

Start message processing loop.

Parameters

client

the MRCP client to start

Returns

the created client instance

Variable Documentation

mrcp_client_handler_f

APT_BEGIN_EXTERN_C typedef void(* mrcp_client_handler_f) (apt_bool_t status)

Event handler used in case of asynchronous start