Fork me on GitHub
plugin.h
Go to the documentation of this file.
1 
146 #ifndef _JANUS_PLUGIN_H
147 #define _JANUS_PLUGIN_H
148 
149 #include <stdlib.h>
150 #include <stdint.h>
151 #include <stdio.h>
152 #include <string.h>
153 #include <ctype.h>
154 #include <unistd.h>
155 #include <inttypes.h>
156 
157 #include <glib.h>
158 #include <jansson.h>
159 
160 
170 #define JANUS_PLUGIN_API_VERSION 8
171 
188 #define JANUS_PLUGIN_INIT(...) { \
189  .init = NULL, \
190  .destroy = NULL, \
191  .get_api_compatibility = NULL, \
192  .get_version = NULL, \
193  .get_version_string = NULL, \
194  .get_description = NULL, \
195  .get_name = NULL, \
196  .get_author = NULL, \
197  .get_package = NULL, \
198  .create_session = NULL, \
199  .handle_message = NULL, \
200  .setup_media = NULL, \
201  .incoming_rtp = NULL, \
202  .incoming_rtcp = NULL, \
203  .incoming_data = NULL, \
204  .slow_link = NULL, \
205  .hangup_media = NULL, \
206  .destroy_session = NULL, \
207  .query_session = NULL, \
208  ## __VA_ARGS__ }
209 
210 
214 typedef struct janus_plugin janus_plugin;
219 
228  int stopped:1;
229 };
230 
232 struct janus_plugin {
237  int (* const init)(janus_callbacks *callback, const char *config_path);
239  void (* const destroy)(void);
240 
247  int (* const get_api_compatibility)(void);
249  int (* const get_version)(void);
251  const char *(* const get_version_string)(void);
253  const char *(* const get_description)(void);
255  const char *(* const get_name)(void);
257  const char *(* const get_author)(void);
259  const char *(* const get_package)(void);
260 
264  void (* const create_session)(janus_plugin_session *handle, int *error);
272  struct janus_plugin_result * (* const handle_message)(janus_plugin_session *handle, char *transaction, json_t *message, json_t *jsep);
275  void (* const setup_media)(janus_plugin_session *handle);
281  void (* const incoming_rtp)(janus_plugin_session *handle, int video, char *buf, int len);
287  void (* const incoming_rtcp)(janus_plugin_session *handle, int video, char *buf, int len);
295  void (* const incoming_data)(janus_plugin_session *handle, char *buf, int len);
312  void (* const slow_link)(janus_plugin_session *handle, int uplink, int video);
315  void (* const hangup_media)(janus_plugin_session *handle);
319  void (* const destroy_session)(janus_plugin_session *handle, int *error);
325  json_t *(* const query_session)(janus_plugin_session *handle);
326 
327 };
328 
340  int (* const push_event)(janus_plugin_session *handle, janus_plugin *plugin, const char *transaction, json_t *message, json_t *jsep);
341 
347  void (* const relay_rtp)(janus_plugin_session *handle, int video, char *buf, int len);
353  void (* const relay_rtcp)(janus_plugin_session *handle, int video, char *buf, int len);
358  void (* const relay_data)(janus_plugin_session *handle, char *buf, int len);
359 
364  void (* const close_pc)(janus_plugin_session *handle);
369  void (* const end_session)(janus_plugin_session *handle);
370 
373  gboolean (* const events_is_enabled)(void);
379  void (* const notify_event)(janus_plugin *plugin, janus_plugin_session *handle, json_t *event);
380 
381 };
382 
384 typedef janus_plugin* create_p(void);
385 
386 
405 
415 
419  janus_plugin_result_type type;
426  const char *text;
434  json_t *content;
435 };
436 
442 janus_plugin_result *janus_plugin_result_new(janus_plugin_result_type type, const char *text, json_t *content);
443 
449 
450 
451 #endif
The request was correctly handled and a response is provided (synchronous)
Definition: plugin.h:411
json_t *(*const query_session)(janus_plugin_session *handle)
Method to get plugin-specific info of a session/handle.
Definition: plugin.h:325
void * gateway_handle
Opaque pointer to the gateway session.
Definition: plugin.h:223
const char *(*const get_author)(void)
Informative method to request the author of the plugin.
Definition: plugin.h:257
const char *(*const get_version_string)(void)
Informative method to request the string version of the plugin.
Definition: plugin.h:251
const char *(*const get_name)(void)
Informative method to request the name of the plugin.
Definition: plugin.h:255
void janus_plugin_result_destroy(janus_plugin_result *result)
Helper to quickly destroy a janus_plugin_result instance.
Definition: plugin.c:32
Janus plugin result.
Definition: plugin.h:417
janus_plugin_result_type
Result types.
Definition: plugin.h:407
const char *(*const get_package)(void)
Informative method to request the package name of the plugin (what will be used in web applications t...
Definition: plugin.h:259
The request was correctly handled and notifications will follow with more info (asynchronous) ...
Definition: plugin.h:413
The plugin session and callbacks interface.
Definition: plugin.h:232
int stopped
Whether this mapping has been stopped definitely or not: if so, the plugin shouldn&#39;t make use of it a...
Definition: plugin.h:228
const char *(*const get_description)(void)
Informative method to request a description of the plugin.
Definition: plugin.h:253
json_t * content
Result content.
Definition: plugin.h:434
A severe error happened (not an application level error)
Definition: plugin.h:409
janus_plugin * create_p(void)
The hook that plugins need to implement to be created from the gateway.
Definition: plugin.h:384
Callbacks to contact the gateway.
Definition: plugin.h:330
janus_plugin_result * janus_plugin_result_new(janus_plugin_result_type type, const char *text, json_t *content)
Helper to quickly create a janus_plugin_result instance.
Definition: plugin.c:17
void * plugin_handle
Opaque pointer to the plugin session.
Definition: plugin.h:225
Plugin-Gateway session mapping.
Definition: plugin.h:221
const char * text
Text associated with this plugin result.
Definition: plugin.h:426
janus_plugin_result_type type
Result type.
Definition: plugin.h:419