Classes
class	CAddonsOperations

class	CApplicationOperations

class	CAudioLibrary

class	CFavouritesOperations

class	CFileItemHandler

class	CFileOperations

class	CGUIOperations

class	CInputOperations

class	CJSONRPC
	JSON RPC handler. More...

class	CJSONRPCUtils

class	CJSONServiceDescription
	Helper class for json schema service descriptor based service descriptions for the json rpc API. More...

class	CJSONUtils
	Helper class containing utility methods to handle json rpc method calls. More...

class	CPlayerOperations

class	CPlaylistOperations

class	CProfilesOperations

class	CPVROperations

class	CSettingsOperations

class	CSystemOperations

class	CTCPServer

class	CTextureOperations

class	CVideoLibrary

class	CXBMCOperations

class	IClient

class	IJSONRPCAnnouncer

class	ITransportLayer

class	JsonRpcMethod
	Structure for a published json rpc method. More...

struct	JsonRpcMethodMap
	Structure mapping a json rpc method definition to an actual method implementation. More...

class	JSONSchemaTypeDefinition
	Class for a parameter of a json rpc method. More...

Typedefs
typedef JSONRPC_STATUS(*	MethodCall) (const std::string &method, ITransportLayer transport, IClient client, const CVariant &parameterObject, CVariant &result)
	Function pointer for JSON-RPC methods.

typedef std::shared_ptr< JSONSchemaTypeDefinition >	JSONSchemaTypeDefinitionPtr

Enumerations
enum	TransportLayerCapability { Response = 0x1 , Announcing = 0x2 , FileDownloadRedirect = 0x4 , FileDownloadDirect = 0x8 }

enum	JSONRPC_STATUS { OK = 0 , ACK = -1 , InvalidRequest = -32600 , MethodNotFound = -32601 , InvalidParams = -32602 , InternalError = -32603 , ParseError = -32700 , BadPermission = -32099 , FailedToExecute = -32100 }
	Possible statuc codes of a response to a JSON-RPC request. More...

enum	OperationPermission { ReadData = 0x1 , ControlPlayback = 0x2 , ControlNotify = 0x4 , ControlPower = 0x8 , UpdateData = 0x10 , RemoveData = 0x20 , Navigate = 0x40 , WriteFile = 0x80 , ControlSystem = 0x100 , ControlGUI = 0x200 , ManageAddon = 0x400 , ExecuteAddon = 0x800 , ControlPVR = 0x1000 }
	Permission categories for json rpc methods. More...

enum	JSONSchemaType { NullValue = 0x01 , StringValue = 0x02 , NumberValue = 0x04 , IntegerValue = 0x08 , BooleanValue = 0x10 , ArrayValue = 0x20 , ObjectValue = 0x40 , AnyValue = 0x80 }
	Possible value types of a parameter or return type. More...

enum	PlayerType { None = 0 , Video = 0x1 , Audio = 0x2 , Picture = 0x4 , External = 0x8 , Remote = 0x10 }

Functions
const char *	PermissionToString (const OperationPermission &permission)
	Returns a string representation for the given OperationPermission.

OperationPermission	StringToPermission (const std::string &permission)
	Returns a OperationPermission value for the given string representation.

Variables
const int	OPERATION_PERMISSION_ALL

const int	OPERATION_PERMISSION_NOTIFICATION

Typedef Documentation

◆ JSONSchemaTypeDefinitionPtr

typedef std::shared_ptr<JSONSchemaTypeDefinition> JSONRPC::JSONSchemaTypeDefinitionPtr

◆ MethodCall

typedef JSONRPC_STATUS(* JSONRPC::MethodCall) (const std::string &method, ITransportLayer *transport, IClient *client, const CVariant &parameterObject, CVariant &result)

Function pointer for JSON-RPC methods.

Enumeration Type Documentation

◆ JSONSchemaType

enum JSONRPC::JSONSchemaType

Possible value types of a parameter or return type.

Enumerator
NullValue
StringValue
NumberValue
IntegerValue
BooleanValue
ArrayValue
ObjectValue
AnyValue

◆ PlayerType

enum JSONRPC::PlayerType

Enumerator
None
Video
Audio
Picture
External
Remote

◆ TransportLayerCapability

enum JSONRPC::TransportLayerCapability

Enumerator
Response
Announcing
FileDownloadRedirect
FileDownloadDirect

Function Documentation

◆ PermissionToString()

const char * JSONRPC::PermissionToString ( const OperationPermission & permission )

inline

Returns a string representation for the given OperationPermission.

Parameters

permission Specific OperationPermission

Returns: String representation of the given OperationPermission

◆ StringToPermission()

OperationPermission JSONRPC::StringToPermission ( const std::string & permission )

inline

Returns a OperationPermission value for the given string representation.

Parameters

permission String representation of the OperationPermission

Returns: OperationPermission value of the given string representation

Variable Documentation

◆ OPERATION_PERMISSION_ALL

const int JSONRPC::OPERATION_PERMISSION_ALL

Initial value:

= (ReadData | ControlPlayback | ControlNotify | ControlPower |
                                        UpdateData | RemoveData | Navigate | WriteFile | ControlSystem |
                                        ControlGUI | ManageAddon | ExecuteAddon | ControlPVR)

◆ OPERATION_PERMISSION_NOTIFICATION

const int JSONRPC::OPERATION_PERMISSION_NOTIFICATION