code.vuplus.com Git - vuplus_xbmc/blob - xbmc/interfaces/json-rpc/notifications.json

   1 {
   2   "Player.OnPlay": {
   3     "type": "notification",
   4     "description": "Playback of a media item has been started or the playback speed has changed. If there is no ID available extra information will be provided.",
   5     "params": [
   6       { "name": "sender", "type": "string", "required": true },
   7       { "name": "data", "$ref": "Player.Notifications.Data", "required": true }
   8     ],
   9     "returns": null
  10   },
  11   "Player.OnPause": {
  12     "type": "notification",
  13     "description": "Playback of a media item has been paused. If there is no ID available extra information will be provided.",
  14     "params": [
  15       { "name": "sender", "type": "string", "required": true },
  16       { "name": "data", "$ref": "Player.Notifications.Data", "required": true }
  17     ],
  18     "returns": null
  19   },
  20   "Player.OnStop": {
  21     "type": "notification",
  22     "description": "Playback of a media item has been stopped. If there is no ID available extra information will be provided.",
  23     "params": [
  24       { "name": "sender", "type": "string", "required": true },
  25       { "name": "data", "type": "object", "required": true,
  26         "properties": {
  27           "item": { "$ref": "Player.Notifications.Item" },
  28           "end": { "type": "boolean", "required": true, "description": "Whether the player has reached the end of the playable item(s) or not" }
  29         }
  30       }
  31     ],
  32     "returns": null
  33   },
  34   "Player.OnSpeedChanged": {
  35     "type": "notification",
  36     "description": "Speed of the playback of a media item has been changed. If there is no ID available extra information will be provided.",
  37     "params": [
  38       { "name": "sender", "type": "string", "required": true },
  39       { "name": "data", "$ref": "Player.Notifications.Data", "required": true }
  40     ],
  41     "returns": null
  42   },
  43   "Player.OnSeek": {
  44     "type": "notification",
  45     "description": "The playback position has been changed. If there is no ID available extra information will be provided.",
  46     "params": [
  47       { "name": "sender", "type": "string", "required": true },
  48       { "name": "data", "type": "object", "required": true,
  49         "properties": {
  50           "item": { "$ref": "Player.Notifications.Item" },
  51           "player": { "$ref": "Player.Notifications.Player.Seek", "required": true }
  52         }
  53       }
  54     ],
  55     "returns": null
  56   },
  57   "AudioLibrary.OnUpdate": {
  58     "type": "notification",
  59     "description": "An audio item has been updated.",
  60     "params": [
  61       { "name": "sender", "type": "string", "required": true },
  62       { "name": "data", "type": "object", "required": true,
  63         "properties": {
  64           "id": { "$ref": "Library.Id", "required": true },
  65           "type": { "type": "string", "id": "Notifications.Library.Audio.Type", "enum": [ "song" ], "required": true }
  66         }
  67       }
  68     ],
  69     "returns": null
  70   },
  71   "AudioLibrary.OnRemove": {
  72     "type": "notification",
  73     "description": "An audio item has been removed.",
  74     "params": [
  75       { "name": "sender", "type": "string", "required": true },
  76       { "name": "data", "type": "object", "required": true,
  77         "properties": {
  78           "id": { "$ref": "Library.Id", "required": true },
  79           "type": { "$ref": "Notifications.Library.Audio.Type", "required": true }
  80         }
  81       }
  82     ],
  83     "returns": null
  84   },
  85   "AudioLibrary.OnScanFinished": {
  86     "type": "notification",
  87     "description": "Scanning the audio library has been finished.",
  88     "params": [
  89       { "name": "sender", "type": "string", "required": true },
  90       { "name": "data", "type": "null", "required": true }
  91     ],
  92     "returns": null
  93   },
  94   "VideoLibrary.OnUpdate": {
  95     "type": "notification",
  96     "description": "A video item has been updated.",
  97     "params": [
  98       { "name": "sender", "type": "string", "required": true },
  99       { "name": "data", "type": "object", "required": true,
 100         "properties": {
 101           "id": { "$ref": "Library.Id", "required": true },
 102           "type": { "type": "string", "id": "Notifications.Library.Video.Type", "enum": [ "movie", "tvshow", "episode", "musicvideo" ], "required": true },
 103           "playcount": { "type": "integer", "minimum": 0, "default": -1 }
 104         }
 105       }
 106     ],
 107     "returns": null
 108   },
 109   "VideoLibrary.OnRemove": {
 110     "type": "notification",
 111     "description": "A video item has been removed.",
 112     "params": [
 113       { "name": "sender", "type": "string", "required": true },
 114       { "name": "data", "type": "object", "required": true,
 115         "properties": {
 116           "id": { "$ref": "Library.Id", "required": true },
 117           "type": { "$ref": "Notifications.Library.Video.Type", "required": true }
 118         }
 119       }
 120     ],
 121     "returns": null
 122   },
 123   "VideoLibrary.OnScanFinished": {
 124     "type": "notification",
 125     "description": "Scanning the video library has been finished.",
 126     "params": [
 127       { "name": "sender", "type": "string", "required": true },
 128       { "name": "data", "type": "null", "required": true }
 129     ],
 130     "returns": null
 131   },
 132   "System.OnQuit": {
 133     "type": "notification",
 134     "description": "XBMC will be closed.",
 135     "params": [
 136       { "name": "sender", "type": "string", "required": true },
 137       { "name": "data", "type": "null", "required": true }
 138     ],
 139     "returns": null
 140   },
 141   "System.OnRestart": {
 142     "type": "notification",
 143     "description": "The system will be restarted.",
 144     "params": [
 145       { "name": "sender", "type": "string", "required": true },
 146       { "name": "data", "type": "null", "required": true }
 147     ],
 148     "returns": null
 149   },
 150   "System.OnSleep": {
 151     "type": "notification",
 152     "description": "The system will be suspended.",
 153     "params": [
 154       { "name": "sender", "type": "string", "required": true },
 155       { "name": "data", "type": "null", "required": true }
 156     ],
 157     "returns": null
 158   },
 159   "System.OnWake": {
 160     "type": "notification",
 161     "description": "The system woke up from suspension.",
 162     "params": [
 163       { "name": "sender", "type": "string", "required": true },
 164       { "name": "data", "type": "null", "required": true }
 165     ],
 166     "returns": null
 167   },
 168   "System.OnLowBattery": {
 169     "type": "notification",
 170     "description": "The system is on low battery.",
 171     "params": [
 172       { "name": "sender", "type": "string", "required": true },
 173       { "name": "data", "type": "null", "required": true }
 174     ],
 175     "returns": null
 176   },
 177   "Application.OnVolumeChanged": {
 178     "type": "notification",
 179     "description": "The volume of the application has changed.",
 180     "params": [
 181       { "name": "sender", "type": "string", "required": true },
 182       { "name": "data", "type": "object", "required": true,
 183         "properties": {
 184           "volume": { "type": "integer", "minimum": 0, "maximum": 100, "required": true },
 185           "muted": { "type": "boolean", "required": true }
 186         }
 187       }
 188     ],
 189     "returns": null
 190   },
 191   "Input.OnInputRequested": {
 192     "type": "notification",
 193     "description": "The user is requested to provide some information.",
 194     "params": [
 195       { "name": "sender", "type": "string", "required": true },
 196       { "name": "data", "type": "object", "required": true,
 197         "properties": {
 198           "type": { "type": "string", "enum": [ "keyboard", "time", "date", "ip", "password", "number", "seconds" ], "required": true },
 199           "title": { "type": "string" }
 200         }
 201       }
 202     ],
 203     "returns": null
 204   },
 205   "Input.OnInputFinished": {
 206     "type": "notification",
 207     "description": "The user has provided the requested input.",
 208     "params": [
 209       { "name": "sender", "type": "string", "required": true },
 210       { "name": "data", "type": "null", "required": true }
 211     ],
 212     "returns": null
 213   }
 214 }