-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathSonos.wsdl
2157 lines (1969 loc) · 101 KB
/
Sonos.wsdl
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
<?xml version="1.0" encoding="utf-8"?>
<!--
Sonos Music Service WSDL definition
Copyright (c) 2007-2016 Sonos, Inc. All Rights Reserved
This document is licensed under the Creative Commons Attribution, Share-Alike
license, v3.0 (Unported) with the following modifications:
As clarified in the license, distribution of any software (source or binary)
that instantiates the API will require the party(ies) distributing such
software to publish the revised API and associated documentation, at no charge,
in accordance with the terms of the license. There is no requirement, however,
to publish the underlying code.
-->
<wsdl:definitions name="Sonos"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://www.sonos.com/Services/1.1"
targetNamespace="http://www.sonos.com/Services/1.1">
<wsdl:types>
<xs:schema targetNamespace="http://www.sonos.com/Services/1.1"
elementFormDefault="qualified">
<xs:simpleType name="privateDataType">
<xs:restriction base="xs:string">
<xs:maxLength value="2048"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="sonosUri">
<xs:restriction base="xs:string">
<xs:maxLength value="2048"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="id">
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="algorithm">
<xs:restriction base="xs:token">
<xs:enumeration value="AES/CBC/PKCS#7"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="id" type="tns:id"/>
<xs:element name="password">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="128"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="username">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="128"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="sessionId">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="128"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="label">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="128"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="login">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:username"/>
<xs:element ref="tns:password"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="loginToken">
<xs:complexType>
<xs:sequence>
<xs:element name="token" type="xs:string"/>
<xs:element name="key" type="xs:string"/>
<xs:element name="householdId" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="nickname">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="32"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:simpleType name="userAccountType">
<xs:restriction base="xs:string">
<xs:enumeration value="premium"/>
<xs:enumeration value="trial"/>
<xs:enumeration value="free"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="userAccountStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="active"/>
<xs:enumeration value="restricted"/>
<xs:enumeration value="expired"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="credentials">
<xs:complexType>
<xs:sequence>
<!-- Unique id for a single zone player -->
<xs:element name="zonePlayerId" type="tns:id" minOccurs="0"/>
<!-- Unique id for all Zone Player's in a single household -->
<xs:element name="deviceId" type="tns:id" minOccurs="0"/>
<xs:element name="deviceProvider" type="xs:string" minOccurs="0"/>
<!-- Zone Player's X.509 certificate (as raw ASN.1 DER), encoded using base64.
This element is sent in the request only when "Requires Player Certificate" capability flag is enabled.
Associated client SOAP Faults:
Client.DeviceCertRequired: a cert was required, but Sonos did not provide one
Client.DeviceCertInvalid: a cert was provided, but is considered invalid
Client.DeviceCertExpired: a cert was provided, but is considered expired
Client.DeviceCertRevoked: a cert was provided, but is revoked by the service
-->
<xs:element name="deviceCert" type="xs:string" minOccurs="0"/>
<xs:choice minOccurs="0">
<xs:element ref="tns:sessionId"/>
<xs:element ref="tns:login"/>
<xs:element ref="tns:loginToken"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="context">
<xs:complexType>
<xs:sequence>
<xs:element name="timeZone" type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="skip" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Extensibility point to add new context header information.
Please refer to Sonos documentation for details
</xs:documentation>
</xs:annotation>
</xs:any>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:simpleType name="itemType">
<xs:restriction base="xs:string">
<xs:enumeration value="artist"/>
<xs:enumeration value="album"/>
<xs:enumeration value="genre"/>
<xs:enumeration value="playlist"/>
<xs:enumeration value="track"/>
<xs:enumeration value="search"/>
<xs:enumeration value="stream"/>
<xs:enumeration value="show"/>
<xs:enumeration value="program"/>
<xs:enumeration value="favorites"/>
<xs:enumeration value="favorite"/>
<xs:enumeration value="collection"/>
<xs:enumeration value="container"/>
<xs:enumeration value="albumList"/>
<xs:enumeration value="trackList"/>
<xs:enumeration value="streamList"/>
<xs:enumeration value="artistTrackList"/>
<xs:enumeration value="audiobook"/>
<xs:enumeration value="other"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="itemType" type="tns:itemType"/>
<xs:simpleType name="deviceSessionToken">
<xs:annotation>
<xs:documentation>It is a token that is specific to a device to allow that device to stream.
If a deviceSessionToken was returned in a previous call, this is provided here. There may be
some tracks that do not include one in the mediaUriResponse; this will not cause Sonos to
remove the previous deviceSessionToken. Sonos will send this element until a new one is returned, always.
This element can be used to avoid having to re-validate the cert by encoding that information.
It can provide a lower cost short cut for encoding session keys.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="2048"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="encryptionType">
<xs:restriction base="xs:string">
<xs:enumeration value="NONE" />
<xs:enumeration value="AES-ECB" />
<xs:enumeration value="AES-CBC" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="encryptionContext">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="type" type="tns:encryptionType"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:simpleType name="mediaUriAction">
<xs:restriction base="xs:string">
<xs:enumeration value="IMPLICIT"/>
<xs:enumeration value="EXPLICIT:PLAY"/>
<xs:enumeration value="EXPLICIT:SEEK"/>
<xs:enumeration value="EXPLICIT:SKIP_FORWARD"/>
<xs:enumeration value="EXPLICIT:SKIP_BACK"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="mediaUriAction" type="tns:mediaUriAction" />
<xs:complexType name="AbstractMedia" abstract="true">
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element ref="tns:itemType"/>
<xs:element name="displayType" type="xs:string"/>
<xs:element name="title" type="xs:string"/>
<!--
The summary field will only be displayed if the displayType
maps to a HeroView or Editorial layout otherwise it will be ignored
-->
<xs:element name="summary" type="xs:string" minOccurs="0"/>
<!--Indicates that the item is currently favorited.
If omitted, we don't know the favorited state. -->
<xs:element name="isFavorite" type="xs:boolean" minOccurs="0"/>
<!--Indicates one or more tags are relevant for the item. In the UI
this may translate to badges (icons) being displayed
with the metadata for the track or container-->
<xs:element name="tags" type="tns:tagsData" minOccurs="0" maxOccurs="1"/>
<!--
Included for backwards compatibility with MOAPI 1.0. These are
currently all disregarded by the Sonos firmware. -->
<xs:element name="language" type="xs:string" minOccurs="0"/>
<xs:element name="country" type="xs:string" minOccurs="0"/>
<xs:element name="genreId" type="xs:string" minOccurs="0"/>
<xs:element name="genre" type="xs:string" minOccurs="0"/>
<xs:element name="twitterId" type="xs:string" minOccurs="0"/>
<xs:element name="liveNow" type="xs:boolean" minOccurs="0"/>
<xs:element name="onDemand" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="appLinkInfo">
<xs:sequence>
<!-- Required. A URL the Sonos Application will open. Typically after a user selects it. -->
<xs:element name="appUrl" type="tns:sonosUri" minOccurs="0"/>
<!-- Required. A string resource id (in strings.xml) to use as a label for the link to "appUrL" -->
<xs:element name="appUrlStringId" type="xs:string" minOccurs="1"/>
<!-- Optional. deviceLink data to use as a fall-back if the app the appURL points to is not installed
or the appLink method is not available on the current platform -->
<xs:element name="deviceLink" type="tns:deviceLinkCodeResult" minOccurs="0" />
<!-- Optional. A string resource id to message the user in case Sonos fails to open "appUrl" -->
<xs:element name="failureStringId" type="xs:string" minOccurs="0"/>
<!-- Optional. A URL where users can go to get support or find out more about what might possibly be wrong. Use
in conjunction with failureStringId message -->
<xs:element name="failureUrl" type="tns:sonosUri" minOccurs="0"/>
<!-- Optional. A string resource id to use as a label for the link to "failureUrl" -->
<xs:element name="failureUrlStringId" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="callToActionInfo">
<xs:sequence>
<!-- Required. A string resource id of a message to help users understand what is the action they need to take -->
<xs:element name="messageStringId" type="xs:string" minOccurs="1"/>
<!-- Optional. A URL where users can navigate to take some action or learn more about options -->
<xs:element name="url" type="tns:sonosUri" minOccurs="0"/>
<!-- Optional. A string resource id to use as a label for the link to "url" in this context -->
<xs:element name="urlStringId" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="appLinkResult">
<xs:choice>
<xs:sequence>
<!-- Required. Where to authorize an account (for "add account" or "re-authorize account" flows -->
<xs:element name="authorizeAccount" type="tns:appLinkInfo" minOccurs="1"/>
<!-- Optional. Provides a way for a user to create an account. -->
<xs:element name="createAccount" type="tns:appLinkInfo" minOccurs="0"/>
<!-- Optional. If a Sonos application detects that the application associated with
"authorizeAccount/appUrl" is not installed, it will use the information in this element to message
the user. -->
<xs:element name="installAction" type="tns:callToActionInfo" minOccurs="0"/>
</xs:sequence>
<!-- if there is no app link for the given hardware, osVersion, sonosAppName combination this
element MUST be returned instead -->
<xs:element name="callToAction" type="tns:callToActionInfo" minOccurs="1"/>
</xs:choice>
</xs:complexType>
<xs:complexType name="deviceLinkCodeResult">
<xs:sequence>
<xs:element name="regUrl" type="xs:string"/>
<xs:element name="linkCode" type="xs:string"/>
<xs:element name="showLinkCode" type="xs:boolean"/>
<xs:element name="linkDeviceId" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="deviceAuthTokenResult">
<xs:sequence>
<xs:element name="authToken" type="xs:string"/>
<xs:element name="privateKey" type="xs:string"/>
<xs:element name="userInfo" type="tns:userInfo" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="userInfo">
<xs:sequence>
<!-- Everything except userIdHashCode and nickname are for future use -->
<xs:element name="userIdHashCode" type="xs:string" minOccurs="1"/>
<xs:element name="accountType" type="tns:userAccountType" minOccurs="0"/>
<xs:element name="accountStatus" type="tns:userAccountStatus" minOccurs="0"/>
<xs:element ref="tns:nickname" minOccurs="0"/>
<xs:element name="profileUrl" type="tns:sonosUri" minOccurs="0"/>
<xs:element name="pictureUrl" type="tns:sonosUri" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="reportPlaySecondsResult">
<xs:sequence>
<xs:element name="interval" type="xs:int"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="albumArtUrl">
<xs:simpleContent>
<xs:extension base="xs:anyURI">
<xs:attribute name="requiresAuthentication" type="xs:boolean" use="optional" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="positionInformation">
<xs:sequence>
<xs:element ref="tns:id"/>
<!-- Required for future use. Base-0 index in the container to the track with 'tns:id'. If there is no container return "0" -->
<xs:element name="index" type="xs:int"/>
<!-- Required. The offset at which playback should be resumed. -->
<xs:element name="offsetMillis" type="xs:int"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="mediaCollection">
<xs:complexContent>
<xs:extension base="tns:AbstractMedia">
<xs:sequence>
<!--The collection can implement one of these two sets of metadata
the first is intended for music collections, the second for audio books-->
<xs:choice>
<xs:sequence>
<!--
Collections can optionally indicate a creator. For example, a
collection could represent an album and "artist" would indicate
the album artist. -->
<xs:element name="artist" type="xs:string" minOccurs="0"/>
<xs:element name="artistId" type="tns:id" minOccurs="0"/>
</xs:sequence>
<xs:sequence>
<xs:element name="authorId" type="xs:string" minOccurs="0" />
<xs:element name="author" type="xs:string" minOccurs="0" />
<xs:element name="narratorId" type="xs:string" minOccurs="0" />
<xs:element name="narrator" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:choice>
<!--
Indicates that the collection supports the getScrollIndices
method if omitted, canScroll is assumed to be false. -->
<xs:element name="canScroll" type="xs:boolean" minOccurs="0"/>
<!--
Indicates that the collection can be "played" by enumerating
using the "recursive" flag to obtain a flat list of all
mediaMetadata items it contains. If omitted, canPlay is assumed
to be false -->
<xs:element name="canPlay" type="xs:boolean" minOccurs="0"/>
<!--
Indicates that the collection can be enumerated, using the
collection id in a subsequent call to getMetadata. If omitted,
canEnumerate is assumed to be true -->
<xs:element name="canEnumerate" type="xs:boolean" minOccurs="0"/>
<!--
Indicates that the collection can be added to user favorites.
If omitted, canAddToFavorites is assumed to be true. -->
<xs:element name="canAddToFavorites" type="xs:boolean" minOccurs="0"/>
<!--
Indicates that the collection contains user favorites.
If omitted, containsFavorite is assumed to be false. -->
<xs:element name="containsFavorite" type="xs:boolean" minOccurs="0"/>
<!--
Included for backwards compatibility with MOAPI 1.0. This is
currently disregarded by the Sonos firmware. -->
<xs:element name="canCache" type="xs:boolean" minOccurs="0"/>
<!--
Indicates that playback of this whole collection allows skip
forward. Defaults to true. -->
<xs:element name="canSkip" type="xs:boolean" minOccurs="0"/>
<!-- This is really any artwork in the square album style. -->
<xs:element name="albumArtURI" type="tns:albumArtUrl" minOccurs="0"/>
<!-- Does this collection support resume from last playhead position reported? -->
<xs:element name="canResume" type="xs:boolean" minOccurs="0"/>
<!--
Included for backwards compatibility with MOAPI 1.0. These
are currently all disregarded by the Sonos firmware. -->
<xs:element name="authRequired" type="xs:boolean" minOccurs="0"/>
<xs:element name="homogeneous" type="xs:boolean" minOccurs="0"/>
<xs:element name="canAddToFavorite" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
<!-- For editable containers you must always return readOnly false. You can further configure
editable features with the use of canReorderItems and canDeleteItems -->
<xs:attribute name="readOnly" type="xs:boolean" use="optional" default="true"/>
<!-- You can control if the items in the collection can be deleted and/or reordered with the
following attributes -->
<xs:attribute name="canReorderItems" type="xs:boolean" use="optional" default="false"/>
<xs:attribute name="canDeleteItems" type="xs:boolean" use="optional" default="false"/>
<xs:attribute name="renameable" type="xs:boolean" use="optional" default="false"/>
<xs:attribute name="userContent" type="xs:boolean" use="optional" default="false"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="trackMetadata">
<xs:sequence>
<xs:choice>
<xs:sequence>
<xs:element name="artistId" type="tns:id" minOccurs="0"/>
<xs:element name="artist" type="xs:string" minOccurs="0"/>
<xs:element name="composerId" type="tns:id" minOccurs="0"/>
<xs:element name="composer" type="xs:string" minOccurs="0"/>
<xs:element name="albumArtistId" type="tns:id" minOccurs="0"/>
<xs:element name="albumArtist" type="xs:string" minOccurs="0"/>
<xs:element name="albumId" type="tns:id" minOccurs="0"/>
<xs:element name="album" type="xs:string" minOccurs="0"/>
</xs:sequence>
<xs:sequence>
<xs:element name="authorId" type="xs:string" minOccurs="0" />
<xs:element name="author" type="xs:string" minOccurs="0" />
<xs:element name="narratorId" type="xs:string" minOccurs="0" />
<xs:element name="narrator" type="xs:string" minOccurs="0" />
<xs:element name="bookId" type="xs:string" minOccurs="0" />
<xs:element name="book" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:choice>
<xs:element name="genreId" type="tns:id" minOccurs="0"/>
<xs:element name="genre" type="xs:string" minOccurs="0"/>
<xs:element name="duration" type="xs:int" minOccurs="0"/>
<xs:element name="rating" type="xs:int" minOccurs="0"/>
<xs:element name="albumArtURI" type="tns:albumArtUrl" minOccurs="0"/>
<xs:element name="trackNumber" type="xs:int" minOccurs="0"/>
<!--
Indicates that the track can be played. If not present, the
default value is "true". If "false" this flag indicates that the
user does not have rights to stream the track. -->
<xs:element name="canPlay" type="xs:boolean" minOccurs="0"/>
<!--
Indicates that playback of this track allows skip forward.
Defaults to true. -->
<xs:element name="canSkip" type="xs:boolean" minOccurs="0"/>
<!-- Indicates that this track can be added to the favorites. -->
<xs:element name="canAddToFavorites" type="xs:boolean" minOccurs="0"/>
<!-- Does this track (or it's container) support resume from last playhead position reported? -->
<xs:element name="canResume" type="xs:boolean" minOccurs="0"/>
<xs:element name="canSeek" type="xs:boolean" minOccurs="0"/>
<xs:element name="hasOutOfBandMetadata" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="streamMetadata">
<xs:sequence>
<xs:element name="currentHost" type="xs:string" minOccurs="0"/>
<xs:element name="currentShowId" type="tns:id" minOccurs="0"/>
<xs:element name="currentShow" type="xs:string" minOccurs="0"/>
<xs:element name="secondsRemaining" type="xs:int" minOccurs="0"/>
<xs:element name="secondsToNextShow" type="xs:int" minOccurs="0"/>
<xs:element name="bitrate" type="xs:int" minOccurs="0"/>
<xs:element name="logo" type="tns:albumArtUrl" minOccurs="0"/>
<xs:element name="description" type="xs:string" minOccurs="0"/>
<!-- is this short lived, if so do not allow adding to Sonos Favorites or alarms-->
<xs:element name="isEphemeral" type="xs:boolean" minOccurs="0"/>
<!--
Included for backwards compatibility with MOAPI 1.0. These are
currently all disregarded by the Sonos firmware. -->
<xs:element name="reliability" type="xs:anyURI" minOccurs="0"/>
<xs:element name="title" type="xs:anyURI" minOccurs="0"/>
<xs:element name="subtitle" type="xs:anyURI" minOccurs="0"/>
<xs:element name="nextShowSeconds" type="xs:anyURI" minOccurs="0"/>
<!-- Deprecated as of 6.3. To embed metadata use HLS specification. -->
<xs:element name="hasOutOfBandMetadata" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="property">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="value" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="dynamicData">
<xs:sequence>
<xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="behaviorsData">
<xs:sequence>
<xs:element name="supportsQuickSkip" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="tagsData">
<xs:sequence>
<xs:element name="explicit" type="xs:int" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="mediaMetadata">
<xs:complexContent>
<xs:extension base="tns:AbstractMedia">
<xs:sequence>
<xs:element name="mimeType" type="xs:string"/>
<xs:choice>
<xs:element name="trackMetadata" type="tns:trackMetadata"/>
<xs:element name="streamMetadata" type="tns:streamMetadata"/>
</xs:choice>
<xs:element name="dynamic" type="tns:dynamicData" minOccurs="0" maxOccurs="1"/>
<xs:element name="behaviors" type="tns:behaviorsData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- Deprecated as of 6.3. To embed metadata use HLS specification. -->
<xs:complexType name="segmentMetadata">
<xs:annotation>
<xs:documentation>segmentMetadata is metadata that applies to a specified time range.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element name="trackId" type="tns:id" minOccurs="0"/>
<xs:element name="track" type="xs:string" minOccurs="0"/>
<xs:element name="artistId" type="tns:id" minOccurs="0"/>
<xs:element name="artist" type="xs:string" minOccurs="0"/>
<xs:element name="composerId" type="tns:id" minOccurs="0"/>
<xs:element name="composer" type="xs:string" minOccurs="0"/>
<xs:element name="albumId" type="tns:id" minOccurs="0"/>
<xs:element name="album" type="xs:string" minOccurs="0"/>
<xs:element name="albumArtistId" type="tns:id" minOccurs="0"/>
<xs:element name="albumArtist" type="xs:string" minOccurs="0"/>
<xs:element name="genreId" type="tns:id" minOccurs="0"/>
<xs:element name="genre" type="xs:string" minOccurs="0"/>
<xs:element name="showId" type="tns:id" minOccurs="0"/>
<xs:element name="show" type="xs:string" minOccurs="0"/>
<xs:element name="episodeId" type="tns:id" minOccurs="0"/>
<xs:element name="episode" type="xs:string" minOccurs="0"/>
<xs:element name="host" type="xs:string" minOccurs="0"/>
<xs:element name="topic" type="xs:string" minOccurs="0"/>
<xs:element name="rating" type="xs:int" minOccurs="0"/>
<xs:element name="albumArtURI" type="xs:anyURI" minOccurs="0"/>
<xs:element name="startTime" type="xs:dateTime">
<xs:annotation>
<xs:documentation>Specifies the inclusive start time of the period to which this metadata
applies.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="duration" type="xs:int">
<xs:annotation>
<xs:documentation>Specifies the length of the period in milliseconds.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="mediaList">
<xs:sequence>
<xs:element name="index" type="xs:int"/>
<xs:element name="count" type="xs:int"/>
<xs:element name="total" type="xs:int"/>
<xs:element name="positionInformation" type="tns:positionInformation" minOccurs="0" maxOccurs="1"/>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="mediaCollection" type="tns:mediaCollection"/>
<xs:element name="mediaMetadata" type="tns:mediaMetadata"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
<xs:complexType name="radioTrackList">
<xs:sequence>
<xs:element name="count" type="xs:int" />
<xs:element name="id" type="xs:string" minOccurs="0" />
<xs:element name="name" type="xs:string" minOccurs="0" />
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="mediaMetadata" type="tns:mediaMetadata"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
<!-- Deprecated as of 6.3. To embed metadata use HLS specification. -->
<xs:complexType name="segmentMetadataList">
<xs:sequence minOccurs="0">
<xs:element name="startTime" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies the inclusive start time of the period for this list. If
omitted, defaults the startTime of the first temporalMediaMetadata element.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="duration" type="xs:int" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies the length of the period of this list in milliseconds. If
omitted, defaults the duration between startTime and the last elment's end time.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="segmentMetadata" type="tns:segmentMetadata" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A chronologically ordered list of segmentMetadata elements
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="lastUpdate">
<xs:sequence>
<xs:element name="catalog" type="xs:string"/>
<xs:element name="favorites" type="xs:string"/>
<!-- Can optionally return a new polling interval in seconds -->
<xs:element name="pollInterval" type="xs:int" minOccurs="0"/>
<!-- Can optionally turn auto refresh OFF for the container a user is browsed into. Auto Refresh
is always ON by default -->
<xs:element name="autoRefreshEnabled" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="relatedBrowse">
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element name="type" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="relatedText">
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element name="type" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="relatedPlay">
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element ref="tns:itemType"/>
<xs:element name="title" type="xs:string"/>
<xs:element name="canPlay" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="relatedActions">
<xs:sequence>
<xs:element name="action" type="tns:genericAction" minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="extendedMetadata">
<xs:sequence>
<xs:choice>
<xs:element name="mediaCollection" type="tns:mediaCollection" minOccurs="0" maxOccurs="1"/>
<xs:element name="mediaMetadata" type="tns:mediaMetadata" minOccurs="0" maxOccurs="1"/>
</xs:choice>
<xs:element name="relatedBrowse" type="tns:relatedBrowse" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="relatedText" type="tns:relatedText" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="relatedPlay" type="tns:relatedPlay" minOccurs="0" maxOccurs="1"/>
<xs:element name="relatedActions" type="tns:relatedActions" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="actionType">
<xs:restriction base="xs:string">
<xs:enumeration value="openUrl"/>
<xs:enumeration value="simpleHttpRequest"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="genericAction">
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element name="title" type="xs:string"/>
<xs:element name="actionType" type="tns:actionType"/>
<xs:element name="showInBrowse" type="xs:boolean" minOccurs="0" maxOccurs="1" />
<xs:choice>
<xs:element name="openUrlAction" type="tns:openUrlAction"/>
<xs:element name="simpleHttpRequestAction" type="tns:simpleHttpRequestAction"/>
</xs:choice>
<xs:element name="successMessageStringId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="failureMessageStringId" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="openUrlAction">
<xs:sequence>
<xs:element name="url" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="simpleHttpRequestAction">
<xs:sequence>
<xs:element name="url" type="xs:string"/>
<xs:element name="method" type="xs:string"/>
<xs:element name="httpHeaders" type="tns:httpHeaders" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="itemRating">
<xs:sequence>
<xs:element name="shouldSkip" type="xs:boolean" minOccurs="0"/>
<xs:element name="messageStringId" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="httpHeader">
<xs:sequence>
<xs:element name="header" type="xs:string"/>
<xs:element name="value" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="httpHeaders">
<xs:sequence>
<xs:element name="httpHeader" type="tns:httpHeader" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="contentKey">
<xs:sequence>
<xs:element name="uri" type="xs:anyURI"/>
<xs:element name="deviceSessionToken" type="tns:deviceSessionToken" minOccurs="0" maxOccurs="1"/>
<xs:element name="deviceSessionKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
<xs:element name="contentKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:element name="getSessionId">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:username"/>
<xs:element ref="tns:password"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getSessionIdResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="getSessionIdResult" type="tns:id"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getMetadata">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element name="index" type="xs:int"/>
<xs:element name="count" type="xs:int"/>
<xs:element name="recursive" type="xs:boolean" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getMetadataResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="getMetadataResult" type="tns:mediaList"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getExtendedMetadata">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:id"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getExtendedMetadataResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="getExtendedMetadataResult" type="tns:extendedMetadata"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getExtendedMetadataText">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element name="type" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getExtendedMetadataTextResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="getExtendedMetadataTextResult" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getUserInfo">
<xs:complexType/>
</xs:element>
<xs:element name="getUserInfoResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="getUserInfoResult" type="tns:userInfo"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="rateItem">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element name="rating" type="xs:int"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="rateItemResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="rateItemResult" type="tns:itemRating"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="search">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:id"/>
<xs:element name="term" type="xs:string"/>
<xs:element name="index" type="xs:int"/>
<xs:element name="count" type="xs:int"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="searchResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="searchResult" type="tns:mediaList"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getMediaMetadata">
<xs:complexType>
<xs:sequence>
<xs:element ref="tns:id"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getMediaMetadataResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="getMediaMetadataResult" type="tns:mediaMetadata"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getMediaURI">
<xs:complexType>
<xs:sequence>
<xs:element name="id" type="tns:id"/>
<xs:element name="action" type="tns:mediaUriAction" minOccurs="0" maxOccurs="1"/>
<xs:element name="secondsSinceExplicit" type="xs:int" minOccurs="0" maxOccurs="1"/>
<xs:element name="deviceSessionToken" type="tns:deviceSessionToken" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getMediaURIResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="getMediaURIResult" type="xs:anyURI"/>
<xs:element name="deviceSessionToken" type="tns:deviceSessionToken" minOccurs="0" maxOccurs="1"/>
<xs:element name="deviceSessionKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
<xs:element name="contentKey" type="tns:encryptionContext" minOccurs="0" maxOccurs="1"/>
<xs:element name="httpHeaders" type="tns:httpHeaders" minOccurs="0" maxOccurs="1"/>
<xs:element name="uriTimeout" type="xs:int" minOccurs="0" maxOccurs="1"/>
<xs:element name="positionInformation" type="tns:positionInformation" minOccurs="0" maxOccurs="1"/>
<!-- if desired, include the field to extracted out of ID3v2 "PRIV" frame.
The data extracted will be sent in the privateData element in reportPlaySeconds and setPlayedSeconds -->
<xs:element name="privateDataFieldName" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="createItem">
<xs:complexType>
<xs:sequence>
<xs:element name="favorite" type="tns:id"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="createItemResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="createItemResult" type="tns:id"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="deleteItem">
<xs:complexType>
<xs:sequence>
<xs:element name="favorite" type="tns:id"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="deleteItemResponse">
<xs:complexType/>
</xs:element>
<xs:element name="getScrollIndices">
<xs:complexType>
<xs:sequence>
<xs:element name="id" type="tns:id"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getScrollIndicesResponse">
<xs:complexType>
<xs:sequence>
<!--
Result is a comma separated list of name value pairs representing
the first letter prefix of an item and its position in the
list (e.g A,0,B,123 etc.) -->
<xs:element name="getScrollIndicesResult" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getLastUpdate">
<xs:complexType/>
</xs:element>
<xs:element name="getLastUpdateResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="getLastUpdateResult" type="tns:lastUpdate"/>
</xs:sequence>