react-native-audio-browser 0.2.0-next.53 → 0.2.0-next.54

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.
Files changed (329) hide show
  1. package/android/src/cast/java/com/audiobrowser/cast/CastSupport.kt +8 -10
  2. package/android/src/main/java/com/audiobrowser/AudioBrowser.kt +96 -243
  3. package/android/src/main/java/com/audiobrowser/AudioBrowserLifecycleModule.kt +8 -12
  4. package/android/src/main/java/com/audiobrowser/AudioBrowserPackage.kt +1 -3
  5. package/android/src/main/java/com/audiobrowser/Callbacks.kt +1 -10
  6. package/android/src/main/java/com/audiobrowser/ForegroundStart.kt +13 -18
  7. package/android/src/main/java/com/audiobrowser/HeadlessTaskService.kt +3 -7
  8. package/android/src/main/java/com/audiobrowser/RemoteOutputs.kt +8 -10
  9. package/android/src/main/java/com/audiobrowser/Service.kt +20 -61
  10. package/android/src/main/java/com/audiobrowser/ServiceBinding.kt +9 -17
  11. package/android/src/main/java/com/audiobrowser/browser/ArtworkResolutionRegistry.kt +10 -9
  12. package/android/src/main/java/com/audiobrowser/browser/BrowseArtworkRegistry.kt +11 -8
  13. package/android/src/main/java/com/audiobrowser/browser/BrowserManager.kt +117 -448
  14. package/android/src/main/java/com/audiobrowser/browser/BrowserUrlResolution.kt +21 -60
  15. package/android/src/main/java/com/audiobrowser/browser/InertStyleDiagnostic.kt +20 -80
  16. package/android/src/main/java/com/audiobrowser/browser/JsonArtwork.kt +6 -10
  17. package/android/src/main/java/com/audiobrowser/browser/JsonModels.kt +7 -24
  18. package/android/src/main/java/com/audiobrowser/browser/RouteMatch.kt +2 -4
  19. package/android/src/main/java/com/audiobrowser/browser/SectionScope.kt +13 -31
  20. package/android/src/main/java/com/audiobrowser/browser/SimpleRouter.kt +12 -40
  21. package/android/src/main/java/com/audiobrowser/browser/StyleResolver.kt +15 -26
  22. package/android/src/main/java/com/audiobrowser/browser/TrackLoadHandler.kt +5 -15
  23. package/android/src/main/java/com/audiobrowser/extension/EnumExtensions.kt +1 -0
  24. package/android/src/main/java/com/audiobrowser/extension/NumberExt.kt +2 -0
  25. package/android/src/main/java/com/audiobrowser/extension/ResolvedTrackExt.kt +4 -8
  26. package/android/src/main/java/com/audiobrowser/extension/TappedTrack.kt +4 -6
  27. package/android/src/main/java/com/audiobrowser/extension/TrackIdentity.kt +3 -7
  28. package/android/src/main/java/com/audiobrowser/http/HttpClient.kt +13 -22
  29. package/android/src/main/java/com/audiobrowser/http/RequestConfigBuilder.kt +17 -38
  30. package/android/src/main/java/com/audiobrowser/model/IcyTitle.kt +5 -6
  31. package/android/src/main/java/com/audiobrowser/model/PlaybackMetadata.kt +4 -9
  32. package/android/src/main/java/com/audiobrowser/model/PlayerSetupOptions.kt +18 -29
  33. package/android/src/main/java/com/audiobrowser/model/PlayerUpdateOptions.kt +6 -16
  34. package/android/src/main/java/com/audiobrowser/player/AutomaticBufferManager.kt +15 -45
  35. package/android/src/main/java/com/audiobrowser/player/CapabilityControls.kt +23 -59
  36. package/android/src/main/java/com/audiobrowser/player/CrossOriginHeaderStripper.kt +14 -26
  37. package/android/src/main/java/com/audiobrowser/player/DynamicLoadControl.kt +15 -43
  38. package/android/src/main/java/com/audiobrowser/player/EnginePlayback.kt +4 -4
  39. package/android/src/main/java/com/audiobrowser/player/EqualizerController.kt +15 -21
  40. package/android/src/main/java/com/audiobrowser/player/InterceptingPlayer.kt +14 -31
  41. package/android/src/main/java/com/audiobrowser/player/LocalEngine.kt +8 -8
  42. package/android/src/main/java/com/audiobrowser/player/MediaFactory.kt +16 -27
  43. package/android/src/main/java/com/audiobrowser/player/MediaSessionCallback.kt +119 -237
  44. package/android/src/main/java/com/audiobrowser/player/MediaSessionCommandManager.kt +48 -145
  45. package/android/src/main/java/com/audiobrowser/player/NowPlayingUpdater.kt +39 -100
  46. package/android/src/main/java/com/audiobrowser/player/PlaybackErrorClassifier.kt +16 -26
  47. package/android/src/main/java/com/audiobrowser/player/PlaybackStateMachine.kt +22 -28
  48. package/android/src/main/java/com/audiobrowser/player/PlaybackStateStore.kt +28 -64
  49. package/android/src/main/java/com/audiobrowser/player/PlaybackTimer.kt +8 -4
  50. package/android/src/main/java/com/audiobrowser/player/Player.kt +117 -405
  51. package/android/src/main/java/com/audiobrowser/player/PlayerCapabilitiesExt.kt +1 -1
  52. package/android/src/main/java/com/audiobrowser/player/PlayerEngineFactory.kt +11 -19
  53. package/android/src/main/java/com/audiobrowser/player/PlayerListener.kt +30 -96
  54. package/android/src/main/java/com/audiobrowser/player/RetryLoadErrorHandlingPolicy.kt +39 -95
  55. package/android/src/main/java/com/audiobrowser/player/ShuffleOrderLedBy.kt +7 -13
  56. package/android/src/main/java/com/audiobrowser/player/SleepTimer.kt +13 -30
  57. package/android/src/main/java/com/audiobrowser/player/SleepTimerManager.kt +7 -11
  58. package/android/src/main/java/com/audiobrowser/player/StuckRecoveryPolicy.kt +9 -22
  59. package/android/src/main/java/com/audiobrowser/player/TransformingDataSource.kt +22 -54
  60. package/android/src/main/java/com/audiobrowser/player/VolumeFader.kt +8 -15
  61. package/android/src/main/java/com/audiobrowser/remote/RemoteItem.kt +9 -8
  62. package/android/src/main/java/com/audiobrowser/remote/RemoteOutputsController.kt +13 -10
  63. package/android/src/main/java/com/audiobrowser/remote/RemotePlayback.kt +8 -8
  64. package/android/src/main/java/com/audiobrowser/remote/RemoteQueue.kt +12 -5
  65. package/android/src/main/java/com/audiobrowser/remote/RemoteSwitchingPlayer.kt +28 -48
  66. package/android/src/main/java/com/audiobrowser/sonos/DeviceDescriptionParser.kt +11 -19
  67. package/android/src/main/java/com/audiobrowser/sonos/DidlLite.kt +2 -2
  68. package/android/src/main/java/com/audiobrowser/sonos/SoapClient.kt +6 -6
  69. package/android/src/main/java/com/audiobrowser/sonos/SoapEnvelopes.kt +8 -9
  70. package/android/src/main/java/com/audiobrowser/sonos/SoapResponseParser.kt +11 -18
  71. package/android/src/main/java/com/audiobrowser/sonos/SonosDiscoverer.kt +10 -10
  72. package/android/src/main/java/com/audiobrowser/sonos/SonosOutputs.kt +10 -10
  73. package/android/src/main/java/com/audiobrowser/sonos/SonosPlayer.kt +21 -33
  74. package/android/src/main/java/com/audiobrowser/sonos/SonosRemote.kt +4 -6
  75. package/android/src/main/java/com/audiobrowser/sonos/SonosRouteProviderService.kt +9 -10
  76. package/android/src/main/java/com/audiobrowser/sonos/SonosStreamUri.kt +7 -7
  77. package/android/src/main/java/com/audiobrowser/sonos/SonosTransport.kt +5 -4
  78. package/android/src/main/java/com/audiobrowser/sonos/SsdpDiscovery.kt +8 -3
  79. package/android/src/main/java/com/audiobrowser/sonos/SsdpMessages.kt +4 -6
  80. package/android/src/main/java/com/audiobrowser/sonos/ZoneGroupState.kt +13 -11
  81. package/android/src/main/java/com/audiobrowser/tls/AiaCertChaser.kt +34 -71
  82. package/android/src/main/java/com/audiobrowser/tls/AiaChasingExtendedTrustManager.kt +20 -37
  83. package/android/src/main/java/com/audiobrowser/tls/AiaChasingTrustManager.kt +18 -27
  84. package/android/src/main/java/com/audiobrowser/tls/AiaTls.kt +14 -29
  85. package/android/src/main/java/com/audiobrowser/tls/CachingCertificateFetcher.kt +68 -133
  86. package/android/src/main/java/com/audiobrowser/util/ArtworkContentProvider.kt +10 -22
  87. package/android/src/main/java/com/audiobrowser/util/ArtworkRoutes.kt +6 -6
  88. package/android/src/main/java/com/audiobrowser/util/ArtworkUris.kt +4 -3
  89. package/android/src/main/java/com/audiobrowser/util/ArtworkVariant.kt +2 -13
  90. package/android/src/main/java/com/audiobrowser/util/Automotive.kt +2 -4
  91. package/android/src/main/java/com/audiobrowser/util/BatteryOptimizationHelper.kt +3 -9
  92. package/android/src/main/java/com/audiobrowser/util/BatteryWarningStore.kt +4 -14
  93. package/android/src/main/java/com/audiobrowser/util/BrowserPathHelper.kt +21 -85
  94. package/android/src/main/java/com/audiobrowser/util/CoilArtworkLoader.kt +7 -7
  95. package/android/src/main/java/com/audiobrowser/util/CoilArtworkLoaderHolder.kt +5 -8
  96. package/android/src/main/java/com/audiobrowser/util/CoilBitmapLoader.kt +8 -24
  97. package/android/src/main/java/com/audiobrowser/util/EqualizerManager.kt +7 -39
  98. package/android/src/main/java/com/audiobrowser/util/MediaExtrasBuilder.kt +10 -14
  99. package/android/src/main/java/com/audiobrowser/util/MetadataAdapter.kt +5 -9
  100. package/android/src/main/java/com/audiobrowser/util/NetworkConnectivityMonitor.kt +5 -9
  101. package/android/src/main/java/com/audiobrowser/util/OutputMonitor.kt +21 -50
  102. package/android/src/main/java/com/audiobrowser/util/OutputSwitcher.kt +7 -20
  103. package/android/src/main/java/com/audiobrowser/util/PlayingStateFactory.kt +3 -5
  104. package/android/src/main/java/com/audiobrowser/util/RatingFavorites.kt +4 -5
  105. package/android/src/main/java/com/audiobrowser/util/StyleWire.kt +5 -5
  106. package/android/src/main/java/com/audiobrowser/util/SvgArtworkRenderer.kt +5 -9
  107. package/android/src/main/java/com/audiobrowser/util/SystemVolumeMonitor.kt +6 -9
  108. package/android/src/main/java/com/audiobrowser/util/TrackFactory.kt +25 -47
  109. package/android/src/nocast/java/com/audiobrowser/cast/CastSupport.kt +0 -2
  110. package/android/src/test/java/com/audiobrowser/ForegroundStartTest.kt +1 -2
  111. package/android/src/test/java/com/audiobrowser/LegacyRatingTest.kt +3 -3
  112. package/android/src/test/java/com/audiobrowser/ServiceBindingTest.kt +0 -13
  113. package/android/src/test/java/com/audiobrowser/ServiceTaskRemovedTest.kt +2 -3
  114. package/android/src/test/java/com/audiobrowser/TestFixtures.kt +5 -14
  115. package/android/src/test/java/com/audiobrowser/browser/BrowseArtworkRegistryTest.kt +1 -1
  116. package/android/src/test/java/com/audiobrowser/browser/BrowserManagerBuildApiRequestTest.kt +2 -8
  117. package/android/src/test/java/com/audiobrowser/browser/BrowserManagerFavoritesTest.kt +2 -12
  118. package/android/src/test/java/com/audiobrowser/browser/BrowserManagerLayerResolutionTest.kt +5 -28
  119. package/android/src/test/java/com/audiobrowser/browser/BrowserManagerTest.kt +11 -43
  120. package/android/src/test/java/com/audiobrowser/browser/BrowserUrlResolutionTest.kt +4 -13
  121. package/android/src/test/java/com/audiobrowser/browser/InertStyleDiagnosticTest.kt +2 -11
  122. package/android/src/test/java/com/audiobrowser/browser/JsonArtworkTest.kt +0 -2
  123. package/android/src/test/java/com/audiobrowser/browser/JsonStyleTest.kt +3 -8
  124. package/android/src/test/java/com/audiobrowser/browser/SectionScopeTest.kt +2 -14
  125. package/android/src/test/java/com/audiobrowser/browser/SimpleRouterTest.kt +1 -5
  126. package/android/src/test/java/com/audiobrowser/browser/StyleResolverTest.kt +2 -13
  127. package/android/src/test/java/com/audiobrowser/extension/TappedTrackTest.kt +1 -7
  128. package/android/src/test/java/com/audiobrowser/extension/TrackIdentityTest.kt +0 -5
  129. package/android/src/test/java/com/audiobrowser/http/RequestConfigBuilderTest.kt +8 -16
  130. package/android/src/test/java/com/audiobrowser/model/IcyTitleTest.kt +1 -1
  131. package/android/src/test/java/com/audiobrowser/player/BrowseTilesTest.kt +12 -29
  132. package/android/src/test/java/com/audiobrowser/player/CapabilityControlsTest.kt +3 -12
  133. package/android/src/test/java/com/audiobrowser/player/CrossOriginHeaderStripperTest.kt +0 -7
  134. package/android/src/test/java/com/audiobrowser/player/DynamicLoadControlTest.kt +0 -1
  135. package/android/src/test/java/com/audiobrowser/player/EqualizerControllerTest.kt +0 -9
  136. package/android/src/test/java/com/audiobrowser/player/LiveSeekCommandTest.kt +1 -2
  137. package/android/src/test/java/com/audiobrowser/player/MediaSessionSlotMappingTest.kt +0 -9
  138. package/android/src/test/java/com/audiobrowser/player/NowPlayingUpdaterTest.kt +15 -22
  139. package/android/src/test/java/com/audiobrowser/player/PlaybackErrorClassifierTest.kt +1 -24
  140. package/android/src/test/java/com/audiobrowser/player/PlaybackStateMachineTest.kt +0 -20
  141. package/android/src/test/java/com/audiobrowser/player/PlaybackStateStoreTrackJsonTest.kt +1 -6
  142. package/android/src/test/java/com/audiobrowser/player/PlaybackTimerTest.kt +2 -4
  143. package/android/src/test/java/com/audiobrowser/player/PlayerCastTest.kt +2 -2
  144. package/android/src/test/java/com/audiobrowser/player/PlayerEngineFactoryTest.kt +0 -3
  145. package/android/src/test/java/com/audiobrowser/player/PlayerInvalidTrackTest.kt +0 -1
  146. package/android/src/test/java/com/audiobrowser/player/PlayerSetupTest.kt +3 -2
  147. package/android/src/test/java/com/audiobrowser/player/PlayerSonosTest.kt +5 -1
  148. package/android/src/test/java/com/audiobrowser/player/PlayerSuppressionTest.kt +5 -7
  149. package/android/src/test/java/com/audiobrowser/player/RetryLoadErrorHandlingPolicyTest.kt +4 -35
  150. package/android/src/test/java/com/audiobrowser/player/SessionErrorMaskTest.kt +0 -5
  151. package/android/src/test/java/com/audiobrowser/player/ShuffleOrderLedByTest.kt +1 -8
  152. package/android/src/test/java/com/audiobrowser/player/StandardSkipTest.kt +4 -6
  153. package/android/src/test/java/com/audiobrowser/player/StuckRecoveryPolicyTest.kt +11 -11
  154. package/android/src/test/java/com/audiobrowser/player/TransformingDataSourceTest.kt +2 -23
  155. package/android/src/test/java/com/audiobrowser/remote/FakeRemote.kt +9 -10
  156. package/android/src/test/java/com/audiobrowser/remote/RemoteSwitchingPlayerTest.kt +0 -1
  157. package/android/src/test/java/com/audiobrowser/sonos/DeviceDescriptionParserTest.kt +1 -3
  158. package/android/src/test/java/com/audiobrowser/sonos/DidlLiteTest.kt +0 -1
  159. package/android/src/test/java/com/audiobrowser/sonos/SoapClientTest.kt +0 -3
  160. package/android/src/test/java/com/audiobrowser/sonos/SoapEnvelopesTest.kt +0 -1
  161. package/android/src/test/java/com/audiobrowser/sonos/SoapResponseParserTest.kt +0 -1
  162. package/android/src/test/java/com/audiobrowser/sonos/SonosDiscovererTest.kt +2 -0
  163. package/android/src/test/java/com/audiobrowser/sonos/SonosPlayerTest.kt +0 -1
  164. package/android/src/test/java/com/audiobrowser/sonos/SonosRemoteTest.kt +1 -1
  165. package/android/src/test/java/com/audiobrowser/sonos/SonosRoutesTest.kt +2 -0
  166. package/android/src/test/java/com/audiobrowser/sonos/SonosTransportTest.kt +2 -6
  167. package/android/src/test/java/com/audiobrowser/sonos/SsdpMessagesTest.kt +0 -2
  168. package/android/src/test/java/com/audiobrowser/tls/AiaCertChaserTest.kt +13 -37
  169. package/android/src/test/java/com/audiobrowser/tls/AiaChasingTrustManagerTest.kt +10 -24
  170. package/android/src/test/java/com/audiobrowser/tls/CachingCertificateFetcherCallSiteTest.kt +15 -39
  171. package/android/src/test/java/com/audiobrowser/tls/CachingCertificateFetcherTest.kt +4 -10
  172. package/android/src/test/java/com/audiobrowser/util/ArtworkContentProviderTest.kt +2 -11
  173. package/android/src/test/java/com/audiobrowser/util/ArtworkUrisTest.kt +0 -1
  174. package/android/src/test/java/com/audiobrowser/util/BrowserPathHelperTest.kt +0 -4
  175. package/android/src/test/java/com/audiobrowser/util/CoilArtworkLoaderHolderTest.kt +1 -1
  176. package/android/src/test/java/com/audiobrowser/util/CoilArtworkLoaderTest.kt +0 -5
  177. package/android/src/test/java/com/audiobrowser/util/FakeImageLoader.kt +2 -2
  178. package/android/src/test/java/com/audiobrowser/util/MediaExtrasBuilderTest.kt +4 -12
  179. package/android/src/test/java/com/audiobrowser/util/OutputMonitorTest.kt +1 -1
  180. package/android/src/test/java/com/audiobrowser/util/PlayingStateFactoryTest.kt +0 -4
  181. package/android/src/test/java/com/audiobrowser/util/TrackFactoryBrowseTest.kt +1 -1
  182. package/android/src/test/java/com/audiobrowser/util/TrackFactoryMediaIdTest.kt +4 -6
  183. package/android/src/testCast/java/com/audiobrowser/cast/CastEndsTest.kt +1 -1
  184. package/android/src/testCast/java/com/audiobrowser/cast/SendingMediaItemConverterTest.kt +1 -0
  185. package/ios/AVPlayerEngine.swift +13 -21
  186. package/ios/AVPlayerEngineCallbacks.swift +2 -4
  187. package/ios/Browser/BrowseGate.swift +7 -8
  188. package/ios/Browser/BrowserConfig.swift +19 -34
  189. package/ios/Browser/BrowserError.swift +0 -1
  190. package/ios/Browser/BrowserManager.swift +29 -75
  191. package/ios/Browser/BrowserPathHelper.swift +13 -93
  192. package/ios/Browser/FavoriteSet.swift +7 -10
  193. package/ios/Browser/InertStyleDiagnostic.swift +17 -82
  194. package/ios/Browser/JsonModels.swift +11 -51
  195. package/ios/Browser/NavigationErrorState.swift +3 -2
  196. package/ios/Browser/PageResolver.swift +13 -23
  197. package/ios/Browser/RequestLayer.swift +16 -20
  198. package/ios/Browser/RequestPipeline.swift +33 -43
  199. package/ios/Browser/SearchDrillIn.swift +7 -13
  200. package/ios/Browser/SectionScope.swift +14 -26
  201. package/ios/Browser/SimpleRouter.swift +8 -15
  202. package/ios/Browser/StyleResolver.swift +12 -29
  203. package/ios/Browser/TabBarEntries.swift +6 -11
  204. package/ios/Browser/TrackIdTemplate.swift +6 -14
  205. package/ios/CarPlay/CPInterfaceController+Safe.swift +19 -28
  206. package/ios/CarPlay/CarPlayArtworkResolver.swift +5 -9
  207. package/ios/CarPlay/CarPlayController.swift +4 -4
  208. package/ios/CarPlay/CarPlayImageLoader.swift +11 -26
  209. package/ios/CarPlay/CarPlayListItemFactory.swift +30 -80
  210. package/ios/CarPlay/CarPlayNowPlayingManager.swift +19 -54
  211. package/ios/CarPlay/CarPlaySession+Navigator.swift +10 -10
  212. package/ios/CarPlay/CarPlaySession+PageLoader.swift +6 -5
  213. package/ios/CarPlay/CarPlaySession+Refresher.swift +2 -2
  214. package/ios/CarPlay/CarPlaySession+TabBar.swift +19 -26
  215. package/ios/CarPlay/CarPlaySession.swift +13 -17
  216. package/ios/CarPlay/CarPlayTemplates.swift +6 -7
  217. package/ios/CarPlay/IntentHandlers.swift +3 -5
  218. package/ios/CarPlay/MediaIntentCriteria.swift +15 -29
  219. package/ios/CarPlay/MediaIntentHandler.swift +4 -7
  220. package/ios/CarPlay/MediaIntentPlayback.swift +9 -8
  221. package/ios/CarPlay/NowPlayingButtonRules.swift +3 -4
  222. package/ios/CarPlay/SectionPresentation.swift +18 -28
  223. package/ios/CarPlay/TopTemplateReplacer.swift +8 -9
  224. package/ios/Extension/Capability+RemoteCommand.swift +3 -3
  225. package/ios/Extension/ChapterMetadata+AVFoundation.swift +2 -5
  226. package/ios/Extension/CxxVectorConformances.swift +4 -16
  227. package/ios/Extension/NavigationError+Conversion.swift +4 -7
  228. package/ios/Extension/PlayerCapabilities+Favorite.swift +0 -1
  229. package/ios/Extension/RequestConfig+Copying.swift +2 -6
  230. package/ios/Extension/ResolvedTrack+Copying.swift +2 -8
  231. package/ios/Extension/SearchParams+Query.swift +4 -4
  232. package/ios/Extension/Section+Copying.swift +3 -6
  233. package/ios/Extension/String+IcyCharset.swift +5 -5
  234. package/ios/Extension/TimedMetadata+AVFoundation.swift +6 -12
  235. package/ios/Extension/Track+AVPlayer.swift +1 -2
  236. package/ios/Extension/Track+Copying.swift +2 -8
  237. package/ios/Extension/Track+Identity.swift +4 -9
  238. package/ios/Extension/TrackMetadata+AVFoundation.swift +10 -13
  239. package/ios/Extension/UIApplication+ActiveScene.swift +6 -14
  240. package/ios/Extension/Variant+Artwork.swift +8 -22
  241. package/ios/Http/HttpClient.swift +3 -3
  242. package/ios/HybridAudioBrowser+Browser.swift +10 -16
  243. package/ios/HybridAudioBrowser+Options.swift +6 -9
  244. package/ios/HybridAudioBrowser+Player.swift +8 -16
  245. package/ios/HybridAudioBrowser+PlayerCallbacks.swift +4 -5
  246. package/ios/HybridAudioBrowser+Stubs.swift +5 -7
  247. package/ios/HybridAudioBrowser.swift +54 -79
  248. package/ios/Model/NitroTypeStubs.swift +15 -22
  249. package/ios/Model/PlayerUpdateOptions.swift +6 -21
  250. package/ios/Model/RemoteCommand.swift +2 -2
  251. package/ios/Model/TrackPlayerError.swift +9 -22
  252. package/ios/NowPlayingInfo/NowPlayingInfoController.swift +21 -40
  253. package/ios/NowPlayingInfo/SilentAudioPrimer.swift +10 -16
  254. package/ios/Observer/ItemObserver.swift +7 -5
  255. package/ios/Observer/PlayerObserver.swift +5 -5
  256. package/ios/PlaybackEvent.swift +2 -2
  257. package/ios/Player/AirPlayStallJudgement.swift +7 -9
  258. package/ios/Player/AudioSessionController.swift +14 -15
  259. package/ios/Player/DeferredSeek.swift +2 -2
  260. package/ios/Player/EndOfTrackJudgement.swift +6 -13
  261. package/ios/Player/ErrorStatus.swift +8 -7
  262. package/ios/Player/MediaLoader.swift +20 -24
  263. package/ios/Player/NowPlayingLines.swift +1 -4
  264. package/ios/Player/NowPlayingUpdater.swift +35 -61
  265. package/ios/Player/PersistedPlaybackState.swift +1 -2
  266. package/ios/Player/PlaybackFailure.swift +20 -24
  267. package/ios/Player/PlaybackPersistence.swift +5 -6
  268. package/ios/Player/PlaybackStateMachine.swift +8 -11
  269. package/ios/Player/PlaybackTimer.swift +8 -11
  270. package/ios/Player/Player.swift +6 -13
  271. package/ios/Player/PlayerEngine.swift +20 -20
  272. package/ios/Player/PlayerStatusTypes.swift +1 -2
  273. package/ios/Player/QueueManager.swift +23 -67
  274. package/ios/Player/RetryLoop.swift +39 -50
  275. package/ios/Player/ShuffleOrder.swift +17 -57
  276. package/ios/Player/SleepTimerManager.swift +13 -28
  277. package/ios/Player/VolumeFader.swift +16 -16
  278. package/ios/RemoteCommand/RemoteCommandCallbacks.swift +6 -16
  279. package/ios/RemoteCommand/RemoteCommandController.swift +8 -10
  280. package/ios/Tests/AirPlayStallJudgementTests.swift +4 -4
  281. package/ios/Tests/BrowserPathHelperTests.swift +3 -6
  282. package/ios/Tests/DeferredSeekTests.swift +1 -3
  283. package/ios/Tests/EmitterTests.swift +0 -1
  284. package/ios/Tests/EndOfTrackJudgementTests.swift +1 -6
  285. package/ios/Tests/FavoriteSetTests.swift +1 -0
  286. package/ios/Tests/GenerationMemoTests.swift +2 -2
  287. package/ios/Tests/InertStyleDiagnosticTests.swift +4 -10
  288. package/ios/Tests/JsonModelsTests.swift +5 -12
  289. package/ios/Tests/LRUCacheTests.swift +1 -5
  290. package/ios/Tests/MediaIntentCriteriaTests.swift +2 -7
  291. package/ios/Tests/MediaLoaderTests.swift +3 -12
  292. package/ios/Tests/ObserverTests.swift +3 -3
  293. package/ios/Tests/PlaybackErrorTests.swift +7 -9
  294. package/ios/Tests/PlaybackFailureTests.swift +9 -17
  295. package/ios/Tests/PlaybackPersistenceTests.swift +1 -0
  296. package/ios/Tests/PlaybackStateMachineTests.swift +1 -16
  297. package/ios/Tests/PlaybackTimerTests.swift +2 -3
  298. package/ios/Tests/PlayerPolicyTests.swift +10 -26
  299. package/ios/Tests/PlayerTests.swift +53 -88
  300. package/ios/Tests/PlayingStateTests.swift +0 -1
  301. package/ios/Tests/QueueManagerTests.swift +30 -80
  302. package/ios/Tests/RemoteCommandControllerTests.swift +5 -13
  303. package/ios/Tests/ResolvedTrackCopyingTests.swift +0 -2
  304. package/ios/Tests/RetryLoopTests.swift +12 -35
  305. package/ios/Tests/SearchDrillInTests.swift +4 -5
  306. package/ios/Tests/SectionPresentationTests.swift +3 -16
  307. package/ios/Tests/SectionScopeTests.swift +3 -6
  308. package/ios/Tests/SimpleRouterTests.swift +1 -5
  309. package/ios/Tests/SleepTimerManagerTests.swift +8 -11
  310. package/ios/Tests/StyleResolverTests.swift +4 -13
  311. package/ios/Tests/Support/ManualSleepTimerScheduler.swift +3 -8
  312. package/ios/Tests/Support/TestTypes.swift +5 -15
  313. package/ios/Tests/TabBarEntriesTests.swift +0 -2
  314. package/ios/Tests/TimedMetadataAVFoundationTests.swift +2 -3
  315. package/ios/Tests/TopTemplateReplacerTests.swift +1 -1
  316. package/ios/Tests/TrackIdTemplateTests.swift +2 -6
  317. package/ios/Tests/TrackMetadataAVFoundationTests.swift +1 -4
  318. package/ios/Tests/TrackSelectorTests.swift +3 -15
  319. package/ios/TrackSelector.swift +13 -25
  320. package/ios/Util/ArtworkFreshness.swift +6 -6
  321. package/ios/Util/ArtworkImageFetcher.swift +19 -20
  322. package/ios/Util/ConcurrentMap.swift +2 -2
  323. package/ios/Util/Emitter.swift +8 -13
  324. package/ios/Util/NetworkMonitor.swift +4 -6
  325. package/ios/Util/OutputPicker.swift +1 -1
  326. package/ios/Util/ReadyValue.swift +3 -2
  327. package/ios/Util/SFSymbolRenderer.swift +17 -30
  328. package/ios/Util/SVGProcessor.swift +5 -9
  329. package/package.json +1 -1
