@portpowered/reference-data 0.4.6 → 0.4.8

package/generated/public/docs/references/schemas/index.json

@@ -361,6 +361,12 @@
       "path": "/docs/references/schemas/BrandingInformation.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/BrandingInformation"
     },
+    {
+      "kind": "schemas",
+      "name": "BrightnessInterfaceAdjustBrightnessMessage",
+      "path": "/docs/references/schemas/BrightnessInterfaceAdjustBrightnessMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/BrightnessInterfaceAdjustBrightnessMessage"
+    },
     {
       "kind": "schemas",
       "name": "BrightnessInterfaceBrightnessAttribute",
@@ -2077,12 +2083,24 @@
       "path": "/docs/references/schemas/MediaPlayerInterfaceConfiguration.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceConfiguration"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaPlayerInterfaceFastForwardMessage",
+      "path": "/docs/references/schemas/MediaPlayerInterfaceFastForwardMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceFastForwardMessage"
+    },
     {
       "kind": "schemas",
       "name": "MediaPlayerInterfaceNextMessage",
       "path": "/docs/references/schemas/MediaPlayerInterfaceNextMessage.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceNextMessage"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaPlayerInterfaceNowPlayingAttribute",
+      "path": "/docs/references/schemas/MediaPlayerInterfaceNowPlayingAttribute.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceNowPlayingAttribute"
+    },
     {
       "kind": "schemas",
       "name": "MediaPlayerInterfacePauseMessage",
@@ -2197,6 +2215,24 @@
       "path": "/docs/references/schemas/MediaPlaylistInterfaceGetPlaylistMessage.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfaceGetPlaylistMessage"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaPlaylistInterfaceListPlaylistsMessage",
+      "path": "/docs/references/schemas/MediaPlaylistInterfaceListPlaylistsMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfaceListPlaylistsMessage"
+    },
+    {
+      "kind": "schemas",
+      "name": "MediaPlaylistInterfacePlaylistContentsMessage",
+      "path": "/docs/references/schemas/MediaPlaylistInterfacePlaylistContentsMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfacePlaylistContentsMessage"
+    },
+    {
+      "kind": "schemas",
+      "name": "MediaPlaylistInterfacePlaylistsMessage",
+      "path": "/docs/references/schemas/MediaPlaylistInterfacePlaylistsMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfacePlaylistsMessage"
+    },
     {
       "kind": "schemas",
       "name": "MediaPlaylistInterfacePlayPlaylistMessage",
@@ -2215,6 +2251,12 @@
       "path": "/docs/references/schemas/MediaPlaylistInterfaceShufflePlaylistMessage.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfaceShufflePlaylistMessage"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaProvider",
+      "path": "/docs/references/schemas/MediaProvider.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaProvider"
+    },
     {
       "kind": "schemas",
       "name": "MediaSearchCapabilityInterfaceConfiguration",
@@ -2227,6 +2269,18 @@
       "path": "/docs/references/schemas/MediaSearchInterfaceAudioMediaResultsMessage.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaSearchInterfaceAudioMediaResultsMessage"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaSearchInterfaceGetMediaMessage",
+      "path": "/docs/references/schemas/MediaSearchInterfaceGetMediaMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaSearchInterfaceGetMediaMessage"
+    },
+    {
+      "kind": "schemas",
+      "name": "MediaSearchInterfaceMediaDetailsMessage",
+      "path": "/docs/references/schemas/MediaSearchInterfaceMediaDetailsMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaSearchInterfaceMediaDetailsMessage"
+    },
     {
       "kind": "schemas",
       "name": "MediaSearchInterfaceSearchMediaMessage",
@@ -2773,6 +2827,18 @@
       "path": "/docs/references/schemas/PM25ConcentrationMeasurementInterfaceMeasuredValueAttribute.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/PM25ConcentrationMeasurementInterfaceMeasuredValueAttribute"
     },
+    {
+      "kind": "schemas",
+      "name": "PodcastEpisode",
+      "path": "/docs/references/schemas/PodcastEpisode.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/PodcastEpisode"
+    },
+    {
+      "kind": "schemas",
+      "name": "PodcastShow",
+      "path": "/docs/references/schemas/PodcastShow.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/PodcastShow"
+    },
     {
       "kind": "schemas",
       "name": "Position",
@@ -3835,6 +3901,12 @@
       "path": "/docs/references/schemas/SupportedInput.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/SupportedInput"
     },
