@portpowered/reference-data 0.4.6 → 0.4.8

package/generated/public/docs/references/openapi.yaml

@@ -9837,12 +9837,31 @@ components:
       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: '#/components/schemas/MediaProvider'
+        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:
         - query
       additionalProperties: false
@@ -10816,6 +10835,7 @@ components:
             - LEFT
             - RIGHT
             - SELECT
+            - HOME
             - BACK
             - EXIT
             - MENU
@@ -10910,6 +10930,17 @@ components:
       x-directionality: in
       type: object
       additionalProperties: false
+    MediaPlayerInterfaceFastForwardMessage:
+      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
     MediaPlayerInterfaceStartOverMessage:
       x-namespace: port1/systems/zero/capability-interfaces/media-player
       x-name: start-over
@@ -11016,6 +11047,73 @@ components:
       required:
         - playlistId
       additionalProperties: false
+    MediaPlaylistInterfaceListPlaylistsMessage:
+      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
+    MediaPlaylistInterfacePlaylistsMessage:
+      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: '#/components/schemas/Playlist'
+        nextToken:
+          type: string
+          minLength: 1
+      required:
+        - playlists
+      additionalProperties: false
+    MediaPlaylistInterfacePlaylistContentsMessage:
+      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: '#/components/schemas/MediaId'
+        tracks:
+          type: array
+          items:
+            $ref: '#/components/schemas/Track'
+        episodes:
+          type: array
+          items:
+            $ref: '#/components/schemas/PodcastEpisode'
+        nextToken:
+          type: string
+          minLength: 1
+      required:
+        - playlistId
+        - tracks
+        - episodes
+      additionalProperties: false
     MediaPlaylistInterfaceGetPlaylistMessage:
       x-namespace: port1/systems/zero/capability-interfaces/media-playlist
       x-name: get-playlist
@@ -11028,6 +11126,15 @@ components:
           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:
         - playlistId
       additionalProperties: false
@@ -11271,6 +11378,24 @@ components:
           maximum: 100
       required:
         - brightness
+    BrightnessInterfaceAdjustBrightnessMessage:
+      x-namespace: port1/systems/zero/capability-interfaces/brightness
+      x-name: adjust-brightness
+      x-version: '1.0'
+      x-type: message
+      x-directionality: in
+      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
     MediaSearchInterfaceAudioMediaResultsMessage:
       x-namespace: port1/systems/zero/capability-interfaces/media-search
       x-name: audio-media-results
@@ -11299,6 +11424,18 @@ components:
           items:
             $ref: '#/components/schemas/Playlist'
           description: Playlist results
+        shows:
+          type: array
+          items:
+            $ref: '#/components/schemas/PodcastShow'
+        episodes:
+          type: array
+          items:
+            $ref: '#/components/schemas/PodcastEpisode'
+        nextToken:
+          type: string
+          minLength: 1
+          description: Opaque continuation for the same search; omit when exhausted.
       required:
         - artists
         - albums
@@ -11318,6 +11455,62 @@ components:
       required:
         - mediaId
       additionalProperties: false
+    MediaSearchInterfaceMediaDetailsMessage:
+      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: '#/components/schemas/MediaId'
+        name:
+          type: string
+        resourceKind:
+          type: string
+          description: Provider resource kind from the media URI.
+        tracks:
+          type: array
+          items:
+            $ref: '#/components/schemas/Track'
+        episodes:
+          type: array
+          items:
+            $ref: '#/components/schemas/PodcastEpisode'
+        nextToken:
+          type: string
+          minLength: 1
+      required:
+        - mediaId
+        - resourceKind
+      additionalProperties: false
+    MediaSearchInterfaceGetMediaMessage:
+      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: '#/components/schemas/MediaId'
+        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
     MediaSearchInterfaceSearchMediaMessage:
       x-namespace: port1/systems/zero/capability-interfaces/media-search
       x-name: search-media
@@ -11331,7 +11524,9 @@ components:
           description: Freeform query string
         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:
           type: string
@@ -11344,6 +11539,16 @@ components:
           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:
         - query
       additionalProperties: false
@@ -13475,6 +13680,27 @@ components:
       required:
         - value
       additionalProperties: false
+    MediaPlayerInterfaceNowPlayingAttribute:
+      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: '#/components/schemas/MediaId'
+        contextMediaId:
+          $ref: '#/components/schemas/MediaId'
+        name:
+          type: string
+      required:
+        - active
+      additionalProperties: false
     MediaPlayerInterfacePlaybackStateAttribute:
       x-namespace: port1/systems/zero/capability-interfaces/media-player
       x-name: playback-state
@@ -17287,6 +17513,7 @@ components:
               - LEFT
               - RIGHT
               - SELECT
+              - HOME
               - BACK
               - EXIT
               - MENU
@@ -17373,6 +17600,35 @@ components:
         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: '#/components/schemas/SupportedMediaResource'
+        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: '#/components/schemas/MediaProvider'
+        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: '#/components/schemas/MediaProvider'
+        defaultAudioProvider:
+          $ref: '#/components/schemas/MediaProvider'
+          description: Default service for an audio search. Must be in supportedAudioProviders.
+        defaultVideoProvider:
+          $ref: '#/components/schemas/MediaProvider'
+          description: Default service for a video search. Must be in supportedVideoProviders.
         supportedPlaybackStates:
           type: array
           items:
@@ -17963,6 +18219,15 @@ components:
       x-version: '1.0'
       x-type: configuration
       type: object
