@portpowered/reference-data 0.4.6 → 0.4.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/capabilities.json +135 -4
- package/generated/openapi.json +135 -2
- package/generated/public/docs/for-ai/capability-interfaces/brightness/1.0.md +1 -0
- package/generated/public/docs/for-ai/capability-interfaces/media-player/1.0.md +2 -1
- package/generated/public/docs/for-ai/schemas/b-1.md +1 -0
- package/generated/public/docs/for-ai/schemas/m-1.md +2 -2
- package/generated/public/docs/for-ai/schemas/m-2.md +2 -0
- package/generated/public/docs/for-ai/schemas.md +3 -3
- package/generated/public/docs/references/capability-interfaces/brightness/1.0/messages/adjust-brightness.yaml +12 -0
- package/generated/public/docs/references/capability-interfaces/brightness/1.0.yaml +18 -0
- package/generated/public/docs/references/capability-interfaces/brightness.yaml +18 -0
- package/generated/public/docs/references/capability-interfaces/keypad-input/1.0/configuration.yaml +1 -0
- package/generated/public/docs/references/capability-interfaces/keypad-input/1.0/messages/send-key.yaml +1 -0
- package/generated/public/docs/references/capability-interfaces/keypad-input/1.0.yaml +2 -0
- package/generated/public/docs/references/capability-interfaces/keypad-input.yaml +2 -0
- package/generated/public/docs/references/capability-interfaces/media-player/1.0/configuration.yaml +40 -0
- package/generated/public/docs/references/capability-interfaces/media-player/1.0/messages/fast-forward.yaml +5 -0
- package/generated/public/docs/references/capability-interfaces/media-player/1.0/messages/search-and-play.yaml +39 -1
- package/generated/public/docs/references/capability-interfaces/media-player/1.0.yaml +89 -2
- package/generated/public/docs/references/capability-interfaces/media-player.yaml +89 -2
- package/generated/public/docs/references/capability-interfaces/speech-synthesizer/1.0/configuration.yaml +14 -0
- package/generated/public/docs/references/capability-interfaces/speech-synthesizer/1.0/messages/speak.yaml +7 -0
- package/generated/public/docs/references/capability-interfaces/speech-synthesizer/1.0.yaml +22 -1
- package/generated/public/docs/references/capability-interfaces/speech-synthesizer.yaml +22 -1
- package/generated/public/docs/references/manifest.json +109 -62
- package/generated/public/docs/references/openapi.yaml +124 -1
- package/generated/public/docs/references/schemas/BrightnessInterfaceAdjustBrightnessMessage.json +21 -0
- package/generated/public/docs/references/schemas/KeypadInputInterfaceConfiguration.json +1 -0
- package/generated/public/docs/references/schemas/KeypadInputInterfaceSendKeyMessage.json +1 -0
- package/generated/public/docs/references/schemas/MediaPlayerInterfaceConfiguration.json +24 -0
- package/generated/public/docs/references/schemas/MediaPlayerInterfaceFastForwardMessage.json +11 -0
- package/generated/public/docs/references/schemas/MediaPlayerInterfaceSearchAndPlayMessage.json +23 -1
- package/generated/public/docs/references/schemas/MediaProvider.json +37 -0
- package/generated/public/docs/references/schemas/SpeechInput.json +7 -1
- package/generated/public/docs/references/schemas/SpeechSynthesizerInterfaceConfiguration.json +13 -0
- package/generated/public/docs/references/schemas/index.json +18 -0
- package/generated/resources/brightness/message-adjust-brightness.json +15 -0
- package/generated/resources/keypad-input/configuration.json +1 -0
- package/generated/resources/keypad-input/message-send-key.json +1 -0
- package/generated/resources/media-player/configuration.json +41 -0
- package/generated/resources/media-player/message-fast-forward.json +5 -0
- package/generated/resources/media-player/message-search-and-play.json +36 -1
- package/generated/resources/speech-synthesizer/configuration.json +18 -1
- package/generated/resources/speech-synthesizer/message-speak.json +7 -1
- package/package.json +1 -1
|
@@ -7,6 +7,30 @@
|
|
|
7
7
|
"description": "Configure media playback, media selection and audio playback. Advertise only the messages implemented by this endpoint.",
|
|
8
8
|
"type": "object",
|
|
9
9
|
"properties": {
|
|
10
|
+
"supportedAudioProviders": {
|
|
11
|
+
"type": "array",
|
|
12
|
+
"uniqueItems": true,
|
|
13
|
+
"description": "Audio services accepted by search-and-play on this endpoint. These describe command support, not active subscriptions.",
|
|
14
|
+
"items": {
|
|
15
|
+
"$ref": "/docs/references/schemas/MediaProvider.json"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"supportedVideoProviders": {
|
|
19
|
+
"type": "array",
|
|
20
|
+
"uniqueItems": true,
|
|
21
|
+
"description": "Video services accepted by search-and-play on this endpoint. These describe command support, not installed applications or active subscriptions.",
|
|
22
|
+
"items": {
|
|
23
|
+
"$ref": "/docs/references/schemas/MediaProvider.json"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"defaultAudioProvider": {
|
|
27
|
+
"$ref": "/docs/references/schemas/MediaProvider.json",
|
|
28
|
+
"description": "Default service for an audio search. Must be in supportedAudioProviders."
|
|
29
|
+
},
|
|
30
|
+
"defaultVideoProvider": {
|
|
31
|
+
"$ref": "/docs/references/schemas/MediaProvider.json",
|
|
32
|
+
"description": "Default service for a video search. Must be in supportedVideoProviders."
|
|
33
|
+
},
|
|
10
34
|
"supportedPlaybackStates": {
|
|
11
35
|
"type": "array",
|
|
12
36
|
"items": {
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"x-namespace": "port1/systems/zero/capability-interfaces/media-player",
|
|
4
|
+
"x-name": "fast-forward",
|
|
5
|
+
"x-version": "1.0",
|
|
6
|
+
"x-type": "message",
|
|
7
|
+
"x-directionality": "in",
|
|
8
|
+
"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.",
|
|
9
|
+
"type": "object",
|
|
10
|
+
"additionalProperties": false
|
|
11
|
+
}
|
package/generated/public/docs/references/schemas/MediaPlayerInterfaceSearchAndPlayMessage.json
CHANGED
|
@@ -5,12 +5,34 @@
|
|
|
5
5
|
"x-version": "1.0",
|
|
6
6
|
"x-type": "message",
|
|
7
7
|
"x-directionality": "in",
|
|
8
|
+
"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.",
|
|
8
9
|
"type": "object",
|
|
9
10
|
"properties": {
|
|
10
11
|
"query": {
|
|
11
12
|
"type": "string",
|
|
12
|
-
"description": "Query to search for
|
|
13
|
+
"description": "Query to search for media content",
|
|
13
14
|
"minLength": 1
|
|
15
|
+
},
|
|
16
|
+
"provider": {
|
|
17
|
+
"$ref": "/docs/references/schemas/MediaProvider.json"
|
|
18
|
+
},
|
|
19
|
+
"mediaType": {
|
|
20
|
+
"type": "string",
|
|
21
|
+
"enum": [
|
|
22
|
+
"AUDIO",
|
|
23
|
+
"VIDEO"
|
|
24
|
+
],
|
|
25
|
+
"description": "Media search domain. The endpoint must advertise support for the selected type.",
|
|
26
|
+
"x-enum-varnames": [
|
|
27
|
+
"MediaSearchTypeAudio",
|
|
28
|
+
"MediaSearchTypeVideo"
|
|
29
|
+
]
|
|
30
|
+
},
|
|
31
|
+
"timerSeconds": {
|
|
32
|
+
"type": "integer",
|
|
33
|
+
"minimum": 1,
|
|
34
|
+
"maximum": 86400,
|
|
35
|
+
"description": "Optional provider playback timer in seconds."
|
|
14
36
|
}
|
|
15
37
|
},
|
|
16
38
|
"required": [
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"type": "string",
|
|
4
|
+
"description": "Media service identifier. A provider enum value does not imply that every endpoint supports that service; use the endpoint's advertised provider lists.",
|
|
5
|
+
"enum": [
|
|
6
|
+
"SPOTIFY",
|
|
7
|
+
"AMAZON_MUSIC",
|
|
8
|
+
"APPLE_MUSIC",
|
|
9
|
+
"AUDIBLE",
|
|
10
|
+
"TUNE_IN",
|
|
11
|
+
"PANDORA",
|
|
12
|
+
"IHEART_RADIO",
|
|
13
|
+
"SIRIUSXM",
|
|
14
|
+
"DEEZER",
|
|
15
|
+
"TIDAL",
|
|
16
|
+
"YOUTUBE",
|
|
17
|
+
"NETFLIX",
|
|
18
|
+
"PRIME_VIDEO",
|
|
19
|
+
"DAILYMOTION"
|
|
20
|
+
],
|
|
21
|
+
"x-enum-varnames": [
|
|
22
|
+
"MediaProviderSpotify",
|
|
23
|
+
"MediaProviderAmazonMusic",
|
|
24
|
+
"MediaProviderAppleMusic",
|
|
25
|
+
"MediaProviderAudible",
|
|
26
|
+
"MediaProviderTuneIn",
|
|
27
|
+
"MediaProviderPandora",
|
|
28
|
+
"MediaProviderIHeartRadio",
|
|
29
|
+
"MediaProviderSiriusXM",
|
|
30
|
+
"MediaProviderDeezer",
|
|
31
|
+
"MediaProviderTidal",
|
|
32
|
+
"MediaProviderYouTube",
|
|
33
|
+
"MediaProviderNetflix",
|
|
34
|
+
"MediaProviderPrimeVideo",
|
|
35
|
+
"MediaProviderDailymotion"
|
|
36
|
+
]
|
|
37
|
+
}
|
|
@@ -9,11 +9,17 @@
|
|
|
9
9
|
"type": {
|
|
10
10
|
"type": "string",
|
|
11
11
|
"enum": [
|
|
12
|
-
"SSML"
|
|
12
|
+
"SSML",
|
|
13
|
+
"CANNED_TTS"
|
|
13
14
|
]
|
|
14
15
|
},
|
|
15
16
|
"ssml": {
|
|
16
17
|
"type": "string"
|
|
18
|
+
},
|
|
19
|
+
"cannedTtsStringId": {
|
|
20
|
+
"type": "string",
|
|
21
|
+
"minLength": 1,
|
|
22
|
+
"description": "Provider-defined canned speech identifier; supported only by integrations advertising canned speech."
|
|
17
23
|
}
|
|
18
24
|
}
|
|
19
25
|
}
|
package/generated/public/docs/references/schemas/SpeechSynthesizerInterfaceConfiguration.json
CHANGED
|
@@ -5,5 +5,18 @@
|
|
|
5
5
|
"x-version": "1.0",
|
|
6
6
|
"x-type": "configuration",
|
|
7
7
|
"type": "object",
|
|
8
|
+
"properties": {
|
|
9
|
+
"supportedInputTypes": {
|
|
10
|
+
"type": "array",
|
|
11
|
+
"uniqueItems": true,
|
|
12
|
+
"items": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"enum": [
|
|
15
|
+
"SSML",
|
|
16
|
+
"CANNED_TTS"
|
|
17
|
+
]
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
},
|
|
8
21
|
"additionalProperties": false
|
|
9
22
|
}
|
|
@@ -361,6 +361,12 @@
|
|
|
361
361
|
"path": "/docs/references/schemas/BrandingInformation.json",
|
|
362
362
|
"source": "/docs/references/openapi.yaml#/components/schemas/BrandingInformation"
|
|
363
363
|
},
|
|
364
|
+
{
|
|
365
|
+
"kind": "schemas",
|
|
366
|
+
"name": "BrightnessInterfaceAdjustBrightnessMessage",
|
|
367
|
+
"path": "/docs/references/schemas/BrightnessInterfaceAdjustBrightnessMessage.json",
|
|
368
|
+
"source": "/docs/references/openapi.yaml#/components/schemas/BrightnessInterfaceAdjustBrightnessMessage"
|
|
369
|
+
},
|
|
364
370
|
{
|
|
365
371
|
"kind": "schemas",
|
|
366
372
|
"name": "BrightnessInterfaceBrightnessAttribute",
|
|
@@ -2077,6 +2083,12 @@
|
|
|
2077
2083
|
"path": "/docs/references/schemas/MediaPlayerInterfaceConfiguration.json",
|
|
2078
2084
|
"source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceConfiguration"
|
|
2079
2085
|
},
|
|
2086
|
+
{
|
|
2087
|
+
"kind": "schemas",
|
|
2088
|
+
"name": "MediaPlayerInterfaceFastForwardMessage",
|
|
2089
|
+
"path": "/docs/references/schemas/MediaPlayerInterfaceFastForwardMessage.json",
|
|
2090
|
+
"source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceFastForwardMessage"
|
|
2091
|
+
},
|
|
2080
2092
|
{
|
|
2081
2093
|
"kind": "schemas",
|
|
2082
2094
|
"name": "MediaPlayerInterfaceNextMessage",
|
|
@@ -2215,6 +2227,12 @@
|
|
|
2215
2227
|
"path": "/docs/references/schemas/MediaPlaylistInterfaceShufflePlaylistMessage.json",
|
|
2216
2228
|
"source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfaceShufflePlaylistMessage"
|
|
2217
2229
|
},
|
|
2230
|
+
{
|
|
2231
|
+
"kind": "schemas",
|
|
2232
|
+
"name": "MediaProvider",
|
|
2233
|
+
"path": "/docs/references/schemas/MediaProvider.json",
|
|
2234
|
+
"source": "/docs/references/openapi.yaml#/components/schemas/MediaProvider"
|
|
2235
|
+
},
|
|
2218
2236
|
{
|
|
2219
2237
|
"kind": "schemas",
|
|
2220
2238
|
"name": "MediaSearchCapabilityInterfaceConfiguration",
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"description": "Adjust brightness by a signed number of percentage points. The endpoint must advertise this message separately from set-brightness.",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"brightnessDelta": {
|
|
6
|
+
"type": "integer",
|
|
7
|
+
"minimum": -100,
|
|
8
|
+
"maximum": 100
|
|
9
|
+
}
|
|
10
|
+
},
|
|
11
|
+
"required": [
|
|
12
|
+
"brightnessDelta"
|
|
13
|
+
],
|
|
14
|
+
"additionalProperties": false
|
|
15
|
+
}
|
|
@@ -2,6 +2,47 @@
|
|
|
2
2
|
"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.",
|
|
3
3
|
"type": "object",
|
|
4
4
|
"properties": {
|
|
5
|
+
"supportedAudioProviders": {
|
|
6
|
+
"type": "array",
|
|
7
|
+
"uniqueItems": true,
|
|
8
|
+
"description": "Audio services accepted by search-and-play on this endpoint. These describe command support, not active subscriptions.",
|
|
9
|
+
"items": {
|
|
10
|
+
"type": "string",
|
|
11
|
+
"description": "Media service identifier. A provider enum value does not imply that every endpoint supports that service; use the endpoint's advertised provider lists.",
|
|
12
|
+
"enum": [
|
|
13
|
+
"SPOTIFY",
|
|
14
|
+
"AMAZON_MUSIC",
|
|
15
|
+
"APPLE_MUSIC",
|
|
16
|
+
"AUDIBLE",
|
|
17
|
+
"TUNE_IN",
|
|
18
|
+
"PANDORA",
|
|
19
|
+
"IHEART_RADIO",
|
|
20
|
+
"SIRIUSXM",
|
|
21
|
+
"DEEZER",
|
|
22
|
+
"TIDAL",
|
|
23
|
+
"YOUTUBE",
|
|
24
|
+
"NETFLIX",
|
|
25
|
+
"PRIME_VIDEO",
|
|
26
|
+
"DAILYMOTION"
|
|
27
|
+
]
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
"supportedVideoProviders": {
|
|
31
|
+
"type": "array",
|
|
32
|
+
"uniqueItems": true,
|
|
33
|
+
"description": "Video services accepted by search-and-play on this endpoint. These describe command support, not installed applications or active subscriptions.",
|
|
34
|
+
"items": {
|
|
35
|
+
"$ref": "#/properties/supportedAudioProviders/items"
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"defaultAudioProvider": {
|
|
39
|
+
"$ref": "#/properties/supportedAudioProviders/items",
|
|
40
|
+
"description": "Default service for an audio search. Must be in supportedAudioProviders."
|
|
41
|
+
},
|
|
42
|
+
"defaultVideoProvider": {
|
|
43
|
+
"$ref": "#/properties/supportedAudioProviders/items",
|
|
44
|
+
"description": "Default service for a video search. Must be in supportedVideoProviders."
|
|
45
|
+
},
|
|
5
46
|
"supportedPlaybackStates": {
|
|
6
47
|
"type": "array",
|
|
7
48
|
"items": {
|
|
@@ -1,10 +1,45 @@
|
|
|
1
1
|
{
|
|
2
|
+
"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.",
|
|
2
3
|
"type": "object",
|
|
3
4
|
"properties": {
|
|
4
5
|
"query": {
|
|
5
6
|
"type": "string",
|
|
6
|
-
"description": "Query to search for
|
|
7
|
+
"description": "Query to search for media content",
|
|
7
8
|
"minLength": 1
|
|
9
|
+
},
|
|
10
|
+
"provider": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"description": "Media service identifier. A provider enum value does not imply that every endpoint supports that service; use the endpoint's advertised provider lists.",
|
|
13
|
+
"enum": [
|
|
14
|
+
"SPOTIFY",
|
|
15
|
+
"AMAZON_MUSIC",
|
|
16
|
+
"APPLE_MUSIC",
|
|
17
|
+
"AUDIBLE",
|
|
18
|
+
"TUNE_IN",
|
|
19
|
+
"PANDORA",
|
|
20
|
+
"IHEART_RADIO",
|
|
21
|
+
"SIRIUSXM",
|
|
22
|
+
"DEEZER",
|
|
23
|
+
"TIDAL",
|
|
24
|
+
"YOUTUBE",
|
|
25
|
+
"NETFLIX",
|
|
26
|
+
"PRIME_VIDEO",
|
|
27
|
+
"DAILYMOTION"
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
"mediaType": {
|
|
31
|
+
"type": "string",
|
|
32
|
+
"enum": [
|
|
33
|
+
"AUDIO",
|
|
34
|
+
"VIDEO"
|
|
35
|
+
],
|
|
36
|
+
"description": "Media search domain. The endpoint must advertise support for the selected type."
|
|
37
|
+
},
|
|
38
|
+
"timerSeconds": {
|
|
39
|
+
"type": "integer",
|
|
40
|
+
"minimum": 1,
|
|
41
|
+
"maximum": 86400,
|
|
42
|
+
"description": "Optional provider playback timer in seconds."
|
|
8
43
|
}
|
|
9
44
|
},
|
|
10
45
|
"required": [
|
|
@@ -1 +1,18 @@
|
|
|
1
|
-
|
|
1
|
+
{
|
|
2
|
+
"type": "object",
|
|
3
|
+
"properties": {
|
|
4
|
+
"supportedInputTypes": {
|
|
5
|
+
"type": "array",
|
|
6
|
+
"uniqueItems": true,
|
|
7
|
+
"items": {
|
|
8
|
+
"type": "string",
|
|
9
|
+
"enum": [
|
|
10
|
+
"SSML",
|
|
11
|
+
"CANNED_TTS"
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"additionalProperties": false,
|
|
17
|
+
"description": "Speech synthesizers accept a request to speak. Use them to send spoken output to a connected device or integration."
|
|
18
|
+
}
|
|
@@ -14,11 +14,17 @@
|
|
|
14
14
|
"type": {
|
|
15
15
|
"type": "string",
|
|
16
16
|
"enum": [
|
|
17
|
-
"SSML"
|
|
17
|
+
"SSML",
|
|
18
|
+
"CANNED_TTS"
|
|
18
19
|
]
|
|
19
20
|
},
|
|
20
21
|
"ssml": {
|
|
21
22
|
"type": "string"
|
|
23
|
+
},
|
|
24
|
+
"cannedTtsStringId": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"minLength": 1,
|
|
27
|
+
"description": "Provider-defined canned speech identifier; supported only by integrations advertising canned speech."
|
|
22
28
|
}
|
|
23
29
|
},
|
|
24
30
|
"title": "SpeechInput"
|
package/package.json
CHANGED