+    {
+      "kind": "schemas",
+      "name": "SupportedMediaResource",
+      "path": "/docs/references/schemas/SupportedMediaResource.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/SupportedMediaResource"
+    },
     {
       "kind": "schemas",
       "name": "SynchronizationItemError",

package/generated/resources/brightness/message-adjust-brightness.json

@@ -0,0 +1,15 @@
+{
+  "description": "Adjust brightness by a signed number of percentage points. The endpoint must advertise this message separately from set-brightness.",
+  "type": "object",
+  "properties": {
+    "brightnessDelta": {
+      "type": "integer",
+      "minimum": -100,
+      "maximum": 100
+    }
+  },
+  "required": [
+    "brightnessDelta"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/keypad-input/configuration.json

@@ -21,6 +21,7 @@
           "LEFT",
           "RIGHT",
           "SELECT",
+          "HOME",
           "BACK",
           "EXIT",
           "MENU",

package/generated/resources/keypad-input/message-send-key.json

@@ -19,6 +19,7 @@
         "LEFT",
         "RIGHT",
         "SELECT",
+        "HOME",
         "BACK",
         "EXIT",
         "MENU",

package/generated/resources/media-player/configuration.json

@@ -2,6 +2,84 @@
   "description": "Media players select media by its Port OS media ID, play supplied audio or a URI, and control playback. Read playback state and use only the commands supported by the connected player.",
   "type": "object",
   "properties": {
+    "supportedMediaResources": {
+      "type": "array",
+      "description": "Exact play-media URI combinations accepted by this route. Member or endpoint unions do not imply support by every route.",
+      "items": {
+        "title": "SupportedMediaResource",
+        "description": "A provider, media type and resource-kind combination accepted by a control route.",
+        "type": "object",
+        "properties": {
+          "provider": {
+            "$ref": "#/properties/supportedAudioProviders/items"
+          },
+          "mediaType": {
+            "type": "string",
+            "enum": [
+              "AUDIO",
+              "VIDEO",
+              "IMAGE"
+            ]
+          },
+          "resourceKinds": {
+            "type": "array",
+            "minItems": 1,
+            "uniqueItems": true,
+            "items": {
+              "type": "string",
+              "description": "Lowercase resource-kind segment from the provider URI."
+            }
+          }
+        },
+        "required": [
+          "provider",
+          "mediaType",
+          "resourceKinds"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "supportedAudioProviders": {
+      "type": "array",
+      "uniqueItems": true,
+      "description": "Audio services accepted by search-and-play on this endpoint. These describe command support, not active subscriptions.",
+      "items": {
+        "type": "string",
+        "description": "Media service identifier. A provider enum value does not imply that every endpoint supports that service; use the endpoint's advertised provider lists.",
+        "enum": [
+          "SPOTIFY",
+          "AMAZON_MUSIC",
+          "APPLE_MUSIC",
+          "AUDIBLE",
+          "TUNE_IN",
+          "PANDORA",
+          "IHEART_RADIO",
+          "SIRIUSXM",
+          "DEEZER",
+          "TIDAL",
+          "YOUTUBE",
+          "NETFLIX",
+          "PRIME_VIDEO",
+          "DAILYMOTION"
+        ]
+      }
+    },
+    "supportedVideoProviders": {
+      "type": "array",
+      "uniqueItems": true,
+      "description": "Video services accepted by search-and-play on this endpoint. These describe command support, not installed applications or active subscriptions.",
+      "items": {
+        "$ref": "#/properties/supportedAudioProviders/items"
+      }
+    },
+    "defaultAudioProvider": {
+      "$ref": "#/properties/supportedAudioProviders/items",
+      "description": "Default service for an audio search. Must be in supportedAudioProviders."
+    },
+    "defaultVideoProvider": {
+      "$ref": "#/properties/supportedAudioProviders/items",
+      "description": "Default service for a video search. Must be in supportedVideoProviders."
+    },
     "supportedPlaybackStates": {
       "type": "array",
       "items": {

package/generated/resources/media-player/message-fast-forward.json

@@ -0,0 +1,5 @@
+{
+  "description": "Begin provider-defined fast-forward playback. This does not seek by a specific duration; use skip-forward or seek for a known position change.",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/resources/media-player/message-play-media.json

@@ -5,7 +5,9 @@
       "title": "MediaId",
       "type": "string",
       "minLength": 1,
-      "description": "Media IDs are a standardized identifier that Port OS uses to represent media across YouTube, Spotify, and other media providers. See https://portpowered.com/docs/media for the current media identifiers documentation."
+      "example": "portos-media://portpowered.com/spotify/audio/track/Ab123",
+      "pattern": "^(portos-media://portpowered[.]com/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+|youtube:video:[A-Za-z0-9_-]+)$",
+      "description": "Exact provider resource identity. The canonical form is portos-media://portpowered.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. Legacy providers retain their own input contracts until explicitly migrated. See https://portpowered.com/docs/media.\n"
     }
   },
   "required": [

package/generated/resources/media-player/message-search-and-play.json

@@ -1,10 +1,45 @@
 {
+  "description": "Search for and play media by title or query using a service advertised by the endpoint. Omitting mediaType retains audio search behavior; video-only endpoints may default to video.",
   "type": "object",
   "properties": {
     "query": {
       "type": "string",
-      "description": "Query to search for audio content",
+      "description": "Query to search for media content",
       "minLength": 1
+    },
+    "provider": {
+      "type": "string",
+      "description": "Media service identifier. A provider enum value does not imply that every endpoint supports that service; use the endpoint's advertised provider lists.",
+      "enum": [
+        "SPOTIFY",
+        "AMAZON_MUSIC",
+        "APPLE_MUSIC",
+        "AUDIBLE",
+        "TUNE_IN",
+        "PANDORA",
+        "IHEART_RADIO",
+        "SIRIUSXM",
+        "DEEZER",
+        "TIDAL",
+        "YOUTUBE",
+        "NETFLIX",
+        "PRIME_VIDEO",
+        "DAILYMOTION"
+      ]
+    },
+    "mediaType": {
+      "type": "string",
+      "enum": [
+        "AUDIO",
+        "VIDEO"
+      ],
+      "description": "Media search domain. The endpoint must advertise support for the selected type."
+    },
+    "timerSeconds": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 86400,
+      "description": "Optional provider playback timer in seconds."
     }
   },
   "required": [

package/generated/resources/media-player/state-now-playing.json

@@ -0,0 +1,27 @@
+{
+  "description": "Media identity observed on this route. Active false means the provider session is on another target; it does not prove the speaker is silent through other providers.",
+  "type": "object",
+  "properties": {
+    "active": {
+      "type": "boolean"
+    },
+    "mediaId": {
+      "title": "MediaId",
+      "type": "string",
+      "minLength": 1,
+      "example": "portos-media://portpowered.com/spotify/audio/track/Ab123",
+      "pattern": "^(portos-media://portpowered[.]com/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+|youtube:video:[A-Za-z0-9_-]+)$",
+      "description": "Exact provider resource identity. The canonical form is portos-media://portpowered.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. Legacy providers retain their own input contracts until explicitly migrated. See https://portpowered.com/docs/media.\n"
+    },
+    "contextMediaId": {
+      "$ref": "#/properties/mediaId"
+    },
+    "name": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "active"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/media-playlist/message-get-playlist.json

@@ -5,6 +5,17 @@
       "type": "string",
       "description": "ID of the playlist to retrieve",
       "minLength": 1
+    },
+    "maxResults": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 50,
+      "default": 20
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Opaque continuation for the same playlist."
     }
   },
   "required": [

package/generated/resources/media-playlist/message-list-playlists.json

@@ -0,0 +1,18 @@
+{
+  "description": "List the connected customer's owned or followed playlists; use search-media for catalog search.",
+  "type": "object",
+  "properties": {
+    "maxResults": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 50,
+      "default": 20
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [],
+  "additionalProperties": false
+}

package/generated/resources/media-playlist/message-playlist-contents.json

@@ -0,0 +1,140 @@
+{
+  "description": "A bounded playlist page containing playable tracks or episodes.",
+  "type": "object",
+  "properties": {
+    "playlistId": {
+      "title": "MediaId",
+      "type": "string",
+      "minLength": 1,
+      "example": "portos-media://portpowered.com/spotify/audio/track/Ab123",
+      "pattern": "^(portos-media://portpowered[.]com/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+|youtube:video:[A-Za-z0-9_-]+)$",
+      "description": "Exact provider resource identity. The canonical form is portos-media://portpowered.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. Legacy providers retain their own input contracts until explicitly migrated. See https://portpowered.com/docs/media.\n"
+    },
+    "tracks": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "Track information",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier for the track",
+            "minLength": 1
+          },
+          "name": {
+            "type": "string",
+            "description": "Track name",
+            "minLength": 1
+          },
+          "artists": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "description": "Artist information",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Unique identifier for the artist",
+                  "minLength": 1
+                },
+                "name": {
+                  "type": "string",
+                  "description": "Artist name",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "id",
+                "name"
+              ],
+              "additionalProperties": false,
+              "title": "Artist"
+            },
+            "description": "Track artists"
+          },
+          "album": {
+            "description": "Track album",
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Unique identifier for the album",
+                "minLength": 1
+              },
+              "name": {
+                "type": "string",
+                "description": "Album name",
+                "minLength": 1
+              },
+              "artists": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/properties/tracks/items/properties/artists/items"
+                },
+                "description": "Album artists"
+              }
+            },
+            "required": [
+              "id",
+              "name",
+              "artists"
+            ],
+            "additionalProperties": false,
+            "title": "Album"
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "artists",
+          "album"
+        ],
+        "additionalProperties": false,
+        "title": "Track"
+      }
+    },
+    "episodes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "Provider-qualified podcast episode with selection metadata.",
+        "properties": {
+          "id": {
+            "$ref": "#/properties/playlistId"
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "showId": {
+            "$ref": "#/properties/playlistId"
+          },
+          "releaseDate": {
+            "type": "string",
+            "description": "Provider release date; precision can be year, month or day."
+          },
+          "releaseDatePrecision": {
+            "type": "string",
+            "description": "Provider date precision."
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ],
+        "additionalProperties": false,
+        "title": "PodcastEpisode"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "playlistId",
+    "tracks",
+    "episodes"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/media-playlist/message-playlists.json

@@ -0,0 +1,46 @@
+{
+  "description": "A page of the connected customer's playlists with exact resource IDs.",
+  "type": "object",
+  "properties": {
+    "playlists": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier for the playlist",
+            "minLength": 1
+          },
+          "name": {
+            "type": "string",
+            "description": "Playlist name",
+            "minLength": 1
+          },
+          "ownerId": {
+            "type": "string",
+            "description": "Provider-scoped owner identity, when supplied by the provider."
+          },
+          "ownerName": {
+            "type": "string",
+            "description": "Owner display name, useful for distinguishing owned and followed playlists."
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ],
+        "additionalProperties": false,
+        "title": "Playlist"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "playlists"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/media-search/message-audio-media-results.json

@@ -114,6 +114,14 @@
             "type": "string",
             "description": "Playlist name",
             "minLength": 1
+          },
+          "ownerId": {
+            "type": "string",
+            "description": "Provider-scoped owner identity, when supplied by the provider."
+          },
+          "ownerName": {
+            "type": "string",
+            "description": "Owner display name, useful for distinguishing owned and followed playlists."
           }
         },
         "required": [
@@ -124,6 +132,74 @@
         "title": "Playlist"
       },
       "description": "Playlist results"
+    },
+    "shows": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "Provider-qualified podcast series; read episodes before playback.",
+        "properties": {
+          "id": {
+            "title": "MediaId",
+            "type": "string",
+            "minLength": 1,
+            "example": "portos-media://portpowered.com/spotify/audio/track/Ab123",
+            "pattern": "^(portos-media://portpowered[.]com/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+|youtube:video:[A-Za-z0-9_-]+)$",
+            "description": "Exact provider resource identity. The canonical form is portos-media://portpowered.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. Legacy providers retain their own input contracts until explicitly migrated. See https://portpowered.com/docs/media.\n"
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "publisher": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ],
+        "additionalProperties": false,
+        "title": "PodcastShow"
+      }
+    },
+    "episodes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "Provider-qualified podcast episode with selection metadata.",
+        "properties": {
+          "id": {
+            "$ref": "#/properties/shows/items/properties/id"
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "showId": {
+            "$ref": "#/properties/shows/items/properties/id"
+          },
+          "releaseDate": {
+            "type": "string",
+            "description": "Provider release date; precision can be year, month or day."
+          },
+          "releaseDatePrecision": {
+            "type": "string",
+            "description": "Provider date precision."
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ],
+        "additionalProperties": false,
+        "title": "PodcastEpisode"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Opaque continuation for the same search; omit when exhausted."
     }
   },
   "required": [