KODI JSON-RPC解读

大概一年前就开始关注KODI了,确实是个非常不错的开源项目,KODI提供很好的操作界面,但作为一个命令行控或者是没有显示屏的树莓派,我希望能够通过命令行对其进行控制,比如播放、暂停、静音等等. 于是去搜索了下,发现有个JSON-RPC,他是kODI官网推出的,方便其他开发者对接,到目前为止已经更新到v8,可以点击这里查看。这里将为大家详细介绍下它的用法。

初步印象

在使用JSON-RPC,必须开启,可以进入设置 - 服务 - 控制,开启服务,可设置端口、用户名、密码,当然可以不设置用户名和密码

入门

JSON-RPC顾名思义就是采用JSON进行RPC通信,那么它的基本格式如下:

请求(REQUEST)
  • URI:http://host:port/jsonrpc
  • METHOD:POST
  • HEADER:ContentType:application/json
  • BODY: {"jsonrpc":"2.0", "method":"xx", "params":{}, "id":xx},jsonrpc必须是2.0,这个与实际版本无关 method为具体方法,会在后面介绍,params为method对应的参数,若无,则可以不传 id是由客户端定义,用于标识客户端,服务器会返回相同的id(见响应)

如:

curl -X POST -H "ContentType:application/json" -d '{"jsonrpc": "2.0", "method": "JSONRPC.Version", "id":"22"}' http://localhost:8080/jsonrpc
响应(RESPONSE)
  • BODY: {"jsonrpc":"2.0", "result":"xxx","error":{"code":xx,"message":"xxx","data":"xxx"},"id":xx } result为返回结果,若错误,则空,error错误,id为请求传递的,若错误,为空
{"id":"22","jsonrpc":"2.0","result":{"version":{"major":8,"minor":0,"patch":0}}}

进阶

以上内容就好比是内功,有了好的内功,其他的都好学,在之前的REQUEST我们了解到了method和params,那么我们来看看都有哪些外功. 外功分为v2、v4、v6、v8几个版本,目前最新的是v8,可以通过上面给出的例子,获取到当前版本. 竟然我用到的是v8,我们就来看下v8的定义。 v8是随着kodi v17一同发布的,它支持WebSocket。正所谓举其一可知大概,我在这里就不对所有的method进行介绍,我会抽出几个,告知大家如何看懂文档。

  • Player.GetActivePlayers - 获取当前激活的播放器
5.9.1 Player.GetActivePlayers
Returns all active players
Permissions:
    ReadData
Returns:
    Type: array

Permissions 权限,可通过JSONRPC.Permission获取权限开关状态
Returns:返回

curl -X POST --header "content-type:application/json" --data '{"jsonrpc": "2.0", "method": "Player.GetActivePlayers", "id":"22"}' http://localhost:8080/jsonrpc

{"id":"22","jsonrpc":"2.0","result":[{"playerid":0,"type":"audio"}]}
  • Application.SetVolume - 设置音量
5.2.4 Application.SetVolume
Set the current volume
Permissions:
    ControlPlayback
Parameters:
    mixed volume
Returns:
    Type: integer

例子:

 curl -X POST --header "content-type:application/json" --data '{"jsonrpc": "2.0", "method": "Application.SetVolume", "params":{"volume":8}, "id":"22"}' http://localhost:8080/jsonrpc
 
{"id":"22","jsonrpc":"2.0","result":8}

扩展

当然KODI还提供了kodi-send命令,来简化请求,格式如下:

 kodi-send -a "XXX"

xxx见http://kodi.wiki/view/List_of_built-in_functions

osmc@osmc:~$ kodi-send -a "SetVolume(10)"
Sending action: SetVolume(10)
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容

  • 前言 最近刚加入区块链学习的热潮,从一些基本技术开始学起。本文翻译自JSON-RPC 2.0 Specificat...
    小胖子嘿嘿嘿阅读 10,217评论 0 6
  • json-rpc 是 rpc 通信过程中定义的一套 json 格式标准,最早是 json-rpc1.0,最新是 j...
    juniway阅读 4,783评论 0 2
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • 起源时间: 2010-03-26(基于2009-05-24版本) 更新: 2013-01-04 作者: JSON-...
    零一间阅读 421评论 0 2
  • 每次和领导讨论需求,都感觉无法正常的进行,有一种想要离开的想法,今年老婆怀孕了,今天孩子烧的厉害,自己给家里付出的...
    李雷川阅读 164评论 0 0