mpf_termination.h File Reference

MPF Termination. More...

#include "mpf_types.h"
#include "apt_timer_queue.h"

Include dependency graph for mpf_termination.h:

Go to the source code of this file.

Data Structures
struct	mpf_termination_vtable_t
struct	mpf_termination_t

Typedefs
typedef struct mpf_termination_vtable_t	mpf_termination_vtable_t

Functions
mpf_termination_t *	mpf_termination_base_create (mpf_termination_factory_t *termination_factory, void *obj, const mpf_termination_vtable_t *vtable, mpf_audio_stream_t *audio_stream, mpf_video_stream_t *video_stream, apr_pool_t *pool)
apt_bool_t	mpf_termination_add (mpf_termination_t *termination, void *descriptor)
apt_bool_t	mpf_termination_modify (mpf_termination_t *termination, void *descriptor)
apt_bool_t	mpf_termination_subtract (mpf_termination_t *termination)

Variables
APT_BEGIN_EXTERN_C typedef apt_bool_t(*	mpf_termination_event_handler_f )(mpf_termination_t *termination, int event_id, void *descriptor)

Detailed Description

MPF Termination.

Typedef Documentation

mpf_termination_vtable_t

typedef struct mpf_termination_vtable_t mpf_termination_vtable_t

Termination vtable declaration

Function Documentation

mpf_termination_add()

apt_bool_t mpf_termination_add	(	mpf_termination_t *	termination,
		void *	descriptor
	)

Add MPF termination.

Parameters

termination	the termination to add
descriptor	the termination specific descriptor

mpf_termination_base_create()

mpf_termination_t* mpf_termination_base_create	(	mpf_termination_factory_t *	termination_factory,
		void *	obj,
		const mpf_termination_vtable_t *	vtable,
		mpf_audio_stream_t *	audio_stream,
		mpf_video_stream_t *	video_stream,
		apr_pool_t *	pool
	)

Create MPF termination base.

Parameters

termination_factory	the termination factory
obj	the external object associated with termination
vtable	the table of virtual functions of termination
audio_stream	the audio stream
video_stream	the video stream
pool	the pool to allocate memory from

mpf_termination_modify()

apt_bool_t mpf_termination_modify	(	mpf_termination_t *	termination,
		void *	descriptor
	)

Modify MPF termination.

Parameters

termination	the termination to modify
descriptor	the termination specific descriptor

mpf_termination_subtract()

apt_bool_t mpf_termination_subtract

(

mpf_termination_t *

termination

)

Subtract MPF termination.

Parameters

termination

the termination to subtract

Variable Documentation

mpf_termination_event_handler_f

APT_BEGIN_EXTERN_C typedef apt_bool_t(* mpf_termination_event_handler_f) (mpf_termination_t *termination, int event_id, void *descriptor)

Prototype of termination event handler