@jellyfin/sdk 0.12.0 → 1.0.0

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 (759) hide show
  1. package/.nvmrc +1 -0
  2. package/.openapi-generator-ignore +2 -0
  3. package/CHANGELOG.md +40 -3
  4. package/README.md +55 -32
  5. package/eslint.config.mjs +118 -0
  6. package/lib/api.d.ts +33 -9
  7. package/lib/api.js +88 -26
  8. package/lib/constants.d.ts +11 -0
  9. package/lib/constants.js +13 -0
  10. package/lib/generated-client/api/{artists-api.d.ts → artist-api.d.ts} +38 -173
  11. package/lib/generated-client/api/{artists-api.js → artist-api.js} +39 -33
  12. package/lib/generated-client/api/audio-api.d.ts +295 -450
  13. package/lib/generated-client/api/audio-api.js +332 -64
  14. package/lib/generated-client/api/authentication-api.d.ts +517 -0
  15. package/lib/generated-client/api/authentication-api.js +870 -0
  16. package/lib/generated-client/api/backup-api.d.ts +0 -22
  17. package/lib/generated-client/api/backup-api.js +5 -11
  18. package/lib/generated-client/api/branding-api.d.ts +0 -9
  19. package/lib/generated-client/api/branding-api.js +4 -10
  20. package/lib/generated-client/api/{channels-api.d.ts → channel-api.d.ts} +32 -95
  21. package/lib/generated-client/api/{channels-api.js → channel-api.js} +35 -41
  22. package/lib/generated-client/api/collection-api.d.ts +0 -31
  23. package/lib/generated-client/api/collection-api.js +4 -10
  24. package/lib/generated-client/api/{devices-api.d.ts → device-api.d.ts} +48 -81
  25. package/lib/generated-client/api/{devices-api.js → device-api.js} +46 -54
  26. package/lib/generated-client/api/{display-preferences-api.d.ts → display-preference-api.d.ts} +20 -46
  27. package/lib/generated-client/api/{display-preferences-api.js → display-preference-api.js} +22 -28
  28. package/lib/generated-client/api/environment-api.d.ts +0 -60
  29. package/lib/generated-client/api/environment-api.js +6 -75
  30. package/lib/generated-client/api/filter-api.d.ts +0 -40
  31. package/lib/generated-client/api/filter-api.js +3 -9
  32. package/lib/generated-client/api/{genres-api.d.ts → genre-api.d.ts} +20 -72
  33. package/lib/generated-client/api/{genres-api.js → genre-api.js} +22 -28
  34. package/lib/generated-client/api/image-api.d.ts +4 -1007
  35. package/lib/generated-client/api/image-api.js +42 -48
  36. package/lib/generated-client/api/instant-mix-api.d.ts +8 -245
  37. package/lib/generated-client/api/instant-mix-api.js +16 -121
  38. package/lib/generated-client/api/item-lookup-api.d.ts +0 -65
  39. package/lib/generated-client/api/item-lookup-api.js +12 -18
  40. package/lib/generated-client/api/item-update-api.d.ts +0 -25
  41. package/lib/generated-client/api/item-update-api.js +4 -10
  42. package/lib/generated-client/api/library-api.d.ts +1239 -327
  43. package/lib/generated-client/api/library-api.js +1307 -95
  44. package/lib/generated-client/api/library-structure-api.d.ts +0 -62
  45. package/lib/generated-client/api/library-structure-api.js +9 -15
  46. package/lib/generated-client/api/live-tv-api.d.ts +0 -622
  47. package/lib/generated-client/api/live-tv-api.js +39 -320
  48. package/lib/generated-client/api/localization-api.d.ts +0 -10
  49. package/lib/generated-client/api/localization-api.js +5 -11
  50. package/lib/generated-client/api/{lyrics-api.d.ts → lyric-api.d.ts} +44 -89
  51. package/lib/generated-client/api/{lyrics-api.js → lyric-api.js} +42 -48
  52. package/lib/generated-client/api/media-info-api.d.ts +4 -91
  53. package/lib/generated-client/api/media-info-api.js +10 -16
  54. package/lib/generated-client/api/{media-segments-api.d.ts → media-segment-api.d.ts} +14 -27
  55. package/lib/generated-client/api/{media-segments-api.js → media-segment-api.js} +17 -23
  56. package/lib/generated-client/api/{movies-api.d.ts → movie-api.d.ts} +14 -33
  57. package/lib/generated-client/api/{movies-api.js → movie-api.js} +17 -23
  58. package/lib/generated-client/api/music-genre-api.d.ts +85 -0
  59. package/lib/generated-client/api/music-genre-api.js +121 -0
  60. package/lib/generated-client/api/{persons-api.d.ts → person-api.d.ts} +52 -64
  61. package/lib/generated-client/api/{persons-api.js → person-api.js} +51 -32
  62. package/lib/generated-client/api/{playlists-api.d.ts → playlist-api.d.ts} +86 -185
  63. package/lib/generated-client/api/{playlists-api.js → playlist-api.js} +80 -81
  64. package/lib/generated-client/api/plugin-api.d.ts +743 -0
  65. package/lib/generated-client/api/plugin-api.js +1186 -0
  66. package/lib/generated-client/api/remote-image-api.d.ts +0 -35
  67. package/lib/generated-client/api/remote-image-api.js +4 -10
  68. package/lib/generated-client/api/{scheduled-tasks-api.d.ts → scheduled-task-api.d.ts} +38 -73
  69. package/lib/generated-client/api/{scheduled-tasks-api.js → scheduled-task-api.js} +37 -43
  70. package/lib/generated-client/api/search-api.d.ts +0 -45
  71. package/lib/generated-client/api/search-api.js +2 -8
  72. package/lib/generated-client/api/session-api.d.ts +163 -181
  73. package/lib/generated-client/api/session-api.js +262 -123
  74. package/lib/generated-client/api/{tv-shows-api.d.ts → show-api.d.ts} +34 -156
  75. package/lib/generated-client/api/{tv-shows-api.js → show-api.js} +36 -47
  76. package/lib/generated-client/api/startup-api.d.ts +20 -25
  77. package/lib/generated-client/api/startup-api.js +28 -14
  78. package/lib/generated-client/api/{studios-api.d.ts → studio-api.d.ts} +20 -70
  79. package/lib/generated-client/api/{studios-api.js → studio-api.js} +22 -28
  80. package/lib/generated-client/api/subtitle-api.d.ts +0 -114
  81. package/lib/generated-client/api/subtitle-api.js +11 -17
  82. package/lib/generated-client/api/{suggestions-api.d.ts → suggestion-api.d.ts} +14 -35
  83. package/lib/generated-client/api/{suggestions-api.js → suggestion-api.js} +17 -23
  84. package/lib/generated-client/api/sync-play-api.d.ts +0 -96
  85. package/lib/generated-client/api/sync-play-api.js +23 -29
  86. package/lib/generated-client/api/system-api.d.ts +420 -20
  87. package/lib/generated-client/api/system-api.js +659 -18
  88. package/lib/generated-client/api/{trailers-api.d.ts → trailer-api.d.ts} +32 -193
  89. package/lib/generated-client/api/{trailers-api.js → trailer-api.js} +35 -27
  90. package/lib/generated-client/api/{trickplay-api.d.ts → trick-play-api.d.ts} +20 -46
  91. package/lib/generated-client/api/{trickplay-api.js → trick-play-api.js} +22 -28
  92. package/lib/generated-client/api/user-api.d.ts +0 -249
  93. package/lib/generated-client/api/user-api.js +11 -277
  94. package/lib/generated-client/api/user-data-api.d.ts +429 -0
  95. package/lib/generated-client/api/{user-library-api.js → user-data-api.js} +149 -324
  96. package/lib/generated-client/api/{user-views-api.d.ts → user-view-api.d.ts} +20 -42
  97. package/lib/generated-client/api/{user-views-api.js → user-view-api.js} +22 -28
  98. package/lib/generated-client/api/{videos-api.d.ts → video-api.d.ts} +111 -533
  99. package/lib/generated-client/api/{videos-api.js → video-api.js} +141 -101
  100. package/lib/generated-client/api/{years-api.d.ts → year-api.d.ts} +20 -66
  101. package/lib/generated-client/api/{years-api.js → year-api.js} +22 -28
  102. package/lib/generated-client/api.d.ts +23 -38
  103. package/lib/generated-client/base.d.ts +0 -24
  104. package/lib/generated-client/base.js +0 -15
  105. package/lib/generated-client/common.d.ts +4 -35
  106. package/lib/generated-client/common.js +15 -26
  107. package/lib/generated-client/configuration.d.ts +24 -17
  108. package/lib/generated-client/configuration.js +8 -2
  109. package/lib/generated-client/index.js +25 -39
  110. package/lib/generated-client/models/access-schedule.d.ts +0 -15
  111. package/lib/generated-client/models/activity-log-entry-message.d.ts +0 -11
  112. package/lib/generated-client/models/activity-log-entry-query-result.d.ts +0 -8
  113. package/lib/generated-client/models/activity-log-entry-start-message.d.ts +1 -10
  114. package/lib/generated-client/models/activity-log-entry-stop-message.d.ts +0 -7
  115. package/lib/generated-client/models/activity-log-entry.d.ts +0 -25
  116. package/lib/generated-client/models/activity-log-sort-by.d.ts +23 -0
  117. package/lib/generated-client/models/{architecture.d.ts → activity-log-sort-by.js} +13 -11
  118. package/lib/generated-client/models/add-virtual-folder-dto.d.ts +0 -7
  119. package/lib/generated-client/models/album-info-remote-search-query.d.ts +0 -19
  120. package/lib/generated-client/models/album-info.d.ts +1 -49
  121. package/lib/generated-client/models/all-theme-media-result.d.ts +0 -20
  122. package/lib/generated-client/models/artist-info-remote-search-query.d.ts +0 -19
  123. package/lib/generated-client/models/artist-info.d.ts +0 -44
  124. package/lib/generated-client/models/audio-spatial-format.d.ts +0 -2
  125. package/lib/generated-client/models/audio-spatial-format.js +0 -2
  126. package/lib/generated-client/models/authenticate-user-by-name.d.ts +0 -6
  127. package/lib/generated-client/models/authentication-info-query-result.d.ts +0 -8
  128. package/lib/generated-client/models/authentication-info.d.ts +0 -35
  129. package/lib/generated-client/models/authentication-result.d.ts +0 -16
  130. package/lib/generated-client/models/backup-manifest-dto.d.ts +5 -20
  131. package/lib/generated-client/models/backup-options-dto.d.ts +0 -10
  132. package/lib/generated-client/models/backup-restore-request-dto.d.ts +1 -5
  133. package/lib/generated-client/models/base-item-dto-image-blur-hashes.d.ts +14 -81
  134. package/lib/generated-client/models/base-item-dto-query-result.d.ts +0 -8
  135. package/lib/generated-client/models/base-item-dto.d.ts +6 -456
  136. package/lib/generated-client/models/base-item-kind.d.ts +0 -2
  137. package/lib/generated-client/models/base-item-kind.js +0 -2
  138. package/lib/generated-client/models/base-item-person-image-blur-hashes.d.ts +13 -80
  139. package/lib/generated-client/models/base-item-person.d.ts +0 -20
  140. package/lib/generated-client/models/book-info-remote-search-query.d.ts +0 -19
  141. package/lib/generated-client/models/book-info.d.ts +2 -40
  142. package/lib/generated-client/models/box-set-info-remote-search-query.d.ts +0 -19
  143. package/lib/generated-client/models/box-set-info.d.ts +1 -37
  144. package/lib/generated-client/models/branding-options-dto.d.ts +1 -9
  145. package/lib/generated-client/models/buffer-request-dto.d.ts +0 -10
  146. package/lib/generated-client/models/cast-receiver-application.d.ts +2 -8
  147. package/lib/generated-client/models/channel-features.d.ts +0 -29
  148. package/lib/generated-client/models/channel-item-sort-field.d.ts +0 -5
  149. package/lib/generated-client/models/channel-item-sort-field.js +0 -5
  150. package/lib/generated-client/models/channel-mapping-options-dto.d.ts +2 -12
  151. package/lib/generated-client/models/channel-media-content-type.d.ts +0 -5
  152. package/lib/generated-client/models/channel-media-content-type.js +0 -5
  153. package/lib/generated-client/models/channel-media-type.d.ts +0 -5
  154. package/lib/generated-client/models/channel-media-type.js +0 -5
  155. package/lib/generated-client/models/channel-type.d.ts +0 -2
  156. package/lib/generated-client/models/channel-type.js +0 -2
  157. package/lib/generated-client/models/chapter-info.d.ts +0 -18
  158. package/lib/generated-client/models/client-capabilities-dto.d.ts +0 -19
  159. package/lib/generated-client/models/client-log-document-response-dto.d.ts +0 -4
  160. package/lib/generated-client/models/codec-profile.d.ts +0 -17
  161. package/lib/generated-client/models/codec-type.d.ts +1 -3
  162. package/lib/generated-client/models/codec-type.js +1 -3
  163. package/lib/generated-client/models/collection-creation-result.d.ts +0 -10
  164. package/lib/generated-client/models/collection-type-options.d.ts +0 -2
  165. package/lib/generated-client/models/collection-type-options.js +0 -2
  166. package/lib/generated-client/models/collection-type.d.ts +0 -2
  167. package/lib/generated-client/models/collection-type.js +0 -2
  168. package/lib/generated-client/models/configuration-page-info.d.ts +0 -14
  169. package/lib/generated-client/models/container-profile.d.ts +0 -13
  170. package/lib/generated-client/models/country-info.d.ts +0 -10
  171. package/lib/generated-client/models/create-playlist-dto.d.ts +1 -18
  172. package/lib/generated-client/models/create-user-by-name.d.ts +0 -6
  173. package/lib/generated-client/models/culture-dto.d.ts +0 -15
  174. package/lib/generated-client/models/custom-database-option.d.ts +2 -8
  175. package/lib/generated-client/models/custom-database-options.d.ts +3 -13
  176. package/lib/generated-client/models/database-configuration-options.d.ts +1 -15
  177. package/lib/generated-client/models/database-locking-behavior-types.d.ts +0 -2
  178. package/lib/generated-client/models/database-locking-behavior-types.js +0 -2
  179. package/lib/generated-client/models/day-of-week.d.ts +0 -5
  180. package/lib/generated-client/models/day-of-week.js +0 -5
  181. package/lib/generated-client/models/day-pattern.d.ts +1 -3
  182. package/lib/generated-client/models/day-pattern.js +1 -3
  183. package/lib/generated-client/models/default-directory-browser-info-dto.d.ts +0 -4
  184. package/lib/generated-client/models/deinterlace-method.d.ts +0 -2
  185. package/lib/generated-client/models/deinterlace-method.js +0 -2
  186. package/lib/generated-client/models/device-info-dto-query-result.d.ts +0 -8
  187. package/lib/generated-client/models/device-info-dto.d.ts +0 -27
  188. package/lib/generated-client/models/device-options-dto.d.ts +0 -8
  189. package/lib/generated-client/models/device-profile.d.ts +1 -25
  190. package/lib/generated-client/models/direct-play-profile.d.ts +0 -13
  191. package/lib/generated-client/models/display-preferences-dto.d.ts +0 -36
  192. package/lib/generated-client/models/dlna-profile-type.d.ts +0 -5
  193. package/lib/generated-client/models/dlna-profile-type.js +0 -5
  194. package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +0 -2
  195. package/lib/generated-client/models/down-mix-stereo-algorithms.js +0 -2
  196. package/lib/generated-client/models/dynamic-day-of-week.d.ts +0 -2
  197. package/lib/generated-client/models/dynamic-day-of-week.js +0 -2
  198. package/lib/generated-client/models/embedded-subtitle-options.d.ts +0 -2
  199. package/lib/generated-client/models/embedded-subtitle-options.js +0 -2
  200. package/lib/generated-client/models/encoder-preset.d.ts +0 -2
  201. package/lib/generated-client/models/encoder-preset.js +0 -2
  202. package/lib/generated-client/models/encoding-context.d.ts +1 -3
  203. package/lib/generated-client/models/encoding-context.js +1 -3
  204. package/lib/generated-client/models/encoding-options.d.ts +6 -117
  205. package/lib/generated-client/models/end-point-info.d.ts +0 -15
  206. package/lib/generated-client/models/external-id-info.d.ts +0 -11
  207. package/lib/generated-client/models/external-id-media-type.d.ts +0 -2
  208. package/lib/generated-client/models/external-id-media-type.js +0 -2
  209. package/lib/generated-client/models/external-url.d.ts +0 -9
  210. package/lib/generated-client/models/extra-type.d.ts +0 -5
  211. package/lib/generated-client/models/extra-type.js +0 -5
  212. package/lib/generated-client/models/file-system-entry-info.d.ts +0 -11
  213. package/lib/generated-client/models/file-system-entry-type.d.ts +0 -2
  214. package/lib/generated-client/models/file-system-entry-type.js +0 -2
  215. package/lib/generated-client/models/folder-storage-dto.d.ts +1 -13
  216. package/lib/generated-client/models/font-file.d.ts +0 -10
  217. package/lib/generated-client/models/force-keep-alive-message.d.ts +0 -11
  218. package/lib/generated-client/models/forgot-password-action.d.ts +0 -5
  219. package/lib/generated-client/models/forgot-password-action.js +0 -5
  220. package/lib/generated-client/models/forgot-password-dto.d.ts +0 -4
  221. package/lib/generated-client/models/forgot-password-pin-dto.d.ts +0 -4
  222. package/lib/generated-client/models/forgot-password-result.d.ts +0 -14
  223. package/lib/generated-client/models/general-command-message.d.ts +0 -14
  224. package/lib/generated-client/models/general-command-type.d.ts +0 -2
  225. package/lib/generated-client/models/general-command-type.js +0 -2
  226. package/lib/generated-client/models/general-command.d.ts +1 -21
  227. package/lib/generated-client/models/get-programs-dto.d.ts +0 -56
  228. package/lib/generated-client/models/group-info-dto.d.ts +0 -15
  229. package/lib/generated-client/models/group-queue-mode.d.ts +0 -2
  230. package/lib/generated-client/models/group-queue-mode.js +0 -2
  231. package/lib/generated-client/models/group-repeat-mode.d.ts +0 -2
  232. package/lib/generated-client/models/group-repeat-mode.js +0 -2
  233. package/lib/generated-client/models/group-shuffle-mode.d.ts +0 -2
  234. package/lib/generated-client/models/group-shuffle-mode.js +0 -2
  235. package/lib/generated-client/models/group-state-type.d.ts +0 -2
  236. package/lib/generated-client/models/group-state-type.js +0 -2
  237. package/lib/generated-client/models/group-state-update.d.ts +0 -12
  238. package/lib/generated-client/models/group-update-type.d.ts +0 -2
  239. package/lib/generated-client/models/group-update-type.js +0 -2
  240. package/lib/generated-client/models/group-update.d.ts +0 -1
  241. package/lib/generated-client/models/guide-info.d.ts +0 -9
  242. package/lib/generated-client/models/hardware-acceleration-type.d.ts +0 -2
  243. package/lib/generated-client/models/hardware-acceleration-type.js +0 -2
  244. package/lib/generated-client/models/{notification-level.d.ts → hls-audio-seek-strategy.d.ts} +5 -8
  245. package/lib/generated-client/models/{transcoding-info.js → hls-audio-seek-strategy.js} +8 -2
  246. package/lib/generated-client/models/ignore-wait-request-dto.d.ts +0 -4
  247. package/lib/generated-client/models/image-format.d.ts +0 -2
  248. package/lib/generated-client/models/image-format.js +0 -2
  249. package/lib/generated-client/models/image-info.d.ts +0 -21
  250. package/lib/generated-client/models/image-option.d.ts +0 -14
  251. package/lib/generated-client/models/image-orientation.d.ts +0 -5
  252. package/lib/generated-client/models/image-orientation.js +0 -5
  253. package/lib/generated-client/models/image-provider-info.d.ts +0 -6
  254. package/lib/generated-client/models/image-resolution.d.ts +0 -2
  255. package/lib/generated-client/models/image-resolution.js +0 -2
  256. package/lib/generated-client/models/image-saving-convention.d.ts +1 -3
  257. package/lib/generated-client/models/image-saving-convention.js +1 -3
  258. package/lib/generated-client/models/image-type.d.ts +0 -2
  259. package/lib/generated-client/models/image-type.js +0 -2
  260. package/lib/generated-client/models/inbound-keep-alive-message.d.ts +0 -7
  261. package/lib/generated-client/models/inbound-web-socket-message.d.ts +0 -1
  262. package/lib/generated-client/models/index.d.ts +2 -2
  263. package/lib/generated-client/models/index.js +2 -1
  264. package/lib/generated-client/models/installation-info.d.ts +0 -19
  265. package/lib/generated-client/models/iplugin.d.ts +0 -16
  266. package/lib/generated-client/models/iso-type.d.ts +0 -2
  267. package/lib/generated-client/models/iso-type.js +0 -2
  268. package/lib/generated-client/models/item-counts.d.ts +0 -26
  269. package/lib/generated-client/models/item-fields.d.ts +0 -2
  270. package/lib/generated-client/models/item-fields.js +0 -2
  271. package/lib/generated-client/models/item-filter.d.ts +0 -2
  272. package/lib/generated-client/models/item-filter.js +0 -2
  273. package/lib/generated-client/models/item-sort-by.d.ts +0 -2
  274. package/lib/generated-client/models/item-sort-by.js +0 -2
  275. package/lib/generated-client/models/join-group-request-dto.d.ts +0 -4
  276. package/lib/generated-client/models/keep-until.d.ts +0 -5
  277. package/lib/generated-client/models/keep-until.js +0 -5
  278. package/lib/generated-client/models/library-changed-message.d.ts +0 -14
  279. package/lib/generated-client/models/library-option-info-dto.d.ts +0 -6
  280. package/lib/generated-client/models/library-options-result-dto.d.ts +0 -14
  281. package/lib/generated-client/models/library-options.d.ts +0 -207
  282. package/lib/generated-client/models/library-storage-dto.d.ts +3 -11
  283. package/lib/generated-client/models/library-type-options-dto.d.ts +4 -12
  284. package/lib/generated-client/models/library-update-info.d.ts +0 -22
  285. package/lib/generated-client/models/listings-provider-info.d.ts +0 -95
  286. package/lib/generated-client/models/live-stream-response.d.ts +0 -10
  287. package/lib/generated-client/models/live-tv-info.d.ts +0 -11
  288. package/lib/generated-client/models/live-tv-options.d.ts +0 -80
  289. package/lib/generated-client/models/live-tv-service-info.d.ts +0 -24
  290. package/lib/generated-client/models/live-tv-service-status.d.ts +1 -3
  291. package/lib/generated-client/models/live-tv-service-status.js +1 -3
  292. package/lib/generated-client/models/localization-option.d.ts +0 -15
  293. package/lib/generated-client/models/location-type.d.ts +0 -2
  294. package/lib/generated-client/models/location-type.js +0 -2
  295. package/lib/generated-client/models/log-file.d.ts +1 -14
  296. package/lib/generated-client/models/log-level.d.ts +0 -5
  297. package/lib/generated-client/models/log-level.js +0 -5
  298. package/lib/generated-client/models/lyric-dto.d.ts +0 -9
  299. package/lib/generated-client/models/lyric-line-cue.d.ts +0 -10
  300. package/lib/generated-client/models/lyric-line.d.ts +0 -8
  301. package/lib/generated-client/models/lyric-metadata.d.ts +0 -22
  302. package/lib/generated-client/models/media-attachment.d.ts +0 -16
  303. package/lib/generated-client/models/media-path-dto.d.ts +0 -11
  304. package/lib/generated-client/models/media-path-info.d.ts +0 -10
  305. package/lib/generated-client/models/media-protocol.d.ts +0 -5
  306. package/lib/generated-client/models/media-protocol.js +0 -5
  307. package/lib/generated-client/models/media-segment-dto-query-result.d.ts +0 -8
  308. package/lib/generated-client/models/media-segment-dto.d.ts +0 -15
  309. package/lib/generated-client/models/media-segment-type.d.ts +0 -2
  310. package/lib/generated-client/models/media-segment-type.js +0 -2
  311. package/lib/generated-client/models/media-source-info.d.ts +1 -228
  312. package/lib/generated-client/models/media-source-type.d.ts +1 -3
  313. package/lib/generated-client/models/media-source-type.js +1 -3
  314. package/lib/generated-client/models/media-stream-protocol.d.ts +1 -3
  315. package/lib/generated-client/models/media-stream-protocol.js +1 -3
  316. package/lib/generated-client/models/media-stream-type.d.ts +0 -2
  317. package/lib/generated-client/models/media-stream-type.js +0 -2
  318. package/lib/generated-client/models/media-stream.d.ts +7 -176
  319. package/lib/generated-client/models/media-type.d.ts +0 -2
  320. package/lib/generated-client/models/media-type.js +0 -2
  321. package/lib/generated-client/models/media-update-info-dto.d.ts +0 -4
  322. package/lib/generated-client/models/media-update-info-path-dto.d.ts +1 -7
  323. package/lib/generated-client/models/media-url.d.ts +0 -15
  324. package/lib/generated-client/models/message-command.d.ts +4 -12
  325. package/lib/generated-client/models/metadata-configuration.d.ts +0 -10
  326. package/lib/generated-client/models/metadata-editor-info.d.ts +0 -17
  327. package/lib/generated-client/models/metadata-field.d.ts +0 -2
  328. package/lib/generated-client/models/metadata-field.js +0 -2
  329. package/lib/generated-client/models/metadata-options.d.ts +0 -37
  330. package/lib/generated-client/models/metadata-refresh-mode.d.ts +0 -5
  331. package/lib/generated-client/models/metadata-refresh-mode.js +0 -5
  332. package/lib/generated-client/models/move-playlist-item-request-dto.d.ts +0 -6
  333. package/lib/generated-client/models/movie-info-remote-search-query.d.ts +0 -19
  334. package/lib/generated-client/models/movie-info.d.ts +1 -37
  335. package/lib/generated-client/models/music-video-info-remote-search-query.d.ts +0 -19
  336. package/lib/generated-client/models/music-video-info.d.ts +0 -44
  337. package/lib/generated-client/models/name-guid-pair.d.ts +0 -15
  338. package/lib/generated-client/models/name-id-pair.d.ts +0 -9
  339. package/lib/generated-client/models/name-value-pair.d.ts +0 -9
  340. package/lib/generated-client/models/network-configuration.d.ts +1 -49
  341. package/lib/generated-client/models/new-group-request-dto.d.ts +0 -4
  342. package/lib/generated-client/models/next-item-request-dto.d.ts +0 -4
  343. package/lib/generated-client/models/open-live-stream-dto.d.ts +0 -33
  344. package/lib/generated-client/models/outbound-keep-alive-message.d.ts +0 -9
  345. package/lib/generated-client/models/outbound-web-socket-message.d.ts +0 -1
  346. package/lib/generated-client/models/package-info.d.ts +1 -19
  347. package/lib/generated-client/models/parental-rating-score.d.ts +0 -6
  348. package/lib/generated-client/models/parental-rating.d.ts +0 -11
  349. package/lib/generated-client/models/path-substitution.d.ts +0 -6
  350. package/lib/generated-client/models/person-kind.d.ts +1 -2
  351. package/lib/generated-client/models/person-kind.js +2 -3
  352. package/lib/generated-client/models/person-lookup-info-remote-search-query.d.ts +0 -19
  353. package/lib/generated-client/models/person-lookup-info.d.ts +1 -37
  354. package/lib/generated-client/models/pin-redeem-result.d.ts +0 -9
  355. package/lib/generated-client/models/ping-request-dto.d.ts +0 -4
  356. package/lib/generated-client/models/play-access.d.ts +1 -3
  357. package/lib/generated-client/models/play-access.js +1 -3
  358. package/lib/generated-client/models/play-command.d.ts +0 -2
  359. package/lib/generated-client/models/play-command.js +0 -2
  360. package/lib/generated-client/models/play-message.d.ts +0 -14
  361. package/lib/generated-client/models/play-method.d.ts +1 -3
  362. package/lib/generated-client/models/play-method.js +1 -3
  363. package/lib/generated-client/models/play-queue-update-reason.d.ts +0 -2
  364. package/lib/generated-client/models/play-queue-update-reason.js +0 -2
  365. package/lib/generated-client/models/play-queue-update.d.ts +0 -27
  366. package/lib/generated-client/models/play-request-dto.d.ts +0 -8
  367. package/lib/generated-client/models/play-request.d.ts +0 -33
  368. package/lib/generated-client/models/playback-error-code.d.ts +1 -3
  369. package/lib/generated-client/models/playback-error-code.js +1 -3
  370. package/lib/generated-client/models/playback-info-dto.d.ts +0 -37
  371. package/lib/generated-client/models/playback-info-response.d.ts +0 -11
  372. package/lib/generated-client/models/playback-order.d.ts +0 -2
  373. package/lib/generated-client/models/playback-order.js +0 -2
  374. package/lib/generated-client/models/playback-progress-info.d.ts +0 -71
  375. package/lib/generated-client/models/playback-request-type.d.ts +0 -2
  376. package/lib/generated-client/models/playback-request-type.js +0 -2
  377. package/lib/generated-client/models/playback-start-info.d.ts +0 -71
  378. package/lib/generated-client/models/playback-stop-info.d.ts +0 -36
  379. package/lib/generated-client/models/player-state-info.d.ts +0 -38
  380. package/lib/generated-client/models/playlist-creation-result.d.ts +0 -10
  381. package/lib/generated-client/models/playlist-dto.d.ts +2 -10
  382. package/lib/generated-client/models/playlist-user-permissions.d.ts +0 -6
  383. package/lib/generated-client/models/playstate-command.d.ts +0 -2
  384. package/lib/generated-client/models/playstate-command.js +0 -2
  385. package/lib/generated-client/models/playstate-message.d.ts +0 -14
  386. package/lib/generated-client/models/playstate-request.d.ts +2 -13
  387. package/lib/generated-client/models/plugin-info.d.ts +0 -21
  388. package/lib/generated-client/models/plugin-installation-cancelled-message.d.ts +0 -14
  389. package/lib/generated-client/models/plugin-installation-completed-message.d.ts +0 -14
  390. package/lib/generated-client/models/plugin-installation-failed-message.d.ts +0 -14
  391. package/lib/generated-client/models/plugin-installing-message.d.ts +0 -14
  392. package/lib/generated-client/models/plugin-status.d.ts +0 -2
  393. package/lib/generated-client/models/plugin-status.js +0 -2
  394. package/lib/generated-client/models/plugin-uninstalled-message.d.ts +0 -14
  395. package/lib/generated-client/models/previous-item-request-dto.d.ts +0 -4
  396. package/lib/generated-client/models/problem-details.d.ts +0 -30
  397. package/lib/generated-client/models/process-priority-class.d.ts +0 -5
  398. package/lib/generated-client/models/process-priority-class.js +0 -5
  399. package/lib/generated-client/models/profile-condition-type.d.ts +0 -5
  400. package/lib/generated-client/models/profile-condition-type.js +0 -5
  401. package/lib/generated-client/models/profile-condition-value.d.ts +1 -5
  402. package/lib/generated-client/models/profile-condition-value.js +2 -6
  403. package/lib/generated-client/models/profile-condition.d.ts +0 -25
  404. package/lib/generated-client/models/program-audio.d.ts +0 -5
  405. package/lib/generated-client/models/program-audio.js +0 -5
  406. package/lib/generated-client/models/public-system-info.d.ts +0 -19
  407. package/lib/generated-client/models/query-filters-legacy.d.ts +0 -25
  408. package/lib/generated-client/models/query-filters.d.ts +3 -15
  409. package/lib/generated-client/models/queue-item.d.ts +3 -9
  410. package/lib/generated-client/models/queue-request-dto.d.ts +0 -9
  411. package/lib/generated-client/models/quick-connect-dto.d.ts +0 -4
  412. package/lib/generated-client/models/quick-connect-result.d.ts +0 -18
  413. package/lib/generated-client/models/rating-type.d.ts +1 -3
  414. package/lib/generated-client/models/rating-type.js +1 -3
  415. package/lib/generated-client/models/ready-request-dto.d.ts +0 -10
  416. package/lib/generated-client/models/recommendation-dto.d.ts +0 -25
  417. package/lib/generated-client/models/recommendation-type.d.ts +0 -5
  418. package/lib/generated-client/models/recommendation-type.js +0 -5
  419. package/lib/generated-client/models/recording-status.d.ts +0 -5
  420. package/lib/generated-client/models/recording-status.js +0 -5
  421. package/lib/generated-client/models/refresh-progress-message.d.ts +0 -11
  422. package/lib/generated-client/models/remote-image-info.d.ts +0 -28
  423. package/lib/generated-client/models/remote-image-result.d.ts +0 -8
  424. package/lib/generated-client/models/remote-lyric-info-dto.d.ts +3 -14
  425. package/lib/generated-client/models/remote-search-result.d.ts +3 -59
  426. package/lib/generated-client/models/remote-subtitle-info.d.ts +0 -85
  427. package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +0 -8
  428. package/lib/generated-client/models/repeat-mode.d.ts +1 -3
  429. package/lib/generated-client/models/repeat-mode.js +1 -3
  430. package/lib/generated-client/models/repository-info.d.ts +0 -8
  431. package/lib/generated-client/models/restart-required-message.d.ts +0 -9
  432. package/lib/generated-client/models/scheduled-task-ended-message.d.ts +0 -14
  433. package/lib/generated-client/models/scheduled-tasks-info-message.d.ts +0 -11
  434. package/lib/generated-client/models/scheduled-tasks-info-start-message.d.ts +1 -10
  435. package/lib/generated-client/models/scheduled-tasks-info-stop-message.d.ts +0 -7
  436. package/lib/generated-client/models/scroll-direction.d.ts +0 -2
  437. package/lib/generated-client/models/scroll-direction.js +0 -2
  438. package/lib/generated-client/models/search-hint-result.d.ts +0 -6
  439. package/lib/generated-client/models/search-hint.d.ts +0 -66
  440. package/lib/generated-client/models/seek-request-dto.d.ts +0 -4
  441. package/lib/generated-client/models/send-command-type.d.ts +0 -2
  442. package/lib/generated-client/models/send-command-type.js +0 -2
  443. package/lib/generated-client/models/send-command.d.ts +0 -17
  444. package/lib/generated-client/models/series-info-remote-search-query.d.ts +0 -19
  445. package/lib/generated-client/models/series-info.d.ts +1 -37
  446. package/lib/generated-client/models/series-status.d.ts +0 -2
  447. package/lib/generated-client/models/series-status.js +0 -2
  448. package/lib/generated-client/models/series-timer-cancelled-message.d.ts +0 -14
  449. package/lib/generated-client/models/series-timer-created-message.d.ts +0 -14
  450. package/lib/generated-client/models/series-timer-info-dto-query-result.d.ts +0 -8
  451. package/lib/generated-client/models/series-timer-info-dto.d.ts +1 -91
  452. package/lib/generated-client/models/server-configuration.d.ts +3 -180
  453. package/lib/generated-client/models/server-discovery-info.d.ts +0 -10
  454. package/lib/generated-client/models/server-restarting-message.d.ts +0 -9
  455. package/lib/generated-client/models/server-shutting-down-message.d.ts +0 -9
  456. package/lib/generated-client/models/session-info-dto.d.ts +1 -80
  457. package/lib/generated-client/models/session-message-type.d.ts +0 -2
  458. package/lib/generated-client/models/session-message-type.js +0 -2
  459. package/lib/generated-client/models/session-user-info.d.ts +0 -6
  460. package/lib/generated-client/models/sessions-message.d.ts +0 -11
  461. package/lib/generated-client/models/sessions-start-message.d.ts +1 -10
  462. package/lib/generated-client/models/sessions-stop-message.d.ts +0 -7
  463. package/lib/generated-client/models/set-channel-mapping-dto.d.ts +0 -8
  464. package/lib/generated-client/models/set-playlist-item-request-dto.d.ts +0 -4
  465. package/lib/generated-client/models/set-repeat-mode-request-dto.d.ts +0 -7
  466. package/lib/generated-client/models/set-shuffle-mode-request-dto.d.ts +0 -7
  467. package/lib/generated-client/models/song-info.d.ts +0 -54
  468. package/lib/generated-client/models/sort-order.d.ts +0 -2
  469. package/lib/generated-client/models/sort-order.js +0 -2
  470. package/lib/generated-client/models/special-view-option-dto.d.ts +0 -6
  471. package/lib/generated-client/models/startup-configuration-dto.d.ts +0 -10
  472. package/lib/generated-client/models/startup-remote-access-dto.d.ts +0 -11
  473. package/lib/generated-client/models/startup-user-dto.d.ts +0 -6
  474. package/lib/generated-client/models/subtitle-delivery-method.d.ts +0 -2
  475. package/lib/generated-client/models/subtitle-delivery-method.js +0 -2
  476. package/lib/generated-client/models/subtitle-playback-mode.d.ts +0 -2
  477. package/lib/generated-client/models/subtitle-playback-mode.js +0 -2
  478. package/lib/generated-client/models/subtitle-profile.d.ts +0 -15
  479. package/lib/generated-client/models/sync-play-command-message.d.ts +0 -14
  480. package/lib/generated-client/models/sync-play-group-does-not-exist-update.d.ts +0 -14
  481. package/lib/generated-client/models/sync-play-group-joined-update.d.ts +0 -17
  482. package/lib/generated-client/models/sync-play-group-left-update.d.ts +0 -14
  483. package/lib/generated-client/models/sync-play-group-update-message.d.ts +0 -14
  484. package/lib/generated-client/models/sync-play-library-access-denied-update.d.ts +0 -14
  485. package/lib/generated-client/models/sync-play-not-in-group-update.d.ts +0 -14
  486. package/lib/generated-client/models/sync-play-play-queue-update.d.ts +0 -17
  487. package/lib/generated-client/models/sync-play-queue-item.d.ts +0 -6
  488. package/lib/generated-client/models/sync-play-state-update.d.ts +0 -17
  489. package/lib/generated-client/models/sync-play-user-access-type.d.ts +0 -2
  490. package/lib/generated-client/models/sync-play-user-access-type.js +0 -2
  491. package/lib/generated-client/models/sync-play-user-joined-update.d.ts +0 -14
  492. package/lib/generated-client/models/sync-play-user-left-update.d.ts +0 -14
  493. package/lib/generated-client/models/system-info.d.ts +0 -62
  494. package/lib/generated-client/models/system-storage-dto.d.ts +8 -47
  495. package/lib/generated-client/models/task-completion-status.d.ts +0 -2
  496. package/lib/generated-client/models/task-completion-status.js +0 -2
  497. package/lib/generated-client/models/task-info.d.ts +0 -28
  498. package/lib/generated-client/models/task-result.d.ts +0 -21
  499. package/lib/generated-client/models/task-state.d.ts +0 -2
  500. package/lib/generated-client/models/task-state.js +0 -2
  501. package/lib/generated-client/models/task-trigger-info-type.d.ts +0 -2
  502. package/lib/generated-client/models/task-trigger-info-type.js +0 -2
  503. package/lib/generated-client/models/task-trigger-info.d.ts +0 -18
  504. package/lib/generated-client/models/theme-media-result.d.ts +0 -10
  505. package/lib/generated-client/models/timer-cancelled-message.d.ts +0 -14
  506. package/lib/generated-client/models/timer-created-message.d.ts +0 -14
  507. package/lib/generated-client/models/timer-event-info.d.ts +0 -15
  508. package/lib/generated-client/models/timer-info-dto-query-result.d.ts +0 -8
  509. package/lib/generated-client/models/timer-info-dto.d.ts +0 -76
  510. package/lib/generated-client/models/tonemapping-algorithm.d.ts +0 -2
  511. package/lib/generated-client/models/tonemapping-algorithm.js +0 -2
  512. package/lib/generated-client/models/tonemapping-mode.d.ts +0 -2
  513. package/lib/generated-client/models/tonemapping-mode.js +0 -2
  514. package/lib/generated-client/models/tonemapping-range.d.ts +0 -2
  515. package/lib/generated-client/models/tonemapping-range.js +0 -2
  516. package/lib/generated-client/models/trailer-info-remote-search-query.d.ts +0 -19
  517. package/lib/generated-client/models/trailer-info.d.ts +1 -37
  518. package/lib/generated-client/models/transcode-reason.d.ts +1 -5
  519. package/lib/generated-client/models/transcode-reason.js +2 -6
  520. package/lib/generated-client/models/transcode-seek-info.d.ts +1 -3
  521. package/lib/generated-client/models/transcode-seek-info.js +1 -3
  522. package/lib/generated-client/models/transcoding-info.d.ts +2 -34
  523. package/lib/generated-client/models/transcoding-profile.d.ts +3 -50
  524. package/lib/generated-client/models/transport-stream-timestamp.d.ts +1 -3
  525. package/lib/generated-client/models/transport-stream-timestamp.js +1 -3
  526. package/lib/generated-client/models/trickplay-info-dto.d.ts +0 -16
  527. package/lib/generated-client/models/trickplay-options.d.ts +1 -33
  528. package/lib/generated-client/models/trickplay-scan-behavior.d.ts +0 -2
  529. package/lib/generated-client/models/trickplay-scan-behavior.js +0 -2
  530. package/lib/generated-client/models/tuner-channel-mapping.d.ts +0 -25
  531. package/lib/generated-client/models/tuner-host-info.d.ts +0 -85
  532. package/lib/generated-client/models/type-options.d.ts +2 -35
  533. package/lib/generated-client/models/unrated-item.d.ts +0 -2
  534. package/lib/generated-client/models/unrated-item.js +0 -2
  535. package/lib/generated-client/models/update-library-options-dto.d.ts +0 -9
  536. package/lib/generated-client/models/update-media-path-request-dto.d.ts +0 -9
  537. package/lib/generated-client/models/update-playlist-dto.d.ts +0 -10
  538. package/lib/generated-client/models/update-playlist-user-dto.d.ts +0 -4
  539. package/lib/generated-client/models/update-user-item-data-dto.d.ts +0 -24
  540. package/lib/generated-client/models/update-user-password.d.ts +0 -10
  541. package/lib/generated-client/models/upload-subtitle-dto.d.ts +0 -12
  542. package/lib/generated-client/models/user-configuration.d.ts +0 -70
  543. package/lib/generated-client/models/user-data-change-info.d.ts +1 -7
  544. package/lib/generated-client/models/user-data-changed-message.d.ts +0 -14
  545. package/lib/generated-client/models/user-deleted-message.d.ts +0 -11
  546. package/lib/generated-client/models/user-dto.d.ts +6 -40
  547. package/lib/generated-client/models/user-item-data-dto.d.ts +1 -25
  548. package/lib/generated-client/models/user-policy.d.ts +0 -201
  549. package/lib/generated-client/models/user-updated-message.d.ts +0 -14
  550. package/lib/generated-client/models/utc-time-response.d.ts +0 -6
  551. package/lib/generated-client/models/validate-path-dto.d.ts +0 -8
  552. package/lib/generated-client/models/version-info.d.ts +0 -20
  553. package/lib/generated-client/models/video-range-type.d.ts +0 -2
  554. package/lib/generated-client/models/video-range-type.js +0 -2
  555. package/lib/generated-client/models/video-range.d.ts +0 -2
  556. package/lib/generated-client/models/video-range.js +0 -2
  557. package/lib/generated-client/models/video-type.d.ts +0 -2
  558. package/lib/generated-client/models/video-type.js +0 -2
  559. package/lib/generated-client/models/video3-dformat.d.ts +0 -5
  560. package/lib/generated-client/models/video3-dformat.js +0 -5
  561. package/lib/generated-client/models/virtual-folder-info.d.ts +0 -30
  562. package/lib/generated-client/models/web-socket-message.d.ts +0 -1
  563. package/lib/generated-client/models/xbmc-metadata-options.d.ts +0 -30
  564. package/lib/index.js +1 -1
  565. package/lib/models/api/image-request-parameters.d.ts +1 -1
  566. package/lib/models/device-info.d.ts +1 -0
  567. package/lib/utils/api/{videos-api.d.ts → artist-api.d.ts} +2 -2
  568. package/lib/utils/api/{movies-api.js → artist-api.js} +4 -4
  569. package/lib/utils/api/authentication-api.d.ts +8 -0
  570. package/lib/utils/api/authentication-api.js +35 -0
  571. package/lib/utils/api/{tmdb-api.d.ts → backup-api.d.ts} +2 -2
  572. package/lib/utils/api/backup-api.js +13 -0
  573. package/lib/utils/api/{artists-api.d.ts → channel-api.d.ts} +2 -2
  574. package/lib/utils/api/{artists-api.js → channel-api.js} +4 -4
  575. package/lib/utils/api/{movies-api.d.ts → device-api.d.ts} +2 -2
  576. package/lib/utils/api/{lyrics-api.js → device-api.js} +4 -4
  577. package/lib/utils/api/display-preference-api.d.ts +8 -0
  578. package/lib/utils/api/display-preference-api.js +12 -0
  579. package/lib/utils/api/{items-api.d.ts → genre-api.d.ts} +2 -2
  580. package/lib/utils/api/{items-api.js → genre-api.js} +4 -4
  581. package/lib/utils/api/index.d.ts +24 -38
  582. package/lib/utils/api/index.js +24 -38
  583. package/lib/utils/api/library-api.d.ts +14 -2
  584. package/lib/utils/api/library-api.js +17 -1
  585. package/lib/utils/api/{years-api.d.ts → lyric-api.d.ts} +2 -2
  586. package/lib/utils/api/{years-api.js → lyric-api.js} +4 -4
  587. package/lib/utils/api/{activity-log-api.d.ts → media-segment-api.d.ts} +2 -2
  588. package/lib/utils/api/{quick-connect-api.js → media-segment-api.js} +4 -4
  589. package/lib/utils/api/movie-api.d.ts +8 -0
  590. package/lib/utils/api/movie-api.js +12 -0
  591. package/lib/utils/api/{dynamic-hls-api.d.ts → music-genre-api.d.ts} +2 -2
  592. package/lib/utils/api/{dynamic-hls-api.js → music-genre-api.js} +4 -4
  593. package/lib/utils/api/{genres-api.d.ts → person-api.d.ts} +2 -2
  594. package/lib/utils/api/{genres-api.js → person-api.js} +4 -4
  595. package/lib/utils/api/{trailers-api.d.ts → playlist-api.d.ts} +2 -2
  596. package/lib/utils/api/{channels-api.js → playlist-api.js} +4 -4
  597. package/lib/utils/api/{lyrics-api.d.ts → plugin-api.d.ts} +2 -2
  598. package/lib/utils/api/{videos-api.js → plugin-api.js} +4 -4
  599. package/lib/utils/api/scheduled-task-api.d.ts +8 -0
  600. package/lib/utils/api/{configuration-api.js → scheduled-task-api.js} +4 -4
  601. package/lib/utils/api/session-api.js +18 -1
  602. package/lib/utils/api/show-api.d.ts +8 -0
  603. package/lib/utils/api/{tmdb-api.js → show-api.js} +4 -4
  604. package/lib/utils/api/studio-api.d.ts +8 -0
  605. package/lib/utils/api/studio-api.js +12 -0
  606. package/lib/utils/api/{hls-segment-api.d.ts → suggestion-api.d.ts} +2 -2
  607. package/lib/utils/api/{hls-segment-api.js → suggestion-api.js} +4 -4
  608. package/lib/utils/api/{package-api.d.ts → trailer-api.d.ts} +2 -2
  609. package/lib/utils/api/{devices-api.js → trailer-api.js} +4 -4
  610. package/lib/utils/api/{dashboard-api.d.ts → trick-play-api.d.ts} +2 -2
  611. package/lib/utils/api/{dashboard-api.js → trick-play-api.js} +4 -4
  612. package/lib/utils/api/{api-key-api.d.ts → user-data-api.d.ts} +2 -2
  613. package/lib/utils/api/{time-sync-api.js → user-data-api.js} +4 -4
  614. package/lib/utils/api/{channels-api.d.ts → user-view-api.d.ts} +2 -2
  615. package/lib/utils/api/{trailers-api.js → user-view-api.js} +4 -4
  616. package/lib/utils/api/video-api.d.ts +8 -0
  617. package/lib/utils/api/video-api.js +12 -0
  618. package/lib/utils/api/year-api.d.ts +8 -0
  619. package/lib/utils/api/year-api.js +12 -0
  620. package/lib/utils/index.js +2 -2
  621. package/lib/utils/url/index.d.ts +1 -0
  622. package/lib/utils/url/index.js +4 -1
  623. package/lib/utils/versioning.d.ts +12 -1
  624. package/lib/utils/versioning.js +44 -13
  625. package/lib/versions.d.ts +1 -1
  626. package/lib/versions.js +1 -1
  627. package/lib/websocket/constants.d.ts +24 -0
  628. package/lib/websocket/constants.js +42 -0
  629. package/lib/websocket/index.d.ts +8 -0
  630. package/lib/websocket/index.js +3 -0
  631. package/lib/{utils/api/client-log-api.d.ts → websocket/models.d.ts} +6 -3
  632. package/lib/websocket/models.js +16 -0
  633. package/lib/websocket/types.d.ts +37 -0
  634. package/lib/websocket/types.js +42 -0
  635. package/lib/websocket/websocket-service.d.ts +142 -0
  636. package/lib/websocket/websocket-service.js +296 -0
  637. package/package.json +20 -16
  638. package/lib/generated-client/api/activity-log-api.d.ts +0 -110
  639. package/lib/generated-client/api/activity-log-api.js +0 -135
  640. package/lib/generated-client/api/api-key-api.d.ts +0 -161
  641. package/lib/generated-client/api/api-key-api.js +0 -245
  642. package/lib/generated-client/api/client-log-api.d.ts +0 -86
  643. package/lib/generated-client/api/client-log-api.js +0 -117
  644. package/lib/generated-client/api/configuration-api.d.ts +0 -292
  645. package/lib/generated-client/api/configuration-api.js +0 -442
  646. package/lib/generated-client/api/dashboard-api.d.ts +0 -132
  647. package/lib/generated-client/api/dashboard-api.js +0 -182
  648. package/lib/generated-client/api/dlna-api.d.ts +0 -292
  649. package/lib/generated-client/api/dlna-server-api.d.ts +0 -784
  650. package/lib/generated-client/api/dynamic-hls-api.d.ts +0 -4261
  651. package/lib/generated-client/api/dynamic-hls-api.js +0 -3025
  652. package/lib/generated-client/api/hls-segment-api.d.ts +0 -325
  653. package/lib/generated-client/api/hls-segment-api.js +0 -415
  654. package/lib/generated-client/api/image-by-name-api.d.ts +0 -292
  655. package/lib/generated-client/api/item-refresh-api.d.ts +0 -126
  656. package/lib/generated-client/api/item-refresh-api.js +0 -143
  657. package/lib/generated-client/api/items-api.d.ts +0 -1052
  658. package/lib/generated-client/api/items-api.js +0 -835
  659. package/lib/generated-client/api/music-genres-api.d.ts +0 -286
  660. package/lib/generated-client/api/music-genres-api.js +0 -278
  661. package/lib/generated-client/api/notifications-api.d.ts +0 -332
  662. package/lib/generated-client/api/package-api.d.ts +0 -315
  663. package/lib/generated-client/api/package-api.js +0 -455
  664. package/lib/generated-client/api/playstate-api.d.ts +0 -679
  665. package/lib/generated-client/api/playstate-api.js +0 -789
  666. package/lib/generated-client/api/plugins-api.d.ts +0 -473
  667. package/lib/generated-client/api/plugins-api.js +0 -663
  668. package/lib/generated-client/api/quick-connect-api.d.ts +0 -198
  669. package/lib/generated-client/api/quick-connect-api.js +0 -305
  670. package/lib/generated-client/api/time-sync-api.d.ts +0 -69
  671. package/lib/generated-client/api/time-sync-api.js +0 -109
  672. package/lib/generated-client/api/tmdb-api.d.ts +0 -69
  673. package/lib/generated-client/api/tmdb-api.js +0 -111
  674. package/lib/generated-client/api/universal-audio-api.d.ts +0 -420
  675. package/lib/generated-client/api/universal-audio-api.js +0 -364
  676. package/lib/generated-client/api/user-library-api.d.ts +0 -657
  677. package/lib/generated-client/api/video-attachments-api.d.ts +0 -101
  678. package/lib/generated-client/api/video-attachments-api.js +0 -126
  679. package/lib/generated-client/models/admin-notification-dto.d.ts +0 -42
  680. package/lib/generated-client/models/base-item.d.ts +0 -84
  681. package/lib/generated-client/models/branding-options.d.ts +0 -35
  682. package/lib/generated-client/models/client-capabilities.d.ts +0 -76
  683. package/lib/generated-client/models/config-image-types.d.ts +0 -59
  684. package/lib/generated-client/models/control-response.d.ts +0 -37
  685. package/lib/generated-client/models/device-identification.d.ts +0 -72
  686. package/lib/generated-client/models/device-info-query-result.d.ts +0 -36
  687. package/lib/generated-client/models/device-info.d.ts +0 -84
  688. package/lib/generated-client/models/device-options.d.ts +0 -35
  689. package/lib/generated-client/models/device-profile-info.d.ts +0 -36
  690. package/lib/generated-client/models/device-profile-type.d.ts +0 -20
  691. package/lib/generated-client/models/dlna-options.d.ts +0 -83
  692. package/lib/generated-client/models/ffmpeg-location.d.ts +0 -22
  693. package/lib/generated-client/models/group-info-dto-group-update.d.ts +0 -37
  694. package/lib/generated-client/models/group-state-update-group-update.d.ts +0 -37
  695. package/lib/generated-client/models/hardware-encoding-type.d.ts +0 -25
  696. package/lib/generated-client/models/header-match-type.d.ts +0 -21
  697. package/lib/generated-client/models/http-header-info.d.ts +0 -36
  698. package/lib/generated-client/models/image-by-name-info.d.ts +0 -47
  699. package/lib/generated-client/models/media-encoder-path-dto.d.ts +0 -29
  700. package/lib/generated-client/models/notification-dto.d.ts +0 -66
  701. package/lib/generated-client/models/notification-option.d.ts +0 -54
  702. package/lib/generated-client/models/notification-options.d.ts +0 -24
  703. package/lib/generated-client/models/notification-result-dto.d.ts +0 -30
  704. package/lib/generated-client/models/notification-type-info.d.ts +0 -47
  705. package/lib/generated-client/models/notifications-summary-dto.d.ts +0 -30
  706. package/lib/generated-client/models/object-group-update.d.ts +0 -36
  707. package/lib/generated-client/models/play-queue-update-group-update.d.ts +0 -37
  708. package/lib/generated-client/models/response-profile.d.ts +0 -61
  709. package/lib/generated-client/models/send-to-user-type.d.ts +0 -21
  710. package/lib/generated-client/models/session-info.d.ts +0 -199
  711. package/lib/generated-client/models/string-group-update.d.ts +0 -36
  712. package/lib/generated-client/models/subtitle-options.d.ts +0 -71
  713. package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +0 -37
  714. package/lib/generated-client/models/trickplay-info.d.ts +0 -65
  715. package/lib/generated-client/models/update-user-easy-password.d.ts +0 -35
  716. package/lib/generated-client/models/wake-on-lan-info.d.ts +0 -29
  717. package/lib/generated-client/models/xml-attribute.d.ts +0 -29
  718. package/lib/utils/api/activity-log-api.js +0 -12
  719. package/lib/utils/api/api-key-api.js +0 -12
  720. package/lib/utils/api/client-log-api.js +0 -12
  721. package/lib/utils/api/configuration-api.d.ts +0 -8
  722. package/lib/utils/api/devices-api.d.ts +0 -8
  723. package/lib/utils/api/display-preferences-api.d.ts +0 -8
  724. package/lib/utils/api/display-preferences-api.js +0 -12
  725. package/lib/utils/api/item-refresh-api.d.ts +0 -8
  726. package/lib/utils/api/item-refresh-api.js +0 -12
  727. package/lib/utils/api/media-segments-api.d.ts +0 -8
  728. package/lib/utils/api/media-segments-api.js +0 -12
  729. package/lib/utils/api/music-genres-api.d.ts +0 -8
  730. package/lib/utils/api/music-genres-api.js +0 -12
  731. package/lib/utils/api/package-api.js +0 -12
  732. package/lib/utils/api/persons-api.d.ts +0 -8
  733. package/lib/utils/api/persons-api.js +0 -12
  734. package/lib/utils/api/playlists-api.d.ts +0 -8
  735. package/lib/utils/api/playlists-api.js +0 -12
  736. package/lib/utils/api/playstate-api.d.ts +0 -8
  737. package/lib/utils/api/playstate-api.js +0 -12
  738. package/lib/utils/api/plugins-api.d.ts +0 -8
  739. package/lib/utils/api/plugins-api.js +0 -12
  740. package/lib/utils/api/quick-connect-api.d.ts +0 -8
  741. package/lib/utils/api/scheduled-tasks-api.d.ts +0 -8
  742. package/lib/utils/api/scheduled-tasks-api.js +0 -12
  743. package/lib/utils/api/studios-api.d.ts +0 -8
  744. package/lib/utils/api/studios-api.js +0 -12
  745. package/lib/utils/api/suggestions-api.d.ts +0 -8
  746. package/lib/utils/api/suggestions-api.js +0 -12
  747. package/lib/utils/api/time-sync-api.d.ts +0 -8
  748. package/lib/utils/api/trickplay-api.d.ts +0 -8
  749. package/lib/utils/api/trickplay-api.js +0 -12
  750. package/lib/utils/api/tv-shows-api.d.ts +0 -8
  751. package/lib/utils/api/tv-shows-api.js +0 -12
  752. package/lib/utils/api/universal-audio-api.d.ts +0 -8
  753. package/lib/utils/api/universal-audio-api.js +0 -12
  754. package/lib/utils/api/user-library-api.d.ts +0 -8
  755. package/lib/utils/api/user-library-api.js +0 -12
  756. package/lib/utils/api/user-views-api.d.ts +0 -8
  757. package/lib/utils/api/user-views-api.js +0 -12
  758. package/lib/utils/api/video-attachments-api.d.ts +0 -8
  759. package/lib/utils/api/video-attachments-api.js +0 -12
