Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
JSON-RPC

Classes

class  JSONRPC::CJSONRPC
 JSON RPC handler. More...
 
class  JSONRPC::JSONSchemaTypeDefinition
 Class for a parameter of a json rpc method. More...
 
class  JSONRPC::JsonRpcMethod
 Structure for a published json rpc method. More...
 
struct  JSONRPC::JsonRpcMethodMap
 Structure mapping a json rpc method definition to an actual method implementation. More...
 
class  JSONRPC::CJSONServiceDescription
 Helper class for json schema service descriptor based service descriptions for the json rpc API. More...
 
class  JSONRPC::CJSONUtils
 Helper class containing utility methods to handle json rpc method calls. More...
 

Enumerations

enum  JSONRPC::JSONRPC_STATUS {
  JSONRPC::OK = 0 , JSONRPC::ACK = -1 , JSONRPC::InvalidRequest = -32600 , JSONRPC::MethodNotFound = -32601 ,
  JSONRPC::InvalidParams = -32602 , JSONRPC::InternalError = -32603 , JSONRPC::ParseError = -32700 , JSONRPC::BadPermission = -32099 ,
  JSONRPC::FailedToExecute = -32100
}
 Possible statuc codes of a response to a JSON-RPC request. More...
 
enum  JSONRPC::OperationPermission {
  JSONRPC::ReadData = 0x1 , JSONRPC::ControlPlayback = 0x2 , JSONRPC::ControlNotify = 0x4 , JSONRPC::ControlPower = 0x8 ,
  JSONRPC::UpdateData = 0x10 , JSONRPC::RemoveData = 0x20 , JSONRPC::Navigate = 0x40 , JSONRPC::WriteFile = 0x80 ,
  JSONRPC::ControlSystem = 0x100 , JSONRPC::ControlGUI = 0x200 , JSONRPC::ManageAddon = 0x400 , JSONRPC::ExecuteAddon = 0x800 ,
  JSONRPC::ControlPVR = 0x1000
}
 Permission categories for json rpc methods. More...
 

Detailed Description

Everything around the json-rpc interface

Everything around the json-rpc interface

Enumeration Type Documentation

◆ JSONRPC_STATUS

Possible statuc codes of a response to a JSON-RPC request.

Enumerator
OK 
ACK 
InvalidRequest 
MethodNotFound 
InvalidParams 
InternalError 
ParseError 
BadPermission 
FailedToExecute 

◆ OperationPermission

Permission categories for json rpc methods.

A JSON-RPC method will only be called if the caller has the correct permissions to execute the method. The method call needs to be perfectly threadsafe.

Enumerator
ReadData 
ControlPlayback 
ControlNotify 
ControlPower 
UpdateData 
RemoveData 
Navigate 
WriteFile 
ControlSystem 
ControlGUI 
ManageAddon 
ExecuteAddon 
ControlPVR