@@ -6,8 +6,8 @@ import androidx.media3.common.Player as MediaPlayer
6
6
  import androidx.media3.common.util.Util
7
7
 
8
8
  /**
9
- * The queue [RemoteSwitchingPlayer] keeps while remote: its items, each with a uid of its own, and
10
- * the current one. It plays in list order.
9
+ * The queue [RemoteSwitchingPlayer] keeps while remote, played in list order. Each item has a uid
10
+ * of its own that follows it through moves, so equal media items stay distinct playlist entries.
11
11
  */
12
12
  internal class RemoteQueue {
13
13
  private val itemList = mutableListOf<MediaItem>()
@@ -36,6 +36,7 @@ internal class RemoteQueue {
36
36
  index = if (newItems.isEmpty()) C.INDEX_UNSET else newIndex.coerceIn(0, newItems.size - 1)
37
37
  }
38
38
 
39
+ /** Inserts [newItems] at [at], clamped; in an empty queue, the first of them becomes current. */
39
40
  fun add(at: Int, newItems: List<MediaItem>) {
40
41
  val to = at.coerceIn(0, itemList.size)
41
42
  itemList.addAll(to, newItems)
@@ -46,7 +47,10 @@ internal class RemoteQueue {
46
47
  }
47
48
  }
48
49
 
49
- /** Removes the items from [fromIndex] to [toIndex]; true when the current one went with them. */
50
+ /**
51
+ * Removes the items from [fromIndex] to [toIndex]; true when the current one went with them, and
52
+ * then the item after them, or else the last, is current.
53
+ */
50
54
  fun remove(fromIndex: Int, toIndex: Int): Boolean {
51
55
  val to = toIndex.coerceAtMost(itemList.size)
52
56
  val removesCurrent = index in fromIndex until to
@@ -64,7 +68,8 @@ internal class RemoteQueue {
64
68
 
65
69
  /**
66
70
  * Puts [newItems] in place of the items from [fromIndex] to [toIndex]. True when the current item
67
- * is now another media; a restamp of its metadata alone is not.
71
+ * is now another media: for a same-length replacement, by media id or uri, so a restamp of its
72
+ * metadata alone is not; otherwise whenever the range held the current item.
68
73
  */
69
74
  fun replace(fromIndex: Int, toIndex: Int, newItems: List<MediaItem>): Boolean {
70
75
  val to = toIndex.coerceAtMost(itemList.size)
@@ -91,13 +96,15 @@ internal class RemoteQueue {
91
96
  index = uidList.indexOf(current)
92
97
  }
93
98
 
99
+ /** Throws when no item is at [newIndex]. */
94
100
  fun moveTo(newIndex: Int) {
95
101
  require(newIndex in itemList.indices) { "No item at $newIndex" }
96
102
  index = newIndex
97
103
  }
98
104
 
99
105
  /**
100
- * The item that follows the current one at its end, or [C.INDEX_UNSET] at the end of the queue.
106
+ * The item that plays when the current one ends under [repeatMode], or [C.INDEX_UNSET] when
107
+ * playback stops.
101
108
  */
102
109
  fun nextAtEnd(repeatMode: Int): Int =
103
110
  when {
@@ -21,17 +21,15 @@ import timber.log.Timber
21
21
  * The session's player while remote outputs are on: the local player while none of the remotes has
22
22
  * a session, else the receiver of the first that has, carrying the queue, position, play intent,
23
23
  * repeat and shuffle across each move.
24
- * - The phone plays on while the current item is resolved for the receiver ([resolve]).
25
- * - While remote, this side owns the queue: it shows changes at once, and sends the receiver one
26
- * item at a time, moving on when the receiver reports the item's end. An edit that leaves the
27
- * current item in place doesn't reach the receiver. The shuffle mode is kept, but the queue plays
28
- * in list order (radio-garden/react-native-audio-browser#210).
29
- * - Moving between remotes, or to a remote's new session, goes straight from receiver to receiver.
30
- * - A receiver's failure to play is the player error, which [prepare] clears by loading the item
31
- * again; so is an item the receiver hasn't started within [startTimeoutMs] of being sent or
32
- * played: holding it ready when paused, playing it when not. [stop] stops the receiver; [prepare]
33
- * loads the item there again.
34
- * - [setVolume] is the receiver's device volume while remote.
24
+ * - The phone plays on until the current item is resolved for the receiver ([resolve]).
25
+ * - While remote, this side owns the queue: it shows edits at once, and sends the receiver one item
26
+ * at a time, moving on at the receiver's end. An edit that leaves the current item in place
27
+ * doesn't reach the receiver. Shuffle is kept, but the queue plays in list order
28
+ * (radio-garden/react-native-audio-browser#210).
29
+ * - Moving between remotes, or to a remote's new session, goes from receiver to receiver.
30
+ * - A receiver's failure, or an item it hasn't started within [startTimeoutMs] of being sent or
31
+ * played, is the player error until [prepare] loads the item again. [stop] stops the receiver.
32
+ * - [setVolume] sets the receiver's device volume while remote.
35
33
  */
36
34
  internal class RemoteSwitchingPlayer(
37
35
  local: MediaPlayer,
@@ -47,6 +45,7 @@ internal class RemoteSwitchingPlayer(
47
45
  private var remotes: List<RemotePlayback> = emptyList()
48
46
  private var route: Route = Route.Local
49
47
 
48
+ /** False while a handover resolves: the phone still plays. */
50
49
  val isRemote: Boolean
51
50
  get() = route is Route.Remote
52
51
 
@@ -58,7 +57,7 @@ internal class RemoteSwitchingPlayer(
58
57
  private sealed interface Route {
59
58
  data object Local : Route
60
59
 
61
- /** The phone plays on while the current item is resolved for [target]'s receiver. */
60
+ /** The phone plays on while the current item resolves for [target]'s receiver. */
62
61
  class HandingOver(val target: RemotePlayback, val job: Job) : Route
63
62
 
64
63
  class Remote(val output: RemotePlayback, val receiver: MediaPlayer) : Route {
@@ -72,22 +71,16 @@ internal class RemoteSwitchingPlayer(
72
71
 
73
72
  /** Where the receiver is with the current item. */
74
73
  private sealed interface Load {
75
- /**
76
- * Nothing loaded there: not prepared, stopped, or an empty queue. Prepare loads from
77
- * [positionMs].
78
- */
74
+ /** Nothing loaded there: unprepared, stopped, or no queue. Prepare loads from [positionMs]. */
79
75
  class Idle(val positionMs: Long) : Load
80
76
 
81
- /**
82
- * The item is resolved for the receiver; until then, the receiver's reports are the last
83
- * item's.
84
- */
77
+ /** The item resolves for the receiver; until then, its reports are the last item's. */
85
78
  class Resolving(val job: Job, val positionMs: Long) : Load
86
79
 
87
- /** [item] went to the receiver, which hasn't reported it yet. */
80
+ /** [item] went to the receiver, which doesn't report holding it yet. */
88
81
  class Sent(val item: MediaItem, val positionMs: Long) : Load
89
82
 
90
- /** The receiver has [item]: what it reports is the current item's. */
83
+ /** The receiver holds [item]: what it reports is the current item's. */
91
84
  class Playing(val item: MediaItem) : Load
92
85
 
93
86
  class Failed(val error: PlaybackException, val positionMs: Long) : Load
@@ -100,16 +93,12 @@ internal class RemoteSwitchingPlayer(
100
93
  setRemotes(remotes)
101
94
  }
102
95
 
103
- /** Puts [newLocal] in the local player's place, and plays on it unless remote. */
104
96
  fun setLocal(newLocal: MediaPlayer) {
105
97
  local = newLocal
106
98
  if (!isRemote) setPlayer(newLocal)
107
99
  }
108
100
 
109
- /**
110
- * Plays on [newRemotes] from now on: a remote that stays keeps its session and what it plays, one
111
- * that goes is released.
112
- */
101
+ /** A remote that stays keeps its session and what it plays; one that goes is released. */
113
102
  fun setRemotes(newRemotes: List<RemotePlayback>) {
114
103
  val gone = remotes.filter { it !in newRemotes }
115
104
  remotes = newRemotes
@@ -150,7 +139,6 @@ internal class RemoteSwitchingPlayer(
150
139
  }
151
140
  }
152
141
 
153
- /** Plays on [remote]'s receiver from now on, with [load] where it is with the current item. */
154
142
  private fun enter(remote: Route.Remote, load: Load) {
155
143
  remote.load = load
156
144
  route = remote
@@ -159,9 +147,8 @@ internal class RemoteSwitchingPlayer(
159
147
  }
160
148
 
161
149
  /**
162
- * Lets go of [remote]'s receiver: its load is cut short and the receiver stopped. Call it after
163
- * [setPlayer] has moved off the receiver: removing a listener delivers its pending events, and
164
- * the stop's would show the receiver's own state.
150
+ * Call after [setPlayer] has moved off the receiver: removing the listener delivers its pending
151
+ * events, and the stop's would show the receiver's own state.
165
152
  */
166
153
  private fun leave(remote: Route.Remote) {
167
154
  cancelLoad(remote)
@@ -197,7 +184,7 @@ internal class RemoteSwitchingPlayer(
197
184
  Route.HandingOver(
198
185
  target,
199
186
  scope.launch {
200
- // The phone plays on, and can move to another item, while the current one resolves.
187
+ // The phone plays on meanwhile, and may move to another item: resolve that one instead.
201
188
  var item: MediaItem?
202
189
  var resolved: Result<MediaItem>?
203
190
  do {
@@ -230,7 +217,7 @@ internal class RemoteSwitchingPlayer(
230
217
  invalidateState()
231
218
  }
232
219
 
233
- /** Moves what plays from [from]'s receiver to [to]'s, without the phone in between. */
220
+ /** Goes straight from [from]'s receiver to [to]'s, without the phone in between. */
234
221
  private fun moveTo(from: Route.Remote, to: RemotePlayback) {
235
222
  val positionMs = positionOn(from)
236
223
  val load = from.load
@@ -244,7 +231,7 @@ internal class RemoteSwitchingPlayer(
244
231
 
245
232
  private fun handOverToLocal(from: Route.Remote) {
246
233
  val positionMs = positionOn(from)
247
- // A failure is the receiver's: the phone still plays the item.
234
+ // After a receiver's failure the phone still plays the item.
248
235
  val prepared = from.load !is Load.Idle && from.load !is Load.Ended
249
236
  local.repeatMode = repeat
250
237
  local.shuffleModeEnabled = shuffle
@@ -257,7 +244,7 @@ internal class RemoteSwitchingPlayer(
257
244
  leave(from)
258
245
  }
259
246
 
260
- /** Where the current item is on [remote]'s receiver, for the next player to go on from. */
247
+ /** Where the next player goes on from; [C.TIME_UNSET] for the item's default position. */
261
248
  private fun positionOn(remote: Route.Remote): Long =
262
249
  when (val load = remote.load) {
263
250
  is Load.Idle -> load.positionMs
@@ -275,9 +262,7 @@ internal class RemoteSwitchingPlayer(
275
262
  disarmStart(remote)
276
263
  }
277
264
 
278
- /**
279
- * Fails the current item unless [remote]'s receiver has [started] it within the start timeout.
280
- */
265
+ /** Fails the current item unless the receiver has [started] it within [startTimeoutMs]. */
281
266
  private fun armStart(remote: Route.Remote) {
282
267
  disarmStart(remote)
283
268
  remote.reportedPlaying = false
@@ -302,7 +287,7 @@ internal class RemoteSwitchingPlayer(
302
287
  remote.startTimeout = null
303
288
  }
304
289
 
305
- /** A receiver whose session already ended refuses commands: it stops by itself. */
290
+ /** A receiver whose session already ended refuses commands; it has stopped by itself. */
306
291
  private fun stopReceiver(receiver: MediaPlayer) {
307
292
  try {
308
293
  receiver.stop()
@@ -311,7 +296,6 @@ internal class RemoteSwitchingPlayer(
311
296
  }
312
297
  }
313
298
 
314
- /** Loads the current item on [remote]'s receiver from [positionMs], once it is resolved. */
315
299
  private fun load(remote: Route.Remote, positionMs: Long) {
316
300
  cancelLoad(remote)
317
301
  val item = queue.current
@@ -370,8 +354,8 @@ internal class RemoteSwitchingPlayer(
370
354
  }
371
355
 
372
356
  /**
373
- * Whether [remote]'s receiver holds the item sent and has started it: reported it playing, or
374
- * holds it ready while paused.
357
+ * Whether the receiver holds the item sent and has started it: reported it playing, or holds it
358
+ * ready while paused.
375
359
  */
376
360
  private fun started(remote: Route.Remote): Boolean {
377
361
  val load = remote.load as? Load.Playing ?: return false
@@ -430,7 +414,6 @@ internal class RemoteSwitchingPlayer(
430
414
  invalidateState()
431
415
  }
432
416
 
433
- /** Whether [remote]'s receiver reports [item] as its own. */
434
417
  private fun receiverHolds(remote: Route.Remote, item: MediaItem) =
435
418
  remote.receiver.currentMediaItem === item
436
419
 
@@ -653,10 +636,7 @@ internal class RemoteSwitchingPlayer(
653
636
  }
654
637
  }
655
638
 
656
- /**
657
- * Brings playback back to the local player if remote, and lets go of the remotes. The local
658
- * player stays with its owner, unreleased.
659
- */
639
+ /** Brings playback back to the local player, which stays unreleased, and releases the remotes. */
660
640
  override fun handleRelease(): ListenableFuture<*> {
661
641
  (route as? Route.HandingOver)?.job?.cancel()
662
642
  if (route is Route.HandingOver) route = Route.Local
@@ -670,7 +650,7 @@ internal class RemoteSwitchingPlayer(
670
650
  private fun done() = Futures.immediateVoidFuture()
671
651
 
672
652
  private companion object {
673
- // Available from the queue this side keeps, whatever the receiver's own.
653
+ // Served from the queue this side keeps, whatever the receiver offers.
674
654
  val QUEUE_COMMANDS =
675
655
  intArrayOf(
676
656
  MediaPlayer.COMMAND_PLAY_PAUSE,
@@ -3,7 +3,7 @@ package com.audiobrowser.sonos
3
3
  import org.w3c.dom.Element
4
4
  import org.w3c.dom.Node
5
5
 
6
- /** A discovered Sonos speaker: its identity, its name, and the absolute control URLs. */
6
+ /** A discovered Sonos speaker; its control URLs are absolute. */
7
7
  internal data class SonosDevice(
8
8
  val udn: String,
9
9
  val name: String,
@@ -13,22 +13,22 @@ internal data class SonosDevice(
13
13
  val zoneGroupTopologyControlUrl: String?,
14
14
  )
15
15
 
16
- /**
17
- * Parses a UPnP `device_description.xml` (fetched from an SSDP `LOCATION`) into a [SonosDevice].
18
- * Sonos nests its services under embedded devices, so the whole device tree is searched. Returns
19
- * null for a non-Sonos device, malformed XML, or a description without `AVTransport` and
20
- * `GroupRenderingControl`; `ZoneGroupTopology` is optional.
21
- */
22
16
  internal object DeviceDescriptionParser {
23
17
  private const val SONOS_MANUFACTURER = "Sonos, Inc."
24
18
  private const val AV_TRANSPORT = "urn:schemas-upnp-org:service:AVTransport:1"
25
19
  private const val GROUP_RENDERING_CONTROL = "urn:schemas-upnp-org:service:GroupRenderingControl:1"
26
20
  private const val ZONE_GROUP_TOPOLOGY = "urn:schemas-upnp-org:service:ZoneGroupTopology:1"
27
21
 
22
+ /**
23
+ * Parses a UPnP device description fetched from an SSDP `LOCATION` header, which is [location].
24
+ * Returns null for malformed XML, a non-Sonos device, or one without a UDN, `AVTransport` or
25
+ * `GroupRenderingControl`; `ZoneGroupTopology` is optional. The name is `roomName`, falling back
26
+ * to `friendlyName`.
27
+ */
28
28
  fun parse(xml: String, location: String): SonosDevice? {
29
29
  val doc = parseSpeakerXml(xml) ?: return null
30
30
 
31
- // From the root <device>, the direct child of <root>, not the first <device> in the document.
31
+ // The root <device> is the direct child of <root>, not the first <device> in the document.
32
32
  val docElement = doc.documentElement ?: return null
33
33
  val root = directChildElement(docElement, "device") ?: return null
34
34
  if (!childText(root, "manufacturer").equals(SONOS_MANUFACTURER, ignoreCase = true)) return null
@@ -38,8 +38,7 @@ internal object DeviceDescriptionParser {
38
38
  }
39
39
  val name = childText(root, "roomName").ifBlank { childText(root, "friendlyName") }
40
40
 
41
- // UPnP allows an explicit <URLBase>; when present it overrides the retrieval location for
42
- // resolving relative control URLs.
41
+ // A <URLBase>, when present, overrides [location] for resolving relative control URLs.
43
42
  val baseUrl =
44
43
  childText(docElement, "URLBase").ifBlank { "" }.trimEnd('/').ifBlank { baseUrlOf(location) }
45
44
  ?: return null
@@ -56,15 +55,12 @@ internal object DeviceDescriptionParser {
56
55
  )
57
56
  }
58
57
 
59
- /**
60
- * Finds the first `<service>` anywhere in the tree with [serviceType] and returns its absolute
61
- * control URL, or null if absent.
62
- */
63
58
  private fun findControlUrl(
64
59
  doc: org.w3c.dom.Document,
65
60
  serviceType: String,
66
61
  baseUrl: String,
67
62
  ): String? {
63
+ // Sonos nests its services under embedded devices, so search the whole tree.
68
64
  val services = doc.getElementsByTagName("service")
69
65
  for (i in 0 until services.length) {
70
66
  val service = services.item(i) as? Element ?: continue
@@ -79,7 +75,6 @@ internal object DeviceDescriptionParser {
79
75
  return null
80
76
  }
81
77
 
82
- /** The scheme://host:port prefix of a URL, or null if it has none. */
83
78
  private fun baseUrlOf(url: String): String? {
84
79
  val schemeEnd = url.indexOf("://")
85
80
  if (schemeEnd < 0) return null
@@ -95,13 +90,10 @@ internal object DeviceDescriptionParser {
95
90
  else -> "$baseUrl/$control"
96
91
  }
97
92
 
98
- /**
99
- * Direct-child element text by tag name (first match), or "" — avoids matching nested devices.
100
- */
101
93
  private fun childText(parent: Element, tag: String): String =
102
94
  directChildElement(parent, tag)?.textContent?.trim() ?: ""
103
95
 
104
- /** The first direct-child [Element] with the given tag name, or null. */
96
+ // Direct children only: embedded devices carry their own manufacturer, UDN and names.
105
97
  private fun directChildElement(parent: Element, tag: String): Element? {
106
98
  var node: Node? = parent.firstChild
107
99
  while (node != null) {
@@ -1,8 +1,8 @@
1
1
  package com.audiobrowser.sonos
2
2
 
3
3
  /**
4
- * Builds the DIDL-Lite metadata Sonos takes as `SetAVTransportURI`'s `CurrentURIMetaData`. Blank
5
- * fields are left out.
4
+ * Builds the DIDL-Lite metadata Sonos takes as `SetAVTransportURI`'s `CurrentURIMetaData`. Optional
5
+ * fields that are null or blank are left out.
6
6
  */
7
7
  internal object DidlLite {
8
8
  private const val HEADER =
@@ -7,8 +7,8 @@ import okhttp3.Request
7
7
  import okhttp3.RequestBody.Companion.toRequestBody
8
8
 
9
9
  /**
10
- * The HTTP client for the speakers, which answer on the local network within moments: a speaker
11
- * that doesn't is gone, and waiting OkHttp's default 10 s per call would hold up every command.
10
+ * The HTTP client for the speakers. Its timeouts are short: a speaker on the local network that
11
+ * doesn't answer within seconds is gone, and OkHttp's default 10 s would hold up every command.
12
12
  */
13
13
  internal val sonosHttpClient: OkHttpClient by lazy {
14
14
  OkHttpClient.Builder()
@@ -18,13 +18,13 @@ internal val sonosHttpClient: OkHttpClient by lazy {
18
18
  .build()
19
19
  }
20
20
 
21
- /** Thrown when a SOAP control call fails (non-2xx HTTP or a SOAP fault). */
21
+ /** Thrown when a SOAP control call gets a non-2xx response, with the SOAP fault if it held one. */
22
22
  internal class SoapException(message: String, val httpCode: Int?, val fault: SoapFault?) :
23
23
  Exception(message)
24
24
 
25
25
  /**
26
- * Posts UPnP SOAP actions to a control URL, blocking. Returns the response body, or throws
27
- * [SoapException] with any SOAP fault on a non-2xx response.
26
+ * Posts UPnP SOAP actions to a control URL, blocking the calling thread. Returns the response body,
27
+ * or throws [SoapException] on a non-2xx response.
28
28
  */
29
29
  internal class SoapClient(private val httpClient: OkHttpClient) {
30
30
  fun execute(controlUrl: String, action: SoapAction): String {
@@ -32,7 +32,7 @@ internal class SoapClient(private val httpClient: OkHttpClient) {
32
32
  val request =
33
33
  Request.Builder()
34
34
  .url(controlUrl)
35
- // UPnP requires the SOAPACTION value be wrapped in double quotes.
35
+ // UPnP requires the SOAPACTION value in double quotes.
36
36
  .header("SOAPACTION", "\"${action.soapAction}\"")
37
37
  .post(body)
38
38
  .build()
@@ -2,18 +2,15 @@ package com.audiobrowser.sonos
2
2
 
3
3
  import java.util.Locale
4
4
 
5
- /** A UPnP SOAP request: the `SOAPACTION` header value (service#action) and the XML body. */
5
+ /** A UPnP SOAP request; [soapAction] is the SOAPACTION header value, `service#action`, unquoted. */
6
6
  internal data class SoapAction(val soapAction: String, val body: String)
7
7
 
8
- /**
9
- * Builds the UPnP SOAP requests sent to a speaker. The DIDL metadata is a document escaped as the
10
- * text of `CurrentURIMetaData`.
11
- */
12
8
  internal object SoapEnvelopes {
13
9
  const val AV_TRANSPORT = "urn:schemas-upnp-org:service:AVTransport:1"
14
10
  const val GROUP_RENDERING_CONTROL = "urn:schemas-upnp-org:service:GroupRenderingControl:1"
15
11
  const val ZONE_GROUP_TOPOLOGY = "urn:schemas-upnp-org:service:ZoneGroupTopology:1"
16
12
 
13
+ /** [metadata] is the DIDL-Lite document as raw XML; it is escaped here into the element text. */
17
14
  fun setAvTransportUri(currentUri: String, metadata: String): SoapAction =
18
15
  action(
19
16
  AV_TRANSPORT,
@@ -30,7 +27,7 @@ internal object SoapEnvelopes {
30
27
 
31
28
  fun stop(): SoapAction = action(AV_TRANSPORT, "Stop", "<InstanceID>0</InstanceID>")
32
29
 
33
- /** Seeks within the current track, to [positionMs] rounded down to the second. */
30
+ /** Seeks within the current track to [positionMs], rounded down to the second; negative is 0. */
34
31
  fun seek(positionMs: Long): SoapAction {
35
32
  val seconds = positionMs.coerceAtLeast(0) / 1000
36
33
  val target =
@@ -53,7 +50,10 @@ internal object SoapEnvelopes {
53
50
 
54
51
  fun getZoneGroupState(): SoapAction = action(ZONE_GROUP_TOPOLOGY, "GetZoneGroupState", "")
55
52
 
56
- /** The volume of the coordinator's whole group, which is the room's own when it plays alone. */
53
+ /**
54
+ * Sets the volume of the coordinator's whole group, which is the room's own when it plays alone.
55
+ * [volume] is clamped to 0..100.
56
+ */
57
57
  fun setGroupVolume(volume: Int): SoapAction =
58
58
  action(
59
59
  GROUP_RENDERING_CONTROL,
@@ -77,7 +77,7 @@ internal object SoapEnvelopes {
77
77
  )
78
78
  }
79
79
 
80
- /** [s] as XML text or attribute content. */
80
+ /** [s] as XML text or attribute content, less the characters XML 1.0 cannot hold even escaped. */
81
81
  internal fun xmlEscape(s: String): String =
82
82
  s.replace(XML_FORBIDDEN, "")
83
83
  .replace("&", "&amp;")
@@ -88,5 +88,4 @@ internal fun xmlEscape(s: String): String =
88
88
  // mishandle.
89
89
  .replace("'", "&#39;")
90
90
 
91
- // The characters XML 1.0 has no place for, even escaped.
92
91
  private val XML_FORBIDDEN = Regex("[\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\uFFFE\\uFFFF]")
@@ -2,27 +2,26 @@ package com.audiobrowser.sonos
2
2
 
3
3
  import org.w3c.dom.Document
4
4
 
5
- /** A parsed UPnP SOAP fault (the `<UPnPError>` detail). */
6
5
  internal data class SoapFault(val errorCode: Int?, val errorDescription: String?)
7
6
 
8
- /** Parses the UPnP SOAP responses the speakers send. Each returns null when its field is absent. */
7
+ /**
8
+ * Reads the UPnP SOAP responses the speakers send. Apart from [fault], each reader returns null for
9
+ * a fault and for XML [parseSpeakerXml] refuses; for a field that is absent or empty, [position]
10
+ * nulls that field and the others return null.
11
+ */
9
12
  internal object SoapResponseParser {
10
- /** Parses a SOAP fault envelope into its UPnP error, or null when the response is not a fault. */
13
+ /** The UPnP error in a fault response, or null when the response is not a fault. */
11
14
  fun fault(xml: String): SoapFault? {
12
15
  val doc = parse(xml) ?: return null
13
16
  return faultOf(doc)
14
17
  }
15
18
 
16
- /**
17
- * The `<CurrentTransportState>` text from a `GetTransportInfo` response, or null (incl. faults).
18
- */
19
19
  fun transportState(xml: String): String? {
20
20
  val doc = parse(xml) ?: return null
21
21
  if (faultOf(doc) != null) return null
22
22
  return firstText(doc, "CurrentTransportState")
23
23
  }
24
24
 
25
- /** The `<CurrentVolume>` integer from a `GetGroupVolume` response, or null (incl. faults). */
26
25
  fun volume(xml: String): Int? {
27
26
  val doc = parse(xml) ?: return null
28
27
  if (faultOf(doc) != null) return null
@@ -31,7 +30,7 @@ internal object SoapResponseParser {
31
30
 
32
31
  /**
33
32
  * The title the speaker reads from the stream (ICY `StreamTitle`, or an HLS stream's ID3), as
34
- * `r:streamContent` in a `GetPositionInfo` response's `TrackMetaData`; null when there is none.
33
+ * `r:streamContent` in a `GetPositionInfo` response's `TrackMetaData`.
35
34
  */
36
35
  fun streamContent(xml: String): String? {
37
36
  val metadata = embeddedDocument(xml, "TrackMetaData") ?: return null
@@ -39,9 +38,8 @@ internal object SoapResponseParser {
39
38
  }
40
39
 
41
40
  /**
42
- * The position, duration and stream title from a `GetPositionInfo` response, or null (incl.
43
- * faults). A time the speaker doesn't report (`NOT_IMPLEMENTED`, or a live stream's empty
44
- * duration) is null.
41
+ * Reads a `GetPositionInfo` response. A time the speaker doesn't report (`NOT_IMPLEMENTED`, or a
42
+ * live stream's `0:00:00` duration) is null.
45
43
  */
46
44
  fun position(xml: String): SonosPosition? {
47
45
  val doc = parse(xml) ?: return null
@@ -53,14 +51,12 @@ internal object SoapResponseParser {
53
51
  )
54
52
  }
55
53
 
56
- /** The `<CurrentURI>` from a `GetMediaInfo` response, or null (incl. faults). */
57
54
  fun currentUri(xml: String): String? {
58
55
  val doc = parse(xml) ?: return null
59
56
  if (faultOf(doc) != null) return null
60
57
  return firstText(doc, "CurrentURI")
61
58
  }
62
59
 
63
- /** `H+:MM:SS` (with optional fractions) in milliseconds, or null for anything else. */
64
60
  private fun upnpTimeMs(time: String): Long? {
65
61
  val parts = time.split(':')
66
62
  if (parts.size != 3) return null
@@ -70,22 +66,19 @@ internal object SoapResponseParser {
70
66
  return (hours * 3600 + minutes * 60) * 1000 + (seconds * 1000).toLong()
71
67
  }
72
68
 
73
- /** The text of a SOAP response's [tag], itself an XML document escaped inside it. */
69
+ /** Parses the text of [tag], an XML document escaped inside the SOAP response. */
74
70
  internal fun embeddedDocument(xml: String, tag: String): Document? {
75
71
  val doc = parse(xml) ?: return null
76
72
  if (faultOf(doc) != null) return null
77
73
  return parse(firstText(doc, tag) ?: return null)
78
74
  }
79
75
 
80
- /** Reads a UPnP fault off an already-parsed document, or null when it is not a fault. */
81
76
  private fun faultOf(doc: Document): SoapFault? {
82
77
  if (!hasElement(doc, "Fault")) return null
83
78
  return SoapFault(firstText(doc, "errorCode")?.toIntOrNull(), firstText(doc, "errorDescription"))
84
79
  }
85
80
 
86
- /**
87
- * True if any element has the given local name, regardless of namespace prefix (`s:Fault`, …).
88
- */
81
+ // The parser is not namespace-aware, so a name keeps its prefix (`s:Fault`).
89
82
  private fun hasElement(doc: Document, localName: String): Boolean {
90
83
  val all = doc.getElementsByTagName("*")
91
84
  for (i in 0 until all.length) {
@@ -4,16 +4,15 @@ import okhttp3.OkHttpClient
4
4
  import okhttp3.Request
5
5
  import timber.log.Timber
6
6
 
7
- /** Runs an SSDP M-SEARCH and returns the raw responses. */
7
+ /** Runs an SSDP M-SEARCH and returns the raw responses. Blocking. */
8
8
  internal interface SsdpScanner {
9
9
  fun search(timeoutMs: Int = 3000, repeats: Int = 3): List<SsdpResponse>
10
10
  }
11
11
 
12
12
  /**
13
- * Finds the Sonos rooms on the local network: an SSDP search finds speakers, the first that answers
14
- * gives the household's group topology, and each group's coordinator gives its control URLs. Finds
15
- * none when the speakers refuse UPnP (HTTP 403, the user's switch in the Sonos app). Blocking: run
16
- * off the main thread.
13
+ * Finds the Sonos rooms on the local network: the first speaker that answers the SSDP search with
14
+ * its topology lists the household's groups, and each group's coordinator gives its control URLs.
15
+ * Blocking: run off the main thread.
17
16
  */
18
17
  internal class SonosDiscoverer(
19
18
  private val httpClient: OkHttpClient,
@@ -21,6 +20,10 @@ internal class SonosDiscoverer(
21
20
  ) {
22
21
  private val soap = SoapClient(httpClient)
23
22
 
23
+ /**
24
+ * The rooms, each at its coordinator; empty when no speaker gives its topology, as when the
25
+ * speakers refuse UPnP (HTTP 403, a switch in the Sonos app).
26
+ */
24
27
  fun discover(timeoutMs: Int = 3000): List<SonosRoom> {
25
28
  val locations = scanner.search(timeoutMs).map { it.location }.distinct()
26
29
  val groups = locations.firstNotNullOfOrNull { groupsFrom(it) } ?: return emptyList()
@@ -31,15 +34,12 @@ internal class SonosDiscoverer(
31
34
  }
32
35
  }
33
36
 
34
- /**
35
- * The groups the speaker at [location] reports, or null when it cannot be read or is a hidden
36
- * speaker, whose view can be missing groups.
37
- */
38
37
  private fun groupsFrom(location: String): List<SonosGroup>? {
39
38
  val device = fetchDevice(location) ?: return null
40
39
  val controlUrl = device.zoneGroupTopologyControlUrl ?: return null
41
40
  return try {
42
41
  val xml = soap.execute(controlUrl, SoapEnvelopes.getZoneGroupState())
42
+ // The hidden half of a stereo pair can leave its own pair out: ask the next speaker.
43
43
  if (ZoneGroupState.isHidden(xml, device.udn.removePrefix("uuid:"))) null
44
44
  else ZoneGroupState.parse(xml)
45
45
  } catch (e: Exception) {
@@ -52,7 +52,7 @@ internal class SonosDiscoverer(
52
52
  }
53
53
  }
54
54
 
55
- /** Fetches and parses a device description, or null on any HTTP or parse failure. */
55
+ /** The device description at [location], or null on any HTTP or parse failure. */
56
56
  fun fetchDevice(location: String): SonosDevice? {
57
57
  val xml =
58
58
  try {