@@ -12,10 +12,10 @@ import type { Configuration } from '../configuration';
12
12
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
13
13
  import { type RequestArgs, BaseAPI } from '../base';
14
14
  import type { EncodingContext } from '../models';
15
+ import type { MediaStreamProtocol } from '../models';
15
16
  import type { SubtitleDeliveryMethod } from '../models';
16
17
  /**
17
18
  * AudioApi - axios parameter creator
18
- * @export
19
19
  */
20
20
  export declare const AudioApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
@@ -37,7 +37,6 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
37
37
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
38
38
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
39
39
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
40
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
41
40
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
42
41
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
43
42
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -74,7 +73,7 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
74
73
  * @param {*} [options] Override http request option.
75
74
  * @throws {RequiredError}
76
75
  */
77
- getAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
76
+ getAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
78
77
  [key: string]: string;
79
78
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
80
79
  /**
@@ -96,7 +95,6 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
96
95
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
97
96
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
98
97
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
99
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
100
98
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
101
99
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
102
100
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -133,9 +131,34 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
133
131
  * @param {*} [options] Override http request option.
134
132
  * @throws {RequiredError}
135
133
  */
136
- getAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
134
+ getAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
137
135
  [key: string]: string;
138
136
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
137
+ /**
138
+ *
139
+ * @summary Gets an audio stream.
140
+ * @param {string} itemId The item id.
141
+ * @param {Array<string>} [container] Optional. The audio container.
142
+ * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
143
+ * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
144
+ * @param {string} [userId] Optional. The user id.
145
+ * @param {string} [audioCodec] Optional. The audio codec to transcode to.
146
+ * @param {number} [maxAudioChannels] Optional. The maximum number of audio channels.
147
+ * @param {number} [transcodingAudioChannels] Optional. The number of how many audio channels to transcode to.
148
+ * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
149
+ * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
150
+ * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
151
+ * @param {string} [transcodingContainer] Optional. The container to transcode to.
152
+ * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol.
153
+ * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate.
154
+ * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
155
+ * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media.
156
+ * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
157
+ * @param {boolean} [enableRedirection] Whether to enable redirection. Defaults to true.
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ getUniversalAudioStream: (itemId: string, container?: Array<string>, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, enableAudioVbrEncoding?: boolean, enableRedirection?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
139
162
  /**
140
163
  *
141
164
  * @summary Gets an audio stream.
@@ -155,7 +178,6 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
155
178
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
156
179
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
157
180
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
158
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
159
181
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
160
182
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
161
183
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -192,7 +214,7 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
192
214
  * @param {*} [options] Override http request option.
193
215
  * @throws {RequiredError}
194
216
  */
