-
Notifications
You must be signed in to change notification settings - Fork 0
/
mozart-api-3.4.1.8.yaml
executable file
·4371 lines (4257 loc) · 156 KB
/
mozart-api-3.4.1.8.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
components:
parameters:
ListeningModeID:
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/ListeningModeID'
responses:
BeolinkJoinResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/BeolinkJoinRequest'
description: 'Join started
Joining always happens asynchronously, use the `requestID` field in
the response to match your request with a
`WebsocketEventBeolinkJoinResult` web socket event.
'
MissingListeningMode:
description: No such listening mode
schemas:
Action:
description: "An action object. Examples:\n\nRadioAction:\n```json\n{\n\
\ \"type\": \"radio\",\n \"radioStationId\": \"8779112938791514\"\
\n}\n```\n\nToneAction:\n```json\n{\n \"type\": \"tone\",\n \"toneName\"\
: \"alarm_2\"\n}\n```\n\nSourcePresetAction:\n```json\n{\n \"type\"\
: \"sourcePreset\",\n \"source\": {\n \"value\": \"spotify\"\n\
\ },\n \"presetKey\": \"Preset3\"\n}\n```\n\nDeezerFlowAction:\n\
```json\n{\n \"type\": \"deezerFlow\",\n \"deezerUserId\": \"1234\"\
\n}\n```\n\nActivateSourceAction:\n```json\n{\n \"type\": \"activateSource\"\
,\n \"source\": {\n \"value\": \"spotify\"\n }\n}\n```\n\nPlayQueueAction:\n\
```\n {\n \"type\": \"playQueue\",\n \"queueItem\": {\n \
\ \"provider\": {\n \"value\": \"deezer\"\n },\n \
\ \"startNowFromPosition\": 0,\n \"type\": \"playlist\",\n\
\ \"uri\": \"playlist:8074581462\"\n },\n \"queueSettings\"\
: {\n \"consume\": false,\n \"repeat\": \"none\",\n \
\ \"shuffle\": false\n }\n }\n```\n\nStandbyAction:\n```json\n\
{\n \"type\": \"standby\"\n}\n```\n\nAllStandbyAction:\n```json\n\
{\n \"type\": \"allStandby\"\n}\n```\n\nTouchToJoinAction:\n```json\n\
{\n \"type\": \"touchToJoin\"\n}\n```\n\nButtonShortPressAction:\n\
```json\n{\n \"type\": \"buttonShortPress\",\n \"buttonName\": \"\
preset1\"\n}\n```\n\nFallbackAction:\n```json\n{\n \"type\": \"fallback\"\
\n}\n```\n\nVolumeAction:\n```json\n{\n \"type\": \"volume\",\n \
\ \"volumeLevel\": 25\n}\n```\n\nStopAction:\n```json\n{\n \"type\"\
: \"stop\",\n \"stopDuration\": 1300\n}\n```\n\nTriggerContentAction:\n\
```json\n{\n \"contentId\": \"tv://netflix\",\n \"type\": \"triggerContent\"\
\n}\n```\n\nSpeakerGroupAction:\n```json\n{\n \"type\": \"speakerGroup\"\
,\n \"speakerGroupId\": \"00112233-4455-6677-8899-aabbccddeeff\"\n\
}\n```\n\nListeningModeAction:\n```json\n{\n \"type\": \"listeningMode\"\
,\n \"listeningModeId\": 1234\n}\n```\n\nStandAction:\n```json\n\
{\n \"type\": \"stand\",\n \"standPosition\": {\n \"angle\":\
\ 7.5\n }\n}\n```\n\nGainAction:\n```json\n{\n \"type\": \"sourceGain\"\
,\n \"source\": {\n \"value\": \"spotify\"\n },\n \"gainDb\"\
: 1.0\n}\n```\n"
properties:
buttonName:
description: Name of the Button used for button-press types ('buttonShortPress')
enum:
- preset1
- preset2
- preset3
- preset4
nullable: true
type: string
contentId:
description: Id of content only used for 'type=triggerContent'
nullable: true
type: string
deezerUserId:
description: Id of user only used for 'type=deezerFlow' and is
optional
format: '[0-9]+'
nullable: true
type: string
gainDb:
description: Only usef for 'type=sourceGain'
maximum: 12
minimum: -12
type: number
listeningModeId:
$ref: '#/components/schemas/ListeningModeID'
description: Only used for 'type=listeningMode'
nullable: true
presetKey:
description: Only used for 'type=sourcePreset'
format: ^Preset[0-9]+$
nullable: true
type: string
queueItem:
$ref: '#/components/schemas/PlayQueueItem'
description: PlayQueue item only used for 'type=playQueue'
nullable: true
queueSettings:
$ref: '#/components/schemas/PlayQueueSettings'
description: PlayQueue settings only used for 'type=playQueue'
and is optional
nullable: true
radioStationId:
description: Id of RadioStation only used for 'type=radio'
format: '[0-9]+'
nullable: true
type: string
source:
$ref: '#/components/schemas/SourceTypeEnum'
nullable: true
speakerGroupId:
$ref: '#/components/schemas/SpeakerGroupId'
description: Only used for 'type=speakerGroup'
nullable: true
standPosition:
$ref: '#/components/schemas/StandPosition'
description: Only used for 'type=stand'
stopDuration:
description: The duration to wait (seconds) until stopping only
used for 'type=stop'
format: int32
minimum: 0
nullable: true
type: integer
toneName:
description: Name of the tone only used for 'type=tone'
enum:
- alarm_1
- alarm_2
nullable: true
type: string
type:
description: The type of Action
enum:
- standby
- tone
- radio
- sourcePreset
- deezerFlow
- activateSource
- playQueue
- buttonShortPress
- allStandby
- touchToJoin
- fallback
- volume
- stop
- triggerContent
- speakerGroup
- listeningMode
- stand
- sourceGain
type: string
volumeLevel:
description: The volume level to configure only used for 'type=volume'
format: int32
maximum: 100
minimum: 0
nullable: true
type: integer
required:
- type
type: object
ActionList:
description: An ordered list of Actions to run on the product
example:
- type: volume
volumeLevel: 35
- radioStationId: '8779112938791514'
type: radio
- stopDuration: 1300
type: stop
items:
$ref: '#/components/schemas/Action'
type: array
AlarmId:
format: uuid
type: string
AlarmLabel:
description: Label for an alarm
maxLength: 128
type: string
AlarmTimerEventData:
properties:
event:
enum:
- add
- update
- delete
type: string
id:
$ref: '#/components/schemas/AlarmId'
type:
enum:
- alarm
- timer
type: string
type: object
AlarmTriggeredInfo:
properties:
id:
$ref: '#/components/schemas/AlarmId'
label:
$ref: '#/components/schemas/AlarmLabel'
type: object
Ambience:
properties:
value:
description: Selected ambience value
format: double
type: number
required:
- value
type: object
AmbienceFeature:
allOf:
- $ref: '#/components/schemas/Ambience'
- $ref: '#/components/schemas/AmbienceRange'
AmbienceRange:
properties:
default:
$ref: '#/components/schemas/Ambience'
description: Product and role specific default ambience value
range:
description: Product and role specific ambience range
items:
$ref: '#/components/schemas/Ambience'
type: array
uniqueItems: true
required:
- default
- range
type: object
Art:
properties:
hasLocalImage:
type: boolean
key:
type: string
size:
type: string
type:
type: string
url:
type: string
type: object
Balance:
properties:
value:
description: Selected balance value
format: double
type: number
required:
- value
type: object
BalanceFeature:
allOf:
- $ref: '#/components/schemas/Balance'
- $ref: '#/components/schemas/BalanceRange'
BalanceRange:
properties:
default:
$ref: '#/components/schemas/Balance'
description: Default balance value
range:
description: balance range
items:
$ref: '#/components/schemas/Balance'
type: array
uniqueItems: true
required:
- default
- range
type: object
Bass:
properties:
value:
description: Selected bass value
format: int32
type: integer
required:
- value
type: object
BassFeature:
allOf:
- $ref: '#/components/schemas/Bass'
- $ref: '#/components/schemas/BassRange'
BassManagement:
properties:
value:
description: Selected bass-management value
enum:
- 'on'
- 'off'
type: string
required:
- value
type: object
BassManagementFeature:
allOf:
- $ref: '#/components/schemas/BassManagement'
- $ref: '#/components/schemas/BassManagementRange'
BassManagementRange:
properties:
default:
$ref: '#/components/schemas/BassManagement'
description: Default bass-management value
range:
description: bass-management range
items:
$ref: '#/components/schemas/BassManagement'
type: array
uniqueItems: true
required:
- default
- range
type: object
BassRange:
properties:
default:
$ref: '#/components/schemas/Bass'
description: Product and role specific default bass value
range:
description: Product and role specific bass range
items:
$ref: '#/components/schemas/Bass'
type: array
uniqueItems: true
required:
- default
- range
type: object
BatteryState:
properties:
batteryLevel:
description: 'Batterylevel in percent
'
type: integer
isCharging:
type: boolean
remainingChargingTimeMinutes:
description: Remaining charging time in minutes
type: integer
remainingPlayingTimeMinutes:
description: Remaining playing time in minutes
type: integer
type: object
BeoRemoteButton:
properties:
Key:
type: string
Type:
enum:
- KeyPress
- KeyRelease
type: object
BeolinkAvailableListener:
properties:
jid:
$ref: '#/components/schemas/BeolinkPeerID'
required:
- jid
type: object
BeolinkExperience:
properties:
category:
description: Source category
enum:
- TV
- RADIO
- MUSIC
- MEDIA
- UNKNOWN
type: string
id:
description: experience id, e.g. "RADIO" or "toslink"
type: string
linkable:
description: Linkable means "Does pressing play on this source
make sense"
type: boolean
name:
description: Experience name, e.g. "Bluetooth" or "B&O Radio"
type: string
productFriendlyName:
description: Optional product friendly name
type: string
sourceFriendlyName:
description: Optional friendly name for source
type: string
type:
description: Source type. This corresponds to the exhaustive list
or sources provided by the control layer
type: string
uniqueSourceId:
description: The actual device jabber id that the experience comes
from
type: string
required:
- id
- name
- type
- category
- uniqueSourceId
- linkable
type: object
BeolinkExperiencesResult:
properties:
experiences:
items:
$ref: '#/components/schemas/BeolinkExperience'
type: array
requestID:
$ref: '#/components/schemas/BeolinkRequestID'
status:
description: 'Current scan status.
* busy: there is another scan in progress
* timeout: the scan timed out. The results will be partial
'
enum:
- ok
- busy
- timeout
type: string
required:
- requestID
- status
- experiences
type: object
BeolinkJoinRequest:
properties:
jid:
$ref: '#/components/schemas/BeolinkPeerID'
requestID:
$ref: '#/components/schemas/BeolinkRequestID'
result:
description: Relative URL of the join result
format: uri
type: string
required:
- requestID
- result
type: object
BeolinkJoinResult:
properties:
error:
description: Join error
enum:
- ok
- busy
- leaderless
- alone
- silent
- missing
- rejected
- timeout
type: string
jid:
$ref: '#/components/schemas/BeolinkPeerID'
requestID:
$ref: '#/components/schemas/BeolinkRequestID'
status:
description: Overall join status
enum:
- idle
- joined
- failed
type: string
type:
description: The type of join request this is a result of
enum:
- join
- joinRequested
- expand
- expandRequested
type: string
required:
- requestID
- status
- jid
- type
type: object
BeolinkLeader:
properties:
friendlyName:
type: string
jid:
$ref: '#/components/schemas/BeolinkPeerID'
required:
- jid
- friendlyName
type: object
BeolinkListener:
properties:
jid:
$ref: '#/components/schemas/BeolinkPeerID'
required:
- jid
type: object
BeolinkPeer:
properties:
friendlyName:
type: string
jid:
$ref: '#/components/schemas/BeolinkPeerID'
required:
- jid
- friendlyName
type: object
BeolinkPeerID:
description: Beolink peer ID
example: 2714.1200304.26451293@products.bang-olufsen.com
type: string
BeolinkRequestID:
description: Beolink request ID
example: 48985a4f-a4de-4b44-9757-c9a7407b8882
format: uuid
type: string
BluetoothDevice:
properties:
address:
type: string
connected:
type: boolean
name:
type: string
type: object
BluetoothDeviceList:
properties:
items:
items:
$ref: '#/components/schemas/BluetoothDevice'
type: array
type: object
ButtonEvent:
properties:
button:
description: identifies the button
type: string
state:
description: identifies the state change
type: string
type: object
Compression:
properties:
value:
description: Selected compression value
enum:
- 'off'
- medium
- maximum
type: string
required:
- value
type: object
CompressionFeature:
allOf:
- $ref: '#/components/schemas/Compression'
- $ref: '#/components/schemas/CompressionRange'
CompressionRange:
properties:
default:
$ref: '#/components/schemas/Compression'
description: Default compression value
range:
description: compression range
items:
$ref: '#/components/schemas/Compression'
type: array
uniqueItems: true
required:
- default
- range
type: object
ContentCategoryList:
items:
enum:
- music
- movie
- tv
- hdmi
- app
type: string
type: array
ContentItem:
example:
contentUri: tv://netflix
label: Netflix
properties:
categories:
$ref: '#/components/schemas/ContentCategoryList'
nullable: true
contentUri:
type: string
label:
nullable: true
type: string
source:
$ref: '#/components/schemas/SourceTypeEnum'
required:
- contentUri
- source
type: object
ContentItemMap:
additionalProperties:
$ref: '#/components/schemas/ContentItem'
example:
475169e4-32bb-59ad-b88d-a6d53c289838:
contentUri: tv://netflix
label: Netflix
type: object
Directivity:
properties:
value:
enum:
- front
- left
- right
- omni
- narrow
- wide
- standalone
type: string
required:
- value
type: object
DirectivityFeature:
allOf:
- $ref: '#/components/schemas/Directivity'
- $ref: '#/components/schemas/DirectivityRange'
DirectivityRange:
properties:
default:
$ref: '#/components/schemas/Directivity'
description: Product and role specific default directivity value
range:
description: Product and role specific list of directivities
items:
$ref: '#/components/schemas/Directivity'
type: array
uniqueItems: true
required:
- default
- range
type: object
ErrorModel:
description: the general error model
properties:
errorCode:
description: 'A wellknown code that signal the error, can be used
by callers
'
type: string
errorId:
description: 'A unique identifier used to e.g. quick find in logs
'
type: string
errorMessage:
description: 'A textual representation, human readable and suitable
for logs
'
type: string
type: object
Fader:
properties:
value:
description: Selected fader value
format: double
type: number
required:
- value
type: object
FaderFeature:
allOf:
- $ref: '#/components/schemas/Fader'
- $ref: '#/components/schemas/FaderRange'
FaderRange:
properties:
default:
$ref: '#/components/schemas/Fader'
description: Default fader value
range:
description: fader range
items:
$ref: '#/components/schemas/Fader'
type: array
uniqueItems: true
required:
- default
- range
type: object
HdmiIdType:
type: string
HdmiInput:
properties:
contentUri:
description: This points to the editable content trigger for this
specific hdmi input
type: string
input:
$ref: '#/components/schemas/HdmiIdType'
type: object
HdmiVideoFormat:
properties:
pixelFormat:
$ref: '#/components/schemas/VideoPixelFormat'
vIC:
format: int32
minimum: 0
type: integer
videoTimings:
$ref: '#/components/schemas/VideoTimings'
type: object
HomeControlIxp:
properties:
uri:
type: string
type: object
HomeControlUri:
properties:
ixp:
nullable: true
type: string
uri:
type: string
type: object
InstallRecordIdState:
properties:
value:
enum:
- idle
- gettingUrl
- urlInvalid
- downloading
- downloadFinished
- downloadFailed
type: string
type: object
LatencyProfile:
description: 'The latency profile of this speaker group.
Needed to handle Beolab''s with latency dependant audio quality.
Default is set to performance.
'
properties:
value:
enum:
- performance
- quality
type: string
type: object
LgeTvSoundSettings:
properties:
digitalOutput:
enum:
- auto
- passThrough
- pcm
- unknown
type: string
eArc:
type: boolean
output:
enum:
- tvSpeaker
- externalOptical
- externalArc
- bluetooth
- wisaSpeakers
- lineout
- headphone
- tvSpeakerAndExternalOptical
- tvSpeakerAndHeadphone
- tvSpeakerAndBluetooth
- externalArcBno
- unknown
type: string
type: object
ListeningMode:
allOf:
- $ref: '#/components/schemas/ListeningModeProps'
required:
- features
- id
- name
- triggers
ListeningModeFeatures:
description: Sound features to apply
properties:
ambience:
$ref: '#/components/schemas/Ambience'
balance:
$ref: '#/components/schemas/Balance'
bassManagement:
$ref: '#/components/schemas/BassManagement'
compression:
$ref: '#/components/schemas/Compression'
directivity:
$ref: '#/components/schemas/Directivity'
fader:
$ref: '#/components/schemas/Fader'
roomCompensation:
$ref: '#/components/schemas/RoomCompensation'
spatialEnvelopment:
$ref: '#/components/schemas/SpatialEnvelopment'
spatialHeight:
$ref: '#/components/schemas/SpatialHeight'
spatialProcessing:
$ref: '#/components/schemas/SpatialProcessing'
spatialSurround:
$ref: '#/components/schemas/SpatialSurround'
spatialWidth:
$ref: '#/components/schemas/SpatialWidth'
speechEnhance:
$ref: '#/components/schemas/SpeechEnhance'
toneTouch:
$ref: '#/components/schemas/ToneTouch'
type: object
ListeningModeID:
format: int32
minimum: 0
type: integer
ListeningModeProps:
properties:
clientCtx:
description: 'An optional generic string property supplied from
the client. If
provided, it will be stored without changes.
If not supplied, any current clientCtx will remain unchanged.
'
maxLength: 4096
nullable: true
type: string
features:
$ref: '#/components/schemas/ListeningModeFeatures'
id:
$ref: '#/components/schemas/ListeningModeID'
name:
description: Friendly name
type: string
origin:
description: User created, default or an edited default listening
mode
enum:
- user
- default
- edited
type: string
role:
description: Role a listening mode applies to
enum:
- standalone
- multichannel
- all
nullable: true
type: string
triggers:
items:
$ref: '#/components/schemas/ListeningModeTrigger'
type: array
type: object
ListeningModeRef:
description: Reference to a listening mode
properties:
href:
description: 'Host relative URI of the listening mode or `null`
if there is no
active listening mode.
'
format: uri
nullable: true
type: string
id:
description: 'ID of the active listening mode or `null` if there
is no active
listening mode.
'
format: int32
minimum: 0
nullable: true
type: integer
required:
- id
- href
type: object
ListeningModeSet:
items:
allOf:
- $ref: '#/components/schemas/ListeningMode'
type: array
ListeningModeTrigger:
oneOf:
- $ref: '#/components/schemas/PowerLinkTrigger'
Loudness:
properties:
value:
type: boolean
type: object
MicrophoneState:
properties:
value:
enum:
- 'on'
- 'off'
type: string
type: object
MicrophonesState:
description: state of microphones, both physical switches and software
state
properties:
microphoneState:
$ref: '#/components/schemas/MicrophoneState'
microphoneSwitchState:
$ref: '#/components/schemas/MicrophoneState'
type: object
OptionalIpAddress:
description: IP address
example: fe80::209:a7ff:fe78:f605
nullable: true
type: string
OverlayPlayRequest:
allOf:
- $ref: '#/components/schemas/OverlayPlayRequestCommon'
- $ref: '#/components/schemas/OverlayPlayRequestUri'
- $ref: '#/components/schemas/OverlayPlayRequestTextToSpeech'
- $ref: '#/components/schemas/OverlayPlayRequestFromUsb'
OverlayPlayRequestCommon:
properties:
volumeAbsolute:
description: 'An optional absolute volume level at which to play
the URI. If not provided, the URI will play at the currently
configured volume level on the product. The level should be
provided in volume steps [0, 100]
'
format: int32
maximum: 100
minimum: 0
nullable: true
type: integer
type: object
OverlayPlayRequestFromUsb:
nullable: true
properties:
fromUsb:
properties:
fileLocation:
description: 'Required field containing the relative path
(i.e. from the USB drive root) and file name with
extension (if one exists) that will be played. A maximum
length of 1024 characters is allowed.
'
maxLength: 1024
type: string
required:
- fileLocation
type: object
type: object
OverlayPlayRequestTextToSpeech:
nullable: true
properties:
textToSpeech:
description: 'Object used for performing a text-to-speech operation
on the product.
'
properties:
lang:
description: 'An optional specification of the language
to use. The default value is ultimately decided by
the BeoCloud API, but currently it defaults to `en-us`.
'
example: en-us
nullable: true
type: string
text:
description: 'Required field containing the actual text
that will be converted to speech (audio). A maximum
length of 2048 characters is allowed.
'