mseventqueue.h 1.92 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
mediastreamer2 library - modular sound and video processing and streaming
Copyright (C) 2010  Simon MORLAT (simon.morlat@linphone.org)

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

#ifndef mseventqueue_h
#define mseventqueue_h

Simon Morlat's avatar
Simon Morlat committed
23
#include <mediastreamer2/mscommon.h>
24 25 26

typedef struct _MSEventQueue MSEventQueue;

27 28 29 30 31 32 33
/**
 * Creates an event queue to receive notifications from MSFilters.
 *
 * The queue can be installed to be global with ms_set_global_event_queue().
 * The application can then schedule the callbacks for the events
 * received by the queue by calling ms_event_queue_pump()
**/ 
Simon Morlat's avatar
Simon Morlat committed
34
MS2_PUBLIC MSEventQueue *ms_event_queue_new();
35

36 37 38 39 40 41 42
/**
 * Install a global event queue.
 *
 * All filters currently scheduled by MSTickers will send events (notifications)
 * to the event queue.
 *
**/
Simon Morlat's avatar
Simon Morlat committed
43
MS2_PUBLIC void ms_set_global_event_queue(MSEventQueue *q);
44

45 46 47 48 49 50
/**
 * Run callbacks associated to the events received.
 * The user can register a notify callback per filter using
 * ms_filter_set_notify_callback() in order to be informed 
 * of various events generated by a MSFilter.
**/
Simon Morlat's avatar
Simon Morlat committed
51
MS2_PUBLIC void ms_event_queue_pump(MSEventQueue *q);
52

53 54 55
/**
 * Discard all pending events.
**/
Simon Morlat's avatar
Simon Morlat committed
56
MS2_PUBLIC void ms_event_queue_skip(MSEventQueue *q);
57

58 59 60
/**
 * Destroys an event queue.
**/
Simon Morlat's avatar
Simon Morlat committed
61
MS2_PUBLIC void ms_event_queue_destroy(MSEventQueue *q);
62 63

#endif