195
- headAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
217
+ headAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
196
218
  [key: string]: string;
197
219
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
198
220
  /**
@@ -214,7 +236,6 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
214
236
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
215
237
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
216
238
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
217
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
218
239
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
219
240
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
220
241
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -251,13 +272,37 @@ export declare const AudioApiAxiosParamCreator: (configuration?: Configuration)
251
272
  * @param {*} [options] Override http request option.
252
273
  * @throws {RequiredError}
253
274
  */
254
- headAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
275
+ headAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
255
276
  [key: string]: string;
256
277
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
278
+ /**
279
+ *
280
+ * @summary Gets an audio stream.
281
+ * @param {string} itemId The item id.
282
+ * @param {Array<string>} [container] Optional. The audio container.
283
+ * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
284
+ * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
285
+ * @param {string} [userId] Optional. The user id.
286
+ * @param {string} [audioCodec] Optional. The audio codec to transcode to.
287
+ * @param {number} [maxAudioChannels] Optional. The maximum number of audio channels.
288
+ * @param {number} [transcodingAudioChannels] Optional. The number of how many audio channels to transcode to.
289
+ * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
290
+ * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
291
+ * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
292
+ * @param {string} [transcodingContainer] Optional. The container to transcode to.
293
+ * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol.
294
+ * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate.
295
+ * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
296
+ * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media.
297
+ * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
298
+ * @param {boolean} [enableRedirection] Whether to enable redirection. Defaults to true.
299
+ * @param {*} [options] Override http request option.
300
+ * @throws {RequiredError}
301
+ */
302
+ headUniversalAudioStream: (itemId: string, container?: Array<string>, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, enableAudioVbrEncoding?: boolean, enableRedirection?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
257
303
  };
