Fork me on GitHub
plugin.h
Go to the documentation of this file.
1 
147 #ifndef _JANUS_PLUGIN_H
148 #define _JANUS_PLUGIN_H
149 
150 #include <stdlib.h>
151 #include <stdint.h>
152 #include <stdio.h>
153 #include <string.h>
154 #include <ctype.h>
155 #include <unistd.h>
156 #include <inttypes.h>
157 
158 #include <glib.h>
159 
169 #define JANUS_PLUGIN_API_VERSION 9
170 
187 #define JANUS_PLUGIN_INIT(...) { \
188  .init = NULL, \
189  .destroy = NULL, \
190  .get_api_compatibility = NULL, \
191  .get_version = NULL, \
192  .get_version_string = NULL, \
193  .get_description = NULL, \
194  .get_name = NULL, \
195  .get_author = NULL, \
196  .get_package = NULL, \
197  .create_session = NULL, \
198  .handle_message = NULL, \
199  .setup_media = NULL, \
200  .incoming_rtp = NULL, \
201  .incoming_rtcp = NULL, \
202  .incoming_data = NULL, \
203  .slow_link = NULL, \
204  .hangup_media = NULL, \
205  .destroy_session = NULL, \
206  .query_session = NULL, \
207  ## __VA_ARGS__ }
208 
209 
213 typedef struct janus_plugin janus_plugin;
218 
219 /* Use forward declaration to avoid including jansson.h */
220 typedef struct json_t json_t;
221 
230  int stopped:1;
231 };
232 
234 struct janus_plugin {
239  int (* const init)(janus_callbacks *callback, const char *config_path);
241  void (* const destroy)(void);
242 
249  int (* const get_api_compatibility)(void);
251  int (* const get_version)(void);
253  const char *(* const get_version_string)(void);
255  const char *(* const get_description)(void);
257  const char *(* const get_name)(void);
259  const char *(* const get_author)(void);
261  const char *(* const get_package)(void);
262 
266  void (* const create_session)(janus_plugin_session *handle, int *error);
274  struct janus_plugin_result * (* const handle_message)(janus_plugin_session *handle, char *transaction, json_t *message, json_t *jsep);
277  void (* const setup_media)(janus_plugin_session *handle);
283  void (* const incoming_rtp)(janus_plugin_session *handle, int video, char *buf, int len);
289  void (* const incoming_rtcp)(janus_plugin_session *handle, int video, char *buf, int len);
297  void (* const incoming_data)(janus_plugin_session *handle, char *buf, int len);
314  void (* const slow_link)(janus_plugin_session *handle, int uplink, int video);
317  void (* const hangup_media)(janus_plugin_session *handle);
321  void (* const destroy_session)(janus_plugin_session *handle, int *error);
328 
329 };
330 
342  int (* const push_event)(janus_plugin_session *handle, janus_plugin *plugin, const char *transaction, json_t *message, json_t *jsep);
343 
349  void (* const relay_rtp)(janus_plugin_session *handle, int video, char *buf, int len);
355  void (* const relay_rtcp)(janus_plugin_session *handle, int video, char *buf, int len);
360  void (* const relay_data)(janus_plugin_session *handle, char *buf, int len);
361 
366  void (* const close_pc)(janus_plugin_session *handle);
371  void (* const end_session)(janus_plugin_session *handle);
372 
375  gboolean (* const events_is_enabled)(void);
381  void (* const notify_event)(janus_plugin *plugin, janus_plugin_session *handle, json_t *event);
382 
387  gboolean (* const auth_is_signature_valid)(janus_plugin *plugin, const char *token);
393  gboolean (* const auth_signature_contains)(janus_plugin *plugin, const char *token, const char *descriptor);
394 };
395 
397 typedef janus_plugin* create_p(void);
398 
399 
418 
428 
432  janus_plugin_result_type type;
439  const char *text;
448 };
449 
455 janus_plugin_result *janus_plugin_result_new(janus_plugin_result_type type, const char *text, json_t *content);
456 
462 
463 
464 #endif
The request was correctly handled and a response is provided (synchronous)
Definition: plugin.h:424
json_t *(*const query_session)(janus_plugin_session *handle)
Method to get plugin-specific info of a session/handle.
Definition: plugin.h:327
struct json_t json_t
Definition: plugin.h:220
void * gateway_handle
Opaque pointer to the gateway session.
Definition: plugin.h:225
const char *(*const get_author)(void)
Informative method to request the author of the plugin.
Definition: plugin.h:259
const char *(*const get_version_string)(void)
Informative method to request the string version of the plugin.
Definition: plugin.h:253
const char *(*const get_name)(void)
Informative method to request the name of the plugin.
Definition: plugin.h:257
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:430
janus_plugin_result_type
Result types.
Definition: plugin.h:420
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:261
The request was correctly handled and notifications will follow with more info (asynchronous) ...
Definition: plugin.h:426
The plugin session and callbacks interface.
Definition: plugin.h:234
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:230
const char *(*const get_description)(void)
Informative method to request a description of the plugin.
Definition: plugin.h:255
json_t * content
Result content.
Definition: plugin.h:447
A severe error happened (not an application level error)
Definition: plugin.h:422
janus_plugin * create_p(void)
The hook that plugins need to implement to be created from the gateway.
Definition: plugin.h:397
Callbacks to contact the gateway.
Definition: plugin.h:332
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:19
void * plugin_handle
Opaque pointer to the plugin session.
Definition: plugin.h:227
Plugin-Gateway session mapping.
Definition: plugin.h:223
const char * text
Text associated with this plugin result.
Definition: plugin.h:439
janus_plugin_result_type type
Result type.
Definition: plugin.h:432