Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
243 changes: 211 additions & 32 deletions docs/openrpc/the-spec/firebolt-open-rpc.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,19 @@
"properties": {
"intent": {
"type": "object",
"required": ["action"],
"required": [
"action"
],
"properties": {
"action": { "type": "string" },
"action": {
"type": "string"
},
"context": {
"type": "object",
"properties": {
"source": { "type": "string" }
"source": {
"type": "string"
}
}
}
}
Expand Down Expand Up @@ -148,13 +154,19 @@
"properties": {
"intent": {
"type": "object",
"required": ["action"],
"required": [
"action"
],
"properties": {
"action": { "type": "string" },
"action": {
"type": "string"
},
"context": {
"type": "object",
"properties": {
"source": { "type": "string" }
"source": {
"type": "string"
}
}
}
}
Expand Down Expand Up @@ -208,13 +220,19 @@
"required": true,
"schema": {
"type": "object",
"required": ["action"],
"required": [
"action"
],
"properties": {
"action": { "type": "string" },
"action": {
"type": "string"
},
"context": {
"type": "object",
"properties": {
"source": { "type": "string" }
"source": {
"type": "string"
}
}
}
}
Expand Down Expand Up @@ -655,6 +673,39 @@
}
]
},
{
"name": "Device.dolbyAtmosExperienceAvailable",
"summary": "Returns whether Dolby Atmos experience is available on the device",
"params": [],
"tags": [
{
"name": "property:readonly"
},
{
"name": "capabilities",
"x-uses": [
"xrn:firebolt:capability:device:info"
]
}
],
"result": {
"name": "dolbyAtmosExperienceAvailable",
"summary": "Whether Dolby Atmos experience is available on the device",
"schema": {
"type": "boolean"
}
},
"examples": [
{
"name": "Getting Dolby Atmos experience availability",
"params": [],
"result": {
"name": "Default Result",
"value": true
}
}
]
},
{
"name": "Discovery.watched",
"summary": "Notify the platform that content was partially or completely watched",
Expand Down Expand Up @@ -775,7 +826,7 @@
},
{
"name": "Discovery.watchedV2",
"summary": "Notify the platform that content was partially or completely watched, returns whether the notification was accepted",
"summary": "Notify the platform that content was partially or completely watched",
"tags": [
{
"name": "polymorphic-reducer"
Expand Down Expand Up @@ -829,9 +880,8 @@
],
"result": {
"name": "result",
"summary": "Whether the platform accepted the watched notification",
"schema": {
"type": "boolean"
"type": "null"
}
},
"examples": [
Expand All @@ -857,7 +907,7 @@
],
"result": {
"name": "result",
"value": true
"value": null
}
},
{
Expand Down Expand Up @@ -886,7 +936,7 @@
],
"result": {
"name": "result",
"value": true
"value": null
}
}
]
Expand Down Expand Up @@ -1215,6 +1265,39 @@
}
]
},
{
"name": "Localization.timeZone",
"tags": [
{
"name": "property:readonly"
},
{
"name": "capabilities",
"x-uses": [
"xrn:firebolt:capability:localization:time-zone"
]
}
],
"summary": "Get the IANA timezone of the device.",
"params": [],
"result": {
"name": "timeZone",
"summary": "The device timezone.",
"schema": {
"type": "string"
}
},
"examples": [
{
"name": "Default example",
"params": [],
"result": {
"name": "Default Result",
"value": "America/New_York"
}
}
]
},
{
"name": "Metrics.ready",
"tags": [
Expand Down Expand Up @@ -2356,7 +2439,7 @@
},
{
"name": "Stats.memoryUsage",
"summary": "Returns information about container memory usage, in units of 1024 bytes.",
"summary": "Returns information about container memory usage in bytes.",
"tags": [
{
"name": "capabilities",
Expand All @@ -2380,10 +2463,10 @@
"name": "value",
"description": "The memory usage information",
"value": {
"userMemoryUsedKiB": 123456,
"userMemoryLimitKiB": 789012,
"gpuMemoryUsedKiB": 345678,
"gpuMemoryLimitKiB": 901234
"userMemoryUsed": 126418944,
"userMemoryLimit": 807948288,
"gpuMemoryUsed": 353974272,
"gpuMemoryLimit": 922863616
Comment thread
swethasukumarr marked this conversation as resolved.
}
}
}
Expand Down Expand Up @@ -3373,6 +3456,52 @@
}
}
},
{
"name": "Device.onDolbyAtmosExperienceAvailableChanged",
"summary": "Returns whether Dolby Atmos experience is available on the device",
"params": [
{
"name": "listen",
"schema": {
"type": "boolean"
}
}
],
"tags": [
{
"name": "event",
"x-notifier": "Device.onDolbyAtmosExperienceAvailableChanged",
"x-subscriber-for": "Device.dolbyAtmosExperienceAvailable"
},
{
"name": "capabilities",
"x-uses": [
"xrn:firebolt:capability:device:info"
]
}
],
"examples": [
{
"name": "Getting Dolby Atmos experience availability",
"params": [
{
"name": "listen",
"value": true
}
],
"result": {
"name": "result",
"value": null
}
}
],
"result": {
"name": "result",
"schema": {
"type": "null"
}
}
},
{
"name": "Localization.onCountryChanged",
"tags": [
Expand Down Expand Up @@ -3524,6 +3653,52 @@
}
}
},
{
"name": "Localization.onTimeZoneChanged",
"tags": [
{
"name": "event",
"x-notifier": "Localization.onTimeZoneChanged",
"x-subscriber-for": "Localization.timeZone"
},
{
"name": "capabilities",
"x-uses": [
"xrn:firebolt:capability:localization:time-zone"
]
}
],
"summary": "Get the IANA timezone of the device.",
"params": [
{
"name": "listen",
"schema": {
"type": "boolean"
}
}
],
"examples": [
{
"name": "Default example",
"params": [
{
"name": "listen",
"value": true
}
],
"result": {
"name": "result",
"value": null
}
}
],
"result": {
"name": "result",
"schema": {
"type": "null"
}
}
},
{
"name": "Network.onConnectedChanged",
"summary": "Returns whether the device currently has a usable network connection.",
Expand Down Expand Up @@ -3777,28 +3952,32 @@
"type": "object",
"description": "Describes current and maximum memory usage of the container.",
"properties": {
"userMemoryUsedKiB": {
"userMemoryUsed": {
"type": "integer",
"description": "User memory currently used in 1024 bytes."
"description": "User memory currently used, in bytes.",
"minimum": 0
},
"userMemoryLimitKiB": {
"userMemoryLimit": {
"type": "integer",
"description": "Maximum user memory available in 1024 bytes."
"description": "Maximum user memory available, in bytes.",
"minimum": 0
},
"gpuMemoryUsedKiB": {
"gpuMemoryUsed": {
"type": "integer",
"description": "GPU memory currently used in 1024 bytes."
"description": "GPU memory currently used, in bytes.",
"minimum": 0
},
"gpuMemoryLimitKiB": {
"gpuMemoryLimit": {
"type": "integer",
"description": "Maximum GPU memory available in 1024 bytes."
"description": "Maximum GPU memory available, in bytes.",
"minimum": 0
}
},
"required": [
"userMemoryUsedKiB",
"userMemoryLimitKiB",
"gpuMemoryUsedKiB",
"gpuMemoryLimitKiB"
"userMemoryUsed",
"userMemoryLimit",
"gpuMemoryUsed",
"gpuMemoryLimit"
]
},
"TTSEnabled": {
Expand Down Expand Up @@ -4168,4 +4347,4 @@
}
}
}
}
}
Loading
Loading