258
304
  /**
259
305
  * AudioApi - functional programming interface
260
- * @export
261
306
  */
262
307
  export declare const AudioApiFp: (configuration?: Configuration) => {
263
308
  /**
@@ -279,7 +324,6 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
279
324
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
280
325
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
281
326
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
282
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
283
327
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
284
328
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
285
329
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -316,7 +360,7 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
316
360
  * @param {*} [options] Override http request option.
317
361
  * @throws {RequiredError}
318
362
  */
319
- getAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
363
+ getAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
320
364
  [key: string]: string;
321
365
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
322
366
  /**
@@ -338,7 +382,6 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
338
382
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
339
383
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
340
384
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
341
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
342
385
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
343
386
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
344
387
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -375,9 +418,34 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
375
418
  * @param {*} [options] Override http request option.
376
419
  * @throws {RequiredError}
377
420
  */
378
- getAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
421
+ getAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
379
422
  [key: string]: string;
380
423
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
424
+ /**
425
+ *
426
+ * @summary Gets an audio stream.
427
+ * @param {string} itemId The item id.
428
+ * @param {Array<string>} [container] Optional. The audio container.
429
+ * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
430
+ * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
431
+ * @param {string} [userId] Optional. The user id.
432
+ * @param {string} [audioCodec] Optional. The audio codec to transcode to.
433
+ * @param {number} [maxAudioChannels] Optional. The maximum number of audio channels.
434
+ * @param {number} [transcodingAudioChannels] Optional. The number of how many audio channels to transcode to.
435
+ * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
436
+ * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
437
+ * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
438
+ * @param {string} [transcodingContainer] Optional. The container to transcode to.
439
+ * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol.
440
+ * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate.
441
+ * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
442
+ * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media.
443
+ * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
444
+ * @param {boolean} [enableRedirection] Whether to enable redirection. Defaults to true.
445
+ * @param {*} [options] Override http request option.
446
+ * @throws {RequiredError}
447
+ */
448
+ getUniversalAudioStream(itemId: string, container?: Array<string>, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, enableAudioVbrEncoding?: boolean, enableRedirection?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
381
449
  /**
382
450
  *
383
451
  * @summary Gets an audio stream.
@@ -397,7 +465,6 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
397
465
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
398
466
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
399
467
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
400
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
401
468
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
402
469
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
403
470
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -434,7 +501,7 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
434
501
  * @param {*} [options] Override http request option.
435
502
  * @throws {RequiredError}
436
503
  */
437
- headAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
504
+ headAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
438
505
  [key: string]: string;
439
506
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
440
507
  /**
@@ -456,7 +523,6 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
456
523
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
457
524
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
458
525
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
459
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
460
526
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
461
527
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
462
528
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -493,13 +559,37 @@ export declare const AudioApiFp: (configuration?: Configuration) => {
493
559
  * @param {*} [options] Override http request option.
494
560
  * @throws {RequiredError}
495
561
  */
496
- headAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
562
+ headAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
497
563
  [key: string]: string;
498
564
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
565
+ /**
566
+ *
567
+ * @summary Gets an audio stream.
568
+ * @param {string} itemId The item id.
569
+ * @param {Array<string>} [container] Optional. The audio container.
570
+ * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
571
+ * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
572
+ * @param {string} [userId] Optional. The user id.
573
+ * @param {string} [audioCodec] Optional. The audio codec to transcode to.
574
+ * @param {number} [maxAudioChannels] Optional. The maximum number of audio channels.
575
+ * @param {number} [transcodingAudioChannels] Optional. The number of how many audio channels to transcode to.
576
+ * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
577
+ * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
578
+ * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
579
+ * @param {string} [transcodingContainer] Optional. The container to transcode to.
580
+ * @param {MediaStreamProtocol} [transcodingProtocol] Optional. The transcoding protocol.
581
+ * @param {number} [maxAudioSampleRate] Optional. The maximum audio sample rate.
582
+ * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
583
+ * @param {boolean} [enableRemoteMedia] Optional. Whether to enable remote media.
584
+ * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
585
+ * @param {boolean} [enableRedirection] Whether to enable redirection. Defaults to true.
586
+ * @param {*} [options] Override http request option.
587
+ * @throws {RequiredError}
588
+ */
589
+ headUniversalAudioStream(itemId: string, container?: Array<string>, mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: MediaStreamProtocol, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, enableAudioVbrEncoding?: boolean, enableRedirection?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
499
590
  };
500
591
  /**
501
592
  * AudioApi - factory interface
502
- * @export
503
593
  */
504
594
  export declare const AudioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
505
595
  /**
@@ -518,6 +608,14 @@ export declare const AudioApiFactory: (configuration?: Configuration, basePath?:
518
608
  * @throws {RequiredError}
519
609
  */
520
610
  getAudioStreamByContainer(requestParameters: AudioApiGetAudioStreamByContainerRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
611
+ /**
612
+ *
613
+ * @summary Gets an audio stream.
614
+ * @param {AudioApiGetUniversalAudioStreamRequest} requestParameters Request parameters.
615
+ * @param {*} [options] Override http request option.
616
+ * @throws {RequiredError}
617
+ */
618
+ getUniversalAudioStream(requestParameters: AudioApiGetUniversalAudioStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
521
619
  /**
522
620
  *
523
621
  * @summary Gets an audio stream.
@@ -534,1248 +632,983 @@ export declare const AudioApiFactory: (configuration?: Configuration, basePath?:
534
632
  * @throws {RequiredError}
535
633
  */
536
634
  headAudioStreamByContainer(requestParameters: AudioApiHeadAudioStreamByContainerRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
635
+ /**
636
+ *
637
+ * @summary Gets an audio stream.
638
+ * @param {AudioApiHeadUniversalAudioStreamRequest} requestParameters Request parameters.
639
+ * @param {*} [options] Override http request option.
640
+ * @throws {RequiredError}
641
+ */
642
+ headUniversalAudioStream(requestParameters: AudioApiHeadUniversalAudioStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
537
643
  };
538
644
  /**
539
645
  * Request parameters for getAudioStream operation in AudioApi.
540
- * @export
541
- * @interface AudioApiGetAudioStreamRequest
542
646
  */
543
647
  export interface AudioApiGetAudioStreamRequest {
544
648
  /**
545
649
  * The item id.
546
- * @type {string}
547
- * @memberof AudioApiGetAudioStream
548
650
  */
549
651
  readonly itemId: string;
550
652
  /**
551
653
  * The audio container.
552
- * @type {string}
553
- * @memberof AudioApiGetAudioStream
554
654
  */
555
655
  readonly container?: string;
556
656
  /**
557
657
  * Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
558
- * @type {boolean}
559
- * @memberof AudioApiGetAudioStream
560
658
  */
561
659
  readonly _static?: boolean;
562
660
  /**
563
661
  * The streaming parameters.
564
- * @type {string}
565
- * @memberof AudioApiGetAudioStream
566
662
  */
567
663
  readonly params?: string;
568
664
  /**
569
665
  * The tag.
570
- * @type {string}
571
- * @memberof AudioApiGetAudioStream
572
666
  */
573
667
  readonly tag?: string;
574
668
  /**
575
669
  * Optional. The dlna device profile id to utilize.
576
- * @type {string}
577
- * @memberof AudioApiGetAudioStream
578
670
  */
579
671
  readonly deviceProfileId?: string;
580
672
  /**
581
673
  * The play session id.
582
- * @type {string}
583
- * @memberof AudioApiGetAudioStream
584
674
  */
585
675
  readonly playSessionId?: string;
586
676
  /**
587
677
  * The segment container.
588
- * @type {string}
589
- * @memberof AudioApiGetAudioStream
590
678
  */
591
679
  readonly segmentContainer?: string;
592
680
  /**
593
681
  * The segment length.
594
- * @type {number}
595
- * @memberof AudioApiGetAudioStream
596
682
  */
597
683
  readonly segmentLength?: number;
598
684
  /**
599
685
  * The minimum number of segments.
600
- * @type {number}
601
- * @memberof AudioApiGetAudioStream
602
686
  */
603
687
  readonly minSegments?: number;
604
688
  /**
605
689
  * The media version id, if playing an alternate version.
606
- * @type {string}
607
- * @memberof AudioApiGetAudioStream
608
690
  */
609
691
  readonly mediaSourceId?: string;
610
692
  /**
611
693
  * The device id of the client requesting. Used to stop encoding processes when needed.
612
- * @type {string}
613
- * @memberof AudioApiGetAudioStream
614
694
  */
615
695
  readonly deviceId?: string;
616
696
  /**
617
697
  * Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\&#39;s extension.
618
- * @type {string}
619
- * @memberof AudioApiGetAudioStream
620
698
  */
621
699
  readonly audioCodec?: string;
622
700
  /**
623
701
  * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
624
- * @type {boolean}
625
- * @memberof AudioApiGetAudioStream
626
702
  */
627
703
  readonly enableAutoStreamCopy?: boolean;
628
704
  /**
629
705
  * Whether or not to allow copying of the video stream url.
630
- * @type {boolean}
631
- * @memberof AudioApiGetAudioStream
632
706
  */
633
707
  readonly allowVideoStreamCopy?: boolean;
634
708
  /**
635
709
  * Whether or not to allow copying of the audio stream url.
636
- * @type {boolean}
637
- * @memberof AudioApiGetAudioStream
638
710
  */
639
711
  readonly allowAudioStreamCopy?: boolean;
640
- /**
641
- * Optional. Whether to break on non key frames.
642
- * @type {boolean}
643
- * @memberof AudioApiGetAudioStream
644
- */
645
- readonly breakOnNonKeyFrames?: boolean;
646
712
  /**
647
713
  * Optional. Specify a specific audio sample rate, e.g. 44100.
648
- * @type {number}
649
- * @memberof AudioApiGetAudioStream
650
714
  */
651
715
  readonly audioSampleRate?: number;
652
716
  /**
653
717
  * Optional. The maximum audio bit depth.
654
- * @type {number}
655
- * @memberof AudioApiGetAudioStream
656
718
  */
657
719
  readonly maxAudioBitDepth?: number;
658
720
  /**
659
721
  * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
660
- * @type {number}
661
- * @memberof AudioApiGetAudioStream
662
722
  */
663
723
  readonly audioBitRate?: number;
664
724
  /**
665
725
  * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
666
- * @type {number}
667
- * @memberof AudioApiGetAudioStream
668
726
  */
669
727
  readonly audioChannels?: number;
670
728
  /**
671
729
  * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
672
- * @type {number}
673
- * @memberof AudioApiGetAudioStream
674
730
  */
675
731
  readonly maxAudioChannels?: number;
676
732
  /**
677
733
  * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
678
- * @type {string}
679
- * @memberof AudioApiGetAudioStream
680
734
  */
681
735
  readonly profile?: string;
682
736
  /**
683
737
  * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
684
- * @type {string}
685
- * @memberof AudioApiGetAudioStream
686
738
  */
687
739
  readonly level?: string;
688
740
  /**
689
741
  * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
690
- * @type {number}
691
- * @memberof AudioApiGetAudioStream
692
742
  */
693
743
  readonly framerate?: number;
694
744
  /**
695
745
  * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
696
- * @type {number}
697
- * @memberof AudioApiGetAudioStream
698
746
  */
699
747
  readonly maxFramerate?: number;
700
748
  /**
701
749
  * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
702
- * @type {boolean}
703
- * @memberof AudioApiGetAudioStream
704
750
  */
705
751
  readonly copyTimestamps?: boolean;
706
752
  /**
707
753
  * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
708
- * @type {number}
709
- * @memberof AudioApiGetAudioStream
710
754
  */
711
755
  readonly startTimeTicks?: number;
712
756
  /**
713
757
  * Optional. The fixed horizontal resolution of the encoded video.
714
- * @type {number}
715
- * @memberof AudioApiGetAudioStream
716
758
  */
717
759
  readonly width?: number;
718
760
  /**
719
761
  * Optional. The fixed vertical resolution of the encoded video.
720
- * @type {number}
721
- * @memberof AudioApiGetAudioStream
722
762
  */
723
763
  readonly height?: number;
724
764
  /**
725
765
  * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
726
- * @type {number}
727
- * @memberof AudioApiGetAudioStream
728
766
  */
729
767
  readonly videoBitRate?: number;
730
768
  /**
731
769
  * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
732
- * @type {number}
733
- * @memberof AudioApiGetAudioStream
734
770
  */
735
771
  readonly subtitleStreamIndex?: number;
736
772
  /**
737
773
  * Optional. Specify the subtitle delivery method.
738
- * @type {SubtitleDeliveryMethod}
739
- * @memberof AudioApiGetAudioStream
740
774
  */
741
775
  readonly subtitleMethod?: SubtitleDeliveryMethod;
742
776
  /**
743
777
  * Optional.
744
- * @type {number}
745
- * @memberof AudioApiGetAudioStream
746
778
  */
747
779
  readonly maxRefFrames?: number;
748
780
  /**
749
781
  * Optional. The maximum video bit depth.
750
- * @type {number}
751
- * @memberof AudioApiGetAudioStream
752
782
  */
753
783
  readonly maxVideoBitDepth?: number;
754
784
  /**
755
785
  * Optional. Whether to require avc.
756
- * @type {boolean}
757
- * @memberof AudioApiGetAudioStream
758
786
  */
759
787
  readonly requireAvc?: boolean;
760
788
  /**
761
789
  * Optional. Whether to deinterlace the video.
762
- * @type {boolean}
763
- * @memberof AudioApiGetAudioStream
764
790
  */
765
791
  readonly deInterlace?: boolean;
766
792
  /**
767
793
  * Optional. Whether to require a non anamorphic stream.
768
- * @type {boolean}
769
- * @memberof AudioApiGetAudioStream
770
794
  */
771
795
  readonly requireNonAnamorphic?: boolean;
772
796
  /**
773
797
  * Optional. The maximum number of audio channels to transcode.
774
- * @type {number}
775
- * @memberof AudioApiGetAudioStream
776
798
  */
777
799
  readonly transcodingMaxAudioChannels?: number;
778
800
  /**
779
801
  * Optional. The limit of how many cpu cores to use.
780
- * @type {number}
781
- * @memberof AudioApiGetAudioStream
782
802
  */
783
803
  readonly cpuCoreLimit?: number;
784
804
  /**
785
805
  * The live stream id.
786
- * @type {string}
787
- * @memberof AudioApiGetAudioStream
788
806
  */
789
807
  readonly liveStreamId?: string;
790
808
  /**
791
809
  * Optional. Whether to enable the MpegtsM2Ts mode.
792
- * @type {boolean}
793
- * @memberof AudioApiGetAudioStream
794
810
  */
795
811
  readonly enableMpegtsM2TsMode?: boolean;
796
812
  /**
797
813
  * Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\&#39;s extension.
798
- * @type {string}
799
- * @memberof AudioApiGetAudioStream
800
814
  */
801
815
  readonly videoCodec?: string;
802
816
  /**
803
817
  * Optional. Specify a subtitle codec to encode to.
804
- * @type {string}
805
- * @memberof AudioApiGetAudioStream
806
818
  */
807
819
  readonly subtitleCodec?: string;
808
820
  /**
809
821
  * Optional. The transcoding reason.
810
- * @type {string}
811
- * @memberof AudioApiGetAudioStream
812
822
  */
813
823
  readonly transcodeReasons?: string;
814
824
  /**
815
825
  * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
816
- * @type {number}
817
- * @memberof AudioApiGetAudioStream
818
826
  */
819
827
  readonly audioStreamIndex?: number;
820
828
  /**
821
829
  * Optional. The index of the video stream to use. If omitted the first video stream will be used.
822
- * @type {number}
823
- * @memberof AudioApiGetAudioStream
824
830
  */
825
831
  readonly videoStreamIndex?: number;
826
832
  /**
827
833
  * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
828
- * @type {EncodingContext}
829
- * @memberof AudioApiGetAudioStream
830
834
  */
831
835
  readonly context?: EncodingContext;
832
836
  /**
833
837
  * Optional. The streaming options.
834
- * @type {{ [key: string]: string; }}
835
- * @memberof AudioApiGetAudioStream
836
838
  */
837
839
  readonly streamOptions?: {
838
840
  [key: string]: string;
839
841
  };
840
842
  /**
841
843
  * Optional. Whether to enable Audio Encoding.
842
- * @type {boolean}
843
- * @memberof AudioApiGetAudioStream
844
844
  */
845
845
  readonly enableAudioVbrEncoding?: boolean;
846
846
  }
847
847
  /**
848
848
  * Request parameters for getAudioStreamByContainer operation in AudioApi.
849
- * @export
850
- * @interface AudioApiGetAudioStreamByContainerRequest
851
849
  */
852
850
  export interface AudioApiGetAudioStreamByContainerRequest {
853
851
  /**
854
852
  * The item id.
855
- * @type {string}
856
- * @memberof AudioApiGetAudioStreamByContainer
857
853
  */
858
854
  readonly itemId: string;
859
855
  /**
860
856
  * The audio container.
861
- * @type {string}
862
- * @memberof AudioApiGetAudioStreamByContainer
863
857
  */
864
858
  readonly container: string;
865
859
  /**
866
860
  * Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
867
- * @type {boolean}
868
- * @memberof AudioApiGetAudioStreamByContainer
869
861
  */
870
862
  readonly _static?: boolean;
871
863
  /**
872
864
  * The streaming parameters.
873
- * @type {string}
874
- * @memberof AudioApiGetAudioStreamByContainer
875
865
  */
876
866
  readonly params?: string;
877
867
  /**
878
868
  * The tag.
879
- * @type {string}
880
- * @memberof AudioApiGetAudioStreamByContainer
881
869
  */
882
870
  readonly tag?: string;
883
871
  /**
884
872
  * Optional. The dlna device profile id to utilize.
885
- * @type {string}
886
- * @memberof AudioApiGetAudioStreamByContainer
887
873
  */
888
874
  readonly deviceProfileId?: string;
889
875
  /**
890
876
  * The play session id.
891
- * @type {string}
892
- * @memberof AudioApiGetAudioStreamByContainer
893
877
  */
894
878
  readonly playSessionId?: string;
895
879
  /**
896
880
  * The segment container.
897
- * @type {string}
898
- * @memberof AudioApiGetAudioStreamByContainer
899
881
  */
900
882
  readonly segmentContainer?: string;
901
883
  /**
902
884
  * The segment length.
903
- * @type {number}
904
- * @memberof AudioApiGetAudioStreamByContainer
905
885
  */
906
886
  readonly segmentLength?: number;
907
887
  /**
908
888
  * The minimum number of segments.
909
- * @type {number}
910
- * @memberof AudioApiGetAudioStreamByContainer
911
889
  */
912
890
  readonly minSegments?: number;
913
891
  /**
914
892
  * The media version id, if playing an alternate version.
915
- * @type {string}
916
- * @memberof AudioApiGetAudioStreamByContainer
917
893
  */
918
894
  readonly mediaSourceId?: string;
919
895
  /**
920
896
  * The device id of the client requesting. Used to stop encoding processes when needed.
921
- * @type {string}
922
- * @memberof AudioApiGetAudioStreamByContainer
923
897
  */
924
898
  readonly deviceId?: string;
925
899
  /**
926
900
  * Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\&#39;s extension.
927
- * @type {string}
928
- * @memberof AudioApiGetAudioStreamByContainer
929
901
  */
930
902
  readonly audioCodec?: string;
931
903
  /**
932
904
  * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
933
- * @type {boolean}
934
- * @memberof AudioApiGetAudioStreamByContainer
935
905
  */
936
906
  readonly enableAutoStreamCopy?: boolean;
937
907
  /**
938
908
  * Whether or not to allow copying of the video stream url.
939
- * @type {boolean}
940
- * @memberof AudioApiGetAudioStreamByContainer
941
909
  */
942
910
  readonly allowVideoStreamCopy?: boolean;
943
911
  /**
944
912
  * Whether or not to allow copying of the audio stream url.
945
- * @type {boolean}
946
- * @memberof AudioApiGetAudioStreamByContainer
947
913
  */
948
914
  readonly allowAudioStreamCopy?: boolean;
949
- /**
950
- * Optional. Whether to break on non key frames.
951
- * @type {boolean}
952
- * @memberof AudioApiGetAudioStreamByContainer
953
- */
954
- readonly breakOnNonKeyFrames?: boolean;
955
915
  /**
956
916
  * Optional. Specify a specific audio sample rate, e.g. 44100.
957
- * @type {number}
958
- * @memberof AudioApiGetAudioStreamByContainer
959
917
  */
960
918
  readonly audioSampleRate?: number;
961
919
  /**
962
920
  * Optional. The maximum audio bit depth.
963
- * @type {number}
964
- * @memberof AudioApiGetAudioStreamByContainer
965
921
  */
966
922
  readonly maxAudioBitDepth?: number;
967
923
  /**
968
924
  * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
969
- * @type {number}
970
- * @memberof AudioApiGetAudioStreamByContainer
971
925
  */
972
926
  readonly audioBitRate?: number;
973
927
  /**
974
928
  * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
975
- * @type {number}
976
- * @memberof AudioApiGetAudioStreamByContainer
977
929
  */
978
930
  readonly audioChannels?: number;
979
931
  /**
980
932
  * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
981
- * @type {number}
982
- * @memberof AudioApiGetAudioStreamByContainer
983
933
  */
984
934
  readonly maxAudioChannels?: number;
985
935
  /**
986
936
  * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
987
- * @type {string}
988
- * @memberof AudioApiGetAudioStreamByContainer
989
937
  */
990
938
  readonly profile?: string;
991
939
  /**
992
940
  * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
993
- * @type {string}
994
- * @memberof AudioApiGetAudioStreamByContainer
995
941
  */
996
942
  readonly level?: string;
997
943
  /**
998
944
  * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
999
- * @type {number}
1000
- * @memberof AudioApiGetAudioStreamByContainer
1001
945
  */
1002
946
  readonly framerate?: number;
1003
947
  /**
1004
948
  * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1005
- * @type {number}
1006
- * @memberof AudioApiGetAudioStreamByContainer
1007
949
  */
1008
950
  readonly maxFramerate?: number;
1009
951
  /**
1010
952
  * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1011
- * @type {boolean}
1012
- * @memberof AudioApiGetAudioStreamByContainer
1013
953
  */
1014
954
  readonly copyTimestamps?: boolean;
1015
955
  /**
1016
956
  * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1017
- * @type {number}
1018
- * @memberof AudioApiGetAudioStreamByContainer
1019
957
  */
1020
958
  readonly startTimeTicks?: number;
1021
959
  /**
1022
960
  * Optional. The fixed horizontal resolution of the encoded video.
1023
- * @type {number}
1024
- * @memberof AudioApiGetAudioStreamByContainer
1025
961
  */
1026
962
  readonly width?: number;
1027
963
  /**
1028
964
  * Optional. The fixed vertical resolution of the encoded video.
1029
- * @type {number}
1030
- * @memberof AudioApiGetAudioStreamByContainer
1031
965
  */
1032
966
  readonly height?: number;
1033
967
  /**
1034
968
  * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1035
- * @type {number}
1036
- * @memberof AudioApiGetAudioStreamByContainer
1037
969
  */
1038
970
  readonly videoBitRate?: number;
1039
971
  /**
1040
972
  * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1041
- * @type {number}
1042
- * @memberof AudioApiGetAudioStreamByContainer
1043
973
  */
1044
974
  readonly subtitleStreamIndex?: number;
1045
975
  /**
1046
976
  * Optional. Specify the subtitle delivery method.
1047
- * @type {SubtitleDeliveryMethod}
1048
- * @memberof AudioApiGetAudioStreamByContainer
1049
977
  */
1050
978
  readonly subtitleMethod?: SubtitleDeliveryMethod;
1051
979
  /**
1052
980
  * Optional.
1053
- * @type {number}
1054
- * @memberof AudioApiGetAudioStreamByContainer
1055
981
  */
1056
982
  readonly maxRefFrames?: number;
1057
983
  /**
1058
984
  * Optional. The maximum video bit depth.
1059
- * @type {number}
1060
- * @memberof AudioApiGetAudioStreamByContainer
1061
985
  */
1062
986
  readonly maxVideoBitDepth?: number;
1063
987
  /**
1064
988
  * Optional. Whether to require avc.
1065
- * @type {boolean}
1066
- * @memberof AudioApiGetAudioStreamByContainer
1067
989
  */
1068
990
  readonly requireAvc?: boolean;
1069
991
  /**
1070
992
  * Optional. Whether to deinterlace the video.
1071
- * @type {boolean}
1072
- * @memberof AudioApiGetAudioStreamByContainer
1073
993
  */
1074
994
  readonly deInterlace?: boolean;
1075
995
  /**
1076
996
  * Optional. Whether to require a non anamorphic stream.
1077
- * @type {boolean}
1078
- * @memberof AudioApiGetAudioStreamByContainer
1079
997
  */
1080
998
  readonly requireNonAnamorphic?: boolean;
1081
999
  /**
1082
1000
  * Optional. The maximum number of audio channels to transcode.
1083
- * @type {number}
1084
- * @memberof AudioApiGetAudioStreamByContainer
1085
1001
  */
1086
1002
  readonly transcodingMaxAudioChannels?: number;
1087
1003
  /**
1088
1004
  * Optional. The limit of how many cpu cores to use.
1089
- * @type {number}
1090
- * @memberof AudioApiGetAudioStreamByContainer
1091
1005
  */
1092
1006
  readonly cpuCoreLimit?: number;
1093
1007
  /**
1094
1008
  * The live stream id.
1095
- * @type {string}
1096
- * @memberof AudioApiGetAudioStreamByContainer
1097
1009
  */
1098
1010
  readonly liveStreamId?: string;
1099
1011
  /**
1100
1012
  * Optional. Whether to enable the MpegtsM2Ts mode.
1101
- * @type {boolean}
1102
- * @memberof AudioApiGetAudioStreamByContainer
1103
1013
  */
1104
1014
  readonly enableMpegtsM2TsMode?: boolean;
1105
1015
  /**
1106
1016
  * Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\&#39;s extension.
1107
- * @type {string}
1108
- * @memberof AudioApiGetAudioStreamByContainer
1109
1017
  */
1110
1018
  readonly videoCodec?: string;
1111
1019
  /**
1112
1020
  * Optional. Specify a subtitle codec to encode to.
1113
- * @type {string}
1114
- * @memberof AudioApiGetAudioStreamByContainer
1115
1021
  */
1116
1022
  readonly subtitleCodec?: string;
1117
1023
  /**
1118
1024
  * Optional. The transcoding reason.
1119
- * @type {string}
1120
- * @memberof AudioApiGetAudioStreamByContainer
1121
1025
  */
1122
1026
  readonly transcodeReasons?: string;
1123
1027
  /**
1124
1028
  * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1125
- * @type {number}
1126
- * @memberof AudioApiGetAudioStreamByContainer
1127
1029
  */
1128
1030
  readonly audioStreamIndex?: number;
1129
1031
  /**
1130
1032
  * Optional. The index of the video stream to use. If omitted the first video stream will be used.
1131
- * @type {number}
1132
- * @memberof AudioApiGetAudioStreamByContainer
1133
1033
  */
1134
1034
  readonly videoStreamIndex?: number;
1135
1035
  /**
1136
1036
  * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1137
- * @type {EncodingContext}
1138
- * @memberof AudioApiGetAudioStreamByContainer
1139
1037
  */
1140
1038
  readonly context?: EncodingContext;
1141
1039
  /**
1142
1040
  * Optional. The streaming options.
1143
- * @type {{ [key: string]: string; }}
1144
- * @memberof AudioApiGetAudioStreamByContainer
1145
1041
  */
1146
1042
  readonly streamOptions?: {
1147
1043
  [key: string]: string;
1148
1044
  };
1149
1045
  /**
1150
1046
  * Optional. Whether to enable Audio Encoding.
1151
- * @type {boolean}
1152
- * @memberof AudioApiGetAudioStreamByContainer
1153
1047
  */
1154
1048
  readonly enableAudioVbrEncoding?: boolean;
1155
1049
  }
1050
+ /**
1051
+ * Request parameters for getUniversalAudioStream operation in AudioApi.
1052
+ */
1053
+ export interface AudioApiGetUniversalAudioStreamRequest {
1054
+ /**
1055
+ * The item id.
1056
+ */
1057
+ readonly itemId: string;
1058
+ /**
1059
+ * Optional. The audio container.
1060
+ */
1061
+ readonly container?: Array<string>;
1062
+ /**
1063
+ * The media version id, if playing an alternate version.
1064
+ */
1065
+ readonly mediaSourceId?: string;
1066
+ /**
1067
+ * The device id of the client requesting. Used to stop encoding processes when needed.
1068
+ */
1069
+ readonly deviceId?: string;
1070
+ /**
1071
+ * Optional. The user id.
1072
+ */
1073
+ readonly userId?: string;
1074
+ /**
1075
+ * Optional. The audio codec to transcode to.
1076
+ */
1077
+ readonly audioCodec?: string;
1078
+ /**
1079
+ * Optional. The maximum number of audio channels.
1080
+ */
1081
+ readonly maxAudioChannels?: number;
1082
+ /**
1083
+ * Optional. The number of how many audio channels to transcode to.
1084
+ */
1085
+ readonly transcodingAudioChannels?: number;
1086
+ /**
1087
+ * Optional. The maximum streaming bitrate.
1088
+ */
1089
+ readonly maxStreamingBitrate?: number;
1090
+ /**
1091
+ * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1092
+ */
1093
+ readonly audioBitRate?: number;
1094
+ /**
1095
+ * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1096
+ */
1097
+ readonly startTimeTicks?: number;
1098
+ /**
1099
+ * Optional. The container to transcode to.
1100
+ */
1101
+ readonly transcodingContainer?: string;
1102
+ /**
1103
+ * Optional. The transcoding protocol.
1104
+ */
1105
+ readonly transcodingProtocol?: MediaStreamProtocol;
1106
+ /**
1107
+ * Optional. The maximum audio sample rate.
1108
+ */
1109
+ readonly maxAudioSampleRate?: number;
1110
+ /**
1111
+ * Optional. The maximum audio bit depth.
1112
+ */
1113
+ readonly maxAudioBitDepth?: number;
1114
+ /**
1115
+ * Optional. Whether to enable remote media.
1116
+ */
1117
+ readonly enableRemoteMedia?: boolean;
1118
+ /**
1119
+ * Optional. Whether to enable Audio Encoding.
1120
+ */
1121
+ readonly enableAudioVbrEncoding?: boolean;
1122
+ /**
1123
+ * Whether to enable redirection. Defaults to true.
1124
+ */
1125
+ readonly enableRedirection?: boolean;
1126
+ }
1156
1127
  /**
1157
1128
  * Request parameters for headAudioStream operation in AudioApi.
1158
- * @export
1159
- * @interface AudioApiHeadAudioStreamRequest
1160
1129
  */
1161
1130
  export interface AudioApiHeadAudioStreamRequest {
1162
1131
  /**
1163
1132
  * The item id.
1164
- * @type {string}
1165
- * @memberof AudioApiHeadAudioStream
1166
1133
  */
1167
1134
  readonly itemId: string;
1168
1135
  /**
1169
1136
  * The audio container.
1170
- * @type {string}
1171
- * @memberof AudioApiHeadAudioStream
1172
1137
  */
1173
1138
  readonly container?: string;
1174
1139
  /**
1175
1140
  * Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
1176
- * @type {boolean}
1177
- * @memberof AudioApiHeadAudioStream
1178
1141
  */
1179
1142
  readonly _static?: boolean;
1180
1143
  /**
1181
1144
  * The streaming parameters.
1182
- * @type {string}
1183
- * @memberof AudioApiHeadAudioStream
1184
1145
  */
1185
1146
  readonly params?: string;
1186
1147
  /**
1187
1148
  * The tag.
1188
- * @type {string}
1189
- * @memberof AudioApiHeadAudioStream
1190
1149
  */
1191
1150
  readonly tag?: string;
1192
1151
  /**
1193
1152
  * Optional. The dlna device profile id to utilize.
1194
- * @type {string}
1195
- * @memberof AudioApiHeadAudioStream
1196
1153
  */
1197
1154
  readonly deviceProfileId?: string;
1198
1155
  /**
1199
1156
  * The play session id.
1200
- * @type {string}
1201
- * @memberof AudioApiHeadAudioStream
1202
1157
  */
1203
1158
  readonly playSessionId?: string;
1204
1159
  /**
1205
1160
  * The segment container.
1206
- * @type {string}
1207
- * @memberof AudioApiHeadAudioStream
1208
1161
  */
1209
1162
  readonly segmentContainer?: string;
1210
1163
  /**
1211
1164
  * The segment length.
1212
- * @type {number}
1213
- * @memberof AudioApiHeadAudioStream
1214
1165
  */
1215
1166
  readonly segmentLength?: number;
1216
1167
  /**
1217
1168
  * The minimum number of segments.
1218
- * @type {number}
1219
- * @memberof AudioApiHeadAudioStream
1220
1169
  */
1221
1170
  readonly minSegments?: number;
1222
1171
  /**
1223
1172
  * The media version id, if playing an alternate version.
1224
- * @type {string}
1225
- * @memberof AudioApiHeadAudioStream
1226
1173
  */
1227
1174
  readonly mediaSourceId?: string;
1228
1175
  /**
1229
1176
  * The device id of the client requesting. Used to stop encoding processes when needed.
1230
- * @type {string}
1231
- * @memberof AudioApiHeadAudioStream
1232
1177
  */
1233
1178
  readonly deviceId?: string;
1234
1179
  /**
1235
1180
  * Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\&#39;s extension.
1236
- * @type {string}
1237
- * @memberof AudioApiHeadAudioStream
1238
1181
  */
1239
1182
  readonly audioCodec?: string;
1240
1183
  /**
1241
1184
  * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
1242
- * @type {boolean}
1243
- * @memberof AudioApiHeadAudioStream
1244
1185
  */
1245
1186
  readonly enableAutoStreamCopy?: boolean;
1246
1187
  /**
1247
1188
  * Whether or not to allow copying of the video stream url.
1248
- * @type {boolean}
1249
- * @memberof AudioApiHeadAudioStream
1250
1189
  */
1251
1190
  readonly allowVideoStreamCopy?: boolean;
1252
1191
  /**
1253
1192
  * Whether or not to allow copying of the audio stream url.
1254
- * @type {boolean}
1255
- * @memberof AudioApiHeadAudioStream
1256
1193
  */
1257
1194
  readonly allowAudioStreamCopy?: boolean;
1258
- /**
1259
- * Optional. Whether to break on non key frames.
1260
- * @type {boolean}
1261
- * @memberof AudioApiHeadAudioStream
1262
- */
1263
- readonly breakOnNonKeyFrames?: boolean;
1264
1195
  /**
1265
1196
  * Optional. Specify a specific audio sample rate, e.g. 44100.
1266
- * @type {number}
1267
- * @memberof AudioApiHeadAudioStream
1268
1197
  */
1269
1198
  readonly audioSampleRate?: number;
1270
1199
  /**
1271
1200
  * Optional. The maximum audio bit depth.
1272
- * @type {number}
1273
- * @memberof AudioApiHeadAudioStream
1274
1201
  */
1275
1202
  readonly maxAudioBitDepth?: number;
1276
1203
  /**
1277
1204
  * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1278
- * @type {number}
1279
- * @memberof AudioApiHeadAudioStream
1280
1205
  */
1281
1206
  readonly audioBitRate?: number;
1282
1207
  /**
1283
1208
  * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
1284
- * @type {number}
1285
- * @memberof AudioApiHeadAudioStream
1286
1209
  */
1287
1210
  readonly audioChannels?: number;
1288
1211
  /**
1289
1212
  * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
1290
- * @type {number}
1291
- * @memberof AudioApiHeadAudioStream
1292
1213
  */
1293
1214
  readonly maxAudioChannels?: number;
1294
1215
  /**
1295
1216
  * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
1296
- * @type {string}
1297
- * @memberof AudioApiHeadAudioStream
1298
1217
  */
1299
1218
  readonly profile?: string;
1300
1219
  /**
1301
1220
  * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
1302
- * @type {string}
1303
- * @memberof AudioApiHeadAudioStream
1304
1221
  */
1305
1222
  readonly level?: string;
1306
1223
  /**
1307
1224
  * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1308
- * @type {number}
1309
- * @memberof AudioApiHeadAudioStream
1310
1225
  */
1311
1226
  readonly framerate?: number;
1312
1227
  /**
1313
1228
  * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1314
- * @type {number}
1315
- * @memberof AudioApiHeadAudioStream
1316
1229
  */
1317
1230
  readonly maxFramerate?: number;
1318
1231
  /**
1319
1232
  * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1320
- * @type {boolean}
1321
- * @memberof AudioApiHeadAudioStream
1322
1233
  */
1323
1234
  readonly copyTimestamps?: boolean;
1324
1235
  /**
1325
1236
  * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1326
- * @type {number}
1327
- * @memberof AudioApiHeadAudioStream
1328
1237
  */
1329
1238
  readonly startTimeTicks?: number;
1330
1239
  /**
1331
1240
  * Optional. The fixed horizontal resolution of the encoded video.
1332
- * @type {number}
1333
- * @memberof AudioApiHeadAudioStream
1334
1241
  */
1335
1242
  readonly width?: number;
1336
1243
  /**
1337
1244
  * Optional. The fixed vertical resolution of the encoded video.
1338
- * @type {number}
1339
- * @memberof AudioApiHeadAudioStream
1340
1245
  */
1341
1246
  readonly height?: number;
1342
1247
  /**
1343
1248
  * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1344
- * @type {number}
1345
- * @memberof AudioApiHeadAudioStream
1346
1249
  */
1347
1250
  readonly videoBitRate?: number;
1348
1251
  /**
1349
1252
  * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1350
- * @type {number}
1351
- * @memberof AudioApiHeadAudioStream
1352
1253
  */
1353
1254
  readonly subtitleStreamIndex?: number;
1354
1255
  /**
1355
1256
  * Optional. Specify the subtitle delivery method.
1356
- * @type {SubtitleDeliveryMethod}
1357
- * @memberof AudioApiHeadAudioStream
1358
1257
  */
1359
1258
  readonly subtitleMethod?: SubtitleDeliveryMethod;
1360
1259
  /**
1361
1260
  * Optional.
1362
- * @type {number}
1363
- * @memberof AudioApiHeadAudioStream
1364
1261
  */
1365
1262
  readonly maxRefFrames?: number;
1366
1263
  /**
1367
1264
  * Optional. The maximum video bit depth.
1368
- * @type {number}
1369
- * @memberof AudioApiHeadAudioStream
1370
1265
  */
1371
1266
  readonly maxVideoBitDepth?: number;
1372
1267
  /**
1373
1268
  * Optional. Whether to require avc.
1374
- * @type {boolean}
1375
- * @memberof AudioApiHeadAudioStream
1376
1269
  */
1377
1270
  readonly requireAvc?: boolean;
1378
1271
  /**
1379
1272
  * Optional. Whether to deinterlace the video.
1380
- * @type {boolean}
1381
- * @memberof AudioApiHeadAudioStream
1382
1273
  */
1383
1274
  readonly deInterlace?: boolean;
1384
1275
  /**
1385
1276
  * Optional. Whether to require a non anamorphic stream.
1386
- * @type {boolean}
1387
- * @memberof AudioApiHeadAudioStream
1388
1277
  */
1389
1278
  readonly requireNonAnamorphic?: boolean;
1390
1279
  /**
1391
1280
  * Optional. The maximum number of audio channels to transcode.
1392
- * @type {number}
1393
- * @memberof AudioApiHeadAudioStream
1394
1281
  */
1395
1282
  readonly transcodingMaxAudioChannels?: number;
1396
1283
  /**
1397
1284
  * Optional. The limit of how many cpu cores to use.
1398
- * @type {number}
1399
- * @memberof AudioApiHeadAudioStream
1400
1285
  */
1401
1286
  readonly cpuCoreLimit?: number;
1402
1287
  /**
1403
1288
  * The live stream id.
1404
- * @type {string}
1405
- * @memberof AudioApiHeadAudioStream
1406
1289
  */
1407
1290
  readonly liveStreamId?: string;
1408
1291
  /**
1409
1292
  * Optional. Whether to enable the MpegtsM2Ts mode.
1410
- * @type {boolean}
1411
- * @memberof AudioApiHeadAudioStream
1412
1293
  */
1413
1294
  readonly enableMpegtsM2TsMode?: boolean;
1414
1295
  /**
1415
1296
  * Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\&#39;s extension.
1416
- * @type {string}
1417
- * @memberof AudioApiHeadAudioStream
1418
1297
  */
1419
1298
  readonly videoCodec?: string;
1420
1299
  /**
1421
1300
  * Optional. Specify a subtitle codec to encode to.
1422
- * @type {string}
1423
- * @memberof AudioApiHeadAudioStream
1424
1301
  */
1425
1302
  readonly subtitleCodec?: string;
1426
1303
  /**
1427
1304
  * Optional. The transcoding reason.
1428
- * @type {string}
1429
- * @memberof AudioApiHeadAudioStream
1430
1305
  */
1431
1306
  readonly transcodeReasons?: string;
1432
1307
  /**
1433
1308
  * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1434
- * @type {number}
1435
- * @memberof AudioApiHeadAudioStream
1436
1309
  */
1437
1310
  readonly audioStreamIndex?: number;
1438
1311
  /**
1439
1312
  * Optional. The index of the video stream to use. If omitted the first video stream will be used.
1440
- * @type {number}
1441
- * @memberof AudioApiHeadAudioStream
1442
1313
  */
1443
1314
  readonly videoStreamIndex?: number;
1444
1315
  /**
1445
1316
  * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1446
- * @type {EncodingContext}
1447
- * @memberof AudioApiHeadAudioStream
1448
1317
  */
1449
1318
  readonly context?: EncodingContext;
1450
1319
  /**
1451
1320
  * Optional. The streaming options.
1452
- * @type {{ [key: string]: string; }}
1453
- * @memberof AudioApiHeadAudioStream
1454
1321
  */
1455
1322
  readonly streamOptions?: {
1456
1323
  [key: string]: string;
1457
1324
  };
1458
1325
  /**
1459
1326
  * Optional. Whether to enable Audio Encoding.
1460
- * @type {boolean}
1461
- * @memberof AudioApiHeadAudioStream
1462
1327
  */
1463
1328
  readonly enableAudioVbrEncoding?: boolean;
1464
1329
  }
1465
1330
  /**
1466
1331
  * Request parameters for headAudioStreamByContainer operation in AudioApi.
1467
- * @export
1468
- * @interface AudioApiHeadAudioStreamByContainerRequest
1469
1332
  */
1470
1333
  export interface AudioApiHeadAudioStreamByContainerRequest {
1471
1334
  /**
1472
1335
  * The item id.
1473
- * @type {string}
1474
- * @memberof AudioApiHeadAudioStreamByContainer
1475
1336
  */
1476
1337
  readonly itemId: string;
1477
1338
  /**
1478
1339
  * The audio container.
1479
- * @type {string}
1480
- * @memberof AudioApiHeadAudioStreamByContainer
1481
1340
  */
1482
1341
  readonly container: string;
1483
1342
  /**
1484
1343
  * Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false.
1485
- * @type {boolean}
1486
- * @memberof AudioApiHeadAudioStreamByContainer
1487
1344
  */
1488
1345
  readonly _static?: boolean;
1489
1346
  /**
1490
1347
  * The streaming parameters.
1491
- * @type {string}
1492
- * @memberof AudioApiHeadAudioStreamByContainer
1493
1348
  */
1494
1349
  readonly params?: string;
1495
1350
  /**
1496
1351
  * The tag.
1497
- * @type {string}
1498
- * @memberof AudioApiHeadAudioStreamByContainer
1499
1352
  */
1500
1353
  readonly tag?: string;
1501
1354
  /**
1502
1355
  * Optional. The dlna device profile id to utilize.
1503
- * @type {string}
1504
- * @memberof AudioApiHeadAudioStreamByContainer
1505
1356
  */
1506
1357
  readonly deviceProfileId?: string;
1507
1358
  /**
1508
1359
  * The play session id.
1509
- * @type {string}
1510
- * @memberof AudioApiHeadAudioStreamByContainer
1511
1360
  */
1512
1361
  readonly playSessionId?: string;
1513
1362
  /**
1514
1363
  * The segment container.
1515
- * @type {string}
1516
- * @memberof AudioApiHeadAudioStreamByContainer
1517
1364
  */
1518
1365
  readonly segmentContainer?: string;
1519
1366
  /**
1520
1367
  * The segment length.
1521
- * @type {number}
1522
- * @memberof AudioApiHeadAudioStreamByContainer
1523
1368
  */
1524
1369
  readonly segmentLength?: number;
1525
1370
  /**
1526
1371
  * The minimum number of segments.
1527
- * @type {number}
1528
- * @memberof AudioApiHeadAudioStreamByContainer
1529
1372
  */
1530
1373
  readonly minSegments?: number;
1531
1374
  /**
1532
1375
  * The media version id, if playing an alternate version.
1533
- * @type {string}
1534
- * @memberof AudioApiHeadAudioStreamByContainer
1535
1376
  */
1536
1377
  readonly mediaSourceId?: string;
1537
1378
  /**
1538
1379
  * The device id of the client requesting. Used to stop encoding processes when needed.
1539
- * @type {string}
1540
- * @memberof AudioApiHeadAudioStreamByContainer
1541
1380
  */
1542
1381
  readonly deviceId?: string;
1543
1382
  /**
1544
1383
  * Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\&#39;s extension.
1545
- * @type {string}
1546
- * @memberof AudioApiHeadAudioStreamByContainer
1547
1384
  */
1548
1385
  readonly audioCodec?: string;
1549
1386
  /**
1550
1387
  * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
1551
- * @type {boolean}
1552
- * @memberof AudioApiHeadAudioStreamByContainer
1553
1388
  */
1554
1389
  readonly enableAutoStreamCopy?: boolean;
1555
1390
  /**
1556
1391
  * Whether or not to allow copying of the video stream url.
1557
- * @type {boolean}
1558
- * @memberof AudioApiHeadAudioStreamByContainer
1559
1392
  */
1560
1393
  readonly allowVideoStreamCopy?: boolean;
1561
1394
  /**
1562
1395
  * Whether or not to allow copying of the audio stream url.
1563
- * @type {boolean}
1564
- * @memberof AudioApiHeadAudioStreamByContainer
1565
1396
  */
1566
1397
  readonly allowAudioStreamCopy?: boolean;
1567
- /**
1568
- * Optional. Whether to break on non key frames.
1569
- * @type {boolean}
1570
- * @memberof AudioApiHeadAudioStreamByContainer
1571
- */
1572
- readonly breakOnNonKeyFrames?: boolean;
1573
1398
  /**
1574
1399
  * Optional. Specify a specific audio sample rate, e.g. 44100.
1575
- * @type {number}
1576
- * @memberof AudioApiHeadAudioStreamByContainer
1577
1400
  */
1578
1401
  readonly audioSampleRate?: number;
1579
1402
  /**
1580
1403
  * Optional. The maximum audio bit depth.
1581
- * @type {number}
1582
- * @memberof AudioApiHeadAudioStreamByContainer
1583
1404
  */
1584
1405
  readonly maxAudioBitDepth?: number;
1585
1406
  /**
1586
1407
  * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1587
- * @type {number}
1588
- * @memberof AudioApiHeadAudioStreamByContainer
1589
1408
  */
1590
1409
  readonly audioBitRate?: number;
1591
1410
  /**
1592
1411
  * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
1593
- * @type {number}
1594
- * @memberof AudioApiHeadAudioStreamByContainer
1595
1412
  */
1596
1413
  readonly audioChannels?: number;
1597
1414
  /**
1598
1415
  * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
1599
- * @type {number}
1600
- * @memberof AudioApiHeadAudioStreamByContainer
1601
1416
  */
1602
1417
  readonly maxAudioChannels?: number;
1603
1418
  /**
1604
1419
  * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
1605
- * @type {string}
1606
- * @memberof AudioApiHeadAudioStreamByContainer
1607
1420
  */
1608
1421
  readonly profile?: string;
1609
1422
  /**
1610
1423
  * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
1611
- * @type {string}
1612
- * @memberof AudioApiHeadAudioStreamByContainer
1613
1424
  */
1614
1425
  readonly level?: string;
1615
1426
  /**
1616
1427
  * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1617
- * @type {number}
1618
- * @memberof AudioApiHeadAudioStreamByContainer
1619
1428
  */
1620
1429
  readonly framerate?: number;
1621
1430
  /**
1622
1431
  * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1623
- * @type {number}
1624
- * @memberof AudioApiHeadAudioStreamByContainer
1625
1432
  */
1626
1433
  readonly maxFramerate?: number;
1627
1434
  /**
1628
1435
  * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1629
- * @type {boolean}
1630
- * @memberof AudioApiHeadAudioStreamByContainer
1631
1436
  */
1632
1437
  readonly copyTimestamps?: boolean;
1633
1438
  /**
1634
1439
  * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1635
- * @type {number}
1636
- * @memberof AudioApiHeadAudioStreamByContainer
1637
1440
  */
1638
1441
  readonly startTimeTicks?: number;
1639
1442
  /**
1640
1443
  * Optional. The fixed horizontal resolution of the encoded video.
1641
- * @type {number}
1642
- * @memberof AudioApiHeadAudioStreamByContainer
1643
1444
  */
1644
1445
  readonly width?: number;
1645
1446
  /**
1646
1447
  * Optional. The fixed vertical resolution of the encoded video.
1647
- * @type {number}
1648
- * @memberof AudioApiHeadAudioStreamByContainer
1649
1448
  */
1650
1449
  readonly height?: number;
1651
1450
  /**
1652
1451
  * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1653
- * @type {number}
1654
- * @memberof AudioApiHeadAudioStreamByContainer
1655
1452
  */
1656
1453
  readonly videoBitRate?: number;
1657
1454
  /**
1658
1455
  * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1659
- * @type {number}
1660
- * @memberof AudioApiHeadAudioStreamByContainer
1661
1456
  */
1662
1457
  readonly subtitleStreamIndex?: number;
1663
1458
  /**
1664
1459
  * Optional. Specify the subtitle delivery method.
1665
- * @type {SubtitleDeliveryMethod}
1666
- * @memberof AudioApiHeadAudioStreamByContainer
1667
1460
  */
1668
1461
  readonly subtitleMethod?: SubtitleDeliveryMethod;
1669
1462
  /**
1670
1463
  * Optional.
1671
- * @type {number}
1672
- * @memberof AudioApiHeadAudioStreamByContainer
1673
1464
  */
1674
1465
  readonly maxRefFrames?: number;
1675
1466
  /**
1676
1467
  * Optional. The maximum video bit depth.
1677
- * @type {number}
1678
- * @memberof AudioApiHeadAudioStreamByContainer
1679
1468
  */
1680
1469
  readonly maxVideoBitDepth?: number;
1681
1470
  /**
1682
1471
  * Optional. Whether to require avc.
1683
- * @type {boolean}
1684
- * @memberof AudioApiHeadAudioStreamByContainer
1685
1472
  */
1686
1473
  readonly requireAvc?: boolean;
1687
1474
  /**
1688
1475
  * Optional. Whether to deinterlace the video.
1689
- * @type {boolean}
1690
- * @memberof AudioApiHeadAudioStreamByContainer
1691
1476
  */
1692
1477
  readonly deInterlace?: boolean;
1693
1478
  /**
1694
1479
  * Optional. Whether to require a non anamorphic stream.
1695
- * @type {boolean}
1696
- * @memberof AudioApiHeadAudioStreamByContainer
1697
1480
  */
1698
1481
  readonly requireNonAnamorphic?: boolean;
1699
1482
  /**
1700
1483
  * Optional. The maximum number of audio channels to transcode.
1701
- * @type {number}
1702
- * @memberof AudioApiHeadAudioStreamByContainer
1703
1484
  */
1704
1485
  readonly transcodingMaxAudioChannels?: number;
1705
1486
  /**
1706
1487
  * Optional. The limit of how many cpu cores to use.
1707
- * @type {number}
1708
- * @memberof AudioApiHeadAudioStreamByContainer
1709
1488
  */
1710
1489
  readonly cpuCoreLimit?: number;
1711
1490
  /**
1712
1491
  * The live stream id.
1713
- * @type {string}
1714
- * @memberof AudioApiHeadAudioStreamByContainer
1715
1492
  */
1716
1493
  readonly liveStreamId?: string;
1717
1494
  /**
1718
1495
  * Optional. Whether to enable the MpegtsM2Ts mode.
1719
- * @type {boolean}
1720
- * @memberof AudioApiHeadAudioStreamByContainer
1721
1496
  */
1722
1497
  readonly enableMpegtsM2TsMode?: boolean;
1723
1498
  /**
1724
1499
  * Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\&#39;s extension.
1725
- * @type {string}
1726
- * @memberof AudioApiHeadAudioStreamByContainer
1727
1500
  */
1728
1501
  readonly videoCodec?: string;
1729
1502
  /**
1730
1503
  * Optional. Specify a subtitle codec to encode to.
1731
- * @type {string}
1732
- * @memberof AudioApiHeadAudioStreamByContainer
1733
1504
  */
1734
1505
  readonly subtitleCodec?: string;
1735
1506
  /**
1736
1507
  * Optional. The transcoding reason.
1737
- * @type {string}
1738
- * @memberof AudioApiHeadAudioStreamByContainer
1739
1508
  */
1740
1509
  readonly transcodeReasons?: string;
1741
1510
  /**
1742
1511
  * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1743
- * @type {number}
1744
- * @memberof AudioApiHeadAudioStreamByContainer
1745
1512
  */
1746
1513
  readonly audioStreamIndex?: number;
1747
1514
  /**
1748
1515
  * Optional. The index of the video stream to use. If omitted the first video stream will be used.
1749
- * @type {number}
1750
- * @memberof AudioApiHeadAudioStreamByContainer
1751
1516
  */
1752
1517
  readonly videoStreamIndex?: number;
1753
1518
  /**
1754
1519
  * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1755
- * @type {EncodingContext}
1756
- * @memberof AudioApiHeadAudioStreamByContainer
1757
1520
  */
1758
1521
  readonly context?: EncodingContext;
1759
1522
  /**
1760
1523
  * Optional. The streaming options.
1761
- * @type {{ [key: string]: string; }}
1762
- * @memberof AudioApiHeadAudioStreamByContainer
1763
1524
  */
1764
1525
  readonly streamOptions?: {
1765
1526
  [key: string]: string;
1766
1527
  };
1767
1528
  /**
1768
1529
  * Optional. Whether to enable Audio Encoding.
1769
- * @type {boolean}
1770
- * @memberof AudioApiHeadAudioStreamByContainer
1771
1530
  */
1772
1531
  readonly enableAudioVbrEncoding?: boolean;
1773
1532
  }
1533
+ /**
1534
+ * Request parameters for headUniversalAudioStream operation in AudioApi.
1535
+ */
1536
+ export interface AudioApiHeadUniversalAudioStreamRequest {
1537
+ /**
1538
+ * The item id.
1539
+ */
1540
+ readonly itemId: string;
1541
+ /**
1542
+ * Optional. The audio container.
1543
+ */
1544
+ readonly container?: Array<string>;
1545
+ /**
1546
+ * The media version id, if playing an alternate version.
1547
+ */
1548
+ readonly mediaSourceId?: string;
1549
+ /**
1550
+ * The device id of the client requesting. Used to stop encoding processes when needed.
1551
+ */
1552
+ readonly deviceId?: string;
1553
+ /**
1554
+ * Optional. The user id.
1555
+ */
1556
+ readonly userId?: string;
1557
+ /**
1558
+ * Optional. The audio codec to transcode to.
1559
+ */
1560
+ readonly audioCodec?: string;
1561
+ /**
1562
+ * Optional. The maximum number of audio channels.
1563
+ */
1564
+ readonly maxAudioChannels?: number;
1565
+ /**
1566
+ * Optional. The number of how many audio channels to transcode to.
1567
+ */
1568
+ readonly transcodingAudioChannels?: number;
1569
+ /**
1570
+ * Optional. The maximum streaming bitrate.
1571
+ */
1572
+ readonly maxStreamingBitrate?: number;
1573
+ /**
1574
+ * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1575
+ */
1576
+ readonly audioBitRate?: number;
1577
+ /**
1578
+ * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1579
+ */
1580
+ readonly startTimeTicks?: number;
1581
+ /**
1582
+ * Optional. The container to transcode to.
1583
+ */
1584
+ readonly transcodingContainer?: string;
1585
+ /**
1586
+ * Optional. The transcoding protocol.
1587
+ */
1588
+ readonly transcodingProtocol?: MediaStreamProtocol;
1589
+ /**
1590
+ * Optional. The maximum audio sample rate.
1591
+ */
1592
+ readonly maxAudioSampleRate?: number;
1593
+ /**
1594
+ * Optional. The maximum audio bit depth.
1595
+ */
1596
+ readonly maxAudioBitDepth?: number;
1597
+ /**
1598
+ * Optional. Whether to enable remote media.
1599
+ */
1600
+ readonly enableRemoteMedia?: boolean;
1601
+ /**
1602
+ * Optional. Whether to enable Audio Encoding.
1603
+ */
1604
+ readonly enableAudioVbrEncoding?: boolean;
1605
+ /**
1606
+ * Whether to enable redirection. Defaults to true.
1607
+ */
1608
+ readonly enableRedirection?: boolean;
1609
+ }
1774
1610
  /**
1775
1611
  * AudioApi - object-oriented interface
1776
- * @export
1777
- * @class AudioApi
1778
- * @extends {BaseAPI}
1779
1612
  */
1780
1613
  export declare class AudioApi extends BaseAPI {
1781
1614
  /**
@@ -1784,7 +1617,6 @@ export declare class AudioApi extends BaseAPI {
1784
1617
  * @param {AudioApiGetAudioStreamRequest} requestParameters Request parameters.
1785
1618
  * @param {*} [options] Override http request option.
1786
1619
  * @throws {RequiredError}
1787
- * @memberof AudioApi
1788
1620
  */
1789
1621
  getAudioStream(requestParameters: AudioApiGetAudioStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1790
1622
  /**
@@ -1793,16 +1625,22 @@ export declare class AudioApi extends BaseAPI {
1793
1625
  * @param {AudioApiGetAudioStreamByContainerRequest} requestParameters Request parameters.
1794
1626
  * @param {*} [options] Override http request option.
1795
1627
  * @throws {RequiredError}
1796
- * @memberof AudioApi
1797
1628
  */
1798
1629
  getAudioStreamByContainer(requestParameters: AudioApiGetAudioStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1630
+ /**
1631
+ *
1632
+ * @summary Gets an audio stream.
1633
+ * @param {AudioApiGetUniversalAudioStreamRequest} requestParameters Request parameters.
1634
+ * @param {*} [options] Override http request option.
1635
+ * @throws {RequiredError}
1636
+ */
1637
+ getUniversalAudioStream(requestParameters: AudioApiGetUniversalAudioStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1799
1638
  /**
1800
1639
  *
1801
1640
  * @summary Gets an audio stream.
1802
1641
  * @param {AudioApiHeadAudioStreamRequest} requestParameters Request parameters.
1803
1642
  * @param {*} [options] Override http request option.
1804
1643
  * @throws {RequiredError}
1805
- * @memberof AudioApi
1806
1644
  */
1807
1645
  headAudioStream(requestParameters: AudioApiHeadAudioStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1808
1646
  /**
@@ -1811,7 +1649,14 @@ export declare class AudioApi extends BaseAPI {
1811
1649
  * @param {AudioApiHeadAudioStreamByContainerRequest} requestParameters Request parameters.
1812
1650
  * @param {*} [options] Override http request option.
1813
1651
  * @throws {RequiredError}
1814
- * @memberof AudioApi
1815
1652
  */
1816
1653
  headAudioStreamByContainer(requestParameters: AudioApiHeadAudioStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1654
+ /**
1655
+ *
1656
+ * @summary Gets an audio stream.
1657
+ * @param {AudioApiHeadUniversalAudioStreamRequest} requestParameters Request parameters.
1658
+ * @param {*} [options] Override http request option.
1659
+ * @throws {RequiredError}
1660
+ */
1661
+ headUniversalAudioStream(requestParameters: AudioApiHeadUniversalAudioStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1817
1662
  }