@portpowered/reference-data 0.4.6 → 0.4.7

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

@@ -3,6 +3,46 @@ description: >-
   playback. Read playback state and use only the commands supported by the connected player.
 type: object
 properties:
+  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/1.0/messages/fast-forward.yaml

@@ -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/public/docs/references/capability-interfaces/media-player/1.0/messages/search-and-play.yaml

@@ -1,9 +1,47 @@
+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

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
@@ -181,15 +192,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
@@ -277,6 +324,46 @@ configuration:
     playback. Read playback state and use only the commands supported by the connected player.
   type: object
   properties:
+    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
@@ -181,15 +192,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
@@ -277,6 +324,46 @@ configuration:
     playback. Read playback state and use only the commands supported by the connected player.
   type: object
   properties:
+    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/speech-synthesizer/1.0/configuration.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  supportedInputTypes:
+    type: array
+    uniqueItems: true
+    items:
+      type: string
+      enum:
+        - SSML
+        - CANNED_TTS
+additionalProperties: false
+description: >-
+  Speech synthesizers accept a request to speak. Use them to send spoken output to a connected
+  device or integration.

package/generated/public/docs/references/capability-interfaces/speech-synthesizer/1.0/messages/speak.yaml

@@ -12,7 +12,14 @@ properties:
         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.
     title: SpeechInput
 additionalProperties: false

package/generated/public/docs/references/capability-interfaces/speech-synthesizer/1.0.yaml

@@ -23,12 +23,33 @@ messages:
               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.
           title: SpeechInput
       additionalProperties: false
 attributes: []
-configuration: null
+configuration:
+  type: object
+  properties:
+    supportedInputTypes:
+      type: array
+      uniqueItems: true
+      items:
+        type: string
+        enum:
+          - SSML
+          - CANNED_TTS
+  additionalProperties: false
+  description: >-
+    Speech synthesizers accept a request to speak. Use them to send spoken output to a connected
+    device or integration.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/speech-synthesizer.yaml

@@ -23,12 +23,33 @@ messages:
               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.
           title: SpeechInput
       additionalProperties: false
 attributes: []
-configuration: null
+configuration:
+  type: object
+  properties:
+    supportedInputTypes:
+      type: array
+      uniqueItems: true
+      items:
+        type: string
+        enum:
+          - SSML
+          - CANNED_TTS
+  additionalProperties: false
+  description: >-
+    Speech synthesizers accept a request to speak. Use them to send spoken output to a connected
+    device or integration.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read