Go to the documentation of this file.
148 #ifndef JANUS_PLUGIN_H
149 #define JANUS_PLUGIN_H
157 #include <inttypes.h>
173 #define JANUS_PLUGIN_API_VERSION 14
191 #define JANUS_PLUGIN_INIT(...) { \
194 .get_api_compatibility = NULL, \
195 .get_version = NULL, \
196 .get_version_string = NULL, \
197 .get_description = 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, \
209 .hangup_media = NULL, \
210 .destroy_session = NULL, \
211 .query_session = NULL, \
gboolean video_flipped
Whether the video orientation extension says it's flipped horizontally.
Definition: plugin.h:550
void(*const relay_rtcp)(janus_plugin_session *handle, janus_plugin_rtcp *packet)
Callback to relay RTCP messages to a peer.
Definition: plugin.h:366
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:20
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:297
The plugin session and callbacks interface.
Definition: plugin.h:250
@ JANUS_PLUGIN_OK_WAIT
The request was correctly handled and notifications will follow with more info (asynchronous)
Definition: plugin.h:448
gboolean video
Whether this is an audio or video RTCP packet.
Definition: plugin.h:581
const char *(*const get_author)(void)
Informative method to request the author of the plugin.
Definition: plugin.h:275
char * buffer
The packet data.
Definition: plugin.h:565
Janus plugin data message.
Definition: plugin.h:596
void janus_plugin_rtcp_reset(janus_plugin_rtcp *packet)
Helper method to initialise/reset the RTCP packet.
Definition: plugin.c:55
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:244
janus_plugin_result_type
Result types.
Definition: plugin.h:442
Janus plugin RTP extensions.
Definition: plugin.h:537
Janus plugin RTP packet.
Definition: plugin.h:561
void * gateway_handle
Opaque pointer to the Janus core-level handle.
Definition: plugin.h:239
void janus_plugin_result_destroy(janus_plugin_result *result)
Helper to quickly destroy a janus_plugin_result instance.
Definition: plugin.c:29
void janus_plugin_rtp_reset(janus_plugin_rtp *packet)
Helper method to initialise/reset the RTP packet.
Definition: plugin.c:49
Plugin-Gateway session mapping.
Definition: plugin.h:237
void(*const send_remb)(janus_plugin_session *handle, guint32 bitrate)
Helper to ask for a keyframe via a RTCP PLI.
Definition: plugin.h:382
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:403
json_t * content
Result content.
Definition: plugin.h:469
uint16_t length
The packet length.
Definition: plugin.h:567
int(*const init)(janus_callbacks *callback, const char *config_path)
Plugin initialization/constructor.
Definition: plugin.h:255
@ JANUS_PLUGIN_ERROR
A severe error happened (not an application level error)
Definition: plugin.h:444
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:357
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:290
const char * text
Text associated with this plugin result.
Definition: plugin.h:461
janus_plugin * create_p(void)
The hook that plugins need to implement to be created from the Janus core.
Definition: plugin.h:419
const char *(*const get_version_string)(void)
Informative method to request the string version of the plugin.
Definition: plugin.h:269
@ JANUS_PLUGIN_OK
The request was correctly handled and a response is provided (synchronous)
Definition: plugin.h:446
janus_plugin_rtp_extensions extensions
RTP extensions.
Definition: plugin.h:569
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:277
void janus_plugin_rtp_extensions_reset(janus_plugin_rtp_extensions *extensions)
Helper method to initialise/reset the RTP extensions field.
Definition: plugin.c:39
const char *(*const get_name)(void)
Informative method to request the name of the plugin.
Definition: plugin.h:273
gboolean video
Whether this is an audio or video RTP packet.
Definition: plugin.h:563
Definition: refcount.h:78
uint16_t length
The message length.
Definition: plugin.h:604
void(*const relay_rtp)(janus_plugin_session *handle, janus_plugin_rtp *packet)
Callback to relay RTP packets to a peer.
Definition: plugin.h:362
gboolean video_back_camera
Whether the video orientation extension says this is the back camera.
Definition: plugin.h:547
janus_plugin_result_type type
Result type.
Definition: plugin.h:454
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:332
void janus_plugin_data_reset(janus_plugin_data *packet)
Helper method to initialise/reset the data message.
Definition: plugin.c:59
int(*const get_api_compatibility)(void)
Informative method to request the API version this plugin was compiled against.
Definition: plugin.h:265
void(*const create_session)(janus_plugin_session *handle, int *error)
Method to create a new session/handle for a peer.
Definition: plugin.h:282
const char *(*const get_description)(void)
Informative method to request a description of the plugin.
Definition: plugin.h:271
Janus plugin result.
Definition: plugin.h:452
gboolean audio_level_vad
Whether the encoder detected voice activity (part of audio-level extension)
Definition: plugin.h:542
void(*const incoming_rtcp)(janus_plugin_session *handle, janus_plugin_rtcp *packet)
Method to handle an incoming RTCP packet from a peer.
Definition: plugin.h:305
struct json_t json_t
Definition: plugin.h:234
int16_t video_rotation
Video orientation rotation (0, 90, 180, 270); -1 means no extension.
Definition: plugin.h:544
gboolean(*const auth_is_signature_valid)(janus_plugin *plugin, const char *token)
Method to check whether a signed token is valid.
Definition: plugin.h:409
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:415
void(*const send_pli)(janus_plugin_session *handle)
Helper to ask for a keyframe via a RTCP PLI.
Definition: plugin.h:376
int8_t audio_level
Audio level, in DB (0-127, 127=silence); -1 means no extension.
Definition: plugin.h:539
gboolean(*const events_is_enabled)(void)
Callback to check whether the event handlers mechanism is enabled.
Definition: plugin.h:397
uint16_t length
The packet length.
Definition: plugin.h:585
void(*const destroy)(void)
Plugin deinitialization/destructor.
Definition: plugin.h:257
char * buffer
The message data.
Definition: plugin.h:602
char * buffer
The packet data.
Definition: plugin.h:583
Callbacks to contact the Janus core.
Definition: plugin.h:347
struct json_t *(*const handle_admin_message)(json_t *message)
Method to handle an incoming Admin API message/request.
Definition: plugin.h:294
int(*const get_version)(void)
Informative method to request the numeric version of the plugin.
Definition: plugin.h:267
void(*const slow_link)(janus_plugin_session *handle, gboolean uplink, gboolean video)
Method to be notified by the core when too many NACKs have been received or sent by Janus,...
Definition: plugin.h:329
janus_refcount ref
Reference counter for this instance.
Definition: plugin.h:246
Janus plugin RTCP packet.
Definition: plugin.h:579
Reference counter mechanism.
char * label
The label this message belongs to.
Definition: plugin.h:598
void(*const relay_data)(janus_plugin_session *handle, janus_plugin_data *packet)
Callback to relay SCTP/DataChannel messages to a peer.
Definition: plugin.h:370
gboolean binary
Whether the message data is text (default=FALSE) or binary.
Definition: plugin.h:600
void(*const destroy_session)(janus_plugin_session *handle, int *error)
Method to destroy a session/handle for a peer.
Definition: plugin.h:336
void * plugin_handle
Opaque pointer to the plugin session.
Definition: plugin.h:241
void(*const close_pc)(janus_plugin_session *handle)
Callback to ask the core to close a WebRTC PeerConnection.
Definition: plugin.h:388
void(*const end_session)(janus_plugin_session *handle)
Callback to ask the core to get rid of a plugin/gateway session.
Definition: plugin.h:393
void(*const incoming_data)(janus_plugin_session *handle, janus_plugin_data *packet)
Method to handle incoming SCTP/DataChannel data from a peer (text only, for the moment)
Definition: plugin.h:312
void(*const incoming_rtp)(janus_plugin_session *handle, janus_plugin_rtp *packet)
Method to handle an incoming RTP packet from a peer.
Definition: plugin.h:301
json_t *(*const query_session)(janus_plugin_session *handle)
Method to get plugin-specific info of a session/handle.
Definition: plugin.h:342