@portpowered/reference-data 0.4.6 → 0.4.8

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

@@ -7,6 +7,37 @@
   "description": "Configure media playback, media selection and audio playback. Advertise only the messages implemented by this endpoint.",
   "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": {
+        "$ref": "/docs/references/schemas/SupportedMediaResource.json"
+      }
+    },
+    "supportedAudioProviders": {
+      "type": "array",
+      "uniqueItems": true,
+      "description": "Audio services accepted by search-and-play on this endpoint. These describe command support, not active subscriptions.",
+      "items": {
+        "$ref": "/docs/references/schemas/MediaProvider.json"
+      }
+    },
+    "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": "/docs/references/schemas/MediaProvider.json"
+      }
+    },
+    "defaultAudioProvider": {
+      "$ref": "/docs/references/schemas/MediaProvider.json",
+      "description": "Default service for an audio search. Must be in supportedAudioProviders."
+    },
+    "defaultVideoProvider": {
+      "$ref": "/docs/references/schemas/MediaProvider.json",
+      "description": "Default service for a video search. Must be in supportedVideoProviders."
+    },
     "supportedPlaybackStates": {
       "type": "array",
       "items": {

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

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/media-player",
+  "x-name": "fast-forward",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "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/public/docs/references/schemas/MediaPlayerInterfaceNowPlayingAttribute.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/media-player",
+  "x-name": "now-playing",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "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": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "contextMediaId": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "name": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "active"
+  ],
+  "additionalProperties": false
+}

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

@@ -5,12 +5,34 @@
   "x-version": "1.0",
   "x-type": "message",
   "x-directionality": "in",
+  "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": {
+      "$ref": "/docs/references/schemas/MediaProvider.json"
+    },
+    "mediaType": {
+      "type": "string",
+      "enum": [
+        "AUDIO",
+        "VIDEO"
+      ],
+      "description": "Media search domain. The endpoint must advertise support for the selected type.",
+      "x-enum-varnames": [
+        "MediaSearchTypeAudio",
+        "MediaSearchTypeVideo"
+      ]
+    },
+    "timerSeconds": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 86400,
+      "description": "Optional provider playback timer in seconds."
     }
   },
   "required": [

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

@@ -11,6 +11,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/public/docs/references/schemas/MediaPlaylistInterfaceListPlaylistsMessage.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/media-playlist",
+  "x-name": "list-playlists",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "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/public/docs/references/schemas/MediaPlaylistInterfacePlaylistContentsMessage.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/media-playlist",
+  "x-name": "playlist-contents",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "out",
+  "description": "A bounded playlist page containing playable tracks or episodes.",
+  "type": "object",
+  "properties": {
+    "playlistId": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "tracks": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/Track.json"
+      }
+    },
+    "episodes": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/PodcastEpisode.json"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "playlistId",
+    "tracks",
+    "episodes"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/media-playlist",
+  "x-name": "playlists",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "out",
+  "description": "A page of the connected customer's playlists with exact resource IDs.",
+  "type": "object",
+  "properties": {
+    "playlists": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/Playlist.json"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "playlists"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "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"
+  ],
+  "x-enum-varnames": [
+    "MediaProviderSpotify",
+    "MediaProviderAmazonMusic",
+    "MediaProviderAppleMusic",
+    "MediaProviderAudible",
+    "MediaProviderTuneIn",
+    "MediaProviderPandora",
+    "MediaProviderIHeartRadio",
+    "MediaProviderSiriusXM",
+    "MediaProviderDeezer",
+    "MediaProviderTidal",
+    "MediaProviderYouTube",
+    "MediaProviderNetflix",
+    "MediaProviderPrimeVideo",
+    "MediaProviderDailymotion"
+  ]
+}

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

@@ -34,6 +34,23 @@
         "$ref": "/docs/references/schemas/Playlist.json"
       },
       "description": "Playlist results"
