Fork me on GitHub
Macros | Functions
apierror.h File Reference

Janus API errors definition. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define JANUS_OK   0
 Success (no error) More...
 
#define JANUS_ERROR_UNAUTHORIZED   403
 Unauthorized (can only happen when using apisecret/auth token) More...
 
#define JANUS_ERROR_UNAUTHORIZED_PLUGIN   405
 Unauthorized access to a plugin (can only happen when using auth token) More...
 
#define JANUS_ERROR_UNKNOWN   490
 Unknown/undocumented error. More...
 
#define JANUS_ERROR_TRANSPORT_SPECIFIC   450
 Transport related error. More...
 
#define JANUS_ERROR_MISSING_REQUEST   452
 The request is missing in the message. More...
 
#define JANUS_ERROR_UNKNOWN_REQUEST   453
 The Janus core does not suppurt this request. More...
 
#define JANUS_ERROR_INVALID_JSON   454
 The payload is not a valid JSON message. More...
 
#define JANUS_ERROR_INVALID_JSON_OBJECT   455
 The object is not a valid JSON object as expected. More...
 
#define JANUS_ERROR_MISSING_MANDATORY_ELEMENT   456
 A mandatory element is missing in the message. More...
 
#define JANUS_ERROR_INVALID_REQUEST_PATH   457
 The request cannot be handled for this webserver path. More...
 
#define JANUS_ERROR_SESSION_NOT_FOUND   458
 The session the request refers to doesn't exist. More...
 
#define JANUS_ERROR_HANDLE_NOT_FOUND   459
 The handle the request refers to doesn't exist. More...
 
#define JANUS_ERROR_PLUGIN_NOT_FOUND   460
 The plugin the request wants to talk to doesn't exist. More...
 
#define JANUS_ERROR_PLUGIN_ATTACH   461
 An error occurring when trying to attach to a plugin and create a handle. More...
 
#define JANUS_ERROR_PLUGIN_MESSAGE   462
 An error occurring when trying to send a message/request to the plugin. More...
 
#define JANUS_ERROR_PLUGIN_DETACH   463
 An error occurring when trying to detach from a plugin and destroy the related handle. More...
 
#define JANUS_ERROR_JSEP_UNKNOWN_TYPE   464
 The Janus core doesn't support this SDP type. More...
 
#define JANUS_ERROR_JSEP_INVALID_SDP   465
 The Session Description provided by the peer is invalid. More...
 
#define JANUS_ERROR_TRICKE_INVALID_STREAM   466
 The stream a trickle candidate for does not exist or is invalid. More...
 
#define JANUS_ERROR_INVALID_ELEMENT_TYPE   467
 A JSON element is of the wrong type (e.g., an integer instead of a string) More...
 
#define JANUS_ERROR_SESSION_CONFLICT   468
 The ID provided to create a new session is already in use. More...
 
#define JANUS_ERROR_UNEXPECTED_ANSWER   469
 We got an ANSWER to an OFFER we never made. More...
 
#define JANUS_ERROR_TOKEN_NOT_FOUND   470
 The auth token the request refers to doesn't exist. More...
 
#define JANUS_ERROR_WEBRTC_STATE   471
 The current request cannot be handled because of not compatible WebRTC state. More...
 

Functions

const char * janus_get_api_error (int error)
 Helper method to get a string representation of an API error code. More...
 

Detailed Description

Janus API errors definition.

Author
Lorenzo Miniero loren.nosp@m.zo@m.nosp@m.eetec.nosp@m.ho.c.nosp@m.om

Definition of all the API errors that may occur when invoking the Janus web-based JSON API.

Todo:
This code still needs proper hooks in the JavaScript libraries that use the interface.

Core

Macro Definition Documentation

#define JANUS_ERROR_HANDLE_NOT_FOUND   459

The handle the request refers to doesn't exist.

#define JANUS_ERROR_INVALID_ELEMENT_TYPE   467

A JSON element is of the wrong type (e.g., an integer instead of a string)

#define JANUS_ERROR_INVALID_JSON   454

The payload is not a valid JSON message.

#define JANUS_ERROR_INVALID_JSON_OBJECT   455

The object is not a valid JSON object as expected.

#define JANUS_ERROR_INVALID_REQUEST_PATH   457

The request cannot be handled for this webserver path.

#define JANUS_ERROR_JSEP_INVALID_SDP   465

The Session Description provided by the peer is invalid.

#define JANUS_ERROR_JSEP_UNKNOWN_TYPE   464

The Janus core doesn't support this SDP type.

#define JANUS_ERROR_MISSING_MANDATORY_ELEMENT   456

A mandatory element is missing in the message.

#define JANUS_ERROR_MISSING_REQUEST   452

The request is missing in the message.

#define JANUS_ERROR_PLUGIN_ATTACH   461

An error occurring when trying to attach to a plugin and create a handle.

#define JANUS_ERROR_PLUGIN_DETACH   463

An error occurring when trying to detach from a plugin and destroy the related handle.

#define JANUS_ERROR_PLUGIN_MESSAGE   462

An error occurring when trying to send a message/request to the plugin.

#define JANUS_ERROR_PLUGIN_NOT_FOUND   460

The plugin the request wants to talk to doesn't exist.

#define JANUS_ERROR_SESSION_CONFLICT   468

The ID provided to create a new session is already in use.

#define JANUS_ERROR_SESSION_NOT_FOUND   458

The session the request refers to doesn't exist.

#define JANUS_ERROR_TOKEN_NOT_FOUND   470

The auth token the request refers to doesn't exist.

#define JANUS_ERROR_TRANSPORT_SPECIFIC   450

Transport related error.

#define JANUS_ERROR_TRICKE_INVALID_STREAM   466

The stream a trickle candidate for does not exist or is invalid.

#define JANUS_ERROR_UNAUTHORIZED   403

Unauthorized (can only happen when using apisecret/auth token)

#define JANUS_ERROR_UNAUTHORIZED_PLUGIN   405

Unauthorized access to a plugin (can only happen when using auth token)

#define JANUS_ERROR_UNEXPECTED_ANSWER   469

We got an ANSWER to an OFFER we never made.

#define JANUS_ERROR_UNKNOWN   490

Unknown/undocumented error.

#define JANUS_ERROR_UNKNOWN_REQUEST   453

The Janus core does not suppurt this request.

#define JANUS_ERROR_WEBRTC_STATE   471

The current request cannot be handled because of not compatible WebRTC state.

#define JANUS_OK   0

Success (no error)

Function Documentation

const char* janus_get_api_error ( int  error)

Helper method to get a string representation of an API error code.

Parameters
[in]errorThe API error code
Returns
A string representation of the error code