@jellyfin/sdk 0.13.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 (760) hide show
  1. package/.nvmrc +1 -0
  2. package/.openapi-generator-ignore +2 -0
  3. package/CHANGELOG.md +24 -2
  4. package/README.md +52 -27
  5. package/eslint.config.mjs +118 -0
  6. package/lib/api.d.ts +30 -8
  7. package/lib/api.js +79 -14
  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 +3 -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/user-api.js +1 -26
  613. package/lib/utils/api/{api-key-api.d.ts → user-data-api.d.ts} +2 -2
  614. package/lib/utils/api/{time-sync-api.js → user-data-api.js} +4 -4
  615. package/lib/utils/api/{channels-api.d.ts → user-view-api.d.ts} +2 -2
  616. package/lib/utils/api/{trailers-api.js → user-view-api.js} +4 -4
  617. package/lib/utils/api/video-api.d.ts +8 -0
  618. package/lib/utils/api/video-api.js +12 -0
  619. package/lib/utils/api/year-api.d.ts +8 -0
  620. package/lib/utils/api/year-api.js +12 -0
  621. package/lib/utils/index.js +2 -2
  622. package/lib/utils/url/index.d.ts +1 -0
  623. package/lib/utils/url/index.js +4 -1
  624. package/lib/utils/versioning.d.ts +12 -1
  625. package/lib/utils/versioning.js +44 -13
  626. package/lib/versions.d.ts +1 -1
  627. package/lib/versions.js +1 -1
  628. package/lib/websocket/constants.d.ts +24 -0
  629. package/lib/websocket/constants.js +42 -0
  630. package/lib/websocket/index.d.ts +8 -0
  631. package/lib/websocket/index.js +3 -0
  632. package/lib/{utils/api/client-log-api.d.ts → websocket/models.d.ts} +6 -3
  633. package/lib/websocket/models.js +16 -0
  634. package/lib/websocket/types.d.ts +37 -0
  635. package/lib/websocket/types.js +42 -0
  636. package/lib/websocket/websocket-service.d.ts +142 -0
  637. package/lib/websocket/websocket-service.js +296 -0
  638. package/package.json +20 -17
  639. package/lib/generated-client/api/activity-log-api.d.ts +0 -110
  640. package/lib/generated-client/api/activity-log-api.js +0 -135
  641. package/lib/generated-client/api/api-key-api.d.ts +0 -161
  642. package/lib/generated-client/api/api-key-api.js +0 -245
  643. package/lib/generated-client/api/client-log-api.d.ts +0 -86
  644. package/lib/generated-client/api/client-log-api.js +0 -117
  645. package/lib/generated-client/api/configuration-api.d.ts +0 -292
  646. package/lib/generated-client/api/configuration-api.js +0 -442
  647. package/lib/generated-client/api/dashboard-api.d.ts +0 -132
  648. package/lib/generated-client/api/dashboard-api.js +0 -182
  649. package/lib/generated-client/api/dlna-api.d.ts +0 -292
  650. package/lib/generated-client/api/dlna-server-api.d.ts +0 -784
  651. package/lib/generated-client/api/dynamic-hls-api.d.ts +0 -4261
  652. package/lib/generated-client/api/dynamic-hls-api.js +0 -3025
  653. package/lib/generated-client/api/hls-segment-api.d.ts +0 -325
  654. package/lib/generated-client/api/hls-segment-api.js +0 -415
  655. package/lib/generated-client/api/image-by-name-api.d.ts +0 -292
  656. package/lib/generated-client/api/item-refresh-api.d.ts +0 -126
  657. package/lib/generated-client/api/item-refresh-api.js +0 -143
  658. package/lib/generated-client/api/items-api.d.ts +0 -1052
  659. package/lib/generated-client/api/items-api.js +0 -835
  660. package/lib/generated-client/api/music-genres-api.d.ts +0 -286
  661. package/lib/generated-client/api/music-genres-api.js +0 -278
  662. package/lib/generated-client/api/notifications-api.d.ts +0 -332
  663. package/lib/generated-client/api/package-api.d.ts +0 -315
  664. package/lib/generated-client/api/package-api.js +0 -455
  665. package/lib/generated-client/api/playstate-api.d.ts +0 -679
  666. package/lib/generated-client/api/playstate-api.js +0 -789
  667. package/lib/generated-client/api/plugins-api.d.ts +0 -473
  668. package/lib/generated-client/api/plugins-api.js +0 -663
  669. package/lib/generated-client/api/quick-connect-api.d.ts +0 -198
  670. package/lib/generated-client/api/quick-connect-api.js +0 -305
  671. package/lib/generated-client/api/time-sync-api.d.ts +0 -69
  672. package/lib/generated-client/api/time-sync-api.js +0 -109
  673. package/lib/generated-client/api/tmdb-api.d.ts +0 -69
  674. package/lib/generated-client/api/tmdb-api.js +0 -111
  675. package/lib/generated-client/api/universal-audio-api.d.ts +0 -420
  676. package/lib/generated-client/api/universal-audio-api.js +0 -364
  677. package/lib/generated-client/api/user-library-api.d.ts +0 -657
  678. package/lib/generated-client/api/video-attachments-api.d.ts +0 -101
  679. package/lib/generated-client/api/video-attachments-api.js +0 -126
  680. package/lib/generated-client/models/admin-notification-dto.d.ts +0 -42
  681. package/lib/generated-client/models/base-item.d.ts +0 -84
  682. package/lib/generated-client/models/branding-options.d.ts +0 -35
  683. package/lib/generated-client/models/client-capabilities.d.ts +0 -76
  684. package/lib/generated-client/models/config-image-types.d.ts +0 -59
  685. package/lib/generated-client/models/control-response.d.ts +0 -37
  686. package/lib/generated-client/models/device-identification.d.ts +0 -72
  687. package/lib/generated-client/models/device-info-query-result.d.ts +0 -36
  688. package/lib/generated-client/models/device-info.d.ts +0 -84
  689. package/lib/generated-client/models/device-options.d.ts +0 -35
  690. package/lib/generated-client/models/device-profile-info.d.ts +0 -36
  691. package/lib/generated-client/models/device-profile-type.d.ts +0 -20
  692. package/lib/generated-client/models/dlna-options.d.ts +0 -83
  693. package/lib/generated-client/models/ffmpeg-location.d.ts +0 -22
  694. package/lib/generated-client/models/group-info-dto-group-update.d.ts +0 -37
  695. package/lib/generated-client/models/group-state-update-group-update.d.ts +0 -37
  696. package/lib/generated-client/models/hardware-encoding-type.d.ts +0 -25
  697. package/lib/generated-client/models/header-match-type.d.ts +0 -21
  698. package/lib/generated-client/models/http-header-info.d.ts +0 -36
  699. package/lib/generated-client/models/image-by-name-info.d.ts +0 -47
  700. package/lib/generated-client/models/media-encoder-path-dto.d.ts +0 -29
  701. package/lib/generated-client/models/notification-dto.d.ts +0 -66
  702. package/lib/generated-client/models/notification-option.d.ts +0 -54
  703. package/lib/generated-client/models/notification-options.d.ts +0 -24
  704. package/lib/generated-client/models/notification-result-dto.d.ts +0 -30
  705. package/lib/generated-client/models/notification-type-info.d.ts +0 -47
  706. package/lib/generated-client/models/notifications-summary-dto.d.ts +0 -30
  707. package/lib/generated-client/models/object-group-update.d.ts +0 -36
  708. package/lib/generated-client/models/play-queue-update-group-update.d.ts +0 -37
  709. package/lib/generated-client/models/response-profile.d.ts +0 -61
  710. package/lib/generated-client/models/send-to-user-type.d.ts +0 -21
  711. package/lib/generated-client/models/session-info.d.ts +0 -199
  712. package/lib/generated-client/models/string-group-update.d.ts +0 -36
  713. package/lib/generated-client/models/subtitle-options.d.ts +0 -71
  714. package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +0 -37
  715. package/lib/generated-client/models/trickplay-info.d.ts +0 -65
  716. package/lib/generated-client/models/update-user-easy-password.d.ts +0 -35
  717. package/lib/generated-client/models/wake-on-lan-info.d.ts +0 -29
  718. package/lib/generated-client/models/xml-attribute.d.ts +0 -29
  719. package/lib/utils/api/activity-log-api.js +0 -12
  720. package/lib/utils/api/api-key-api.js +0 -12
  721. package/lib/utils/api/client-log-api.js +0 -12
  722. package/lib/utils/api/configuration-api.d.ts +0 -8
  723. package/lib/utils/api/devices-api.d.ts +0 -8
  724. package/lib/utils/api/display-preferences-api.d.ts +0 -8
  725. package/lib/utils/api/display-preferences-api.js +0 -12
  726. package/lib/utils/api/item-refresh-api.d.ts +0 -8
  727. package/lib/utils/api/item-refresh-api.js +0 -12
  728. package/lib/utils/api/media-segments-api.d.ts +0 -8
  729. package/lib/utils/api/media-segments-api.js +0 -12
  730. package/lib/utils/api/music-genres-api.d.ts +0 -8
  731. package/lib/utils/api/music-genres-api.js +0 -12
  732. package/lib/utils/api/package-api.js +0 -12
  733. package/lib/utils/api/persons-api.d.ts +0 -8
  734. package/lib/utils/api/persons-api.js +0 -12
  735. package/lib/utils/api/playlists-api.d.ts +0 -8
  736. package/lib/utils/api/playlists-api.js +0 -12
  737. package/lib/utils/api/playstate-api.d.ts +0 -8
  738. package/lib/utils/api/playstate-api.js +0 -12
  739. package/lib/utils/api/plugins-api.d.ts +0 -8
  740. package/lib/utils/api/plugins-api.js +0 -12
  741. package/lib/utils/api/quick-connect-api.d.ts +0 -8
  742. package/lib/utils/api/scheduled-tasks-api.d.ts +0 -8
  743. package/lib/utils/api/scheduled-tasks-api.js +0 -12
  744. package/lib/utils/api/studios-api.d.ts +0 -8
  745. package/lib/utils/api/studios-api.js +0 -12
  746. package/lib/utils/api/suggestions-api.d.ts +0 -8
  747. package/lib/utils/api/suggestions-api.js +0 -12
  748. package/lib/utils/api/time-sync-api.d.ts +0 -8
  749. package/lib/utils/api/trickplay-api.d.ts +0 -8
  750. package/lib/utils/api/trickplay-api.js +0 -12
  751. package/lib/utils/api/tv-shows-api.d.ts +0 -8
  752. package/lib/utils/api/tv-shows-api.js +0 -12
  753. package/lib/utils/api/universal-audio-api.d.ts +0 -8
  754. package/lib/utils/api/universal-audio-api.js +0 -12
  755. package/lib/utils/api/user-library-api.d.ts +0 -8
  756. package/lib/utils/api/user-library-api.js +0 -12
  757. package/lib/utils/api/user-views-api.d.ts +0 -8
  758. package/lib/utils/api/user-views-api.js +0 -12
  759. package/lib/utils/api/video-attachments-api.d.ts +0 -8
  760. package/lib/utils/api/video-attachments-api.js +0 -12