+      properties:
+        supportedInputTypes:
+          type: array
+          uniqueItems: true
+          items:
+            type: string
+            enum:
+              - SSML
+              - CANNED_TTS
       additionalProperties: false
     TemperatureSensorInterfaceConfiguration:
       x-namespace: port1/systems/zero/capability-interfaces/temperature-sensor
@@ -18042,10 +18307,16 @@ components:
       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.
     PlayableAudio:
       type: object
       description: An audio object to play on an endpoint with audio output.
@@ -20908,6 +21179,11 @@ components:
         id:
           type: string
           description: The ID of the target
+        routeId:
+          type: string
+          description: >-
+            Optional full route or group-route ID belonging to this target. Selects one advertised
+            provider route and preserves that provider for follow-up transport or volume commands.
     CreateMessageRequestResponseType:
       type: string
       enum:
@@ -21126,6 +21402,41 @@ components:
           type: string
           description: The ID of the view that was created or updated
       additionalProperties: false
+    MediaProvider:
+      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
     NotificationPayload:
       type: object
       description: Notification payload information
@@ -21340,39 +21651,27 @@ components:
           format: uri
           description: Logo image URL
       additionalProperties: false
-    MovementInstruction:
+    Playlist:
       type: object
-      description: A movement instruction for remote control
       properties:
-        velocity:
-          type: number
-          description: Forward/backward speed
-        omega:
-          type: number
-          description: Angular velocity for turning
-        duration:
-          type: integer
-          description: Duration in milliseconds
+        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:
-        - velocity
-        - omega
-        - duration
+        - id
+        - name
       additionalProperties: false
-    CleaningMode:
-      type: string
-      description: Robot vacuum cleaning mode
-      enum:
-        - AUTO
-        - SPOT
-        - EDGE
-        - SINGLE_ROOM
-        - CUSTOM
-      x-enum-varnames:
-        - CleaningModeAuto
-        - CleaningModeSpot
-        - CleaningModeEdge
-        - CleaningModeSingleRoom
-        - CleaningModeCustom
     Artist:
       type: object
       description: Artist information
@@ -21437,17 +21736,71 @@ components:
         - artists
         - album
       additionalProperties: false
-    Playlist:
+    PodcastEpisode:
       type: object
+      description: Provider-qualified podcast episode with selection metadata.
       properties:
         id:
+          $ref: '#/components/schemas/MediaId'
+        name:
           type: string
-          description: Unique identifier for the playlist
           minLength: 1
+        showId:
+          $ref: '#/components/schemas/MediaId'
+        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
+    MovementInstruction:
+      type: object
+      description: A movement instruction for remote control
+      properties:
+        velocity:
+          type: number
+          description: Forward/backward speed
+        omega:
+          type: number
+          description: Angular velocity for turning
+        duration:
+          type: integer
+          description: Duration in milliseconds
+      required:
+        - velocity
+        - omega
+        - duration
+      additionalProperties: false
+    CleaningMode:
+      type: string
+      description: Robot vacuum cleaning mode
+      enum:
+        - AUTO
+        - SPOT
+        - EDGE
+        - SINGLE_ROOM
+        - CUSTOM
+      x-enum-varnames:
+        - CleaningModeAuto
+        - CleaningModeSpot
+        - CleaningModeEdge
+        - CleaningModeSingleRoom
+        - CleaningModeCustom
+    PodcastShow:
+      type: object
+      description: Provider-qualified podcast series; read episodes before playback.
+      properties:
+        id:
+          $ref: '#/components/schemas/MediaId'
         name:
           type: string
-          description: Playlist name
           minLength: 1
+        publisher:
+          type: string
       required:
         - id
         - name
@@ -21612,8 +21965,15 @@ components:
           type: string
           enum:
             - SSML
+            - CANNED_TTS
         ssml:
           type: string
+        cannedTtsStringId:
+          type: string
+          minLength: 1
+          description: >-
+            Provider-defined canned speech identifier; supported only by integrations advertising
+            canned speech.
     AttributeSchema:
       type: object
       properties:
@@ -22260,6 +22620,31 @@ components:
       required:
         - name
       additionalProperties: false
+    SupportedMediaResource:
+      title: SupportedMediaResource
+      description: A provider, media type and resource-kind combination accepted by a control route.
+      type: object
+      properties:
+        provider:
+          $ref: '#/components/schemas/MediaProvider'
+        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
     MeasurementRange:
       type: object
       description: Range of measurement values (min and max)
@@ -22294,6 +22679,8 @@ components:
               - PLAYLIST
               - GENRE
               - YEAR
+              - SHOW
+              - EPISODE
             x-enum-varnames:
               - Configuration6SupportedSearchTypesTrack
               - Configuration6SupportedSearchTypesAlbum
@@ -22301,6 +22688,8 @@ components:
               - Configuration6SupportedSearchTypesPlaylist
               - Configuration6SupportedSearchTypesGenre
               - Configuration6SupportedSearchTypesYear
+              - Configuration6SupportedSearchTypesShow
+              - Configuration6SupportedSearchTypesEpisode
           description: List of supported search types
         maxResults:
           type: integer

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

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

@@ -12,6 +12,10 @@
     "id": {
       "type": "string",
       "description": "The ID of the target"
+    },
+    "routeId": {
+      "type": "string",
+      "description": "Optional full route or group-route ID belonging to this target. Selects one advertised provider route and preserves that provider for follow-up transport or volume commands."
     }
   }
 }

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

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

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

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

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

@@ -3,5 +3,7 @@
   "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"
 }