Fork me on GitHub
plugin.h
Go to the documentation of this file.
1 
148 #ifndef _JANUS_PLUGIN_H
149 #define _JANUS_PLUGIN_H
150 
151 #include <stdlib.h>
152 #include <stdint.h>
153 #include <stdio.h>
154 #include <string.h>
155 #include <ctype.h>
156 #include <unistd.h>
157 #include <inttypes.h>
158 
159 #include <glib.h>
160 
161 #include "refcount.h"
162 
163 
173 #define JANUS_PLUGIN_API_VERSION 13
174 
191 #define JANUS_PLUGIN_INIT(...) { \
192  .init = NULL, \
193  .destroy = NULL, \
194  .get_api_compatibility = NULL, \
195  .get_version = NULL, \
196  .get_version_string = NULL, \
197  .get_description = NULL, \
198  .get_name = NULL, \
199  .get_author = NULL, \
200  .get_package = NULL, \
201  .create_session = NULL, \
202  .handle_message = NULL, \
203  .handle_admin_message = NULL, \
204  .setup_media = NULL, \
205  .incoming_rtp = NULL, \
206  .incoming_rtcp = NULL, \
207  .incoming_data = NULL, \
208  .slow_link = NULL, \
209  .hangup_media = NULL, \
210  .destroy_session = NULL, \
211  .query_session = NULL, \
212  ## __VA_ARGS__ }
213 
214 
218 typedef struct janus_plugin janus_plugin;
223 
224 /* Use forward declaration to avoid including jansson.h */
225 typedef struct json_t json_t;
226 
235  volatile gint stopped;
238 };
239 
241 struct janus_plugin {
246  int (* const init)(janus_callbacks *callback, const char *config_path);
248  void (* const destroy)(void);
249 
256  int (* const get_api_compatibility)(void);
258  int (* const get_version)(void);
260  const char *(* const get_version_string)(void);
262  const char *(* const get_description)(void);
264  const char *(* const get_name)(void);
266  const char *(* const get_author)(void);
268  const char *(* const get_package)(void);
269 
273  void (* const create_session)(janus_plugin_session *handle, int *error);
281  struct janus_plugin_result * (* const handle_message)(janus_plugin_session *handle, char *transaction, json_t *message, json_t *jsep);
285  struct json_t * (* const handle_admin_message)(json_t *message);
288  void (* const setup_media)(janus_plugin_session *handle);
294  void (* const incoming_rtp)(janus_plugin_session *handle, int video, char *buf, int len);
300  void (* const incoming_rtcp)(janus_plugin_session *handle, int video, char *buf, int len);
309  void (* const incoming_data)(janus_plugin_session *handle, char *label, char *buf, int len);
326  void (* const slow_link)(janus_plugin_session *handle, int uplink, int video);
329  void (* const hangup_media)(janus_plugin_session *handle);
333  void (* const destroy_session)(janus_plugin_session *handle, int *error);
340 
341 };
342 
354  int (* const push_event)(janus_plugin_session *handle, janus_plugin *plugin, const char *transaction, json_t *message, json_t *jsep);
355 
361  void (* const relay_rtp)(janus_plugin_session *handle, int video, char *buf, int len);
367  void (* const relay_rtcp)(janus_plugin_session *handle, int video, char *buf, int len);
373  void (* const relay_data)(janus_plugin_session *handle, char *label, char *buf, int len);
374 
379  void (* const close_pc)(janus_plugin_session *handle);
384  void (* const end_session)(janus_plugin_session *handle);
385 
388  gboolean (* const events_is_enabled)(void);
394  void (* const notify_event)(janus_plugin *plugin, janus_plugin_session *handle, json_t *event);
395 
400  gboolean (* const auth_is_signature_valid)(janus_plugin *plugin, const char *token);
406  gboolean (* const auth_signature_contains)(janus_plugin *plugin, const char *token, const char *descriptor);
407 };
408 
410 typedef janus_plugin* create_p(void);
411 
412 
431 
441 
452  const char *text;
461 };
462 
469 
475 
476 
477 #endif
janus_callbacks::relay_data
void(*const relay_data)(janus_plugin_session *handle, char *label, char *buf, int len)
Callback to relay SCTP/DataChannel messages to a peer.
Definition: plugin.h:373
janus_plugin_result_new
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
janus_plugin::setup_media
void(*const setup_media)(janus_plugin_session *handle)
Callback to be notified when the associated PeerConnection is up and ready to be used.
Definition: plugin.h:288
janus_plugin
The plugin session and callbacks interface.
Definition: plugin.h:241
JANUS_PLUGIN_OK_WAIT
The request was correctly handled and notifications will follow with more info (asynchronous)
Definition: plugin.h:439
janus_plugin::slow_link
void(*const slow_link)(janus_plugin_session *handle, int uplink, int video)
Method to be notified by the core when too many NACKs have been received or sent by Janus,...
Definition: plugin.h:326
janus_plugin::get_author
const char *(*const get_author)(void)
Informative method to request the author of the plugin.
Definition: plugin.h:266
janus_plugin_session::stopped
volatile gint stopped
Whether this mapping has been stopped definitely or not: if so, the plugin shouldn't make use of it a...
Definition: plugin.h:235
janus_plugin_result_type
janus_plugin_result_type
Result types.
Definition: plugin.h:433
janus_plugin_session::gateway_handle
void * gateway_handle
Opaque pointer to the Janus core-level handle.
Definition: plugin.h:230
janus_plugin_result_destroy
void janus_plugin_result_destroy(janus_plugin_result *result)
Helper to quickly destroy a janus_plugin_result instance.
Definition: plugin.c:32
janus_plugin_session
Plugin-Gateway session mapping.
Definition: plugin.h:228
janus_callbacks::notify_event
void(*const notify_event)(janus_plugin *plugin, janus_plugin_session *handle, json_t *event)
Callback to notify an event to the registered and subscribed event handlers.
Definition: plugin.h:394
janus_callbacks::relay_rtp
void(*const relay_rtp)(janus_plugin_session *handle, int video, char *buf, int len)
Callback to relay RTP packets to a peer.
Definition: plugin.h:361
janus_plugin_result::content
json_t * content
Result content.
Definition: plugin.h:460
janus_plugin::incoming_data
void(*const incoming_data)(janus_plugin_session *handle, char *label, char *buf, int len)
Method to handle incoming SCTP/DataChannel data from a peer (text only, for the moment)
Definition: plugin.h:309
janus_plugin::init
int(*const init)(janus_callbacks *callback, const char *config_path)
Plugin initialization/constructor.
Definition: plugin.h:246
JANUS_PLUGIN_ERROR
A severe error happened (not an application level error)
Definition: plugin.h:435
janus_callbacks::push_event
int(*const push_event)(janus_plugin_session *handle, janus_plugin *plugin, const char *transaction, json_t *message, json_t *jsep)
Callback to push events/messages to a peer.
Definition: plugin.h:354
janus_plugin::handle_message
struct janus_plugin_result *(*const handle_message)(janus_plugin_session *handle, char *transaction, json_t *message, json_t *jsep)
Method to handle an incoming message/request from a peer.
Definition: plugin.h:281
janus_plugin_result::text
const char * text
Text associated with this plugin result.
Definition: plugin.h:452
create_p
janus_plugin * create_p(void)
The hook that plugins need to implement to be created from the Janus core.
Definition: plugin.h:410
janus_plugin::get_version_string
const char *(*const get_version_string)(void)
Informative method to request the string version of the plugin.
Definition: plugin.h:260
JANUS_PLUGIN_OK
The request was correctly handled and a response is provided (synchronous)
Definition: plugin.h:437
janus_plugin::get_package
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:268
janus_plugin::get_name
const char *(*const get_name)(void)
Informative method to request the name of the plugin.
Definition: plugin.h:264
janus_refcount
Definition: refcount.h:78
janus_plugin::incoming_rtcp
void(*const incoming_rtcp)(janus_plugin_session *handle, int video, char *buf, int len)
Method to handle an incoming RTCP packet from a peer.
Definition: plugin.h:300
janus_plugin::incoming_rtp
void(*const incoming_rtp)(janus_plugin_session *handle, int video, char *buf, int len)
Method to handle an incoming RTP packet from a peer.
Definition: plugin.h:294
janus_plugin_result::type
janus_plugin_result_type type
Result type.
Definition: plugin.h:445
janus_callbacks::relay_rtcp
void(*const relay_rtcp)(janus_plugin_session *handle, int video, char *buf, int len)
Callback to relay RTCP messages to a peer.
Definition: plugin.h:367
janus_plugin::hangup_media
void(*const hangup_media)(janus_plugin_session *handle)
Callback to be notified about DTLS alerts from a peer (i.e., the PeerConnection is not valid any more...
Definition: plugin.h:329
janus_plugin::get_api_compatibility
int(*const get_api_compatibility)(void)
Informative method to request the API version this plugin was compiled against.
Definition: plugin.h:256
janus_plugin::create_session
void(*const create_session)(janus_plugin_session *handle, int *error)
Method to create a new session/handle for a peer.
Definition: plugin.h:273
janus_plugin::get_description
const char *(*const get_description)(void)
Informative method to request a description of the plugin.
Definition: plugin.h:262
janus_plugin_result
Janus plugin result.
Definition: plugin.h:443
json_t
struct json_t json_t
Definition: plugin.h:225
janus_callbacks::auth_is_signature_valid
gboolean(*const auth_is_signature_valid)(janus_plugin *plugin, const char *token)
Method to check whether a signed token is valid.
Definition: plugin.h:400
janus_callbacks::auth_signature_contains
gboolean(*const auth_signature_contains)(janus_plugin *plugin, const char *token, const char *descriptor)
Method to verify a signed token grants access to a descriptor.
Definition: plugin.h:406
janus_callbacks::events_is_enabled
gboolean(*const events_is_enabled)(void)
Callback to check whether the event handlers mechanism is enabled.
Definition: plugin.h:388
janus_plugin::destroy
void(*const destroy)(void)
Plugin deinitialization/destructor.
Definition: plugin.h:248
janus_callbacks
Callbacks to contact the Janus core.
Definition: plugin.h:344
janus_plugin::handle_admin_message
struct json_t *(*const handle_admin_message)(json_t *message)
Method to handle an incoming Admin API message/request.
Definition: plugin.h:285
janus_plugin::get_version
int(*const get_version)(void)
Informative method to request the numeric version of the plugin.
Definition: plugin.h:258
janus_plugin_session::ref
janus_refcount ref
Reference counter for this instance.
Definition: plugin.h:237
refcount.h
Reference counter mechanism.
janus_plugin::destroy_session
void(*const destroy_session)(janus_plugin_session *handle, int *error)
Method to destroy a session/handle for a peer.
Definition: plugin.h:333
janus_plugin_session::plugin_handle
void * plugin_handle
Opaque pointer to the plugin session.
Definition: plugin.h:232
janus_callbacks::close_pc
void(*const close_pc)(janus_plugin_session *handle)
Callback to ask the core to close a WebRTC PeerConnection.
Definition: plugin.h:379
janus_callbacks::end_session
void(*const end_session)(janus_plugin_session *handle)
Callback to ask the core to get rid of a plugin/gateway session.
Definition: plugin.h:384
janus_plugin::query_session
json_t *(*const query_session)(janus_plugin_session *handle)
Method to get plugin-specific info of a session/handle.
Definition: plugin.h:339