mpf_context.h File Reference

MPF Context. More...

#include "mpf_types.h"

Go to the source code of this file.

Typedefs
typedef typedefAPT_BEGIN_EXTERN_C struct mpf_context_factory_t	mpf_context_factory_t
Functions
mpf_context_factory_t *	mpf_context_factory_create (apr_pool_t *pool)
void	mpf_context_factory_destroy (mpf_context_factory_t *factory)
apt_bool_t	mpf_context_factory_process (mpf_context_factory_t *factory)
mpf_context_t *	mpf_context_create (mpf_context_factory_t *factory, const char *name, void *obj, apr_size_t max_termination_count, apr_pool_t *pool)
apt_bool_t	mpf_context_destroy (mpf_context_t *context)
void *	mpf_context_object_get (const mpf_context_t *context)
apt_bool_t	mpf_context_termination_add (mpf_context_t *context, mpf_termination_t *termination)
apt_bool_t	mpf_context_termination_subtract (mpf_context_t *context, mpf_termination_t *termination)
apt_bool_t	mpf_context_association_add (mpf_context_t *context, mpf_termination_t *termination1, mpf_termination_t *termination2)
apt_bool_t	mpf_context_association_remove (mpf_context_t *context, mpf_termination_t *termination1, mpf_termination_t *termination2)
apt_bool_t	mpf_context_associations_reset (mpf_context_t *context)
apt_bool_t	mpf_context_topology_apply (mpf_context_t *context)
apt_bool_t	mpf_context_topology_destroy (mpf_context_t *context)
apt_bool_t	mpf_context_process (mpf_context_t *context)

---

Detailed Description

MPF Context.

---

Typedef Documentation

typedef typedefAPT_BEGIN_EXTERN_C struct mpf_context_factory_t mpf_context_factory_t

Opaque factory of media contexts

---

Function Documentation

apt_bool_t mpf_context_association_add	(	mpf_context_t *	context,
		mpf_termination_t *	termination1,
		mpf_termination_t *	termination2
	)

Add association between specified terminations.

Parameters:

	context	the context to add association in the scope of
	termination1	the first termination to associate
	termination2	the second termination to associate

apt_bool_t mpf_context_association_remove	(	mpf_context_t *	context,
		mpf_termination_t *	termination1,
		mpf_termination_t *	termination2
	)

Remove association between specified terminations.

Parameters:

	context	the context to remove association in the scope of
	termination1	the first termination
	termination2	the second termination

apt_bool_t mpf_context_associations_reset

(

mpf_context_t *

context

)

Reset assigned associations and destroy applied topology.

Parameters:

context

the context to reset associations for

mpf_context_t* mpf_context_create	(	mpf_context_factory_t *	factory,
		const char *	name,
		void *	obj,
		apr_size_t	max_termination_count,
		apr_pool_t *	pool
	)

Create MPF context.

Parameters:

	factory	the factory context belongs to
	name	the informative name of the context
	obj	the external object associated with context
	max_termination_count	the max number of terminations in context
	pool	the pool to allocate memory from

apt_bool_t mpf_context_destroy

(

mpf_context_t *

context

)

Destroy MPF context.

Parameters:

context

the context to destroy

mpf_context_factory_t* mpf_context_factory_create

(

apr_pool_t *

pool

)

Create factory of media contexts.

void mpf_context_factory_destroy

(

mpf_context_factory_t *

factory

)

Destroy factory of media contexts.

apt_bool_t mpf_context_factory_process

(

mpf_context_factory_t *

factory

)

Process factory of media contexts.

void* mpf_context_object_get

(

const mpf_context_t *

context

)

Get external object associated with MPF context.

Parameters:

context

the context to get object from

apt_bool_t mpf_context_process

(

mpf_context_t *

context

)

Process context.

Parameters:

context

the context to process

apt_bool_t mpf_context_termination_add	(	mpf_context_t *	context,
		mpf_termination_t *	termination
	)

Add termination to context.

Parameters:

	context	the context to add termination to
	termination	the termination to add

apt_bool_t mpf_context_termination_subtract	(	mpf_context_t *	context,
		mpf_termination_t *	termination
	)

Subtract termination from context.

Parameters:

	context	the context to subtract termination from
	termination	the termination to subtract

apt_bool_t mpf_context_topology_apply

(

mpf_context_t *

context

)

Apply topology.

Parameters:

context

the context to apply topology for

apt_bool_t mpf_context_topology_destroy

(

mpf_context_t *

context

)

Destroy topology.

Parameters:

context

the context to destroy topology for