@portpowered/reference-data 0.4.6 → 0.4.8

package/generated/public/docs/references/capability-interfaces/media-player/1.0.yaml

@@ -74,6 +74,17 @@ messages:
         - sequenceId
         - isFinal
       additionalProperties: false
+  - name: fast-forward
+    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.
+    directionality: in
+    schema:
+      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
   - name: next
     description: null
     directionality: in
@@ -133,10 +144,16 @@ messages:
           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.
       required:
         - mediaId
       additionalProperties: false
@@ -181,15 +198,51 @@ messages:
       type: object
       additionalProperties: false
   - name: search-and-play
-    description: null
+    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.
     directionality: in
     schema:
+      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:
         - query
       additionalProperties: false
@@ -241,6 +294,39 @@ messages:
       type: object
       additionalProperties: false
 attributes:
+  - name: now-playing
+    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.
+    schema:
+      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.
+        contextMediaId:
+          $ref: '#/properties/mediaId'
+        name:
+          type: string
+      required:
+        - active
+      additionalProperties: false
   - name: playback-speed
     description: null
     schema:
@@ -277,6 +363,76 @@ configuration:
     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/public/docs/references/capability-interfaces/media-player.yaml

@@ -74,6 +74,17 @@ messages:
         - sequenceId
         - isFinal
       additionalProperties: false
+  - name: fast-forward
+    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.
+    directionality: in
+    schema:
+      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
   - name: next
     description: null
     directionality: in
@@ -133,10 +144,16 @@ messages:
           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.
       required:
         - mediaId
       additionalProperties: false
@@ -181,15 +198,51 @@ messages:
       type: object
       additionalProperties: false
   - name: search-and-play
-    description: null
+    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.
     directionality: in
     schema:
+      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:
         - query
       additionalProperties: false
@@ -241,6 +294,39 @@ messages:
       type: object
       additionalProperties: false
 attributes:
+  - name: now-playing
+    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.
+    schema:
+      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.
+        contextMediaId:
+          $ref: '#/properties/mediaId'
+        name:
+          type: string
+      required:
+        - active
+      additionalProperties: false
   - name: playback-speed
     description: null
     schema:
@@ -277,6 +363,76 @@ configuration:
     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/public/docs/references/capability-interfaces/media-playlist/1.0/messages/get-playlist.yaml

@@ -4,6 +4,15 @@ properties:
     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

package/generated/public/docs/references/capability-interfaces/media-playlist/1.0/messages/list-playlists.yaml

@@ -0,0 +1,15 @@
+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/capability-interfaces/media-playlist/1.0/messages/playlist-contents.yaml

@@ -0,0 +1,114 @@
+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.
+  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/public/docs/references/capability-interfaces/media-playlist/1.0/messages/playlists.yaml

@@ -0,0 +1,35 @@
+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