+    },
+    "shows": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/PodcastShow.json"
+      }
+    },
+    "episodes": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/PodcastEpisode.json"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Opaque continuation for the same search; omit when exhausted."
     }
   },
   "required": [

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

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/media-search",
+  "x-name": "get-media",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "description": "Inspect an exact media resource or traverse an album/show. Use get-playlist for playlist contents.",
+  "type": "object",
+  "properties": {
+    "mediaId": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "maxResults": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 50,
+      "default": 20
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Opaque continuation for the same resource."
+    }
+  },
+  "required": [
+    "mediaId"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/media-search",
+  "x-name": "media-details",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "out",
+  "description": "Exact media resource details and a bounded page of its children.",
+  "type": "object",
+  "properties": {
+    "mediaId": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "name": {
+      "type": "string"
+    },
+    "resourceKind": {
+      "type": "string",
+      "description": "Provider resource kind from the media URI."
+    },
+    "tracks": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/Track.json"
+      }
+    },
+    "episodes": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/PodcastEpisode.json"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "mediaId",
+    "resourceKind"
+  ],
+  "additionalProperties": false
+}

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

@@ -13,7 +13,7 @@
     },
     "type": {
       "type": "string",
-      "description": "Supported types, track, album, artist, playlist. Defaults to track",
+      "description": "Resource kind: track, album, artist, playlist, show or episode when advertised. Defaults to track",
       "default": "track"
     },
     "album": {
@@ -27,6 +27,18 @@
     "year": {
       "type": "string",
       "description": "Search by year, can only be used when searching albums, years, and tracks. You can pass a range like 1990-2000"
+    },
+    "maxResults": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 50,
+      "default": 20,
+      "description": "Maximum results on one page."
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Copy the opaque continuation from the previous result with the same query and filters."
     }
   },
   "required": [

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

@@ -11,6 +11,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": [

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

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Provider-qualified podcast episode with selection metadata.",
+  "properties": {
+    "id": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "showId": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "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
+}

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

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Provider-qualified podcast series; read episodes before playback.",
+  "properties": {
+    "id": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "publisher": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "name"
+  ],
+  "additionalProperties": false
+}

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

@@ -9,11 +9,17 @@
     "type": {
       "type": "string",
       "enum": [
-        "SSML"
+        "SSML",
+        "CANNED_TTS"
       ]
     },
     "ssml": {
       "type": "string"
+    },
+    "cannedTtsStringId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Provider-defined canned speech identifier; supported only by integrations advertising canned speech."
     }
   }
 }

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

@@ -5,5 +5,18 @@
   "x-version": "1.0",
   "x-type": "configuration",
   "type": "object",
+  "properties": {
+    "supportedInputTypes": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "enum": [
+          "SSML",
+          "CANNED_TTS"
+        ]
+      }
+    }
+  },
   "additionalProperties": false
 }

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

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "SupportedMediaResource",
+  "description": "A provider, media type and resource-kind combination accepted by a control route.",
+  "type": "object",
+  "properties": {
+    "provider": {
+      "$ref": "/docs/references/schemas/MediaProvider.json"
+    },
+    "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
+}

package/generated/public/docs/references/schemas/configuration-6.json

@@ -18,7 +18,9 @@
           "ARTIST",
           "PLAYLIST",
           "GENRE",
-          "YEAR"
+          "YEAR",
+          "SHOW",
+          "EPISODE"
         ],
         "x-enum-varnames": [
           "Configuration6SupportedSearchTypesTrack",
@@ -26,7 +28,9 @@
           "Configuration6SupportedSearchTypesArtist",
           "Configuration6SupportedSearchTypesPlaylist",
           "Configuration6SupportedSearchTypesGenre",
-          "Configuration6SupportedSearchTypesYear"
+          "Configuration6SupportedSearchTypesYear",
+          "Configuration6SupportedSearchTypesShow",
+          "Configuration6SupportedSearchTypesEpisode"
         ]
       },
       "description": "List of supported search types"