@@ -15,10 +15,9 @@ import type { BaseItemDtoQueryResult } from '../models';
15
15
  import type { EncodingContext } from '../models';
16
16
  import type { SubtitleDeliveryMethod } from '../models';
17
17
  /**
18
- * VideosApi - axios parameter creator
19
- * @export
18
+ * VideoApi - axios parameter creator
20
19
  */
21
- export declare const VideosApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ export declare const VideoApiAxiosParamCreator: (configuration?: Configuration) => {
22
21
  /**
23
22
  *
24
23
  * @summary Removes alternate video sources.
@@ -36,6 +35,16 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
36
35
  * @throws {RequiredError}
37
36
  */
38
37
  getAdditionalPart: (itemId: string, userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
+ /**
39
+ *
40
+ * @summary Get video attachment.
41
+ * @param {string} videoId Video ID.
42
+ * @param {string} mediaSourceId Media Source ID.
43
+ * @param {number} index Attachment Index.
44
+ * @param {*} [options] Override http request option.
45
+ * @throws {RequiredError}
46
+ */
47
+ getAttachment: (videoId: string, mediaSourceId: string, index: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
39
48
  /**
40
49
  *
41
50
  * @summary Gets a video stream.
@@ -55,7 +64,6 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
55
64
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
56
65
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
57
66
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
58
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
59
67
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
60
68
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
61
69
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -94,7 +102,7 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
94
102
  * @param {*} [options] Override http request option.
95
103
  * @throws {RequiredError}
96
104
  */
97
- getVideoStream: (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, maxWidth?: number, maxHeight?: 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?: {
105
+ getVideoStream: (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, maxWidth?: number, maxHeight?: 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?: {
98
106
  [key: string]: string;
99
107
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
100
108
  /**
@@ -116,7 +124,6 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
116
124
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
117
125
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
118
126
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
119
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
120
127
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
121
128
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
122
129
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -155,7 +162,7 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
155
162
  * @param {*} [options] Override http request option.
156
163
  * @throws {RequiredError}
157
164
  */
158
- getVideoStreamByContainer: (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, maxWidth?: number, maxHeight?: 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?: {
165
+ getVideoStreamByContainer: (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, maxWidth?: number, maxHeight?: 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?: {
159
166
  [key: string]: string;
160
167
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
161
168
  /**
@@ -177,7 +184,6 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
177
184
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
178
185
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
179
186
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
180
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
181
187
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
182
188
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
183
189
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -216,7 +222,7 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
216
222
  * @param {*} [options] Override http request option.
217
223
  * @throws {RequiredError}
218
224
  */
219
- headVideoStream: (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, maxWidth?: number, maxHeight?: 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?: {
225
+ headVideoStream: (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, maxWidth?: number, maxHeight?: 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?: {
220
226
  [key: string]: string;
221
227
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
222
228
  /**
@@ -238,7 +244,6 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
238
244
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
239
245
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
240
246
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
241
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
242
247
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
243
248
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
244
249
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -277,7 +282,7 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
277
282
  * @param {*} [options] Override http request option.
278
283
  * @throws {RequiredError}
279
284
  */
280
- headVideoStreamByContainer: (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, maxWidth?: number, maxHeight?: 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?: {
285
+ headVideoStreamByContainer: (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, maxWidth?: number, maxHeight?: 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?: {
281
286
  [key: string]: string;
282
287
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
283
288
  /**
@@ -290,10 +295,9 @@ export declare const VideosApiAxiosParamCreator: (configuration?: Configuration)
290
295
  mergeVersions: (ids: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
291
296
  };
292
297
  /**
293
- * VideosApi - functional programming interface
294
- * @export
298
+ * VideoApi - functional programming interface
295
299
  */
296
- export declare const VideosApiFp: (configuration?: Configuration) => {
300
+ export declare const VideoApiFp: (configuration?: Configuration) => {
297
301
  /**
298
302
  *
299
303
  * @summary Removes alternate video sources.
@@ -311,6 +315,16 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
311
315
  * @throws {RequiredError}
312
316
  */
313
317
  getAdditionalPart(itemId: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
318
+ /**
319
+ *
320
+ * @summary Get video attachment.
321
+ * @param {string} videoId Video ID.
322
+ * @param {string} mediaSourceId Media Source ID.
323
+ * @param {number} index Attachment Index.
324
+ * @param {*} [options] Override http request option.
325
+ * @throws {RequiredError}
326
+ */
327
+ getAttachment(videoId: string, mediaSourceId: string, index: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
314
328
  /**
315
329
  *
316
330
  * @summary Gets a video stream.
@@ -330,7 +344,6 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
330
344
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
331
345
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
332
346
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
333
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
334
347
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
335
348
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
336
349
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -369,7 +382,7 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
369
382
  * @param {*} [options] Override http request option.
370
383
  * @throws {RequiredError}
371
384
  */
372
- getVideoStream(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, maxWidth?: number, maxHeight?: 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?: {
385
+ getVideoStream(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, maxWidth?: number, maxHeight?: 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?: {
373
386
  [key: string]: string;
374
387
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
375
388
  /**
@@ -391,7 +404,6 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
391
404
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
392
405
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
393
406
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
394
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
395
407
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
396
408
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
397
409
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -430,7 +442,7 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
430
442
  * @param {*} [options] Override http request option.
431
443
  * @throws {RequiredError}
432
444
  */
433
- getVideoStreamByContainer(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, maxWidth?: number, maxHeight?: 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?: {
445
+ getVideoStreamByContainer(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, maxWidth?: number, maxHeight?: 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?: {
434
446
  [key: string]: string;
435
447
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
436
448
  /**
@@ -452,7 +464,6 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
452
464
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
453
465
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
454
466
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
455
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
456
467
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
457
468
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
458
469
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -491,7 +502,7 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
491
502
  * @param {*} [options] Override http request option.
492
503
  * @throws {RequiredError}
493
504
  */
494
- headVideoStream(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, maxWidth?: number, maxHeight?: 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?: {
505
+ headVideoStream(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, maxWidth?: number, maxHeight?: 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?: {
495
506
  [key: string]: string;
496
507
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
497
508
  /**
@@ -513,7 +524,6 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
513
524
  * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
514
525
  * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
515
526
  * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
516
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
517
527
  * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
518
528
  * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
519
529
  * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
@@ -552,7 +562,7 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
552
562
  * @param {*} [options] Override http request option.
553
563
  * @throws {RequiredError}
554
564
  */
555
- headVideoStreamByContainer(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, maxWidth?: number, maxHeight?: 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?: {
565
+ headVideoStreamByContainer(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, maxWidth?: number, maxHeight?: 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?: {
556
566
  [key: string]: string;
557
567
  }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
558
568
  /**
@@ -565,1464 +575,1032 @@ export declare const VideosApiFp: (configuration?: Configuration) => {
565
575
  mergeVersions(ids: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
566
576
  };
567
577
  /**
568
- * VideosApi - factory interface
569
- * @export
578
+ * VideoApi - factory interface
570
579
  */
571
- export declare const VideosApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
580
+ export declare const VideoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
572
581
  /**
573
582
  *
574
583
  * @summary Removes alternate video sources.
575
- * @param {VideosApiDeleteAlternateSourcesRequest} requestParameters Request parameters.
584
+ * @param {VideoApiDeleteAlternateSourcesRequest} requestParameters Request parameters.
576
585
  * @param {*} [options] Override http request option.
577
586
  * @throws {RequiredError}
578
587
  */
579
- deleteAlternateSources(requestParameters: VideosApiDeleteAlternateSourcesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
588
+ deleteAlternateSources(requestParameters: VideoApiDeleteAlternateSourcesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
580
589
  /**
581
590
  *
582
591
  * @summary Gets additional parts for a video.
583
- * @param {VideosApiGetAdditionalPartRequest} requestParameters Request parameters.
592
+ * @param {VideoApiGetAdditionalPartRequest} requestParameters Request parameters.
584
593
  * @param {*} [options] Override http request option.
585
594
  * @throws {RequiredError}
586
595
  */
587
- getAdditionalPart(requestParameters: VideosApiGetAdditionalPartRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
596
+ getAdditionalPart(requestParameters: VideoApiGetAdditionalPartRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseItemDtoQueryResult>;
597
+ /**
598
+ *
599
+ * @summary Get video attachment.
600
+ * @param {VideoApiGetAttachmentRequest} requestParameters Request parameters.
601
+ * @param {*} [options] Override http request option.
602
+ * @throws {RequiredError}
603
+ */
604
+ getAttachment(requestParameters: VideoApiGetAttachmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
588
605
  /**
589
606
  *
590
607
  * @summary Gets a video stream.
591
- * @param {VideosApiGetVideoStreamRequest} requestParameters Request parameters.
608
+ * @param {VideoApiGetVideoStreamRequest} requestParameters Request parameters.
592
609
  * @param {*} [options] Override http request option.
593
610
  * @throws {RequiredError}
594
611
  */
595
- getVideoStream(requestParameters: VideosApiGetVideoStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
612
+ getVideoStream(requestParameters: VideoApiGetVideoStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
596
613
  /**
597
614
  *
598
615
  * @summary Gets a video stream.
599
- * @param {VideosApiGetVideoStreamByContainerRequest} requestParameters Request parameters.
616
+ * @param {VideoApiGetVideoStreamByContainerRequest} requestParameters Request parameters.
600
617
  * @param {*} [options] Override http request option.
601
618
  * @throws {RequiredError}
602
619
  */
603
- getVideoStreamByContainer(requestParameters: VideosApiGetVideoStreamByContainerRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
620
+ getVideoStreamByContainer(requestParameters: VideoApiGetVideoStreamByContainerRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
604
621
  /**
605
622
  *
606
623
  * @summary Gets a video stream.
607
- * @param {VideosApiHeadVideoStreamRequest} requestParameters Request parameters.
624
+ * @param {VideoApiHeadVideoStreamRequest} requestParameters Request parameters.
608
625
  * @param {*} [options] Override http request option.
609
626
  * @throws {RequiredError}
610
627
  */
611
- headVideoStream(requestParameters: VideosApiHeadVideoStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
628
+ headVideoStream(requestParameters: VideoApiHeadVideoStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
612
629
  /**
613
630
  *
614
631
  * @summary Gets a video stream.
615
- * @param {VideosApiHeadVideoStreamByContainerRequest} requestParameters Request parameters.
632
+ * @param {VideoApiHeadVideoStreamByContainerRequest} requestParameters Request parameters.
616
633
  * @param {*} [options] Override http request option.
617
634
  * @throws {RequiredError}
618
635
  */
619
- headVideoStreamByContainer(requestParameters: VideosApiHeadVideoStreamByContainerRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
636
+ headVideoStreamByContainer(requestParameters: VideoApiHeadVideoStreamByContainerRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
620
637
  /**
621
638
  *
622
639
  * @summary Merges videos into a single record.
623
- * @param {VideosApiMergeVersionsRequest} requestParameters Request parameters.
640
+ * @param {VideoApiMergeVersionsRequest} requestParameters Request parameters.
624
641
  * @param {*} [options] Override http request option.
625
642
  * @throws {RequiredError}
626
643
  */
627
- mergeVersions(requestParameters: VideosApiMergeVersionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
644
+ mergeVersions(requestParameters: VideoApiMergeVersionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
628
645
  };
629
646
  /**
630
- * Request parameters for deleteAlternateSources operation in VideosApi.
631
- * @export
632
- * @interface VideosApiDeleteAlternateSourcesRequest
647
+ * Request parameters for deleteAlternateSources operation in VideoApi.
633
648
  */
634
- export interface VideosApiDeleteAlternateSourcesRequest {
649
+ export interface VideoApiDeleteAlternateSourcesRequest {
635
650
  /**
636
651
  * The item id.
637
- * @type {string}
638
- * @memberof VideosApiDeleteAlternateSources
639
652
  */
640
653
  readonly itemId: string;
641
654
  }
642
655
  /**
643
- * Request parameters for getAdditionalPart operation in VideosApi.
644
- * @export
645
- * @interface VideosApiGetAdditionalPartRequest
656
+ * Request parameters for getAdditionalPart operation in VideoApi.
646
657
  */
647
- export interface VideosApiGetAdditionalPartRequest {
658
+ export interface VideoApiGetAdditionalPartRequest {
648
659
  /**
649
660
  * The item id.
650
- * @type {string}
651
- * @memberof VideosApiGetAdditionalPart
652
661
  */
653
662
  readonly itemId: string;
654
663
  /**
655
664
  * Optional. Filter by user id, and attach user data.
656
- * @type {string}
657
- * @memberof VideosApiGetAdditionalPart
658
665
  */
659
666
  readonly userId?: string;
660
667
  }
661
668
  /**
662
- * Request parameters for getVideoStream operation in VideosApi.
663
- * @export
664
- * @interface VideosApiGetVideoStreamRequest
669
+ * Request parameters for getAttachment operation in VideoApi.
665
670
  */
666
- export interface VideosApiGetVideoStreamRequest {
671
+ export interface VideoApiGetAttachmentRequest {
672
+ /**
673
+ * Video ID.
674
+ */
675
+ readonly videoId: string;
676
+ /**
677
+ * Media Source ID.
678
+ */
679
+ readonly mediaSourceId: string;
680
+ /**
681
+ * Attachment Index.
682
+ */
683
+ readonly index: number;
684
+ }
685
+ /**
686
+ * Request parameters for getVideoStream operation in VideoApi.
687
+ */
688
+ export interface VideoApiGetVideoStreamRequest {
667
689
  /**
668
690
  * The item id.
669
- * @type {string}
670
- * @memberof VideosApiGetVideoStream
671
691
  */
672
692
  readonly itemId: string;
673
693
  /**
674
694
  * The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
675
- * @type {string}
676
- * @memberof VideosApiGetVideoStream
677
695
  */
678
696
  readonly container?: string;
679
697
  /**
680
698
  * 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.
681
- * @type {boolean}
682
- * @memberof VideosApiGetVideoStream
683
699
  */
684
700
  readonly _static?: boolean;
685
701
  /**
686
702
  * The streaming parameters.
687
- * @type {string}
688
- * @memberof VideosApiGetVideoStream
689
703
  */
690
704
  readonly params?: string;
691
705
  /**
692
706
  * The tag.
693
- * @type {string}
694
- * @memberof VideosApiGetVideoStream
695
707
  */
696
708
  readonly tag?: string;
697
709
  /**
698
710
  * Optional. The dlna device profile id to utilize.
699
- * @type {string}
700
- * @memberof VideosApiGetVideoStream
701
711
  */
702
712
  readonly deviceProfileId?: string;
703
713
  /**
704
714
  * The play session id.
705
- * @type {string}
706
- * @memberof VideosApiGetVideoStream
707
715
  */
708
716
  readonly playSessionId?: string;
709
717
  /**
710
718
  * The segment container.
711
- * @type {string}
712
- * @memberof VideosApiGetVideoStream
713
719
  */
714
720
  readonly segmentContainer?: string;
715
721
  /**
716
722
  * The segment length.
717
- * @type {number}
718
- * @memberof VideosApiGetVideoStream
719
723
  */
720
724
  readonly segmentLength?: number;
721
725
  /**
722
726
  * The minimum number of segments.
723
- * @type {number}
724
- * @memberof VideosApiGetVideoStream
725
727
  */
726
728
  readonly minSegments?: number;
727
729
  /**
728
730
  * The media version id, if playing an alternate version.
729
- * @type {string}
730
- * @memberof VideosApiGetVideoStream
731
731
  */
732
732
  readonly mediaSourceId?: string;
733
733
  /**
734
734
  * The device id of the client requesting. Used to stop encoding processes when needed.
735
- * @type {string}
736
- * @memberof VideosApiGetVideoStream
737
735
  */
738
736
  readonly deviceId?: string;
739
737
  /**
740
738
  * Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\&#39;s extension.
741
- * @type {string}
742
- * @memberof VideosApiGetVideoStream
743
739
  */
744
740
  readonly audioCodec?: string;
745
741
  /**
746
742
  * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
747
- * @type {boolean}
748
- * @memberof VideosApiGetVideoStream
749
743
  */
750
744
  readonly enableAutoStreamCopy?: boolean;
751
745
  /**
752
746
  * Whether or not to allow copying of the video stream url.
753
- * @type {boolean}
754
- * @memberof VideosApiGetVideoStream
755
747
  */
756
748
  readonly allowVideoStreamCopy?: boolean;
757
749
  /**
758
750
  * Whether or not to allow copying of the audio stream url.
759
- * @type {boolean}
760
- * @memberof VideosApiGetVideoStream
761
751
  */
762
752
  readonly allowAudioStreamCopy?: boolean;
763
- /**
764
- * Optional. Whether to break on non key frames.
765
- * @type {boolean}
766
- * @memberof VideosApiGetVideoStream
767
- */
768
- readonly breakOnNonKeyFrames?: boolean;
769
753
  /**
770
754
  * Optional. Specify a specific audio sample rate, e.g. 44100.
771
- * @type {number}
772
- * @memberof VideosApiGetVideoStream
773
755
  */
774
756
  readonly audioSampleRate?: number;
775
757
  /**
776
758
  * Optional. The maximum audio bit depth.
777
- * @type {number}
778
- * @memberof VideosApiGetVideoStream
779
759
  */
780
760
  readonly maxAudioBitDepth?: number;
781
761
  /**
782
762
  * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
783
- * @type {number}
784
- * @memberof VideosApiGetVideoStream
785
763
  */
786
764
  readonly audioBitRate?: number;
787
765
  /**
788
766
  * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
789
- * @type {number}
790
- * @memberof VideosApiGetVideoStream
791
767
  */
792
768
  readonly audioChannels?: number;
793
769
  /**
794
770
  * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
795
- * @type {number}
796
- * @memberof VideosApiGetVideoStream
797
771
  */
798
772
  readonly maxAudioChannels?: number;
799
773
  /**
800
774
  * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
801
- * @type {string}
802
- * @memberof VideosApiGetVideoStream
803
775
  */
804
776
  readonly profile?: string;
805
777
  /**
806
778
  * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
807
- * @type {string}
808
- * @memberof VideosApiGetVideoStream
809
779
  */
810
780
  readonly level?: string;
811
781
  /**
812
782
  * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
813
- * @type {number}
814
- * @memberof VideosApiGetVideoStream
815
783
  */
816
784
  readonly framerate?: number;
817
785
  /**
818
786
  * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
819
- * @type {number}
820
- * @memberof VideosApiGetVideoStream
821
787
  */
822
788
  readonly maxFramerate?: number;
823
789
  /**
824
790
  * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
825
- * @type {boolean}
826
- * @memberof VideosApiGetVideoStream
827
791
  */
828
792
  readonly copyTimestamps?: boolean;
829
793
  /**
830
794
  * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
831
- * @type {number}
832
- * @memberof VideosApiGetVideoStream
833
795
  */
834
796
  readonly startTimeTicks?: number;
835
797
  /**
836
798
  * Optional. The fixed horizontal resolution of the encoded video.
837
- * @type {number}
838
- * @memberof VideosApiGetVideoStream
839
799
  */
840
800
  readonly width?: number;
841
801
  /**
842
802
  * Optional. The fixed vertical resolution of the encoded video.
843
- * @type {number}
844
- * @memberof VideosApiGetVideoStream
845
803
  */
846
804
  readonly height?: number;
847
805
  /**
848
806
  * Optional. The maximum horizontal resolution of the encoded video.
849
- * @type {number}
850
- * @memberof VideosApiGetVideoStream
851
807
  */
852
808
  readonly maxWidth?: number;
853
809
  /**
854
810
  * Optional. The maximum vertical resolution of the encoded video.
855
- * @type {number}
856
- * @memberof VideosApiGetVideoStream
857
811
  */
858
812
  readonly maxHeight?: number;
859
813
  /**
860
814
  * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
861
- * @type {number}
862
- * @memberof VideosApiGetVideoStream
863
815
  */
864
816
  readonly videoBitRate?: number;
865
817
  /**
866
818
  * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
867
- * @type {number}
868
- * @memberof VideosApiGetVideoStream
869
819
  */
870
820
  readonly subtitleStreamIndex?: number;
871
821
  /**
872
822
  * Optional. Specify the subtitle delivery method.
873
- * @type {SubtitleDeliveryMethod}
874
- * @memberof VideosApiGetVideoStream
875
823
  */
876
824
  readonly subtitleMethod?: SubtitleDeliveryMethod;
877
825
  /**
878
826
  * Optional.
879
- * @type {number}
880
- * @memberof VideosApiGetVideoStream
881
827
  */
882
828
  readonly maxRefFrames?: number;
883
829
  /**
884
830
  * Optional. The maximum video bit depth.
885
- * @type {number}
886
- * @memberof VideosApiGetVideoStream
887
831
  */
888
832
  readonly maxVideoBitDepth?: number;
889
833
  /**
890
834
  * Optional. Whether to require avc.
891
- * @type {boolean}
892
- * @memberof VideosApiGetVideoStream
893
835
  */
894
836
  readonly requireAvc?: boolean;
895
837
  /**
896
838
  * Optional. Whether to deinterlace the video.
897
- * @type {boolean}
898
- * @memberof VideosApiGetVideoStream
899
839
  */
900
840
  readonly deInterlace?: boolean;
901
841
  /**
902
842
  * Optional. Whether to require a non anamorphic stream.
903
- * @type {boolean}
904
- * @memberof VideosApiGetVideoStream
905
843
  */
906
844
  readonly requireNonAnamorphic?: boolean;
907
845
  /**
908
846
  * Optional. The maximum number of audio channels to transcode.
909
- * @type {number}
910
- * @memberof VideosApiGetVideoStream
911
847
  */
912
848
  readonly transcodingMaxAudioChannels?: number;
913
849
  /**
914
850
  * Optional. The limit of how many cpu cores to use.
915
- * @type {number}
916
- * @memberof VideosApiGetVideoStream
917
851
  */
918
852
  readonly cpuCoreLimit?: number;
919
853
  /**
920
854
  * The live stream id.
921
- * @type {string}
922
- * @memberof VideosApiGetVideoStream
923
855
  */
924
856
  readonly liveStreamId?: string;
925
857
  /**
926
858
  * Optional. Whether to enable the MpegtsM2Ts mode.
927
- * @type {boolean}
928
- * @memberof VideosApiGetVideoStream
929
859
  */
930
860
  readonly enableMpegtsM2TsMode?: boolean;
931
861
  /**
932
862
  * Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\&#39;s extension.
933
- * @type {string}
934
- * @memberof VideosApiGetVideoStream
935
863
  */
936
864
  readonly videoCodec?: string;
937
865
  /**
938
866
  * Optional. Specify a subtitle codec to encode to.
939
- * @type {string}
940
- * @memberof VideosApiGetVideoStream
941
867
  */
942
868
  readonly subtitleCodec?: string;
943
869
  /**
944
870
  * Optional. The transcoding reason.
945
- * @type {string}
946
- * @memberof VideosApiGetVideoStream
947
871
  */
948
872
  readonly transcodeReasons?: string;
949
873
  /**
950
874
  * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
951
- * @type {number}
952
- * @memberof VideosApiGetVideoStream
953
875
  */
954
876
  readonly audioStreamIndex?: number;
955
877
  /**
956
878
  * Optional. The index of the video stream to use. If omitted the first video stream will be used.
957
- * @type {number}
958
- * @memberof VideosApiGetVideoStream
959
879
  */
960
880
  readonly videoStreamIndex?: number;
961
881
  /**
962
882
  * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
963
- * @type {EncodingContext}
964
- * @memberof VideosApiGetVideoStream
965
883
  */
966
884
  readonly context?: EncodingContext;
967
885
  /**
968
886
  * Optional. The streaming options.
969
- * @type {{ [key: string]: string; }}
970
- * @memberof VideosApiGetVideoStream
971
887
  */
972
888
  readonly streamOptions?: {
973
889
  [key: string]: string;
974
890
  };
975
891
  /**
976
892
  * Optional. Whether to enable Audio Encoding.
977
- * @type {boolean}
978
- * @memberof VideosApiGetVideoStream
979
893
  */
980
894
  readonly enableAudioVbrEncoding?: boolean;
981
895
  }
982
896
  /**
983
- * Request parameters for getVideoStreamByContainer operation in VideosApi.
984
- * @export
985
- * @interface VideosApiGetVideoStreamByContainerRequest
897
+ * Request parameters for getVideoStreamByContainer operation in VideoApi.
986
898
  */
987
- export interface VideosApiGetVideoStreamByContainerRequest {
899
+ export interface VideoApiGetVideoStreamByContainerRequest {
988
900
  /**
989
901
  * The item id.
990
- * @type {string}
991
- * @memberof VideosApiGetVideoStreamByContainer
992
902
  */
993
903
  readonly itemId: string;
994
904
  /**
995
905
  * The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
996
- * @type {string}
997
- * @memberof VideosApiGetVideoStreamByContainer
998
906
  */
999
907
  readonly container: string;
1000
908
  /**
1001
909
  * 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.
1002
- * @type {boolean}
1003
- * @memberof VideosApiGetVideoStreamByContainer
1004
910
  */
1005
911
  readonly _static?: boolean;
1006
912
  /**
1007
913
  * The streaming parameters.
1008
- * @type {string}
1009
- * @memberof VideosApiGetVideoStreamByContainer
1010
914
  */
1011
915
  readonly params?: string;
1012
916
  /**
1013
917
  * The tag.
1014
- * @type {string}
1015
- * @memberof VideosApiGetVideoStreamByContainer
1016
918
  */
1017
919
  readonly tag?: string;
1018
920
  /**
1019
921
  * Optional. The dlna device profile id to utilize.
1020
- * @type {string}
1021
- * @memberof VideosApiGetVideoStreamByContainer
1022
922
  */
1023
923
  readonly deviceProfileId?: string;
1024
924
  /**
1025
925
  * The play session id.
1026
- * @type {string}
1027
- * @memberof VideosApiGetVideoStreamByContainer
1028
926
  */
1029
927
  readonly playSessionId?: string;
1030
928
  /**
1031
929
  * The segment container.
1032
- * @type {string}
1033
- * @memberof VideosApiGetVideoStreamByContainer
1034
930
  */
1035
931
  readonly segmentContainer?: string;
1036
932
  /**
1037
933
  * The segment length.
1038
- * @type {number}
1039
- * @memberof VideosApiGetVideoStreamByContainer
1040
934
  */
1041
935
  readonly segmentLength?: number;
1042
936
  /**
1043
937
  * The minimum number of segments.
1044
- * @type {number}
1045
- * @memberof VideosApiGetVideoStreamByContainer
1046
938
  */
1047
939
  readonly minSegments?: number;
1048
940
  /**
1049
941
  * The media version id, if playing an alternate version.
1050
- * @type {string}
1051
- * @memberof VideosApiGetVideoStreamByContainer
1052
942
  */
1053
943
  readonly mediaSourceId?: string;
1054
944
  /**
1055
945
  * The device id of the client requesting. Used to stop encoding processes when needed.
1056
- * @type {string}
1057
- * @memberof VideosApiGetVideoStreamByContainer
1058
946
  */
1059
947
  readonly deviceId?: string;
1060
948
  /**
1061
949
  * Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\&#39;s extension.
1062
- * @type {string}
1063
- * @memberof VideosApiGetVideoStreamByContainer
1064
950
  */
1065
951
  readonly audioCodec?: string;
1066
952
  /**
1067
953
  * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
1068
- * @type {boolean}
1069
- * @memberof VideosApiGetVideoStreamByContainer
1070
954
  */
1071
955
  readonly enableAutoStreamCopy?: boolean;
1072
956
  /**
1073
957
  * Whether or not to allow copying of the video stream url.
1074
- * @type {boolean}
1075
- * @memberof VideosApiGetVideoStreamByContainer
1076
958
  */
1077
959
  readonly allowVideoStreamCopy?: boolean;
1078
960
  /**
1079
961
  * Whether or not to allow copying of the audio stream url.
1080
- * @type {boolean}
1081
- * @memberof VideosApiGetVideoStreamByContainer
1082
962
  */
1083
963
  readonly allowAudioStreamCopy?: boolean;
1084
- /**
1085
- * Optional. Whether to break on non key frames.
1086
- * @type {boolean}
1087
- * @memberof VideosApiGetVideoStreamByContainer
1088
- */
1089
- readonly breakOnNonKeyFrames?: boolean;
1090
964
  /**
1091
965
  * Optional. Specify a specific audio sample rate, e.g. 44100.
1092
- * @type {number}
1093
- * @memberof VideosApiGetVideoStreamByContainer
1094
966
  */
1095
967
  readonly audioSampleRate?: number;
1096
968
  /**
1097
969
  * Optional. The maximum audio bit depth.
1098
- * @type {number}
1099
- * @memberof VideosApiGetVideoStreamByContainer
1100
970
  */
1101
971
  readonly maxAudioBitDepth?: number;
1102
972
  /**
1103
973
  * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1104
- * @type {number}
1105
- * @memberof VideosApiGetVideoStreamByContainer
1106
974
  */
1107
975
  readonly audioBitRate?: number;
1108
976
  /**
1109
977
  * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
1110
- * @type {number}
1111
- * @memberof VideosApiGetVideoStreamByContainer
1112
978
  */
1113
979
  readonly audioChannels?: number;
1114
980
  /**
1115
981
  * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
1116
- * @type {number}
1117
- * @memberof VideosApiGetVideoStreamByContainer
1118
982
  */
1119
983
  readonly maxAudioChannels?: number;
1120
984
  /**
1121
985
  * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
1122
- * @type {string}
1123
- * @memberof VideosApiGetVideoStreamByContainer
1124
986
  */
1125
987
  readonly profile?: string;
1126
988
  /**
1127
989
  * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
1128
- * @type {string}
1129
- * @memberof VideosApiGetVideoStreamByContainer
1130
990
  */
1131
991
  readonly level?: string;
1132
992
  /**
1133
993
  * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1134
- * @type {number}
1135
- * @memberof VideosApiGetVideoStreamByContainer
1136
994
  */
1137
995
  readonly framerate?: number;
1138
996
  /**
1139
997
  * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1140
- * @type {number}
1141
- * @memberof VideosApiGetVideoStreamByContainer
1142
998
  */
1143
999
  readonly maxFramerate?: number;
1144
1000
  /**
1145
1001
  * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1146
- * @type {boolean}
1147
- * @memberof VideosApiGetVideoStreamByContainer
1148
1002
  */
1149
1003
  readonly copyTimestamps?: boolean;
1150
1004
  /**
1151
1005
  * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1152
- * @type {number}
1153
- * @memberof VideosApiGetVideoStreamByContainer
1154
1006
  */
1155
1007
  readonly startTimeTicks?: number;
1156
1008
  /**
1157
1009
  * Optional. The fixed horizontal resolution of the encoded video.
1158
- * @type {number}
1159
- * @memberof VideosApiGetVideoStreamByContainer
1160
1010
  */
1161
1011
  readonly width?: number;
1162
1012
  /**
1163
1013
  * Optional. The fixed vertical resolution of the encoded video.
1164
- * @type {number}
1165
- * @memberof VideosApiGetVideoStreamByContainer
1166
1014
  */
1167
1015
  readonly height?: number;
1168
1016
  /**
1169
1017
  * Optional. The maximum horizontal resolution of the encoded video.
1170
- * @type {number}
1171
- * @memberof VideosApiGetVideoStreamByContainer
1172
1018
  */
1173
1019
  readonly maxWidth?: number;
1174
1020
  /**
1175
1021
  * Optional. The maximum vertical resolution of the encoded video.
1176
- * @type {number}
1177
- * @memberof VideosApiGetVideoStreamByContainer
1178
1022
  */
1179
1023
  readonly maxHeight?: number;
1180
1024
  /**
1181
1025
  * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1182
- * @type {number}
1183
- * @memberof VideosApiGetVideoStreamByContainer
1184
1026
  */
1185
1027
  readonly videoBitRate?: number;
1186
1028
  /**
1187
1029
  * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1188
- * @type {number}
1189
- * @memberof VideosApiGetVideoStreamByContainer
1190
1030
  */
1191
1031
  readonly subtitleStreamIndex?: number;
1192
1032
  /**
1193
1033
  * Optional. Specify the subtitle delivery method.
1194
- * @type {SubtitleDeliveryMethod}
1195
- * @memberof VideosApiGetVideoStreamByContainer
1196
1034
  */
1197
1035
  readonly subtitleMethod?: SubtitleDeliveryMethod;
1198
1036
  /**
1199
1037
  * Optional.
1200
- * @type {number}
1201
- * @memberof VideosApiGetVideoStreamByContainer
1202
1038
  */
1203
1039
  readonly maxRefFrames?: number;
1204
1040
  /**
1205
1041
  * Optional. The maximum video bit depth.
1206
- * @type {number}
1207
- * @memberof VideosApiGetVideoStreamByContainer
1208
1042
  */
1209
1043
  readonly maxVideoBitDepth?: number;
1210
1044
  /**
1211
1045
  * Optional. Whether to require avc.
1212
- * @type {boolean}
1213
- * @memberof VideosApiGetVideoStreamByContainer
1214
1046
  */
1215
1047
  readonly requireAvc?: boolean;
1216
1048
  /**
1217
1049
  * Optional. Whether to deinterlace the video.
1218
- * @type {boolean}
1219
- * @memberof VideosApiGetVideoStreamByContainer
1220
1050
  */
1221
1051
  readonly deInterlace?: boolean;
1222
1052
  /**
1223
1053
  * Optional. Whether to require a non anamorphic stream.
1224
- * @type {boolean}
1225
- * @memberof VideosApiGetVideoStreamByContainer
1226
1054
  */
1227
1055
  readonly requireNonAnamorphic?: boolean;
1228
1056
  /**
1229
1057
  * Optional. The maximum number of audio channels to transcode.
1230
- * @type {number}
1231
- * @memberof VideosApiGetVideoStreamByContainer
1232
1058
  */
1233
1059
  readonly transcodingMaxAudioChannels?: number;
1234
1060
  /**
1235
1061
  * Optional. The limit of how many cpu cores to use.
1236
- * @type {number}
1237
- * @memberof VideosApiGetVideoStreamByContainer
1238
1062
  */
1239
1063
  readonly cpuCoreLimit?: number;
1240
1064
  /**
1241
1065
  * The live stream id.
1242
- * @type {string}
1243
- * @memberof VideosApiGetVideoStreamByContainer
1244
1066
  */
1245
1067
  readonly liveStreamId?: string;
1246
1068
  /**
1247
1069
  * Optional. Whether to enable the MpegtsM2Ts mode.
1248
- * @type {boolean}
1249
- * @memberof VideosApiGetVideoStreamByContainer
1250
1070
  */
1251
1071
  readonly enableMpegtsM2TsMode?: boolean;
1252
1072
  /**
1253
1073
  * Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\&#39;s extension.
1254
- * @type {string}
1255
- * @memberof VideosApiGetVideoStreamByContainer
1256
1074
  */
1257
1075
  readonly videoCodec?: string;
1258
1076
  /**
1259
1077
  * Optional. Specify a subtitle codec to encode to.
1260
- * @type {string}
1261
- * @memberof VideosApiGetVideoStreamByContainer
1262
1078
  */
1263
1079
  readonly subtitleCodec?: string;
1264
1080
  /**
1265
1081
  * Optional. The transcoding reason.
1266
- * @type {string}
1267
- * @memberof VideosApiGetVideoStreamByContainer
1268
1082
  */
1269
1083
  readonly transcodeReasons?: string;
1270
1084
  /**
1271
1085
  * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1272
- * @type {number}
1273
- * @memberof VideosApiGetVideoStreamByContainer
1274
1086
  */
1275
1087
  readonly audioStreamIndex?: number;
1276
1088
  /**
1277
1089
  * Optional. The index of the video stream to use. If omitted the first video stream will be used.
1278
- * @type {number}
1279
- * @memberof VideosApiGetVideoStreamByContainer
1280
1090
  */
1281
1091
  readonly videoStreamIndex?: number;
1282
1092
  /**
1283
1093
  * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1284
- * @type {EncodingContext}
1285
- * @memberof VideosApiGetVideoStreamByContainer
1286
1094
  */
1287
1095
  readonly context?: EncodingContext;
1288
1096
  /**
1289
1097
  * Optional. The streaming options.
1290
- * @type {{ [key: string]: string; }}
1291
- * @memberof VideosApiGetVideoStreamByContainer
1292
1098
  */
1293
1099
  readonly streamOptions?: {
1294
1100
  [key: string]: string;
1295
1101
  };
1296
1102
  /**
1297
1103
  * Optional. Whether to enable Audio Encoding.
1298
- * @type {boolean}
1299
- * @memberof VideosApiGetVideoStreamByContainer
1300
1104
  */
1301
1105
  readonly enableAudioVbrEncoding?: boolean;
1302
1106
  }
1303
1107
  /**
1304
- * Request parameters for headVideoStream operation in VideosApi.
1305
- * @export
1306
- * @interface VideosApiHeadVideoStreamRequest
1108
+ * Request parameters for headVideoStream operation in VideoApi.
1307
1109
  */
1308
- export interface VideosApiHeadVideoStreamRequest {
1110
+ export interface VideoApiHeadVideoStreamRequest {
1309
1111
  /**
1310
1112
  * The item id.
1311
- * @type {string}
1312
- * @memberof VideosApiHeadVideoStream
1313
1113
  */
1314
1114
  readonly itemId: string;
1315
1115
  /**
1316
1116
  * The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
1317
- * @type {string}
1318
- * @memberof VideosApiHeadVideoStream
1319
1117
  */
1320
1118
  readonly container?: string;
1321
1119
  /**
1322
1120
  * 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.
1323
- * @type {boolean}
1324
- * @memberof VideosApiHeadVideoStream
1325
1121
  */
1326
1122
  readonly _static?: boolean;
1327
1123
  /**
1328
1124
  * The streaming parameters.
1329
- * @type {string}
1330
- * @memberof VideosApiHeadVideoStream
1331
1125
  */
1332
1126
  readonly params?: string;
1333
1127
  /**
1334
1128
  * The tag.
1335
- * @type {string}
1336
- * @memberof VideosApiHeadVideoStream
1337
1129
  */
1338
1130
  readonly tag?: string;
1339
1131
  /**
1340
1132
  * Optional. The dlna device profile id to utilize.
1341
- * @type {string}
1342
- * @memberof VideosApiHeadVideoStream
1343
1133
  */
1344
1134
  readonly deviceProfileId?: string;
1345
1135
  /**
1346
1136
  * The play session id.
1347
- * @type {string}
1348
- * @memberof VideosApiHeadVideoStream
1349
1137
  */
1350
1138
  readonly playSessionId?: string;
1351
1139
  /**
1352
1140
  * The segment container.
1353
- * @type {string}
1354
- * @memberof VideosApiHeadVideoStream
1355
1141
  */
1356
1142
  readonly segmentContainer?: string;
1357
1143
  /**
1358
1144
  * The segment length.
1359
- * @type {number}
1360
- * @memberof VideosApiHeadVideoStream
1361
1145
  */
1362
1146
  readonly segmentLength?: number;
1363
1147
  /**
1364
1148
  * The minimum number of segments.
1365
- * @type {number}
1366
- * @memberof VideosApiHeadVideoStream
1367
1149
  */
1368
1150
  readonly minSegments?: number;
1369
1151
  /**
1370
1152
  * The media version id, if playing an alternate version.
1371
- * @type {string}
1372
- * @memberof VideosApiHeadVideoStream
1373
1153
  */
1374
1154
  readonly mediaSourceId?: string;
1375
1155
  /**
1376
1156
  * The device id of the client requesting. Used to stop encoding processes when needed.
1377
- * @type {string}
1378
- * @memberof VideosApiHeadVideoStream
1379
1157
  */
1380
1158
  readonly deviceId?: string;
1381
1159
  /**
1382
1160
  * Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\&#39;s extension.
1383
- * @type {string}
1384
- * @memberof VideosApiHeadVideoStream
1385
1161
  */
1386
1162
  readonly audioCodec?: string;
1387
1163
  /**
1388
1164
  * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
1389
- * @type {boolean}
1390
- * @memberof VideosApiHeadVideoStream
1391
1165
  */
1392
1166
  readonly enableAutoStreamCopy?: boolean;
1393
1167
  /**
1394
1168
  * Whether or not to allow copying of the video stream url.
1395
- * @type {boolean}
1396
- * @memberof VideosApiHeadVideoStream
1397
1169
  */
1398
1170
  readonly allowVideoStreamCopy?: boolean;
1399
1171
  /**
1400
1172
  * Whether or not to allow copying of the audio stream url.
1401
- * @type {boolean}
1402
- * @memberof VideosApiHeadVideoStream
1403
1173
  */
1404
1174
  readonly allowAudioStreamCopy?: boolean;
1405
- /**
1406
- * Optional. Whether to break on non key frames.
1407
- * @type {boolean}
1408
- * @memberof VideosApiHeadVideoStream
1409
- */
1410
- readonly breakOnNonKeyFrames?: boolean;
1411
1175
  /**
1412
1176
  * Optional. Specify a specific audio sample rate, e.g. 44100.
1413
- * @type {number}
1414
- * @memberof VideosApiHeadVideoStream
1415
1177
  */
1416
1178
  readonly audioSampleRate?: number;
1417
1179
  /**
1418
1180
  * Optional. The maximum audio bit depth.
1419
- * @type {number}
1420
- * @memberof VideosApiHeadVideoStream
1421
1181
  */
1422
1182
  readonly maxAudioBitDepth?: number;
1423
1183
  /**
1424
1184
  * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1425
- * @type {number}
1426
- * @memberof VideosApiHeadVideoStream
1427
1185
  */
1428
1186
  readonly audioBitRate?: number;
1429
1187
  /**
1430
1188
  * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
1431
- * @type {number}
1432
- * @memberof VideosApiHeadVideoStream
1433
1189
  */
1434
1190
  readonly audioChannels?: number;
1435
1191
  /**
1436
1192
  * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
1437
- * @type {number}
1438
- * @memberof VideosApiHeadVideoStream
1439
1193
  */
1440
1194
  readonly maxAudioChannels?: number;
1441
1195
  /**
1442
1196
  * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
1443
- * @type {string}
1444
- * @memberof VideosApiHeadVideoStream
1445
1197
  */
1446
1198
  readonly profile?: string;
1447
1199
  /**
1448
1200
  * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
1449
- * @type {string}
1450
- * @memberof VideosApiHeadVideoStream
1451
1201
  */
1452
1202
  readonly level?: string;
1453
1203
  /**
1454
1204
  * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1455
- * @type {number}
1456
- * @memberof VideosApiHeadVideoStream
1457
1205
  */
1458
1206
  readonly framerate?: number;
1459
1207
  /**
1460
1208
  * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1461
- * @type {number}
1462
- * @memberof VideosApiHeadVideoStream
1463
1209
  */
1464
1210
  readonly maxFramerate?: number;
1465
1211
  /**
1466
1212
  * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1467
- * @type {boolean}
1468
- * @memberof VideosApiHeadVideoStream
1469
1213
  */
1470
1214
  readonly copyTimestamps?: boolean;
1471
1215
  /**
1472
1216
  * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1473
- * @type {number}
1474
- * @memberof VideosApiHeadVideoStream
1475
1217
  */
1476
1218
  readonly startTimeTicks?: number;
1477
1219
  /**
1478
1220
  * Optional. The fixed horizontal resolution of the encoded video.
1479
- * @type {number}
1480
- * @memberof VideosApiHeadVideoStream
1481
1221
  */
1482
1222
  readonly width?: number;
1483
1223
  /**
1484
1224
  * Optional. The fixed vertical resolution of the encoded video.
1485
- * @type {number}
1486
- * @memberof VideosApiHeadVideoStream
1487
1225
  */
1488
1226
  readonly height?: number;
1489
1227
  /**
1490
1228
  * Optional. The maximum horizontal resolution of the encoded video.
1491
- * @type {number}
1492
- * @memberof VideosApiHeadVideoStream
1493
1229
  */
1494
1230
  readonly maxWidth?: number;
1495
1231
  /**
1496
1232
  * Optional. The maximum vertical resolution of the encoded video.
1497
- * @type {number}
1498
- * @memberof VideosApiHeadVideoStream
1499
1233
  */
1500
1234
  readonly maxHeight?: number;
1501
1235
  /**
1502
1236
  * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1503
- * @type {number}
1504
- * @memberof VideosApiHeadVideoStream
1505
1237
  */
1506
1238
  readonly videoBitRate?: number;
1507
1239
  /**
1508
1240
  * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1509
- * @type {number}
1510
- * @memberof VideosApiHeadVideoStream
1511
1241
  */
1512
1242
  readonly subtitleStreamIndex?: number;
1513
1243
  /**
1514
1244
  * Optional. Specify the subtitle delivery method.
1515
- * @type {SubtitleDeliveryMethod}
1516
- * @memberof VideosApiHeadVideoStream
1517
1245
  */
1518
1246
  readonly subtitleMethod?: SubtitleDeliveryMethod;
1519
1247
  /**
1520
1248
  * Optional.
1521
- * @type {number}
1522
- * @memberof VideosApiHeadVideoStream
1523
1249
  */
1524
1250
  readonly maxRefFrames?: number;
1525
1251
  /**
1526
1252
  * Optional. The maximum video bit depth.
1527
- * @type {number}
1528
- * @memberof VideosApiHeadVideoStream
1529
1253
  */
1530
1254
  readonly maxVideoBitDepth?: number;
1531
1255
  /**
1532
1256
  * Optional. Whether to require avc.
1533
- * @type {boolean}
1534
- * @memberof VideosApiHeadVideoStream
1535
1257
  */
1536
1258
  readonly requireAvc?: boolean;
1537
1259
  /**
1538
1260
  * Optional. Whether to deinterlace the video.
1539
- * @type {boolean}
1540
- * @memberof VideosApiHeadVideoStream
1541
1261
  */
1542
1262
  readonly deInterlace?: boolean;
1543
1263
  /**
1544
1264
  * Optional. Whether to require a non anamorphic stream.
1545
- * @type {boolean}
1546
- * @memberof VideosApiHeadVideoStream
1547
1265
  */
1548
1266
  readonly requireNonAnamorphic?: boolean;
1549
1267
  /**
1550
1268
  * Optional. The maximum number of audio channels to transcode.
1551
- * @type {number}
1552
- * @memberof VideosApiHeadVideoStream
1553
1269
  */
1554
1270
  readonly transcodingMaxAudioChannels?: number;
1555
1271
  /**
1556
1272
  * Optional. The limit of how many cpu cores to use.
1557
- * @type {number}
1558
- * @memberof VideosApiHeadVideoStream
1559
1273
  */
1560
1274
  readonly cpuCoreLimit?: number;
1561
1275
  /**
1562
1276
  * The live stream id.
1563
- * @type {string}
1564
- * @memberof VideosApiHeadVideoStream
1565
1277
  */
1566
1278
  readonly liveStreamId?: string;
1567
1279
  /**
1568
1280
  * Optional. Whether to enable the MpegtsM2Ts mode.
1569
- * @type {boolean}
1570
- * @memberof VideosApiHeadVideoStream
1571
1281
  */
1572
1282
  readonly enableMpegtsM2TsMode?: boolean;
1573
1283
  /**
1574
1284
  * Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\&#39;s extension.
1575
- * @type {string}
1576
- * @memberof VideosApiHeadVideoStream
1577
1285
  */
1578
1286
  readonly videoCodec?: string;
1579
1287
  /**
1580
1288
  * Optional. Specify a subtitle codec to encode to.
1581
- * @type {string}
1582
- * @memberof VideosApiHeadVideoStream
1583
1289
  */
1584
1290
  readonly subtitleCodec?: string;
1585
1291
  /**
1586
1292
  * Optional. The transcoding reason.
1587
- * @type {string}
1588
- * @memberof VideosApiHeadVideoStream
1589
1293
  */
1590
1294
  readonly transcodeReasons?: string;
1591
1295
  /**
1592
1296
  * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1593
- * @type {number}
1594
- * @memberof VideosApiHeadVideoStream
1595
1297
  */
1596
1298
  readonly audioStreamIndex?: number;
1597
1299
  /**
1598
1300
  * Optional. The index of the video stream to use. If omitted the first video stream will be used.
1599
- * @type {number}
1600
- * @memberof VideosApiHeadVideoStream
1601
1301
  */
1602
1302
  readonly videoStreamIndex?: number;
1603
1303
  /**
1604
1304
  * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1605
- * @type {EncodingContext}
1606
- * @memberof VideosApiHeadVideoStream
1607
1305
  */
1608
1306
  readonly context?: EncodingContext;
1609
1307
  /**
1610
1308
  * Optional. The streaming options.
1611
- * @type {{ [key: string]: string; }}
1612
- * @memberof VideosApiHeadVideoStream
1613
1309
  */
1614
1310
  readonly streamOptions?: {
1615
1311
  [key: string]: string;
1616
1312
  };
1617
1313
  /**
1618
1314
  * Optional. Whether to enable Audio Encoding.
1619
- * @type {boolean}
1620
- * @memberof VideosApiHeadVideoStream
1621
1315
  */
1622
1316
  readonly enableAudioVbrEncoding?: boolean;
1623
1317
  }
1624
1318
  /**
1625
- * Request parameters for headVideoStreamByContainer operation in VideosApi.
1626
- * @export
1627
- * @interface VideosApiHeadVideoStreamByContainerRequest
1319
+ * Request parameters for headVideoStreamByContainer operation in VideoApi.
1628
1320
  */
1629
- export interface VideosApiHeadVideoStreamByContainerRequest {
1321
+ export interface VideoApiHeadVideoStreamByContainerRequest {
1630
1322
  /**
1631
1323
  * The item id.
1632
- * @type {string}
1633
- * @memberof VideosApiHeadVideoStreamByContainer
1634
1324
  */
1635
1325
  readonly itemId: string;
1636
1326
  /**
1637
1327
  * The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
1638
- * @type {string}
1639
- * @memberof VideosApiHeadVideoStreamByContainer
1640
1328
  */
1641
1329
  readonly container: string;
1642
1330
  /**
1643
1331
  * 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.
1644
- * @type {boolean}
1645
- * @memberof VideosApiHeadVideoStreamByContainer
1646
1332
  */
1647
1333
  readonly _static?: boolean;
1648
1334
  /**
1649
1335
  * The streaming parameters.
1650
- * @type {string}
1651
- * @memberof VideosApiHeadVideoStreamByContainer
1652
1336
  */
1653
1337
  readonly params?: string;
1654
1338
  /**
1655
1339
  * The tag.
1656
- * @type {string}
1657
- * @memberof VideosApiHeadVideoStreamByContainer
1658
1340
  */
1659
1341
  readonly tag?: string;
1660
1342
  /**
1661
1343
  * Optional. The dlna device profile id to utilize.
1662
- * @type {string}
1663
- * @memberof VideosApiHeadVideoStreamByContainer
1664
1344
  */
1665
1345
  readonly deviceProfileId?: string;
1666
1346
  /**
1667
1347
  * The play session id.
1668
- * @type {string}
1669
- * @memberof VideosApiHeadVideoStreamByContainer
1670
1348
  */
1671
1349
  readonly playSessionId?: string;
1672
1350
  /**
1673
1351
  * The segment container.
1674
- * @type {string}
1675
- * @memberof VideosApiHeadVideoStreamByContainer
1676
1352
  */
1677
1353
  readonly segmentContainer?: string;
1678
1354
  /**
1679
1355
  * The segment length.
1680
- * @type {number}
1681
- * @memberof VideosApiHeadVideoStreamByContainer
1682
1356
  */
1683
1357
  readonly segmentLength?: number;
1684
1358
  /**
1685
1359
  * The minimum number of segments.
1686
- * @type {number}
1687
- * @memberof VideosApiHeadVideoStreamByContainer
1688
1360
  */
1689
1361
  readonly minSegments?: number;
1690
1362
  /**
1691
1363
  * The media version id, if playing an alternate version.
1692
- * @type {string}
1693
- * @memberof VideosApiHeadVideoStreamByContainer
1694
1364
  */
1695
1365
  readonly mediaSourceId?: string;
1696
1366
  /**
1697
1367
  * The device id of the client requesting. Used to stop encoding processes when needed.
1698
- * @type {string}
1699
- * @memberof VideosApiHeadVideoStreamByContainer
1700
1368
  */
1701
1369
  readonly deviceId?: string;
1702
1370
  /**
1703
1371
  * Optional. Specify an audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url\&#39;s extension.
1704
- * @type {string}
1705
- * @memberof VideosApiHeadVideoStreamByContainer
1706
1372
  */
1707
1373
  readonly audioCodec?: string;
1708
1374
  /**
1709
1375
  * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
1710
- * @type {boolean}
1711
- * @memberof VideosApiHeadVideoStreamByContainer
1712
1376
  */
1713
1377
  readonly enableAutoStreamCopy?: boolean;
1714
1378
  /**
1715
1379
  * Whether or not to allow copying of the video stream url.
1716
- * @type {boolean}
1717
- * @memberof VideosApiHeadVideoStreamByContainer
1718
1380
  */
1719
1381
  readonly allowVideoStreamCopy?: boolean;
1720
1382
  /**
1721
1383
  * Whether or not to allow copying of the audio stream url.
1722
- * @type {boolean}
1723
- * @memberof VideosApiHeadVideoStreamByContainer
1724
1384
  */
1725
1385
  readonly allowAudioStreamCopy?: boolean;
1726
- /**
1727
- * Optional. Whether to break on non key frames.
1728
- * @type {boolean}
1729
- * @memberof VideosApiHeadVideoStreamByContainer
1730
- */
1731
- readonly breakOnNonKeyFrames?: boolean;
1732
1386
  /**
1733
1387
  * Optional. Specify a specific audio sample rate, e.g. 44100.
1734
- * @type {number}
1735
- * @memberof VideosApiHeadVideoStreamByContainer
1736
1388
  */
1737
1389
  readonly audioSampleRate?: number;
1738
1390
  /**
1739
1391
  * Optional. The maximum audio bit depth.
1740
- * @type {number}
1741
- * @memberof VideosApiHeadVideoStreamByContainer
1742
1392
  */
1743
1393
  readonly maxAudioBitDepth?: number;
1744
1394
  /**
1745
1395
  * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1746
- * @type {number}
1747
- * @memberof VideosApiHeadVideoStreamByContainer
1748
1396
  */
1749
1397
  readonly audioBitRate?: number;
1750
1398
  /**
1751
1399
  * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
1752
- * @type {number}
1753
- * @memberof VideosApiHeadVideoStreamByContainer
1754
1400
  */
1755
1401
  readonly audioChannels?: number;
1756
1402
  /**
1757
1403
  * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
1758
- * @type {number}
1759
- * @memberof VideosApiHeadVideoStreamByContainer
1760
1404
  */
1761
1405
  readonly maxAudioChannels?: number;
1762
1406
  /**
1763
1407
  * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
1764
- * @type {string}
1765
- * @memberof VideosApiHeadVideoStreamByContainer
1766
1408
  */
1767
1409
  readonly profile?: string;
1768
1410
  /**
1769
1411
  * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
1770
- * @type {string}
1771
- * @memberof VideosApiHeadVideoStreamByContainer
1772
1412
  */
1773
1413
  readonly level?: string;
1774
1414
  /**
1775
1415
  * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1776
- * @type {number}
1777
- * @memberof VideosApiHeadVideoStreamByContainer
1778
1416
  */
1779
1417
  readonly framerate?: number;
1780
1418
  /**
1781
1419
  * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1782
- * @type {number}
1783
- * @memberof VideosApiHeadVideoStreamByContainer
1784
1420
  */
1785
1421
  readonly maxFramerate?: number;
1786
1422
  /**
1787
1423
  * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1788
- * @type {boolean}
1789
- * @memberof VideosApiHeadVideoStreamByContainer
1790
1424
  */
1791
1425
  readonly copyTimestamps?: boolean;
1792
1426
  /**
1793
1427
  * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1794
- * @type {number}
1795
- * @memberof VideosApiHeadVideoStreamByContainer
1796
1428
  */
1797
1429
  readonly startTimeTicks?: number;
1798
1430
  /**
1799
1431
  * Optional. The fixed horizontal resolution of the encoded video.
1800
- * @type {number}
1801
- * @memberof VideosApiHeadVideoStreamByContainer
1802
1432
  */
1803
1433
  readonly width?: number;
1804
1434
  /**
1805
1435
  * Optional. The fixed vertical resolution of the encoded video.
1806
- * @type {number}
1807
- * @memberof VideosApiHeadVideoStreamByContainer
1808
1436
  */
1809
1437
  readonly height?: number;
1810
1438
  /**
1811
1439
  * Optional. The maximum horizontal resolution of the encoded video.
1812
- * @type {number}
1813
- * @memberof VideosApiHeadVideoStreamByContainer
1814
1440
  */
1815
1441
  readonly maxWidth?: number;
1816
1442
  /**
1817
1443
  * Optional. The maximum vertical resolution of the encoded video.
1818
- * @type {number}
1819
- * @memberof VideosApiHeadVideoStreamByContainer
1820
1444
  */
1821
1445
  readonly maxHeight?: number;
1822
1446
  /**
1823
1447
  * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1824
- * @type {number}
1825
- * @memberof VideosApiHeadVideoStreamByContainer
1826
1448
  */
1827
1449
  readonly videoBitRate?: number;
1828
1450
  /**
1829
1451
  * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1830
- * @type {number}
1831
- * @memberof VideosApiHeadVideoStreamByContainer
1832
1452
  */
1833
1453
  readonly subtitleStreamIndex?: number;
1834
1454
  /**
1835
1455
  * Optional. Specify the subtitle delivery method.
1836
- * @type {SubtitleDeliveryMethod}
1837
- * @memberof VideosApiHeadVideoStreamByContainer
1838
1456
  */
1839
1457
  readonly subtitleMethod?: SubtitleDeliveryMethod;
1840
1458
  /**
1841
1459
  * Optional.
1842
- * @type {number}
1843
- * @memberof VideosApiHeadVideoStreamByContainer
1844
1460
  */
1845
1461
  readonly maxRefFrames?: number;
1846
1462
  /**
1847
1463
  * Optional. The maximum video bit depth.
1848
- * @type {number}
1849
- * @memberof VideosApiHeadVideoStreamByContainer
1850
1464
  */
1851
1465
  readonly maxVideoBitDepth?: number;
1852
1466
  /**
1853
1467
  * Optional. Whether to require avc.
1854
- * @type {boolean}
1855
- * @memberof VideosApiHeadVideoStreamByContainer
1856
1468
  */
1857
1469
  readonly requireAvc?: boolean;
1858
1470
  /**
1859
1471
  * Optional. Whether to deinterlace the video.
1860
- * @type {boolean}
1861
- * @memberof VideosApiHeadVideoStreamByContainer
1862
1472
  */
1863
1473
  readonly deInterlace?: boolean;
1864
1474
  /**
1865
1475
  * Optional. Whether to require a non anamorphic stream.
1866
- * @type {boolean}
1867
- * @memberof VideosApiHeadVideoStreamByContainer
1868
1476
  */
1869
1477
  readonly requireNonAnamorphic?: boolean;
1870
1478
  /**
1871
1479
  * Optional. The maximum number of audio channels to transcode.
1872
- * @type {number}
1873
- * @memberof VideosApiHeadVideoStreamByContainer
1874
1480
  */
1875
1481
  readonly transcodingMaxAudioChannels?: number;
1876
1482
  /**
1877
1483
  * Optional. The limit of how many cpu cores to use.
1878
- * @type {number}
1879
- * @memberof VideosApiHeadVideoStreamByContainer
1880
1484
  */
1881
1485
  readonly cpuCoreLimit?: number;
1882
1486
  /**
1883
1487
  * The live stream id.
1884
- * @type {string}
1885
- * @memberof VideosApiHeadVideoStreamByContainer
1886
1488
  */
1887
1489
  readonly liveStreamId?: string;
1888
1490
  /**
1889
1491
  * Optional. Whether to enable the MpegtsM2Ts mode.
1890
- * @type {boolean}
1891
- * @memberof VideosApiHeadVideoStreamByContainer
1892
1492
  */
1893
1493
  readonly enableMpegtsM2TsMode?: boolean;
1894
1494
  /**
1895
1495
  * Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url\&#39;s extension.
1896
- * @type {string}
1897
- * @memberof VideosApiHeadVideoStreamByContainer
1898
1496
  */
1899
1497
  readonly videoCodec?: string;
1900
1498
  /**
1901
1499
  * Optional. Specify a subtitle codec to encode to.
1902
- * @type {string}
1903
- * @memberof VideosApiHeadVideoStreamByContainer
1904
1500
  */
1905
1501
  readonly subtitleCodec?: string;
1906
1502
  /**
1907
1503
  * Optional. The transcoding reason.
1908
- * @type {string}
1909
- * @memberof VideosApiHeadVideoStreamByContainer
1910
1504
  */
1911
1505
  readonly transcodeReasons?: string;
1912
1506
  /**
1913
1507
  * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1914
- * @type {number}
1915
- * @memberof VideosApiHeadVideoStreamByContainer
1916
1508
  */
1917
1509
  readonly audioStreamIndex?: number;
1918
1510
  /**
1919
1511
  * Optional. The index of the video stream to use. If omitted the first video stream will be used.
1920
- * @type {number}
1921
- * @memberof VideosApiHeadVideoStreamByContainer
1922
1512
  */
1923
1513
  readonly videoStreamIndex?: number;
1924
1514
  /**
1925
1515
  * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1926
- * @type {EncodingContext}
1927
- * @memberof VideosApiHeadVideoStreamByContainer
1928
1516
  */
1929
1517
  readonly context?: EncodingContext;
1930
1518
  /**
1931
1519
  * Optional. The streaming options.
1932
- * @type {{ [key: string]: string; }}
1933
- * @memberof VideosApiHeadVideoStreamByContainer
1934
1520
  */
1935
1521
  readonly streamOptions?: {
1936
1522
  [key: string]: string;
1937
1523
  };
1938
1524
  /**
1939
1525
  * Optional. Whether to enable Audio Encoding.
1940
- * @type {boolean}
1941
- * @memberof VideosApiHeadVideoStreamByContainer
1942
1526
  */
1943
1527
  readonly enableAudioVbrEncoding?: boolean;
1944
1528
  }
1945
1529
  /**
1946
- * Request parameters for mergeVersions operation in VideosApi.
1947
- * @export
1948
- * @interface VideosApiMergeVersionsRequest
1530
+ * Request parameters for mergeVersions operation in VideoApi.
1949
1531
  */
1950
- export interface VideosApiMergeVersionsRequest {
1532
+ export interface VideoApiMergeVersionsRequest {
1951
1533
  /**
1952
1534
  * Item id list. This allows multiple, comma delimited.
1953
- * @type {Array<string>}
1954
- * @memberof VideosApiMergeVersions
1955
1535
  */
1956
1536
  readonly ids: Array<string>;
1957
1537
  }
1958
1538
  /**
1959
- * VideosApi - object-oriented interface
1960
- * @export
1961
- * @class VideosApi
1962
- * @extends {BaseAPI}
1539
+ * VideoApi - object-oriented interface
1963
1540
  */
1964
- export declare class VideosApi extends BaseAPI {
1541
+ export declare class VideoApi extends BaseAPI {
1965
1542
  /**
1966
1543
  *
1967
1544
  * @summary Removes alternate video sources.
1968
- * @param {VideosApiDeleteAlternateSourcesRequest} requestParameters Request parameters.
1545
+ * @param {VideoApiDeleteAlternateSourcesRequest} requestParameters Request parameters.
1969
1546
  * @param {*} [options] Override http request option.
1970
1547
  * @throws {RequiredError}
1971
- * @memberof VideosApi
1972
1548
  */
1973
- deleteAlternateSources(requestParameters: VideosApiDeleteAlternateSourcesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1549
+ deleteAlternateSources(requestParameters: VideoApiDeleteAlternateSourcesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1974
1550
  /**
1975
1551
  *
1976
1552
  * @summary Gets additional parts for a video.
1977
- * @param {VideosApiGetAdditionalPartRequest} requestParameters Request parameters.
1553
+ * @param {VideoApiGetAdditionalPartRequest} requestParameters Request parameters.
1554
+ * @param {*} [options] Override http request option.
1555
+ * @throws {RequiredError}
1556
+ */
1557
+ getAdditionalPart(requestParameters: VideoApiGetAdditionalPartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
1558
+ /**
1559
+ *
1560
+ * @summary Get video attachment.
1561
+ * @param {VideoApiGetAttachmentRequest} requestParameters Request parameters.
1978
1562
  * @param {*} [options] Override http request option.
1979
1563
  * @throws {RequiredError}
1980
- * @memberof VideosApi
1981
1564
  */
1982
- getAdditionalPart(requestParameters: VideosApiGetAdditionalPartRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any, {}>>;
1565
+ getAttachment(requestParameters: VideoApiGetAttachmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1983
1566
  /**
1984
1567
  *
1985
1568
  * @summary Gets a video stream.
1986
- * @param {VideosApiGetVideoStreamRequest} requestParameters Request parameters.
1569
+ * @param {VideoApiGetVideoStreamRequest} requestParameters Request parameters.
1987
1570
  * @param {*} [options] Override http request option.
1988
1571
  * @throws {RequiredError}
1989
- * @memberof VideosApi
1990
1572
  */
1991
- getVideoStream(requestParameters: VideosApiGetVideoStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1573
+ getVideoStream(requestParameters: VideoApiGetVideoStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1992
1574
  /**
1993
1575
  *
1994
1576
  * @summary Gets a video stream.
1995
- * @param {VideosApiGetVideoStreamByContainerRequest} requestParameters Request parameters.
1577
+ * @param {VideoApiGetVideoStreamByContainerRequest} requestParameters Request parameters.
1996
1578
  * @param {*} [options] Override http request option.
1997
1579
  * @throws {RequiredError}
1998
- * @memberof VideosApi
1999
1580
  */
2000
- getVideoStreamByContainer(requestParameters: VideosApiGetVideoStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1581
+ getVideoStreamByContainer(requestParameters: VideoApiGetVideoStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
2001
1582
  /**
2002
1583
  *
2003
1584
  * @summary Gets a video stream.
2004
- * @param {VideosApiHeadVideoStreamRequest} requestParameters Request parameters.
1585
+ * @param {VideoApiHeadVideoStreamRequest} requestParameters Request parameters.
2005
1586
  * @param {*} [options] Override http request option.
2006
1587
  * @throws {RequiredError}
2007
- * @memberof VideosApi
2008
1588
  */
2009
- headVideoStream(requestParameters: VideosApiHeadVideoStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1589
+ headVideoStream(requestParameters: VideoApiHeadVideoStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
2010
1590
  /**
2011
1591
  *
2012
1592
  * @summary Gets a video stream.
2013
- * @param {VideosApiHeadVideoStreamByContainerRequest} requestParameters Request parameters.
1593
+ * @param {VideoApiHeadVideoStreamByContainerRequest} requestParameters Request parameters.
2014
1594
  * @param {*} [options] Override http request option.
2015
1595
  * @throws {RequiredError}
2016
- * @memberof VideosApi
2017
1596
  */
2018
- headVideoStreamByContainer(requestParameters: VideosApiHeadVideoStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
1597
+ headVideoStreamByContainer(requestParameters: VideoApiHeadVideoStreamByContainerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
2019
1598
  /**
2020
1599
  *
2021
1600
  * @summary Merges videos into a single record.
2022
- * @param {VideosApiMergeVersionsRequest} requestParameters Request parameters.
1601
+ * @param {VideoApiMergeVersionsRequest} requestParameters Request parameters.
2023
1602
  * @param {*} [options] Override http request option.
2024
1603
  * @throws {RequiredError}
2025
- * @memberof VideosApi
2026
1604
  */
2027
- mergeVersions(requestParameters: VideosApiMergeVersionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1605
+ mergeVersions(requestParameters: VideoApiMergeVersionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
2028
1606
  }