@jellyfin/sdk 0.12.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (759) hide show
  1. package/.nvmrc +1 -0
  2. package/.openapi-generator-ignore +2 -0
  3. package/CHANGELOG.md +40 -3
  4. package/README.md +55 -32
  5. package/eslint.config.mjs +118 -0
  6. package/lib/api.d.ts +33 -9
  7. package/lib/api.js +88 -26
  8. package/lib/constants.d.ts +11 -0
  9. package/lib/constants.js +13 -0
  10. package/lib/generated-client/api/{artists-api.d.ts → artist-api.d.ts} +38 -173
  11. package/lib/generated-client/api/{artists-api.js → artist-api.js} +39 -33
  12. package/lib/generated-client/api/audio-api.d.ts +295 -450
  13. package/lib/generated-client/api/audio-api.js +332 -64
  14. package/lib/generated-client/api/authentication-api.d.ts +517 -0
  15. package/lib/generated-client/api/authentication-api.js +870 -0
  16. package/lib/generated-client/api/backup-api.d.ts +0 -22
  17. package/lib/generated-client/api/backup-api.js +5 -11
  18. package/lib/generated-client/api/branding-api.d.ts +0 -9
  19. package/lib/generated-client/api/branding-api.js +4 -10
  20. package/lib/generated-client/api/{channels-api.d.ts → channel-api.d.ts} +32 -95
  21. package/lib/generated-client/api/{channels-api.js → channel-api.js} +35 -41
  22. package/lib/generated-client/api/collection-api.d.ts +0 -31
  23. package/lib/generated-client/api/collection-api.js +4 -10
  24. package/lib/generated-client/api/{devices-api.d.ts → device-api.d.ts} +48 -81
  25. package/lib/generated-client/api/{devices-api.js → device-api.js} +46 -54
  26. package/lib/generated-client/api/{display-preferences-api.d.ts → display-preference-api.d.ts} +20 -46
  27. package/lib/generated-client/api/{display-preferences-api.js → display-preference-api.js} +22 -28
  28. package/lib/generated-client/api/environment-api.d.ts +0 -60
  29. package/lib/generated-client/api/environment-api.js +6 -75
  30. package/lib/generated-client/api/filter-api.d.ts +0 -40
  31. package/lib/generated-client/api/filter-api.js +3 -9
  32. package/lib/generated-client/api/{genres-api.d.ts → genre-api.d.ts} +20 -72
  33. package/lib/generated-client/api/{genres-api.js → genre-api.js} +22 -28
  34. package/lib/generated-client/api/image-api.d.ts +4 -1007
  35. package/lib/generated-client/api/image-api.js +42 -48
  36. package/lib/generated-client/api/instant-mix-api.d.ts +8 -245
  37. package/lib/generated-client/api/instant-mix-api.js +16 -121
  38. package/lib/generated-client/api/item-lookup-api.d.ts +0 -65
  39. package/lib/generated-client/api/item-lookup-api.js +12 -18
  40. package/lib/generated-client/api/item-update-api.d.ts +0 -25
  41. package/lib/generated-client/api/item-update-api.js +4 -10
  42. package/lib/generated-client/api/library-api.d.ts +1239 -327
  43. package/lib/generated-client/api/library-api.js +1307 -95
  44. package/lib/generated-client/api/library-structure-api.d.ts +0 -62
  45. package/lib/generated-client/api/library-structure-api.js +9 -15
  46. package/lib/generated-client/api/live-tv-api.d.ts +0 -622
  47. package/lib/generated-client/api/live-tv-api.js +39 -320
  48. package/lib/generated-client/api/localization-api.d.ts +0 -10
  49. package/lib/generated-client/api/localization-api.js +5 -11
  50. package/lib/generated-client/api/{lyrics-api.d.ts → lyric-api.d.ts} +44 -89
  51. package/lib/generated-client/api/{lyrics-api.js → lyric-api.js} +42 -48
  52. package/lib/generated-client/api/media-info-api.d.ts +4 -91
  53. package/lib/generated-client/api/media-info-api.js +10 -16
  54. package/lib/generated-client/api/{media-segments-api.d.ts → media-segment-api.d.ts} +14 -27
  55. package/lib/generated-client/api/{media-segments-api.js → media-segment-api.js} +17 -23
  56. package/lib/generated-client/api/{movies-api.d.ts → movie-api.d.ts} +14 -33
  57. package/lib/generated-client/api/{movies-api.js → movie-api.js} +17 -23
  58. package/lib/generated-client/api/music-genre-api.d.ts +85 -0
  59. package/lib/generated-client/api/music-genre-api.js +121 -0
  60. package/lib/generated-client/api/{persons-api.d.ts → person-api.d.ts} +52 -64
  61. package/lib/generated-client/api/{persons-api.js → person-api.js} +51 -32
  62. package/lib/generated-client/api/{playlists-api.d.ts → playlist-api.d.ts} +86 -185
  63. package/lib/generated-client/api/{playlists-api.js → playlist-api.js} +80 -81
  64. package/lib/generated-client/api/plugin-api.d.ts +743 -0
  65. package/lib/generated-client/api/plugin-api.js +1186 -0
  66. package/lib/generated-client/api/remote-image-api.d.ts +0 -35
  67. package/lib/generated-client/api/remote-image-api.js +4 -10
  68. package/lib/generated-client/api/{scheduled-tasks-api.d.ts → scheduled-task-api.d.ts} +38 -73
  69. package/lib/generated-client/api/{scheduled-tasks-api.js → scheduled-task-api.js} +37 -43
  70. package/lib/generated-client/api/search-api.d.ts +0 -45
  71. package/lib/generated-client/api/search-api.js +2 -8
  72. package/lib/generated-client/api/session-api.d.ts +163 -181
  73. package/lib/generated-client/api/session-api.js +262 -123
  74. package/lib/generated-client/api/{tv-shows-api.d.ts → show-api.d.ts} +34 -156
  75. package/lib/generated-client/api/{tv-shows-api.js → show-api.js} +36 -47
  76. package/lib/generated-client/api/startup-api.d.ts +20 -25
  77. package/lib/generated-client/api/startup-api.js +28 -14
  78. package/lib/generated-client/api/{studios-api.d.ts → studio-api.d.ts} +20 -70
  79. package/lib/generated-client/api/{studios-api.js → studio-api.js} +22 -28
  80. package/lib/generated-client/api/subtitle-api.d.ts +0 -114
  81. package/lib/generated-client/api/subtitle-api.js +11 -17
  82. package/lib/generated-client/api/{suggestions-api.d.ts → suggestion-api.d.ts} +14 -35
  83. package/lib/generated-client/api/{suggestions-api.js → suggestion-api.js} +17 -23
  84. package/lib/generated-client/api/sync-play-api.d.ts +0 -96
  85. package/lib/generated-client/api/sync-play-api.js +23 -29
  86. package/lib/generated-client/api/system-api.d.ts +420 -20
  87. package/lib/generated-client/api/system-api.js +659 -18
  88. package/lib/generated-client/api/{trailers-api.d.ts → trailer-api.d.ts} +32 -193
  89. package/lib/generated-client/api/{trailers-api.js → trailer-api.js} +35 -27
  90. package/lib/generated-client/api/{trickplay-api.d.ts → trick-play-api.d.ts} +20 -46
  91. package/lib/generated-client/api/{trickplay-api.js → trick-play-api.js} +22 -28
  92. package/lib/generated-client/api/user-api.d.ts +0 -249
  93. package/lib/generated-client/api/user-api.js +11 -277
  94. package/lib/generated-client/api/user-data-api.d.ts +429 -0
  95. package/lib/generated-client/api/{user-library-api.js → user-data-api.js} +149 -324
  96. package/lib/generated-client/api/{user-views-api.d.ts → user-view-api.d.ts} +20 -42
  97. package/lib/generated-client/api/{user-views-api.js → user-view-api.js} +22 -28
  98. package/lib/generated-client/api/{videos-api.d.ts → video-api.d.ts} +111 -533
  99. package/lib/generated-client/api/{videos-api.js → video-api.js} +141 -101
  100. package/lib/generated-client/api/{years-api.d.ts → year-api.d.ts} +20 -66
  101. package/lib/generated-client/api/{years-api.js → year-api.js} +22 -28
  102. package/lib/generated-client/api.d.ts +23 -38
  103. package/lib/generated-client/base.d.ts +0 -24
  104. package/lib/generated-client/base.js +0 -15
  105. package/lib/generated-client/common.d.ts +4 -35
  106. package/lib/generated-client/common.js +15 -26
  107. package/lib/generated-client/configuration.d.ts +24 -17
  108. package/lib/generated-client/configuration.js +8 -2
  109. package/lib/generated-client/index.js +25 -39
  110. package/lib/generated-client/models/access-schedule.d.ts +0 -15
  111. package/lib/generated-client/models/activity-log-entry-message.d.ts +0 -11
  112. package/lib/generated-client/models/activity-log-entry-query-result.d.ts +0 -8
  113. package/lib/generated-client/models/activity-log-entry-start-message.d.ts +1 -10
  114. package/lib/generated-client/models/activity-log-entry-stop-message.d.ts +0 -7
  115. package/lib/generated-client/models/activity-log-entry.d.ts +0 -25
  116. package/lib/generated-client/models/activity-log-sort-by.d.ts +23 -0
  117. package/lib/generated-client/models/{architecture.d.ts → activity-log-sort-by.js} +13 -11
  118. package/lib/generated-client/models/add-virtual-folder-dto.d.ts +0 -7
  119. package/lib/generated-client/models/album-info-remote-search-query.d.ts +0 -19
  120. package/lib/generated-client/models/album-info.d.ts +1 -49
  121. package/lib/generated-client/models/all-theme-media-result.d.ts +0 -20
  122. package/lib/generated-client/models/artist-info-remote-search-query.d.ts +0 -19
  123. package/lib/generated-client/models/artist-info.d.ts +0 -44
  124. package/lib/generated-client/models/audio-spatial-format.d.ts +0 -2
  125. package/lib/generated-client/models/audio-spatial-format.js +0 -2
  126. package/lib/generated-client/models/authenticate-user-by-name.d.ts +0 -6
  127. package/lib/generated-client/models/authentication-info-query-result.d.ts +0 -8
  128. package/lib/generated-client/models/authentication-info.d.ts +0 -35
  129. package/lib/generated-client/models/authentication-result.d.ts +0 -16
  130. package/lib/generated-client/models/backup-manifest-dto.d.ts +5 -20
  131. package/lib/generated-client/models/backup-options-dto.d.ts +0 -10
  132. package/lib/generated-client/models/backup-restore-request-dto.d.ts +1 -5
  133. package/lib/generated-client/models/base-item-dto-image-blur-hashes.d.ts +14 -81
  134. package/lib/generated-client/models/base-item-dto-query-result.d.ts +0 -8
  135. package/lib/generated-client/models/base-item-dto.d.ts +6 -456
  136. package/lib/generated-client/models/base-item-kind.d.ts +0 -2
  137. package/lib/generated-client/models/base-item-kind.js +0 -2
  138. package/lib/generated-client/models/base-item-person-image-blur-hashes.d.ts +13 -80
  139. package/lib/generated-client/models/base-item-person.d.ts +0 -20
  140. package/lib/generated-client/models/book-info-remote-search-query.d.ts +0 -19
  141. package/lib/generated-client/models/book-info.d.ts +2 -40
  142. package/lib/generated-client/models/box-set-info-remote-search-query.d.ts +0 -19
  143. package/lib/generated-client/models/box-set-info.d.ts +1 -37
  144. package/lib/generated-client/models/branding-options-dto.d.ts +1 -9
  145. package/lib/generated-client/models/buffer-request-dto.d.ts +0 -10
  146. package/lib/generated-client/models/cast-receiver-application.d.ts +2 -8
  147. package/lib/generated-client/models/channel-features.d.ts +0 -29
  148. package/lib/generated-client/models/channel-item-sort-field.d.ts +0 -5
  149. package/lib/generated-client/models/channel-item-sort-field.js +0 -5
  150. package/lib/generated-client/models/channel-mapping-options-dto.d.ts +2 -12
  151. package/lib/generated-client/models/channel-media-content-type.d.ts +0 -5
  152. package/lib/generated-client/models/channel-media-content-type.js +0 -5
  153. package/lib/generated-client/models/channel-media-type.d.ts +0 -5
  154. package/lib/generated-client/models/channel-media-type.js +0 -5
  155. package/lib/generated-client/models/channel-type.d.ts +0 -2
  156. package/lib/generated-client/models/channel-type.js +0 -2
  157. package/lib/generated-client/models/chapter-info.d.ts +0 -18
  158. package/lib/generated-client/models/client-capabilities-dto.d.ts +0 -19
  159. package/lib/generated-client/models/client-log-document-response-dto.d.ts +0 -4
  160. package/lib/generated-client/models/codec-profile.d.ts +0 -17
  161. package/lib/generated-client/models/codec-type.d.ts +1 -3
  162. package/lib/generated-client/models/codec-type.js +1 -3
  163. package/lib/generated-client/models/collection-creation-result.d.ts +0 -10
  164. package/lib/generated-client/models/collection-type-options.d.ts +0 -2
  165. package/lib/generated-client/models/collection-type-options.js +0 -2
  166. package/lib/generated-client/models/collection-type.d.ts +0 -2
  167. package/lib/generated-client/models/collection-type.js +0 -2
  168. package/lib/generated-client/models/configuration-page-info.d.ts +0 -14
  169. package/lib/generated-client/models/container-profile.d.ts +0 -13
  170. package/lib/generated-client/models/country-info.d.ts +0 -10
  171. package/lib/generated-client/models/create-playlist-dto.d.ts +1 -18
  172. package/lib/generated-client/models/create-user-by-name.d.ts +0 -6
  173. package/lib/generated-client/models/culture-dto.d.ts +0 -15
  174. package/lib/generated-client/models/custom-database-option.d.ts +2 -8
  175. package/lib/generated-client/models/custom-database-options.d.ts +3 -13
  176. package/lib/generated-client/models/database-configuration-options.d.ts +1 -15
  177. package/lib/generated-client/models/database-locking-behavior-types.d.ts +0 -2
  178. package/lib/generated-client/models/database-locking-behavior-types.js +0 -2
  179. package/lib/generated-client/models/day-of-week.d.ts +0 -5
  180. package/lib/generated-client/models/day-of-week.js +0 -5
  181. package/lib/generated-client/models/day-pattern.d.ts +1 -3
  182. package/lib/generated-client/models/day-pattern.js +1 -3
  183. package/lib/generated-client/models/default-directory-browser-info-dto.d.ts +0 -4
  184. package/lib/generated-client/models/deinterlace-method.d.ts +0 -2
  185. package/lib/generated-client/models/deinterlace-method.js +0 -2
  186. package/lib/generated-client/models/device-info-dto-query-result.d.ts +0 -8
  187. package/lib/generated-client/models/device-info-dto.d.ts +0 -27
  188. package/lib/generated-client/models/device-options-dto.d.ts +0 -8
  189. package/lib/generated-client/models/device-profile.d.ts +1 -25
  190. package/lib/generated-client/models/direct-play-profile.d.ts +0 -13
  191. package/lib/generated-client/models/display-preferences-dto.d.ts +0 -36
  192. package/lib/generated-client/models/dlna-profile-type.d.ts +0 -5
  193. package/lib/generated-client/models/dlna-profile-type.js +0 -5
  194. package/lib/generated-client/models/down-mix-stereo-algorithms.d.ts +0 -2
  195. package/lib/generated-client/models/down-mix-stereo-algorithms.js +0 -2
  196. package/lib/generated-client/models/dynamic-day-of-week.d.ts +0 -2
  197. package/lib/generated-client/models/dynamic-day-of-week.js +0 -2
  198. package/lib/generated-client/models/embedded-subtitle-options.d.ts +0 -2
  199. package/lib/generated-client/models/embedded-subtitle-options.js +0 -2
  200. package/lib/generated-client/models/encoder-preset.d.ts +0 -2
  201. package/lib/generated-client/models/encoder-preset.js +0 -2
  202. package/lib/generated-client/models/encoding-context.d.ts +1 -3
  203. package/lib/generated-client/models/encoding-context.js +1 -3
  204. package/lib/generated-client/models/encoding-options.d.ts +6 -117
  205. package/lib/generated-client/models/end-point-info.d.ts +0 -15
  206. package/lib/generated-client/models/external-id-info.d.ts +0 -11
  207. package/lib/generated-client/models/external-id-media-type.d.ts +0 -2
  208. package/lib/generated-client/models/external-id-media-type.js +0 -2
  209. package/lib/generated-client/models/external-url.d.ts +0 -9
  210. package/lib/generated-client/models/extra-type.d.ts +0 -5
  211. package/lib/generated-client/models/extra-type.js +0 -5
  212. package/lib/generated-client/models/file-system-entry-info.d.ts +0 -11
  213. package/lib/generated-client/models/file-system-entry-type.d.ts +0 -2
  214. package/lib/generated-client/models/file-system-entry-type.js +0 -2
  215. package/lib/generated-client/models/folder-storage-dto.d.ts +1 -13
  216. package/lib/generated-client/models/font-file.d.ts +0 -10
  217. package/lib/generated-client/models/force-keep-alive-message.d.ts +0 -11
  218. package/lib/generated-client/models/forgot-password-action.d.ts +0 -5
  219. package/lib/generated-client/models/forgot-password-action.js +0 -5
  220. package/lib/generated-client/models/forgot-password-dto.d.ts +0 -4
  221. package/lib/generated-client/models/forgot-password-pin-dto.d.ts +0 -4
  222. package/lib/generated-client/models/forgot-password-result.d.ts +0 -14
  223. package/lib/generated-client/models/general-command-message.d.ts +0 -14
  224. package/lib/generated-client/models/general-command-type.d.ts +0 -2
  225. package/lib/generated-client/models/general-command-type.js +0 -2
  226. package/lib/generated-client/models/general-command.d.ts +1 -21
  227. package/lib/generated-client/models/get-programs-dto.d.ts +0 -56
  228. package/lib/generated-client/models/group-info-dto.d.ts +0 -15
  229. package/lib/generated-client/models/group-queue-mode.d.ts +0 -2
  230. package/lib/generated-client/models/group-queue-mode.js +0 -2
  231. package/lib/generated-client/models/group-repeat-mode.d.ts +0 -2
  232. package/lib/generated-client/models/group-repeat-mode.js +0 -2
  233. package/lib/generated-client/models/group-shuffle-mode.d.ts +0 -2
  234. package/lib/generated-client/models/group-shuffle-mode.js +0 -2
  235. package/lib/generated-client/models/group-state-type.d.ts +0 -2
  236. package/lib/generated-client/models/group-state-type.js +0 -2
  237. package/lib/generated-client/models/group-state-update.d.ts +0 -12
  238. package/lib/generated-client/models/group-update-type.d.ts +0 -2
  239. package/lib/generated-client/models/group-update-type.js +0 -2
  240. package/lib/generated-client/models/group-update.d.ts +0 -1
  241. package/lib/generated-client/models/guide-info.d.ts +0 -9
  242. package/lib/generated-client/models/hardware-acceleration-type.d.ts +0 -2
  243. package/lib/generated-client/models/hardware-acceleration-type.js +0 -2
  244. package/lib/generated-client/models/{notification-level.d.ts → hls-audio-seek-strategy.d.ts} +5 -8
  245. package/lib/generated-client/models/{transcoding-info.js → hls-audio-seek-strategy.js} +8 -2
  246. package/lib/generated-client/models/ignore-wait-request-dto.d.ts +0 -4
  247. package/lib/generated-client/models/image-format.d.ts +0 -2
  248. package/lib/generated-client/models/image-format.js +0 -2
  249. package/lib/generated-client/models/image-info.d.ts +0 -21
  250. package/lib/generated-client/models/image-option.d.ts +0 -14
  251. package/lib/generated-client/models/image-orientation.d.ts +0 -5
  252. package/lib/generated-client/models/image-orientation.js +0 -5
  253. package/lib/generated-client/models/image-provider-info.d.ts +0 -6
  254. package/lib/generated-client/models/image-resolution.d.ts +0 -2
  255. package/lib/generated-client/models/image-resolution.js +0 -2
  256. package/lib/generated-client/models/image-saving-convention.d.ts +1 -3
  257. package/lib/generated-client/models/image-saving-convention.js +1 -3
  258. package/lib/generated-client/models/image-type.d.ts +0 -2
  259. package/lib/generated-client/models/image-type.js +0 -2
  260. package/lib/generated-client/models/inbound-keep-alive-message.d.ts +0 -7
  261. package/lib/generated-client/models/inbound-web-socket-message.d.ts +0 -1
  262. package/lib/generated-client/models/index.d.ts +2 -2
  263. package/lib/generated-client/models/index.js +2 -1
  264. package/lib/generated-client/models/installation-info.d.ts +0 -19
  265. package/lib/generated-client/models/iplugin.d.ts +0 -16
  266. package/lib/generated-client/models/iso-type.d.ts +0 -2
  267. package/lib/generated-client/models/iso-type.js +0 -2
  268. package/lib/generated-client/models/item-counts.d.ts +0 -26
  269. package/lib/generated-client/models/item-fields.d.ts +0 -2
  270. package/lib/generated-client/models/item-fields.js +0 -2
  271. package/lib/generated-client/models/item-filter.d.ts +0 -2
  272. package/lib/generated-client/models/item-filter.js +0 -2
  273. package/lib/generated-client/models/item-sort-by.d.ts +0 -2
  274. package/lib/generated-client/models/item-sort-by.js +0 -2
  275. package/lib/generated-client/models/join-group-request-dto.d.ts +0 -4
  276. package/lib/generated-client/models/keep-until.d.ts +0 -5
  277. package/lib/generated-client/models/keep-until.js +0 -5
  278. package/lib/generated-client/models/library-changed-message.d.ts +0 -14
  279. package/lib/generated-client/models/library-option-info-dto.d.ts +0 -6
  280. package/lib/generated-client/models/library-options-result-dto.d.ts +0 -14
  281. package/lib/generated-client/models/library-options.d.ts +0 -207
  282. package/lib/generated-client/models/library-storage-dto.d.ts +3 -11
  283. package/lib/generated-client/models/library-type-options-dto.d.ts +4 -12
  284. package/lib/generated-client/models/library-update-info.d.ts +0 -22
  285. package/lib/generated-client/models/listings-provider-info.d.ts +0 -95
  286. package/lib/generated-client/models/live-stream-response.d.ts +0 -10
  287. package/lib/generated-client/models/live-tv-info.d.ts +0 -11
  288. package/lib/generated-client/models/live-tv-options.d.ts +0 -80
  289. package/lib/generated-client/models/live-tv-service-info.d.ts +0 -24
  290. package/lib/generated-client/models/live-tv-service-status.d.ts +1 -3
  291. package/lib/generated-client/models/live-tv-service-status.js +1 -3
  292. package/lib/generated-client/models/localization-option.d.ts +0 -15
  293. package/lib/generated-client/models/location-type.d.ts +0 -2
  294. package/lib/generated-client/models/location-type.js +0 -2
  295. package/lib/generated-client/models/log-file.d.ts +1 -14
  296. package/lib/generated-client/models/log-level.d.ts +0 -5
  297. package/lib/generated-client/models/log-level.js +0 -5
  298. package/lib/generated-client/models/lyric-dto.d.ts +0 -9
  299. package/lib/generated-client/models/lyric-line-cue.d.ts +0 -10
  300. package/lib/generated-client/models/lyric-line.d.ts +0 -8
  301. package/lib/generated-client/models/lyric-metadata.d.ts +0 -22
  302. package/lib/generated-client/models/media-attachment.d.ts +0 -16
  303. package/lib/generated-client/models/media-path-dto.d.ts +0 -11
  304. package/lib/generated-client/models/media-path-info.d.ts +0 -10
  305. package/lib/generated-client/models/media-protocol.d.ts +0 -5
  306. package/lib/generated-client/models/media-protocol.js +0 -5
  307. package/lib/generated-client/models/media-segment-dto-query-result.d.ts +0 -8
  308. package/lib/generated-client/models/media-segment-dto.d.ts +0 -15
  309. package/lib/generated-client/models/media-segment-type.d.ts +0 -2
  310. package/lib/generated-client/models/media-segment-type.js +0 -2
  311. package/lib/generated-client/models/media-source-info.d.ts +1 -228
  312. package/lib/generated-client/models/media-source-type.d.ts +1 -3
  313. package/lib/generated-client/models/media-source-type.js +1 -3
  314. package/lib/generated-client/models/media-stream-protocol.d.ts +1 -3
  315. package/lib/generated-client/models/media-stream-protocol.js +1 -3
  316. package/lib/generated-client/models/media-stream-type.d.ts +0 -2
  317. package/lib/generated-client/models/media-stream-type.js +0 -2
  318. package/lib/generated-client/models/media-stream.d.ts +7 -176
  319. package/lib/generated-client/models/media-type.d.ts +0 -2
  320. package/lib/generated-client/models/media-type.js +0 -2
  321. package/lib/generated-client/models/media-update-info-dto.d.ts +0 -4
  322. package/lib/generated-client/models/media-update-info-path-dto.d.ts +1 -7
  323. package/lib/generated-client/models/media-url.d.ts +0 -15
  324. package/lib/generated-client/models/message-command.d.ts +4 -12
  325. package/lib/generated-client/models/metadata-configuration.d.ts +0 -10
  326. package/lib/generated-client/models/metadata-editor-info.d.ts +0 -17
  327. package/lib/generated-client/models/metadata-field.d.ts +0 -2
  328. package/lib/generated-client/models/metadata-field.js +0 -2
  329. package/lib/generated-client/models/metadata-options.d.ts +0 -37
  330. package/lib/generated-client/models/metadata-refresh-mode.d.ts +0 -5
  331. package/lib/generated-client/models/metadata-refresh-mode.js +0 -5
  332. package/lib/generated-client/models/move-playlist-item-request-dto.d.ts +0 -6
  333. package/lib/generated-client/models/movie-info-remote-search-query.d.ts +0 -19
  334. package/lib/generated-client/models/movie-info.d.ts +1 -37
  335. package/lib/generated-client/models/music-video-info-remote-search-query.d.ts +0 -19
  336. package/lib/generated-client/models/music-video-info.d.ts +0 -44
  337. package/lib/generated-client/models/name-guid-pair.d.ts +0 -15
  338. package/lib/generated-client/models/name-id-pair.d.ts +0 -9
  339. package/lib/generated-client/models/name-value-pair.d.ts +0 -9
  340. package/lib/generated-client/models/network-configuration.d.ts +1 -49
  341. package/lib/generated-client/models/new-group-request-dto.d.ts +0 -4
  342. package/lib/generated-client/models/next-item-request-dto.d.ts +0 -4
  343. package/lib/generated-client/models/open-live-stream-dto.d.ts +0 -33
  344. package/lib/generated-client/models/outbound-keep-alive-message.d.ts +0 -9
  345. package/lib/generated-client/models/outbound-web-socket-message.d.ts +0 -1
  346. package/lib/generated-client/models/package-info.d.ts +1 -19
  347. package/lib/generated-client/models/parental-rating-score.d.ts +0 -6
  348. package/lib/generated-client/models/parental-rating.d.ts +0 -11
  349. package/lib/generated-client/models/path-substitution.d.ts +0 -6
  350. package/lib/generated-client/models/person-kind.d.ts +1 -2
  351. package/lib/generated-client/models/person-kind.js +2 -3
  352. package/lib/generated-client/models/person-lookup-info-remote-search-query.d.ts +0 -19
  353. package/lib/generated-client/models/person-lookup-info.d.ts +1 -37
  354. package/lib/generated-client/models/pin-redeem-result.d.ts +0 -9
  355. package/lib/generated-client/models/ping-request-dto.d.ts +0 -4
  356. package/lib/generated-client/models/play-access.d.ts +1 -3
  357. package/lib/generated-client/models/play-access.js +1 -3
  358. package/lib/generated-client/models/play-command.d.ts +0 -2
  359. package/lib/generated-client/models/play-command.js +0 -2
  360. package/lib/generated-client/models/play-message.d.ts +0 -14
  361. package/lib/generated-client/models/play-method.d.ts +1 -3
  362. package/lib/generated-client/models/play-method.js +1 -3
  363. package/lib/generated-client/models/play-queue-update-reason.d.ts +0 -2
  364. package/lib/generated-client/models/play-queue-update-reason.js +0 -2
  365. package/lib/generated-client/models/play-queue-update.d.ts +0 -27
  366. package/lib/generated-client/models/play-request-dto.d.ts +0 -8
  367. package/lib/generated-client/models/play-request.d.ts +0 -33
  368. package/lib/generated-client/models/playback-error-code.d.ts +1 -3
  369. package/lib/generated-client/models/playback-error-code.js +1 -3
  370. package/lib/generated-client/models/playback-info-dto.d.ts +0 -37
  371. package/lib/generated-client/models/playback-info-response.d.ts +0 -11
  372. package/lib/generated-client/models/playback-order.d.ts +0 -2
  373. package/lib/generated-client/models/playback-order.js +0 -2
  374. package/lib/generated-client/models/playback-progress-info.d.ts +0 -71
  375. package/lib/generated-client/models/playback-request-type.d.ts +0 -2
  376. package/lib/generated-client/models/playback-request-type.js +0 -2
  377. package/lib/generated-client/models/playback-start-info.d.ts +0 -71
  378. package/lib/generated-client/models/playback-stop-info.d.ts +0 -36
  379. package/lib/generated-client/models/player-state-info.d.ts +0 -38
  380. package/lib/generated-client/models/playlist-creation-result.d.ts +0 -10
  381. package/lib/generated-client/models/playlist-dto.d.ts +2 -10
  382. package/lib/generated-client/models/playlist-user-permissions.d.ts +0 -6
  383. package/lib/generated-client/models/playstate-command.d.ts +0 -2
  384. package/lib/generated-client/models/playstate-command.js +0 -2
  385. package/lib/generated-client/models/playstate-message.d.ts +0 -14
  386. package/lib/generated-client/models/playstate-request.d.ts +2 -13
  387. package/lib/generated-client/models/plugin-info.d.ts +0 -21
  388. package/lib/generated-client/models/plugin-installation-cancelled-message.d.ts +0 -14
  389. package/lib/generated-client/models/plugin-installation-completed-message.d.ts +0 -14
  390. package/lib/generated-client/models/plugin-installation-failed-message.d.ts +0 -14
  391. package/lib/generated-client/models/plugin-installing-message.d.ts +0 -14
  392. package/lib/generated-client/models/plugin-status.d.ts +0 -2
  393. package/lib/generated-client/models/plugin-status.js +0 -2
  394. package/lib/generated-client/models/plugin-uninstalled-message.d.ts +0 -14
  395. package/lib/generated-client/models/previous-item-request-dto.d.ts +0 -4
  396. package/lib/generated-client/models/problem-details.d.ts +0 -30
  397. package/lib/generated-client/models/process-priority-class.d.ts +0 -5
  398. package/lib/generated-client/models/process-priority-class.js +0 -5
  399. package/lib/generated-client/models/profile-condition-type.d.ts +0 -5
  400. package/lib/generated-client/models/profile-condition-type.js +0 -5
  401. package/lib/generated-client/models/profile-condition-value.d.ts +1 -5
  402. package/lib/generated-client/models/profile-condition-value.js +2 -6
  403. package/lib/generated-client/models/profile-condition.d.ts +0 -25
  404. package/lib/generated-client/models/program-audio.d.ts +0 -5
  405. package/lib/generated-client/models/program-audio.js +0 -5
  406. package/lib/generated-client/models/public-system-info.d.ts +0 -19
  407. package/lib/generated-client/models/query-filters-legacy.d.ts +0 -25
  408. package/lib/generated-client/models/query-filters.d.ts +3 -15
  409. package/lib/generated-client/models/queue-item.d.ts +3 -9
  410. package/lib/generated-client/models/queue-request-dto.d.ts +0 -9
  411. package/lib/generated-client/models/quick-connect-dto.d.ts +0 -4
  412. package/lib/generated-client/models/quick-connect-result.d.ts +0 -18
  413. package/lib/generated-client/models/rating-type.d.ts +1 -3
  414. package/lib/generated-client/models/rating-type.js +1 -3
  415. package/lib/generated-client/models/ready-request-dto.d.ts +0 -10
  416. package/lib/generated-client/models/recommendation-dto.d.ts +0 -25
  417. package/lib/generated-client/models/recommendation-type.d.ts +0 -5
  418. package/lib/generated-client/models/recommendation-type.js +0 -5
  419. package/lib/generated-client/models/recording-status.d.ts +0 -5
  420. package/lib/generated-client/models/recording-status.js +0 -5
  421. package/lib/generated-client/models/refresh-progress-message.d.ts +0 -11
  422. package/lib/generated-client/models/remote-image-info.d.ts +0 -28
  423. package/lib/generated-client/models/remote-image-result.d.ts +0 -8
  424. package/lib/generated-client/models/remote-lyric-info-dto.d.ts +3 -14
  425. package/lib/generated-client/models/remote-search-result.d.ts +3 -59
  426. package/lib/generated-client/models/remote-subtitle-info.d.ts +0 -85
  427. package/lib/generated-client/models/remove-from-playlist-request-dto.d.ts +0 -8
  428. package/lib/generated-client/models/repeat-mode.d.ts +1 -3
  429. package/lib/generated-client/models/repeat-mode.js +1 -3
  430. package/lib/generated-client/models/repository-info.d.ts +0 -8
  431. package/lib/generated-client/models/restart-required-message.d.ts +0 -9
  432. package/lib/generated-client/models/scheduled-task-ended-message.d.ts +0 -14
  433. package/lib/generated-client/models/scheduled-tasks-info-message.d.ts +0 -11
  434. package/lib/generated-client/models/scheduled-tasks-info-start-message.d.ts +1 -10
  435. package/lib/generated-client/models/scheduled-tasks-info-stop-message.d.ts +0 -7
  436. package/lib/generated-client/models/scroll-direction.d.ts +0 -2
  437. package/lib/generated-client/models/scroll-direction.js +0 -2
  438. package/lib/generated-client/models/search-hint-result.d.ts +0 -6
  439. package/lib/generated-client/models/search-hint.d.ts +0 -66
  440. package/lib/generated-client/models/seek-request-dto.d.ts +0 -4
  441. package/lib/generated-client/models/send-command-type.d.ts +0 -2
  442. package/lib/generated-client/models/send-command-type.js +0 -2
  443. package/lib/generated-client/models/send-command.d.ts +0 -17
  444. package/lib/generated-client/models/series-info-remote-search-query.d.ts +0 -19
  445. package/lib/generated-client/models/series-info.d.ts +1 -37
  446. package/lib/generated-client/models/series-status.d.ts +0 -2
  447. package/lib/generated-client/models/series-status.js +0 -2
  448. package/lib/generated-client/models/series-timer-cancelled-message.d.ts +0 -14
  449. package/lib/generated-client/models/series-timer-created-message.d.ts +0 -14
  450. package/lib/generated-client/models/series-timer-info-dto-query-result.d.ts +0 -8
  451. package/lib/generated-client/models/series-timer-info-dto.d.ts +1 -91
  452. package/lib/generated-client/models/server-configuration.d.ts +3 -180
  453. package/lib/generated-client/models/server-discovery-info.d.ts +0 -10
  454. package/lib/generated-client/models/server-restarting-message.d.ts +0 -9
  455. package/lib/generated-client/models/server-shutting-down-message.d.ts +0 -9
  456. package/lib/generated-client/models/session-info-dto.d.ts +1 -80
  457. package/lib/generated-client/models/session-message-type.d.ts +0 -2
  458. package/lib/generated-client/models/session-message-type.js +0 -2
  459. package/lib/generated-client/models/session-user-info.d.ts +0 -6
  460. package/lib/generated-client/models/sessions-message.d.ts +0 -11
  461. package/lib/generated-client/models/sessions-start-message.d.ts +1 -10
  462. package/lib/generated-client/models/sessions-stop-message.d.ts +0 -7
  463. package/lib/generated-client/models/set-channel-mapping-dto.d.ts +0 -8
  464. package/lib/generated-client/models/set-playlist-item-request-dto.d.ts +0 -4
  465. package/lib/generated-client/models/set-repeat-mode-request-dto.d.ts +0 -7
  466. package/lib/generated-client/models/set-shuffle-mode-request-dto.d.ts +0 -7
  467. package/lib/generated-client/models/song-info.d.ts +0 -54
  468. package/lib/generated-client/models/sort-order.d.ts +0 -2
  469. package/lib/generated-client/models/sort-order.js +0 -2
  470. package/lib/generated-client/models/special-view-option-dto.d.ts +0 -6
  471. package/lib/generated-client/models/startup-configuration-dto.d.ts +0 -10
  472. package/lib/generated-client/models/startup-remote-access-dto.d.ts +0 -11
  473. package/lib/generated-client/models/startup-user-dto.d.ts +0 -6
  474. package/lib/generated-client/models/subtitle-delivery-method.d.ts +0 -2
  475. package/lib/generated-client/models/subtitle-delivery-method.js +0 -2
  476. package/lib/generated-client/models/subtitle-playback-mode.d.ts +0 -2
  477. package/lib/generated-client/models/subtitle-playback-mode.js +0 -2
  478. package/lib/generated-client/models/subtitle-profile.d.ts +0 -15
  479. package/lib/generated-client/models/sync-play-command-message.d.ts +0 -14
  480. package/lib/generated-client/models/sync-play-group-does-not-exist-update.d.ts +0 -14
  481. package/lib/generated-client/models/sync-play-group-joined-update.d.ts +0 -17
  482. package/lib/generated-client/models/sync-play-group-left-update.d.ts +0 -14
  483. package/lib/generated-client/models/sync-play-group-update-message.d.ts +0 -14
  484. package/lib/generated-client/models/sync-play-library-access-denied-update.d.ts +0 -14
  485. package/lib/generated-client/models/sync-play-not-in-group-update.d.ts +0 -14
  486. package/lib/generated-client/models/sync-play-play-queue-update.d.ts +0 -17
  487. package/lib/generated-client/models/sync-play-queue-item.d.ts +0 -6
  488. package/lib/generated-client/models/sync-play-state-update.d.ts +0 -17
  489. package/lib/generated-client/models/sync-play-user-access-type.d.ts +0 -2
  490. package/lib/generated-client/models/sync-play-user-access-type.js +0 -2
  491. package/lib/generated-client/models/sync-play-user-joined-update.d.ts +0 -14
  492. package/lib/generated-client/models/sync-play-user-left-update.d.ts +0 -14
  493. package/lib/generated-client/models/system-info.d.ts +0 -62
  494. package/lib/generated-client/models/system-storage-dto.d.ts +8 -47
  495. package/lib/generated-client/models/task-completion-status.d.ts +0 -2
  496. package/lib/generated-client/models/task-completion-status.js +0 -2
  497. package/lib/generated-client/models/task-info.d.ts +0 -28
  498. package/lib/generated-client/models/task-result.d.ts +0 -21
  499. package/lib/generated-client/models/task-state.d.ts +0 -2
  500. package/lib/generated-client/models/task-state.js +0 -2
  501. package/lib/generated-client/models/task-trigger-info-type.d.ts +0 -2
  502. package/lib/generated-client/models/task-trigger-info-type.js +0 -2
  503. package/lib/generated-client/models/task-trigger-info.d.ts +0 -18
  504. package/lib/generated-client/models/theme-media-result.d.ts +0 -10
  505. package/lib/generated-client/models/timer-cancelled-message.d.ts +0 -14
  506. package/lib/generated-client/models/timer-created-message.d.ts +0 -14
  507. package/lib/generated-client/models/timer-event-info.d.ts +0 -15
  508. package/lib/generated-client/models/timer-info-dto-query-result.d.ts +0 -8
  509. package/lib/generated-client/models/timer-info-dto.d.ts +0 -76
  510. package/lib/generated-client/models/tonemapping-algorithm.d.ts +0 -2
  511. package/lib/generated-client/models/tonemapping-algorithm.js +0 -2
  512. package/lib/generated-client/models/tonemapping-mode.d.ts +0 -2
  513. package/lib/generated-client/models/tonemapping-mode.js +0 -2
  514. package/lib/generated-client/models/tonemapping-range.d.ts +0 -2
  515. package/lib/generated-client/models/tonemapping-range.js +0 -2
  516. package/lib/generated-client/models/trailer-info-remote-search-query.d.ts +0 -19
  517. package/lib/generated-client/models/trailer-info.d.ts +1 -37
  518. package/lib/generated-client/models/transcode-reason.d.ts +1 -5
  519. package/lib/generated-client/models/transcode-reason.js +2 -6
  520. package/lib/generated-client/models/transcode-seek-info.d.ts +1 -3
  521. package/lib/generated-client/models/transcode-seek-info.js +1 -3
  522. package/lib/generated-client/models/transcoding-info.d.ts +2 -34
  523. package/lib/generated-client/models/transcoding-profile.d.ts +3 -50
  524. package/lib/generated-client/models/transport-stream-timestamp.d.ts +1 -3
  525. package/lib/generated-client/models/transport-stream-timestamp.js +1 -3
  526. package/lib/generated-client/models/trickplay-info-dto.d.ts +0 -16
  527. package/lib/generated-client/models/trickplay-options.d.ts +1 -33
  528. package/lib/generated-client/models/trickplay-scan-behavior.d.ts +0 -2
  529. package/lib/generated-client/models/trickplay-scan-behavior.js +0 -2
  530. package/lib/generated-client/models/tuner-channel-mapping.d.ts +0 -25
  531. package/lib/generated-client/models/tuner-host-info.d.ts +0 -85
  532. package/lib/generated-client/models/type-options.d.ts +2 -35
  533. package/lib/generated-client/models/unrated-item.d.ts +0 -2
  534. package/lib/generated-client/models/unrated-item.js +0 -2
  535. package/lib/generated-client/models/update-library-options-dto.d.ts +0 -9
  536. package/lib/generated-client/models/update-media-path-request-dto.d.ts +0 -9
  537. package/lib/generated-client/models/update-playlist-dto.d.ts +0 -10
  538. package/lib/generated-client/models/update-playlist-user-dto.d.ts +0 -4
  539. package/lib/generated-client/models/update-user-item-data-dto.d.ts +0 -24
  540. package/lib/generated-client/models/update-user-password.d.ts +0 -10
  541. package/lib/generated-client/models/upload-subtitle-dto.d.ts +0 -12
  542. package/lib/generated-client/models/user-configuration.d.ts +0 -70
  543. package/lib/generated-client/models/user-data-change-info.d.ts +1 -7
  544. package/lib/generated-client/models/user-data-changed-message.d.ts +0 -14
  545. package/lib/generated-client/models/user-deleted-message.d.ts +0 -11
  546. package/lib/generated-client/models/user-dto.d.ts +6 -40
  547. package/lib/generated-client/models/user-item-data-dto.d.ts +1 -25
  548. package/lib/generated-client/models/user-policy.d.ts +0 -201
  549. package/lib/generated-client/models/user-updated-message.d.ts +0 -14
  550. package/lib/generated-client/models/utc-time-response.d.ts +0 -6
  551. package/lib/generated-client/models/validate-path-dto.d.ts +0 -8
  552. package/lib/generated-client/models/version-info.d.ts +0 -20
  553. package/lib/generated-client/models/video-range-type.d.ts +0 -2
  554. package/lib/generated-client/models/video-range-type.js +0 -2
  555. package/lib/generated-client/models/video-range.d.ts +0 -2
  556. package/lib/generated-client/models/video-range.js +0 -2
  557. package/lib/generated-client/models/video-type.d.ts +0 -2
  558. package/lib/generated-client/models/video-type.js +0 -2
  559. package/lib/generated-client/models/video3-dformat.d.ts +0 -5
  560. package/lib/generated-client/models/video3-dformat.js +0 -5
  561. package/lib/generated-client/models/virtual-folder-info.d.ts +0 -30
  562. package/lib/generated-client/models/web-socket-message.d.ts +0 -1
  563. package/lib/generated-client/models/xbmc-metadata-options.d.ts +0 -30
  564. package/lib/index.js +1 -1
  565. package/lib/models/api/image-request-parameters.d.ts +1 -1
  566. package/lib/models/device-info.d.ts +1 -0
  567. package/lib/utils/api/{videos-api.d.ts → artist-api.d.ts} +2 -2
  568. package/lib/utils/api/{movies-api.js → artist-api.js} +4 -4
  569. package/lib/utils/api/authentication-api.d.ts +8 -0
  570. package/lib/utils/api/authentication-api.js +35 -0
  571. package/lib/utils/api/{tmdb-api.d.ts → backup-api.d.ts} +2 -2
  572. package/lib/utils/api/backup-api.js +13 -0
  573. package/lib/utils/api/{artists-api.d.ts → channel-api.d.ts} +2 -2
  574. package/lib/utils/api/{artists-api.js → channel-api.js} +4 -4
  575. package/lib/utils/api/{movies-api.d.ts → device-api.d.ts} +2 -2
  576. package/lib/utils/api/{lyrics-api.js → device-api.js} +4 -4
  577. package/lib/utils/api/display-preference-api.d.ts +8 -0
  578. package/lib/utils/api/display-preference-api.js +12 -0
  579. package/lib/utils/api/{items-api.d.ts → genre-api.d.ts} +2 -2
  580. package/lib/utils/api/{items-api.js → genre-api.js} +4 -4
  581. package/lib/utils/api/index.d.ts +24 -38
  582. package/lib/utils/api/index.js +24 -38
  583. package/lib/utils/api/library-api.d.ts +14 -2
  584. package/lib/utils/api/library-api.js +17 -1
  585. package/lib/utils/api/{years-api.d.ts → lyric-api.d.ts} +2 -2
  586. package/lib/utils/api/{years-api.js → lyric-api.js} +4 -4
  587. package/lib/utils/api/{activity-log-api.d.ts → media-segment-api.d.ts} +2 -2
  588. package/lib/utils/api/{quick-connect-api.js → media-segment-api.js} +4 -4
  589. package/lib/utils/api/movie-api.d.ts +8 -0
  590. package/lib/utils/api/movie-api.js +12 -0
  591. package/lib/utils/api/{dynamic-hls-api.d.ts → music-genre-api.d.ts} +2 -2
  592. package/lib/utils/api/{dynamic-hls-api.js → music-genre-api.js} +4 -4
  593. package/lib/utils/api/{genres-api.d.ts → person-api.d.ts} +2 -2
  594. package/lib/utils/api/{genres-api.js → person-api.js} +4 -4
  595. package/lib/utils/api/{trailers-api.d.ts → playlist-api.d.ts} +2 -2
  596. package/lib/utils/api/{channels-api.js → playlist-api.js} +4 -4
  597. package/lib/utils/api/{lyrics-api.d.ts → plugin-api.d.ts} +2 -2
  598. package/lib/utils/api/{videos-api.js → plugin-api.js} +4 -4
  599. package/lib/utils/api/scheduled-task-api.d.ts +8 -0
  600. package/lib/utils/api/{configuration-api.js → scheduled-task-api.js} +4 -4
  601. package/lib/utils/api/session-api.js +18 -1
  602. package/lib/utils/api/show-api.d.ts +8 -0
  603. package/lib/utils/api/{tmdb-api.js → show-api.js} +4 -4
  604. package/lib/utils/api/studio-api.d.ts +8 -0
  605. package/lib/utils/api/studio-api.js +12 -0
  606. package/lib/utils/api/{hls-segment-api.d.ts → suggestion-api.d.ts} +2 -2
  607. package/lib/utils/api/{hls-segment-api.js → suggestion-api.js} +4 -4
  608. package/lib/utils/api/{package-api.d.ts → trailer-api.d.ts} +2 -2
  609. package/lib/utils/api/{devices-api.js → trailer-api.js} +4 -4
  610. package/lib/utils/api/{dashboard-api.d.ts → trick-play-api.d.ts} +2 -2
  611. package/lib/utils/api/{dashboard-api.js → trick-play-api.js} +4 -4
  612. package/lib/utils/api/{api-key-api.d.ts → user-data-api.d.ts} +2 -2
  613. package/lib/utils/api/{time-sync-api.js → user-data-api.js} +4 -4
  614. package/lib/utils/api/{channels-api.d.ts → user-view-api.d.ts} +2 -2
  615. package/lib/utils/api/{trailers-api.js → user-view-api.js} +4 -4
  616. package/lib/utils/api/video-api.d.ts +8 -0
  617. package/lib/utils/api/video-api.js +12 -0
  618. package/lib/utils/api/year-api.d.ts +8 -0
  619. package/lib/utils/api/year-api.js +12 -0
  620. package/lib/utils/index.js +2 -2
  621. package/lib/utils/url/index.d.ts +1 -0
  622. package/lib/utils/url/index.js +4 -1
  623. package/lib/utils/versioning.d.ts +12 -1
  624. package/lib/utils/versioning.js +44 -13
  625. package/lib/versions.d.ts +1 -1
  626. package/lib/versions.js +1 -1
  627. package/lib/websocket/constants.d.ts +24 -0
  628. package/lib/websocket/constants.js +42 -0
  629. package/lib/websocket/index.d.ts +8 -0
  630. package/lib/websocket/index.js +3 -0
  631. package/lib/{utils/api/client-log-api.d.ts → websocket/models.d.ts} +6 -3
  632. package/lib/websocket/models.js +16 -0
  633. package/lib/websocket/types.d.ts +37 -0
  634. package/lib/websocket/types.js +42 -0
  635. package/lib/websocket/websocket-service.d.ts +142 -0
  636. package/lib/websocket/websocket-service.js +296 -0
  637. package/package.json +20 -16
  638. package/lib/generated-client/api/activity-log-api.d.ts +0 -110
  639. package/lib/generated-client/api/activity-log-api.js +0 -135
  640. package/lib/generated-client/api/api-key-api.d.ts +0 -161
  641. package/lib/generated-client/api/api-key-api.js +0 -245
  642. package/lib/generated-client/api/client-log-api.d.ts +0 -86
  643. package/lib/generated-client/api/client-log-api.js +0 -117
  644. package/lib/generated-client/api/configuration-api.d.ts +0 -292
  645. package/lib/generated-client/api/configuration-api.js +0 -442
  646. package/lib/generated-client/api/dashboard-api.d.ts +0 -132
  647. package/lib/generated-client/api/dashboard-api.js +0 -182
  648. package/lib/generated-client/api/dlna-api.d.ts +0 -292
  649. package/lib/generated-client/api/dlna-server-api.d.ts +0 -784
  650. package/lib/generated-client/api/dynamic-hls-api.d.ts +0 -4261
  651. package/lib/generated-client/api/dynamic-hls-api.js +0 -3025
  652. package/lib/generated-client/api/hls-segment-api.d.ts +0 -325
  653. package/lib/generated-client/api/hls-segment-api.js +0 -415
  654. package/lib/generated-client/api/image-by-name-api.d.ts +0 -292
  655. package/lib/generated-client/api/item-refresh-api.d.ts +0 -126
  656. package/lib/generated-client/api/item-refresh-api.js +0 -143
  657. package/lib/generated-client/api/items-api.d.ts +0 -1052
  658. package/lib/generated-client/api/items-api.js +0 -835
  659. package/lib/generated-client/api/music-genres-api.d.ts +0 -286
  660. package/lib/generated-client/api/music-genres-api.js +0 -278
  661. package/lib/generated-client/api/notifications-api.d.ts +0 -332
  662. package/lib/generated-client/api/package-api.d.ts +0 -315
  663. package/lib/generated-client/api/package-api.js +0 -455
  664. package/lib/generated-client/api/playstate-api.d.ts +0 -679
  665. package/lib/generated-client/api/playstate-api.js +0 -789
  666. package/lib/generated-client/api/plugins-api.d.ts +0 -473
  667. package/lib/generated-client/api/plugins-api.js +0 -663
  668. package/lib/generated-client/api/quick-connect-api.d.ts +0 -198
  669. package/lib/generated-client/api/quick-connect-api.js +0 -305
  670. package/lib/generated-client/api/time-sync-api.d.ts +0 -69
  671. package/lib/generated-client/api/time-sync-api.js +0 -109
  672. package/lib/generated-client/api/tmdb-api.d.ts +0 -69
  673. package/lib/generated-client/api/tmdb-api.js +0 -111
  674. package/lib/generated-client/api/universal-audio-api.d.ts +0 -420
  675. package/lib/generated-client/api/universal-audio-api.js +0 -364
  676. package/lib/generated-client/api/user-library-api.d.ts +0 -657
  677. package/lib/generated-client/api/video-attachments-api.d.ts +0 -101
  678. package/lib/generated-client/api/video-attachments-api.js +0 -126
  679. package/lib/generated-client/models/admin-notification-dto.d.ts +0 -42
  680. package/lib/generated-client/models/base-item.d.ts +0 -84
  681. package/lib/generated-client/models/branding-options.d.ts +0 -35
  682. package/lib/generated-client/models/client-capabilities.d.ts +0 -76
  683. package/lib/generated-client/models/config-image-types.d.ts +0 -59
  684. package/lib/generated-client/models/control-response.d.ts +0 -37
  685. package/lib/generated-client/models/device-identification.d.ts +0 -72
  686. package/lib/generated-client/models/device-info-query-result.d.ts +0 -36
  687. package/lib/generated-client/models/device-info.d.ts +0 -84
  688. package/lib/generated-client/models/device-options.d.ts +0 -35
  689. package/lib/generated-client/models/device-profile-info.d.ts +0 -36
  690. package/lib/generated-client/models/device-profile-type.d.ts +0 -20
  691. package/lib/generated-client/models/dlna-options.d.ts +0 -83
  692. package/lib/generated-client/models/ffmpeg-location.d.ts +0 -22
  693. package/lib/generated-client/models/group-info-dto-group-update.d.ts +0 -37
  694. package/lib/generated-client/models/group-state-update-group-update.d.ts +0 -37
  695. package/lib/generated-client/models/hardware-encoding-type.d.ts +0 -25
  696. package/lib/generated-client/models/header-match-type.d.ts +0 -21
  697. package/lib/generated-client/models/http-header-info.d.ts +0 -36
  698. package/lib/generated-client/models/image-by-name-info.d.ts +0 -47
  699. package/lib/generated-client/models/media-encoder-path-dto.d.ts +0 -29
  700. package/lib/generated-client/models/notification-dto.d.ts +0 -66
  701. package/lib/generated-client/models/notification-option.d.ts +0 -54
  702. package/lib/generated-client/models/notification-options.d.ts +0 -24
  703. package/lib/generated-client/models/notification-result-dto.d.ts +0 -30
  704. package/lib/generated-client/models/notification-type-info.d.ts +0 -47
  705. package/lib/generated-client/models/notifications-summary-dto.d.ts +0 -30
  706. package/lib/generated-client/models/object-group-update.d.ts +0 -36
  707. package/lib/generated-client/models/play-queue-update-group-update.d.ts +0 -37
  708. package/lib/generated-client/models/response-profile.d.ts +0 -61
  709. package/lib/generated-client/models/send-to-user-type.d.ts +0 -21
  710. package/lib/generated-client/models/session-info.d.ts +0 -199
  711. package/lib/generated-client/models/string-group-update.d.ts +0 -36
  712. package/lib/generated-client/models/subtitle-options.d.ts +0 -71
  713. package/lib/generated-client/models/sync-play-group-update-command-message.d.ts +0 -37
  714. package/lib/generated-client/models/trickplay-info.d.ts +0 -65
  715. package/lib/generated-client/models/update-user-easy-password.d.ts +0 -35
  716. package/lib/generated-client/models/wake-on-lan-info.d.ts +0 -29
  717. package/lib/generated-client/models/xml-attribute.d.ts +0 -29
  718. package/lib/utils/api/activity-log-api.js +0 -12
  719. package/lib/utils/api/api-key-api.js +0 -12
  720. package/lib/utils/api/client-log-api.js +0 -12
  721. package/lib/utils/api/configuration-api.d.ts +0 -8
  722. package/lib/utils/api/devices-api.d.ts +0 -8
  723. package/lib/utils/api/display-preferences-api.d.ts +0 -8
  724. package/lib/utils/api/display-preferences-api.js +0 -12
  725. package/lib/utils/api/item-refresh-api.d.ts +0 -8
  726. package/lib/utils/api/item-refresh-api.js +0 -12
  727. package/lib/utils/api/media-segments-api.d.ts +0 -8
  728. package/lib/utils/api/media-segments-api.js +0 -12
  729. package/lib/utils/api/music-genres-api.d.ts +0 -8
  730. package/lib/utils/api/music-genres-api.js +0 -12
  731. package/lib/utils/api/package-api.js +0 -12
  732. package/lib/utils/api/persons-api.d.ts +0 -8
  733. package/lib/utils/api/persons-api.js +0 -12
  734. package/lib/utils/api/playlists-api.d.ts +0 -8
  735. package/lib/utils/api/playlists-api.js +0 -12
  736. package/lib/utils/api/playstate-api.d.ts +0 -8
  737. package/lib/utils/api/playstate-api.js +0 -12
  738. package/lib/utils/api/plugins-api.d.ts +0 -8
  739. package/lib/utils/api/plugins-api.js +0 -12
  740. package/lib/utils/api/quick-connect-api.d.ts +0 -8
  741. package/lib/utils/api/scheduled-tasks-api.d.ts +0 -8
  742. package/lib/utils/api/scheduled-tasks-api.js +0 -12
  743. package/lib/utils/api/studios-api.d.ts +0 -8
  744. package/lib/utils/api/studios-api.js +0 -12
  745. package/lib/utils/api/suggestions-api.d.ts +0 -8
  746. package/lib/utils/api/suggestions-api.js +0 -12
  747. package/lib/utils/api/time-sync-api.d.ts +0 -8
  748. package/lib/utils/api/trickplay-api.d.ts +0 -8
  749. package/lib/utils/api/trickplay-api.js +0 -12
  750. package/lib/utils/api/tv-shows-api.d.ts +0 -8
  751. package/lib/utils/api/tv-shows-api.js +0 -12
  752. package/lib/utils/api/universal-audio-api.d.ts +0 -8
  753. package/lib/utils/api/universal-audio-api.js +0 -12
  754. package/lib/utils/api/user-library-api.d.ts +0 -8
  755. package/lib/utils/api/user-library-api.js +0 -12
  756. package/lib/utils/api/user-views-api.d.ts +0 -8
  757. package/lib/utils/api/user-views-api.js +0 -12
  758. package/lib/utils/api/video-attachments-api.d.ts +0 -8
  759. package/lib/utils/api/video-attachments-api.js +0 -12
@@ -1,4261 +0,0 @@
1
- /**
2
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3
- * Do not edit the class manually.
4
- *
5
- * Jellyfin API
6
- *
7
- * This Source Code Form is subject to the terms of the Mozilla Public
8
- * License, v. 2.0. If a copy of the MPL was not distributed with this
9
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
10
- */
11
- import type { Configuration } from '../configuration';
12
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
13
- import { type RequestArgs, BaseAPI } from '../base';
14
- import type { EncodingContext } from '../models';
15
- import type { SubtitleDeliveryMethod } from '../models';
16
- /**
17
- * DynamicHlsApi - axios parameter creator
18
- * @export
19
- */
20
- export declare const DynamicHlsApiAxiosParamCreator: (configuration?: Configuration) => {
21
- /**
22
- *
23
- * @summary Gets a video stream using HTTP live streaming.
24
- * @param {string} itemId The item id.
25
- * @param {string} playlistId The playlist id.
26
- * @param {number} segmentId The segment id.
27
- * @param {string} container The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
28
- * @param {number} runtimeTicks The position of the requested segment in ticks.
29
- * @param {number} actualSegmentLengthTicks The length of the requested segment in ticks.
30
- * @param {boolean} [_static] 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.
31
- * @param {string} [params] The streaming parameters.
32
- * @param {string} [tag] The tag.
33
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
34
- * @param {string} [playSessionId] The play session id.
35
- * @param {string} [segmentContainer] The segment container.
36
- * @param {number} [segmentLength] The segment length.
37
- * @param {number} [minSegments] The minimum number of segments.
38
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
39
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
40
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
41
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
42
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
43
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
44
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
45
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
46
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
47
- * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
48
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
49
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
50
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
51
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
52
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
53
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
54
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
55
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
56
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
57
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
58
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
59
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
60
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
61
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
62
- * @param {number} [maxRefFrames] Optional.
63
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
64
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
65
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
66
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
67
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
68
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
69
- * @param {string} [liveStreamId] The live stream id.
70
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
71
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
72
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
73
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
74
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
75
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
76
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
77
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
78
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
79
- * @param {*} [options] Override http request option.
80
- * @throws {RequiredError}
81
- */
82
- getHlsAudioSegment: (itemId: string, playlistId: string, segmentId: number, container: string, runtimeTicks: number, actualSegmentLengthTicks: number, _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, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
83
- [key: string]: string;
84
- }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
85
- /**
86
- *
87
- * @summary Gets a video stream using HTTP live streaming.
88
- * @param {string} itemId The item id.
89
- * @param {string} playlistId The playlist id.
90
- * @param {number} segmentId The segment id.
91
- * @param {string} container The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
92
- * @param {number} runtimeTicks The position of the requested segment in ticks.
93
- * @param {number} actualSegmentLengthTicks The length of the requested segment in ticks.
94
- * @param {boolean} [_static] 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.
95
- * @param {string} [params] The streaming parameters.
96
- * @param {string} [tag] The tag.
97
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
98
- * @param {string} [playSessionId] The play session id.
99
- * @param {string} [segmentContainer] The segment container.
100
- * @param {number} [segmentLength] The desired segment length.
101
- * @param {number} [minSegments] The minimum number of segments.
102
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
103
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
104
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
105
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
106
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
107
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
108
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
109
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
110
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
111
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
112
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
113
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
114
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
115
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
116
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
117
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
118
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
119
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
120
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
121
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
122
- * @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
123
- * @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
124
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
125
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
126
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
127
- * @param {number} [maxRefFrames] Optional.
128
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
129
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
130
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
131
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
132
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
133
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
134
- * @param {string} [liveStreamId] The live stream id.
135
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
136
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
137
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
138
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
139
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
140
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
141
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
142
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
143
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
144
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
145
- * @param {*} [options] Override http request option.
146
- * @throws {RequiredError}
147
- */
148
- getHlsVideoSegment: (itemId: string, playlistId: string, segmentId: number, container: string, runtimeTicks: number, actualSegmentLengthTicks: number, _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?: {
149
- [key: string]: string;
150
- }, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
151
- /**
152
- *
153
- * @summary Gets a hls live stream.
154
- * @param {string} itemId The item id.
155
- * @param {string} [container] The audio container.
156
- * @param {boolean} [_static] 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.
157
- * @param {string} [params] The streaming parameters.
158
- * @param {string} [tag] The tag.
159
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
160
- * @param {string} [playSessionId] The play session id.
161
- * @param {string} [segmentContainer] The segment container.
162
- * @param {number} [segmentLength] The segment length.
163
- * @param {number} [minSegments] The minimum number of segments.
164
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
165
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
166
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
167
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
168
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
169
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
170
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
171
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
172
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
173
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
174
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
175
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
176
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
177
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
178
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
179
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
180
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
181
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
182
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
183
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
184
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
185
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
186
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
187
- * @param {number} [maxRefFrames] Optional.
188
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
189
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
190
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
191
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
192
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
193
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
194
- * @param {string} [liveStreamId] The live stream id.
195
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
196
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
197
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
198
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
199
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
200
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
201
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
202
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
203
- * @param {number} [maxWidth] Optional. The max width.
204
- * @param {number} [maxHeight] Optional. The max height.
205
- * @param {boolean} [enableSubtitlesInManifest] Optional. Whether to enable subtitles in the manifest.
206
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
207
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
208
- * @param {*} [options] Override http request option.
209
- * @throws {RequiredError}
210
- */
211
- getLiveHlsStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
212
- [key: string]: string;
213
- }, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
214
- /**
215
- *
216
- * @summary Gets an audio hls playlist stream.
217
- * @param {string} itemId The item id.
218
- * @param {string} mediaSourceId The media version id, if playing an alternate version.
219
- * @param {boolean} [_static] 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.
220
- * @param {string} [params] The streaming parameters.
221
- * @param {string} [tag] The tag.
222
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
223
- * @param {string} [playSessionId] The play session id.
224
- * @param {string} [segmentContainer] The segment container.
225
- * @param {number} [segmentLength] The segment length.
226
- * @param {number} [minSegments] The minimum number of segments.
227
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
228
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
229
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
230
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
231
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
232
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
233
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
234
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
235
- * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
236
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
237
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
238
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
239
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
240
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
241
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
242
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
243
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
244
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
245
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
246
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
247
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
248
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
249
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
250
- * @param {number} [maxRefFrames] Optional.
251
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
252
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
253
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
254
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
255
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
256
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
257
- * @param {string} [liveStreamId] The live stream id.
258
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
259
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
260
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
261
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
262
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
263
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
264
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
265
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
266
- * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming.
267
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
268
- * @param {*} [options] Override http request option.
269
- * @throws {RequiredError}
270
- */
271
- getMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
272
- [key: string]: string;
273
- }, enableAdaptiveBitrateStreaming?: boolean, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
274
- /**
275
- *
276
- * @summary Gets a video hls playlist stream.
277
- * @param {string} itemId The item id.
278
- * @param {string} mediaSourceId The media version id, if playing an alternate version.
279
- * @param {boolean} [_static] 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.
280
- * @param {string} [params] The streaming parameters.
281
- * @param {string} [tag] The tag.
282
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
283
- * @param {string} [playSessionId] The play session id.
284
- * @param {string} [segmentContainer] The segment container.
285
- * @param {number} [segmentLength] The segment length.
286
- * @param {number} [minSegments] The minimum number of segments.
287
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
288
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
289
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
290
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
291
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
292
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
293
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
294
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
295
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
296
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
297
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
298
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
299
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
300
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
301
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
302
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
303
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
304
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
305
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
306
- * @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
307
- * @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
308
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
309
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
310
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
311
- * @param {number} [maxRefFrames] Optional.
312
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
313
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
314
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
315
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
316
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
317
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
318
- * @param {string} [liveStreamId] The live stream id.
319
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
320
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
321
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
322
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
323
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
324
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
325
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
326
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
327
- * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming.
328
- * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist.
329
- * @param {boolean} [enableAudioVbrEncoding] Whether to enable Audio Encoding.
330
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
331
- * @param {*} [options] Override http request option.
332
- * @throws {RequiredError}
333
- */
334
- getMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, 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?: {
335
- [key: string]: string;
336
- }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
337
- /**
338
- *
339
- * @summary Gets an audio stream using HTTP live streaming.
340
- * @param {string} itemId The item id.
341
- * @param {boolean} [_static] 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.
342
- * @param {string} [params] The streaming parameters.
343
- * @param {string} [tag] The tag.
344
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
345
- * @param {string} [playSessionId] The play session id.
346
- * @param {string} [segmentContainer] The segment container.
347
- * @param {number} [segmentLength] The segment length.
348
- * @param {number} [minSegments] The minimum number of segments.
349
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
350
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
351
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
352
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
353
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
354
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
355
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
356
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
357
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
358
- * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
359
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
360
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
361
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
362
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
363
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
364
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
365
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
366
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
367
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
368
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
369
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
370
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
371
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
372
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
373
- * @param {number} [maxRefFrames] Optional.
374
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
375
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
376
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
377
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
378
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
379
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
380
- * @param {string} [liveStreamId] The live stream id.
381
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
382
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
383
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
384
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
385
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
386
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
387
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
388
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
389
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
390
- * @param {*} [options] Override http request option.
391
- * @throws {RequiredError}
392
- */
393
- getVariantHlsAudioPlaylist: (itemId: 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, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
394
- [key: string]: string;
395
- }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
396
- /**
397
- *
398
- * @summary Gets a video stream using HTTP live streaming.
399
- * @param {string} itemId The item id.
400
- * @param {boolean} [_static] 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.
401
- * @param {string} [params] The streaming parameters.
402
- * @param {string} [tag] The tag.
403
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
404
- * @param {string} [playSessionId] The play session id.
405
- * @param {string} [segmentContainer] The segment container.
406
- * @param {number} [segmentLength] The segment length.
407
- * @param {number} [minSegments] The minimum number of segments.
408
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
409
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
410
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
411
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
412
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
413
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
414
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
415
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
416
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
417
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
418
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
419
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
420
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
421
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
422
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
423
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
424
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
425
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
426
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
427
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
428
- * @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
429
- * @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
430
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
431
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
432
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
433
- * @param {number} [maxRefFrames] Optional.
434
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
435
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
436
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
437
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
438
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
439
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
440
- * @param {string} [liveStreamId] The live stream id.
441
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
442
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
443
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
444
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
445
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
446
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
447
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
448
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
449
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
450
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
451
- * @param {*} [options] Override http request option.
452
- * @throws {RequiredError}
453
- */
454
- getVariantHlsVideoPlaylist: (itemId: 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?: {
455
- [key: string]: string;
456
- }, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
457
- /**
458
- *
459
- * @summary Gets an audio hls playlist stream.
460
- * @param {string} itemId The item id.
461
- * @param {string} mediaSourceId The media version id, if playing an alternate version.
462
- * @param {boolean} [_static] 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.
463
- * @param {string} [params] The streaming parameters.
464
- * @param {string} [tag] The tag.
465
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
466
- * @param {string} [playSessionId] The play session id.
467
- * @param {string} [segmentContainer] The segment container.
468
- * @param {number} [segmentLength] The segment length.
469
- * @param {number} [minSegments] The minimum number of segments.
470
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
471
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
472
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
473
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
474
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
475
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
476
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
477
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
478
- * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
479
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
480
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
481
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
482
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
483
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
484
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
485
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
486
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
487
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
488
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
489
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
490
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
491
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
492
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
493
- * @param {number} [maxRefFrames] Optional.
494
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
495
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
496
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
497
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
498
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
499
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
500
- * @param {string} [liveStreamId] The live stream id.
501
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
502
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
503
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
504
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
505
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
506
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
507
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
508
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
509
- * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming.
510
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
511
- * @param {*} [options] Override http request option.
512
- * @throws {RequiredError}
513
- */
514
- headMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
515
- [key: string]: string;
516
- }, enableAdaptiveBitrateStreaming?: boolean, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
517
- /**
518
- *
519
- * @summary Gets a video hls playlist stream.
520
- * @param {string} itemId The item id.
521
- * @param {string} mediaSourceId The media version id, if playing an alternate version.
522
- * @param {boolean} [_static] 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.
523
- * @param {string} [params] The streaming parameters.
524
- * @param {string} [tag] The tag.
525
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
526
- * @param {string} [playSessionId] The play session id.
527
- * @param {string} [segmentContainer] The segment container.
528
- * @param {number} [segmentLength] The segment length.
529
- * @param {number} [minSegments] The minimum number of segments.
530
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
531
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
532
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
533
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
534
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
535
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
536
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
537
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
538
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
539
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
540
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
541
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
542
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
543
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
544
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
545
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
546
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
547
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
548
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
549
- * @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
550
- * @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
551
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
552
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
553
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
554
- * @param {number} [maxRefFrames] Optional.
555
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
556
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
557
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
558
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
559
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
560
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
561
- * @param {string} [liveStreamId] The live stream id.
562
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
563
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
564
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
565
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
566
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
567
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
568
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
569
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
570
- * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming.
571
- * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist.
572
- * @param {boolean} [enableAudioVbrEncoding] Whether to enable Audio Encoding.
573
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
574
- * @param {*} [options] Override http request option.
575
- * @throws {RequiredError}
576
- */
577
- headMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, 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?: {
578
- [key: string]: string;
579
- }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
580
- };
581
- /**
582
- * DynamicHlsApi - functional programming interface
583
- * @export
584
- */
585
- export declare const DynamicHlsApiFp: (configuration?: Configuration) => {
586
- /**
587
- *
588
- * @summary Gets a video stream using HTTP live streaming.
589
- * @param {string} itemId The item id.
590
- * @param {string} playlistId The playlist id.
591
- * @param {number} segmentId The segment id.
592
- * @param {string} container The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
593
- * @param {number} runtimeTicks The position of the requested segment in ticks.
594
- * @param {number} actualSegmentLengthTicks The length of the requested segment in ticks.
595
- * @param {boolean} [_static] 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.
596
- * @param {string} [params] The streaming parameters.
597
- * @param {string} [tag] The tag.
598
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
599
- * @param {string} [playSessionId] The play session id.
600
- * @param {string} [segmentContainer] The segment container.
601
- * @param {number} [segmentLength] The segment length.
602
- * @param {number} [minSegments] The minimum number of segments.
603
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
604
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
605
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
606
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
607
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
608
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
609
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
610
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
611
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
612
- * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
613
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
614
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
615
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
616
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
617
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
618
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
619
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
620
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
621
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
622
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
623
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
624
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
625
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
626
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
627
- * @param {number} [maxRefFrames] Optional.
628
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
629
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
630
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
631
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
632
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
633
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
634
- * @param {string} [liveStreamId] The live stream id.
635
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
636
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
637
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
638
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
639
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
640
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
641
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
642
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
643
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
644
- * @param {*} [options] Override http request option.
645
- * @throws {RequiredError}
646
- */
647
- getHlsAudioSegment(itemId: string, playlistId: string, segmentId: number, container: string, runtimeTicks: number, actualSegmentLengthTicks: number, _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, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
648
- [key: string]: string;
649
- }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
650
- /**
651
- *
652
- * @summary Gets a video stream using HTTP live streaming.
653
- * @param {string} itemId The item id.
654
- * @param {string} playlistId The playlist id.
655
- * @param {number} segmentId The segment id.
656
- * @param {string} container The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
657
- * @param {number} runtimeTicks The position of the requested segment in ticks.
658
- * @param {number} actualSegmentLengthTicks The length of the requested segment in ticks.
659
- * @param {boolean} [_static] 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.
660
- * @param {string} [params] The streaming parameters.
661
- * @param {string} [tag] The tag.
662
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
663
- * @param {string} [playSessionId] The play session id.
664
- * @param {string} [segmentContainer] The segment container.
665
- * @param {number} [segmentLength] The desired segment length.
666
- * @param {number} [minSegments] The minimum number of segments.
667
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
668
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
669
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
670
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
671
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
672
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
673
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
674
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
675
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
676
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
677
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
678
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
679
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
680
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
681
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
682
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
683
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
684
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
685
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
686
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
687
- * @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
688
- * @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
689
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
690
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
691
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
692
- * @param {number} [maxRefFrames] Optional.
693
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
694
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
695
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
696
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
697
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
698
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
699
- * @param {string} [liveStreamId] The live stream id.
700
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
701
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
702
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
703
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
704
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
705
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
706
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
707
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
708
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
709
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
710
- * @param {*} [options] Override http request option.
711
- * @throws {RequiredError}
712
- */
713
- getHlsVideoSegment(itemId: string, playlistId: string, segmentId: number, container: string, runtimeTicks: number, actualSegmentLengthTicks: number, _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?: {
714
- [key: string]: string;
715
- }, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
716
- /**
717
- *
718
- * @summary Gets a hls live stream.
719
- * @param {string} itemId The item id.
720
- * @param {string} [container] The audio container.
721
- * @param {boolean} [_static] 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.
722
- * @param {string} [params] The streaming parameters.
723
- * @param {string} [tag] The tag.
724
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
725
- * @param {string} [playSessionId] The play session id.
726
- * @param {string} [segmentContainer] The segment container.
727
- * @param {number} [segmentLength] The segment length.
728
- * @param {number} [minSegments] The minimum number of segments.
729
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
730
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
731
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
732
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
733
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
734
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
735
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
736
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
737
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
738
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
739
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
740
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
741
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
742
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
743
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
744
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
745
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
746
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
747
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
748
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
749
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
750
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
751
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
752
- * @param {number} [maxRefFrames] Optional.
753
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
754
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
755
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
756
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
757
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
758
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
759
- * @param {string} [liveStreamId] The live stream id.
760
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
761
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
762
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
763
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
764
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
765
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
766
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
767
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
768
- * @param {number} [maxWidth] Optional. The max width.
769
- * @param {number} [maxHeight] Optional. The max height.
770
- * @param {boolean} [enableSubtitlesInManifest] Optional. Whether to enable subtitles in the manifest.
771
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
772
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
773
- * @param {*} [options] Override http request option.
774
- * @throws {RequiredError}
775
- */
776
- getLiveHlsStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
777
- [key: string]: string;
778
- }, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
779
- /**
780
- *
781
- * @summary Gets an audio hls playlist stream.
782
- * @param {string} itemId The item id.
783
- * @param {string} mediaSourceId The media version id, if playing an alternate version.
784
- * @param {boolean} [_static] 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.
785
- * @param {string} [params] The streaming parameters.
786
- * @param {string} [tag] The tag.
787
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
788
- * @param {string} [playSessionId] The play session id.
789
- * @param {string} [segmentContainer] The segment container.
790
- * @param {number} [segmentLength] The segment length.
791
- * @param {number} [minSegments] The minimum number of segments.
792
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
793
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
794
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
795
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
796
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
797
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
798
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
799
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
800
- * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
801
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
802
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
803
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
804
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
805
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
806
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
807
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
808
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
809
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
810
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
811
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
812
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
813
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
814
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
815
- * @param {number} [maxRefFrames] Optional.
816
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
817
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
818
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
819
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
820
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
821
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
822
- * @param {string} [liveStreamId] The live stream id.
823
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
824
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
825
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
826
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
827
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
828
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
829
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
830
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
831
- * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming.
832
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
833
- * @param {*} [options] Override http request option.
834
- * @throws {RequiredError}
835
- */
836
- getMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
837
- [key: string]: string;
838
- }, enableAdaptiveBitrateStreaming?: boolean, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
839
- /**
840
- *
841
- * @summary Gets a video hls playlist stream.
842
- * @param {string} itemId The item id.
843
- * @param {string} mediaSourceId The media version id, if playing an alternate version.
844
- * @param {boolean} [_static] 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.
845
- * @param {string} [params] The streaming parameters.
846
- * @param {string} [tag] The tag.
847
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
848
- * @param {string} [playSessionId] The play session id.
849
- * @param {string} [segmentContainer] The segment container.
850
- * @param {number} [segmentLength] The segment length.
851
- * @param {number} [minSegments] The minimum number of segments.
852
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
853
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
854
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
855
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
856
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
857
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
858
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
859
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
860
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
861
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
862
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
863
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
864
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
865
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
866
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
867
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
868
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
869
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
870
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
871
- * @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
872
- * @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
873
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
874
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
875
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
876
- * @param {number} [maxRefFrames] Optional.
877
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
878
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
879
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
880
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
881
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
882
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
883
- * @param {string} [liveStreamId] The live stream id.
884
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
885
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
886
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
887
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
888
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
889
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
890
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
891
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
892
- * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming.
893
- * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist.
894
- * @param {boolean} [enableAudioVbrEncoding] Whether to enable Audio Encoding.
895
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
896
- * @param {*} [options] Override http request option.
897
- * @throws {RequiredError}
898
- */
899
- getMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, 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?: {
900
- [key: string]: string;
901
- }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
902
- /**
903
- *
904
- * @summary Gets an audio stream using HTTP live streaming.
905
- * @param {string} itemId The item id.
906
- * @param {boolean} [_static] 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.
907
- * @param {string} [params] The streaming parameters.
908
- * @param {string} [tag] The tag.
909
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
910
- * @param {string} [playSessionId] The play session id.
911
- * @param {string} [segmentContainer] The segment container.
912
- * @param {number} [segmentLength] The segment length.
913
- * @param {number} [minSegments] The minimum number of segments.
914
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
915
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
916
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
917
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
918
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
919
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
920
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
921
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
922
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
923
- * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
924
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
925
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
926
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
927
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
928
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
929
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
930
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
931
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
932
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
933
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
934
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
935
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
936
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
937
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
938
- * @param {number} [maxRefFrames] Optional.
939
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
940
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
941
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
942
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
943
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
944
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
945
- * @param {string} [liveStreamId] The live stream id.
946
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
947
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
948
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
949
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
950
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
951
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
952
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
953
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
954
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
955
- * @param {*} [options] Override http request option.
956
- * @throws {RequiredError}
957
- */
958
- getVariantHlsAudioPlaylist(itemId: 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, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
959
- [key: string]: string;
960
- }, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
961
- /**
962
- *
963
- * @summary Gets a video stream using HTTP live streaming.
964
- * @param {string} itemId The item id.
965
- * @param {boolean} [_static] 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.
966
- * @param {string} [params] The streaming parameters.
967
- * @param {string} [tag] The tag.
968
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
969
- * @param {string} [playSessionId] The play session id.
970
- * @param {string} [segmentContainer] The segment container.
971
- * @param {number} [segmentLength] The segment length.
972
- * @param {number} [minSegments] The minimum number of segments.
973
- * @param {string} [mediaSourceId] The media version id, if playing an alternate version.
974
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
975
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
976
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
977
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
978
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
979
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
980
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
981
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
982
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
983
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
984
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
985
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
986
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
987
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
988
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
989
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
990
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
991
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
992
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
993
- * @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
994
- * @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
995
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
996
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
997
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
998
- * @param {number} [maxRefFrames] Optional.
999
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
1000
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
1001
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
1002
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
1003
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
1004
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
1005
- * @param {string} [liveStreamId] The live stream id.
1006
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
1007
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
1008
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
1009
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
1010
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1011
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
1012
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1013
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
1014
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
1015
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
1016
- * @param {*} [options] Override http request option.
1017
- * @throws {RequiredError}
1018
- */
1019
- getVariantHlsVideoPlaylist(itemId: 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?: {
1020
- [key: string]: string;
1021
- }, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1022
- /**
1023
- *
1024
- * @summary Gets an audio hls playlist stream.
1025
- * @param {string} itemId The item id.
1026
- * @param {string} mediaSourceId The media version id, if playing an alternate version.
1027
- * @param {boolean} [_static] 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.
1028
- * @param {string} [params] The streaming parameters.
1029
- * @param {string} [tag] The tag.
1030
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
1031
- * @param {string} [playSessionId] The play session id.
1032
- * @param {string} [segmentContainer] The segment container.
1033
- * @param {number} [segmentLength] The segment length.
1034
- * @param {number} [minSegments] The minimum number of segments.
1035
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
1036
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
1037
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
1038
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
1039
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
1040
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
1041
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
1042
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
1043
- * @param {number} [maxStreamingBitrate] Optional. The maximum streaming bitrate.
1044
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1045
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
1046
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
1047
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
1048
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
1049
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1050
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1051
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1052
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1053
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
1054
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
1055
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1056
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1057
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
1058
- * @param {number} [maxRefFrames] Optional.
1059
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
1060
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
1061
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
1062
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
1063
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
1064
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
1065
- * @param {string} [liveStreamId] The live stream id.
1066
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
1067
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
1068
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
1069
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
1070
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1071
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
1072
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1073
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
1074
- * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming.
1075
- * @param {boolean} [enableAudioVbrEncoding] Optional. Whether to enable Audio Encoding.
1076
- * @param {*} [options] Override http request option.
1077
- * @throws {RequiredError}
1078
- */
1079
- headMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
1080
- [key: string]: string;
1081
- }, enableAdaptiveBitrateStreaming?: boolean, enableAudioVbrEncoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1082
- /**
1083
- *
1084
- * @summary Gets a video hls playlist stream.
1085
- * @param {string} itemId The item id.
1086
- * @param {string} mediaSourceId The media version id, if playing an alternate version.
1087
- * @param {boolean} [_static] 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.
1088
- * @param {string} [params] The streaming parameters.
1089
- * @param {string} [tag] The tag.
1090
- * @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
1091
- * @param {string} [playSessionId] The play session id.
1092
- * @param {string} [segmentContainer] The segment container.
1093
- * @param {number} [segmentLength] The segment length.
1094
- * @param {number} [minSegments] The minimum number of segments.
1095
- * @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
1096
- * @param {string} [audioCodec] Optional. Specify an audio codec to encode to, e.g. mp3.
1097
- * @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
1098
- * @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
1099
- * @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
1100
- * @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
1101
- * @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
1102
- * @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
1103
- * @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1104
- * @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
1105
- * @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
1106
- * @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
1107
- * @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
1108
- * @param {number} [framerate] Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1109
- * @param {number} [maxFramerate] Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1110
- * @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1111
- * @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1112
- * @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
1113
- * @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
1114
- * @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
1115
- * @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
1116
- * @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1117
- * @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1118
- * @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
1119
- * @param {number} [maxRefFrames] Optional.
1120
- * @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
1121
- * @param {boolean} [requireAvc] Optional. Whether to require avc.
1122
- * @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
1123
- * @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
1124
- * @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
1125
- * @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
1126
- * @param {string} [liveStreamId] The live stream id.
1127
- * @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
1128
- * @param {string} [videoCodec] Optional. Specify a video codec to encode to, e.g. h264.
1129
- * @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
1130
- * @param {string} [transcodeReasons] Optional. The transcoding reason.
1131
- * @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1132
- * @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
1133
- * @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1134
- * @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
1135
- * @param {boolean} [enableAdaptiveBitrateStreaming] Enable adaptive bitrate streaming.
1136
- * @param {boolean} [enableTrickplay] Enable trickplay image playlists being added to master playlist.
1137
- * @param {boolean} [enableAudioVbrEncoding] Whether to enable Audio Encoding.
1138
- * @param {boolean} [alwaysBurnInSubtitleWhenTranscoding] Whether to always burn in subtitles when transcoding.
1139
- * @param {*} [options] Override http request option.
1140
- * @throws {RequiredError}
1141
- */
1142
- headMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, 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?: {
1143
- [key: string]: string;
1144
- }, enableAdaptiveBitrateStreaming?: boolean, enableTrickplay?: boolean, enableAudioVbrEncoding?: boolean, alwaysBurnInSubtitleWhenTranscoding?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1145
- };
1146
- /**
1147
- * DynamicHlsApi - factory interface
1148
- * @export
1149
- */
1150
- export declare const DynamicHlsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1151
- /**
1152
- *
1153
- * @summary Gets a video stream using HTTP live streaming.
1154
- * @param {DynamicHlsApiGetHlsAudioSegmentRequest} requestParameters Request parameters.
1155
- * @param {*} [options] Override http request option.
1156
- * @throws {RequiredError}
1157
- */
1158
- getHlsAudioSegment(requestParameters: DynamicHlsApiGetHlsAudioSegmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1159
- /**
1160
- *
1161
- * @summary Gets a video stream using HTTP live streaming.
1162
- * @param {DynamicHlsApiGetHlsVideoSegmentRequest} requestParameters Request parameters.
1163
- * @param {*} [options] Override http request option.
1164
- * @throws {RequiredError}
1165
- */
1166
- getHlsVideoSegment(requestParameters: DynamicHlsApiGetHlsVideoSegmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1167
- /**
1168
- *
1169
- * @summary Gets a hls live stream.
1170
- * @param {DynamicHlsApiGetLiveHlsStreamRequest} requestParameters Request parameters.
1171
- * @param {*} [options] Override http request option.
1172
- * @throws {RequiredError}
1173
- */
1174
- getLiveHlsStream(requestParameters: DynamicHlsApiGetLiveHlsStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1175
- /**
1176
- *
1177
- * @summary Gets an audio hls playlist stream.
1178
- * @param {DynamicHlsApiGetMasterHlsAudioPlaylistRequest} requestParameters Request parameters.
1179
- * @param {*} [options] Override http request option.
1180
- * @throws {RequiredError}
1181
- */
1182
- getMasterHlsAudioPlaylist(requestParameters: DynamicHlsApiGetMasterHlsAudioPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1183
- /**
1184
- *
1185
- * @summary Gets a video hls playlist stream.
1186
- * @param {DynamicHlsApiGetMasterHlsVideoPlaylistRequest} requestParameters Request parameters.
1187
- * @param {*} [options] Override http request option.
1188
- * @throws {RequiredError}
1189
- */
1190
- getMasterHlsVideoPlaylist(requestParameters: DynamicHlsApiGetMasterHlsVideoPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1191
- /**
1192
- *
1193
- * @summary Gets an audio stream using HTTP live streaming.
1194
- * @param {DynamicHlsApiGetVariantHlsAudioPlaylistRequest} requestParameters Request parameters.
1195
- * @param {*} [options] Override http request option.
1196
- * @throws {RequiredError}
1197
- */
1198
- getVariantHlsAudioPlaylist(requestParameters: DynamicHlsApiGetVariantHlsAudioPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1199
- /**
1200
- *
1201
- * @summary Gets a video stream using HTTP live streaming.
1202
- * @param {DynamicHlsApiGetVariantHlsVideoPlaylistRequest} requestParameters Request parameters.
1203
- * @param {*} [options] Override http request option.
1204
- * @throws {RequiredError}
1205
- */
1206
- getVariantHlsVideoPlaylist(requestParameters: DynamicHlsApiGetVariantHlsVideoPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1207
- /**
1208
- *
1209
- * @summary Gets an audio hls playlist stream.
1210
- * @param {DynamicHlsApiHeadMasterHlsAudioPlaylistRequest} requestParameters Request parameters.
1211
- * @param {*} [options] Override http request option.
1212
- * @throws {RequiredError}
1213
- */
1214
- headMasterHlsAudioPlaylist(requestParameters: DynamicHlsApiHeadMasterHlsAudioPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1215
- /**
1216
- *
1217
- * @summary Gets a video hls playlist stream.
1218
- * @param {DynamicHlsApiHeadMasterHlsVideoPlaylistRequest} requestParameters Request parameters.
1219
- * @param {*} [options] Override http request option.
1220
- * @throws {RequiredError}
1221
- */
1222
- headMasterHlsVideoPlaylist(requestParameters: DynamicHlsApiHeadMasterHlsVideoPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1223
- };
1224
- /**
1225
- * Request parameters for getHlsAudioSegment operation in DynamicHlsApi.
1226
- * @export
1227
- * @interface DynamicHlsApiGetHlsAudioSegmentRequest
1228
- */
1229
- export interface DynamicHlsApiGetHlsAudioSegmentRequest {
1230
- /**
1231
- * The item id.
1232
- * @type {string}
1233
- * @memberof DynamicHlsApiGetHlsAudioSegment
1234
- */
1235
- readonly itemId: string;
1236
- /**
1237
- * The playlist id.
1238
- * @type {string}
1239
- * @memberof DynamicHlsApiGetHlsAudioSegment
1240
- */
1241
- readonly playlistId: string;
1242
- /**
1243
- * The segment id.
1244
- * @type {number}
1245
- * @memberof DynamicHlsApiGetHlsAudioSegment
1246
- */
1247
- readonly segmentId: number;
1248
- /**
1249
- * The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
1250
- * @type {string}
1251
- * @memberof DynamicHlsApiGetHlsAudioSegment
1252
- */
1253
- readonly container: string;
1254
- /**
1255
- * The position of the requested segment in ticks.
1256
- * @type {number}
1257
- * @memberof DynamicHlsApiGetHlsAudioSegment
1258
- */
1259
- readonly runtimeTicks: number;
1260
- /**
1261
- * The length of the requested segment in ticks.
1262
- * @type {number}
1263
- * @memberof DynamicHlsApiGetHlsAudioSegment
1264
- */
1265
- readonly actualSegmentLengthTicks: number;
1266
- /**
1267
- * 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.
1268
- * @type {boolean}
1269
- * @memberof DynamicHlsApiGetHlsAudioSegment
1270
- */
1271
- readonly _static?: boolean;
1272
- /**
1273
- * The streaming parameters.
1274
- * @type {string}
1275
- * @memberof DynamicHlsApiGetHlsAudioSegment
1276
- */
1277
- readonly params?: string;
1278
- /**
1279
- * The tag.
1280
- * @type {string}
1281
- * @memberof DynamicHlsApiGetHlsAudioSegment
1282
- */
1283
- readonly tag?: string;
1284
- /**
1285
- * Optional. The dlna device profile id to utilize.
1286
- * @type {string}
1287
- * @memberof DynamicHlsApiGetHlsAudioSegment
1288
- */
1289
- readonly deviceProfileId?: string;
1290
- /**
1291
- * The play session id.
1292
- * @type {string}
1293
- * @memberof DynamicHlsApiGetHlsAudioSegment
1294
- */
1295
- readonly playSessionId?: string;
1296
- /**
1297
- * The segment container.
1298
- * @type {string}
1299
- * @memberof DynamicHlsApiGetHlsAudioSegment
1300
- */
1301
- readonly segmentContainer?: string;
1302
- /**
1303
- * The segment length.
1304
- * @type {number}
1305
- * @memberof DynamicHlsApiGetHlsAudioSegment
1306
- */
1307
- readonly segmentLength?: number;
1308
- /**
1309
- * The minimum number of segments.
1310
- * @type {number}
1311
- * @memberof DynamicHlsApiGetHlsAudioSegment
1312
- */
1313
- readonly minSegments?: number;
1314
- /**
1315
- * The media version id, if playing an alternate version.
1316
- * @type {string}
1317
- * @memberof DynamicHlsApiGetHlsAudioSegment
1318
- */
1319
- readonly mediaSourceId?: string;
1320
- /**
1321
- * The device id of the client requesting. Used to stop encoding processes when needed.
1322
- * @type {string}
1323
- * @memberof DynamicHlsApiGetHlsAudioSegment
1324
- */
1325
- readonly deviceId?: string;
1326
- /**
1327
- * Optional. Specify an audio codec to encode to, e.g. mp3.
1328
- * @type {string}
1329
- * @memberof DynamicHlsApiGetHlsAudioSegment
1330
- */
1331
- readonly audioCodec?: string;
1332
- /**
1333
- * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
1334
- * @type {boolean}
1335
- * @memberof DynamicHlsApiGetHlsAudioSegment
1336
- */
1337
- readonly enableAutoStreamCopy?: boolean;
1338
- /**
1339
- * Whether or not to allow copying of the video stream url.
1340
- * @type {boolean}
1341
- * @memberof DynamicHlsApiGetHlsAudioSegment
1342
- */
1343
- readonly allowVideoStreamCopy?: boolean;
1344
- /**
1345
- * Whether or not to allow copying of the audio stream url.
1346
- * @type {boolean}
1347
- * @memberof DynamicHlsApiGetHlsAudioSegment
1348
- */
1349
- readonly allowAudioStreamCopy?: boolean;
1350
- /**
1351
- * Optional. Whether to break on non key frames.
1352
- * @type {boolean}
1353
- * @memberof DynamicHlsApiGetHlsAudioSegment
1354
- */
1355
- readonly breakOnNonKeyFrames?: boolean;
1356
- /**
1357
- * Optional. Specify a specific audio sample rate, e.g. 44100.
1358
- * @type {number}
1359
- * @memberof DynamicHlsApiGetHlsAudioSegment
1360
- */
1361
- readonly audioSampleRate?: number;
1362
- /**
1363
- * Optional. The maximum audio bit depth.
1364
- * @type {number}
1365
- * @memberof DynamicHlsApiGetHlsAudioSegment
1366
- */
1367
- readonly maxAudioBitDepth?: number;
1368
- /**
1369
- * Optional. The maximum streaming bitrate.
1370
- * @type {number}
1371
- * @memberof DynamicHlsApiGetHlsAudioSegment
1372
- */
1373
- readonly maxStreamingBitrate?: number;
1374
- /**
1375
- * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1376
- * @type {number}
1377
- * @memberof DynamicHlsApiGetHlsAudioSegment
1378
- */
1379
- readonly audioBitRate?: number;
1380
- /**
1381
- * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
1382
- * @type {number}
1383
- * @memberof DynamicHlsApiGetHlsAudioSegment
1384
- */
1385
- readonly audioChannels?: number;
1386
- /**
1387
- * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
1388
- * @type {number}
1389
- * @memberof DynamicHlsApiGetHlsAudioSegment
1390
- */
1391
- readonly maxAudioChannels?: number;
1392
- /**
1393
- * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
1394
- * @type {string}
1395
- * @memberof DynamicHlsApiGetHlsAudioSegment
1396
- */
1397
- readonly profile?: string;
1398
- /**
1399
- * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
1400
- * @type {string}
1401
- * @memberof DynamicHlsApiGetHlsAudioSegment
1402
- */
1403
- readonly level?: string;
1404
- /**
1405
- * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1406
- * @type {number}
1407
- * @memberof DynamicHlsApiGetHlsAudioSegment
1408
- */
1409
- readonly framerate?: number;
1410
- /**
1411
- * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1412
- * @type {number}
1413
- * @memberof DynamicHlsApiGetHlsAudioSegment
1414
- */
1415
- readonly maxFramerate?: number;
1416
- /**
1417
- * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1418
- * @type {boolean}
1419
- * @memberof DynamicHlsApiGetHlsAudioSegment
1420
- */
1421
- readonly copyTimestamps?: boolean;
1422
- /**
1423
- * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1424
- * @type {number}
1425
- * @memberof DynamicHlsApiGetHlsAudioSegment
1426
- */
1427
- readonly startTimeTicks?: number;
1428
- /**
1429
- * Optional. The fixed horizontal resolution of the encoded video.
1430
- * @type {number}
1431
- * @memberof DynamicHlsApiGetHlsAudioSegment
1432
- */
1433
- readonly width?: number;
1434
- /**
1435
- * Optional. The fixed vertical resolution of the encoded video.
1436
- * @type {number}
1437
- * @memberof DynamicHlsApiGetHlsAudioSegment
1438
- */
1439
- readonly height?: number;
1440
- /**
1441
- * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1442
- * @type {number}
1443
- * @memberof DynamicHlsApiGetHlsAudioSegment
1444
- */
1445
- readonly videoBitRate?: number;
1446
- /**
1447
- * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1448
- * @type {number}
1449
- * @memberof DynamicHlsApiGetHlsAudioSegment
1450
- */
1451
- readonly subtitleStreamIndex?: number;
1452
- /**
1453
- * Optional. Specify the subtitle delivery method.
1454
- * @type {SubtitleDeliveryMethod}
1455
- * @memberof DynamicHlsApiGetHlsAudioSegment
1456
- */
1457
- readonly subtitleMethod?: SubtitleDeliveryMethod;
1458
- /**
1459
- * Optional.
1460
- * @type {number}
1461
- * @memberof DynamicHlsApiGetHlsAudioSegment
1462
- */
1463
- readonly maxRefFrames?: number;
1464
- /**
1465
- * Optional. The maximum video bit depth.
1466
- * @type {number}
1467
- * @memberof DynamicHlsApiGetHlsAudioSegment
1468
- */
1469
- readonly maxVideoBitDepth?: number;
1470
- /**
1471
- * Optional. Whether to require avc.
1472
- * @type {boolean}
1473
- * @memberof DynamicHlsApiGetHlsAudioSegment
1474
- */
1475
- readonly requireAvc?: boolean;
1476
- /**
1477
- * Optional. Whether to deinterlace the video.
1478
- * @type {boolean}
1479
- * @memberof DynamicHlsApiGetHlsAudioSegment
1480
- */
1481
- readonly deInterlace?: boolean;
1482
- /**
1483
- * Optional. Whether to require a non anamorphic stream.
1484
- * @type {boolean}
1485
- * @memberof DynamicHlsApiGetHlsAudioSegment
1486
- */
1487
- readonly requireNonAnamorphic?: boolean;
1488
- /**
1489
- * Optional. The maximum number of audio channels to transcode.
1490
- * @type {number}
1491
- * @memberof DynamicHlsApiGetHlsAudioSegment
1492
- */
1493
- readonly transcodingMaxAudioChannels?: number;
1494
- /**
1495
- * Optional. The limit of how many cpu cores to use.
1496
- * @type {number}
1497
- * @memberof DynamicHlsApiGetHlsAudioSegment
1498
- */
1499
- readonly cpuCoreLimit?: number;
1500
- /**
1501
- * The live stream id.
1502
- * @type {string}
1503
- * @memberof DynamicHlsApiGetHlsAudioSegment
1504
- */
1505
- readonly liveStreamId?: string;
1506
- /**
1507
- * Optional. Whether to enable the MpegtsM2Ts mode.
1508
- * @type {boolean}
1509
- * @memberof DynamicHlsApiGetHlsAudioSegment
1510
- */
1511
- readonly enableMpegtsM2TsMode?: boolean;
1512
- /**
1513
- * Optional. Specify a video codec to encode to, e.g. h264.
1514
- * @type {string}
1515
- * @memberof DynamicHlsApiGetHlsAudioSegment
1516
- */
1517
- readonly videoCodec?: string;
1518
- /**
1519
- * Optional. Specify a subtitle codec to encode to.
1520
- * @type {string}
1521
- * @memberof DynamicHlsApiGetHlsAudioSegment
1522
- */
1523
- readonly subtitleCodec?: string;
1524
- /**
1525
- * Optional. The transcoding reason.
1526
- * @type {string}
1527
- * @memberof DynamicHlsApiGetHlsAudioSegment
1528
- */
1529
- readonly transcodeReasons?: string;
1530
- /**
1531
- * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1532
- * @type {number}
1533
- * @memberof DynamicHlsApiGetHlsAudioSegment
1534
- */
1535
- readonly audioStreamIndex?: number;
1536
- /**
1537
- * Optional. The index of the video stream to use. If omitted the first video stream will be used.
1538
- * @type {number}
1539
- * @memberof DynamicHlsApiGetHlsAudioSegment
1540
- */
1541
- readonly videoStreamIndex?: number;
1542
- /**
1543
- * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1544
- * @type {EncodingContext}
1545
- * @memberof DynamicHlsApiGetHlsAudioSegment
1546
- */
1547
- readonly context?: EncodingContext;
1548
- /**
1549
- * Optional. The streaming options.
1550
- * @type {{ [key: string]: string; }}
1551
- * @memberof DynamicHlsApiGetHlsAudioSegment
1552
- */
1553
- readonly streamOptions?: {
1554
- [key: string]: string;
1555
- };
1556
- /**
1557
- * Optional. Whether to enable Audio Encoding.
1558
- * @type {boolean}
1559
- * @memberof DynamicHlsApiGetHlsAudioSegment
1560
- */
1561
- readonly enableAudioVbrEncoding?: boolean;
1562
- }
1563
- /**
1564
- * Request parameters for getHlsVideoSegment operation in DynamicHlsApi.
1565
- * @export
1566
- * @interface DynamicHlsApiGetHlsVideoSegmentRequest
1567
- */
1568
- export interface DynamicHlsApiGetHlsVideoSegmentRequest {
1569
- /**
1570
- * The item id.
1571
- * @type {string}
1572
- * @memberof DynamicHlsApiGetHlsVideoSegment
1573
- */
1574
- readonly itemId: string;
1575
- /**
1576
- * The playlist id.
1577
- * @type {string}
1578
- * @memberof DynamicHlsApiGetHlsVideoSegment
1579
- */
1580
- readonly playlistId: string;
1581
- /**
1582
- * The segment id.
1583
- * @type {number}
1584
- * @memberof DynamicHlsApiGetHlsVideoSegment
1585
- */
1586
- readonly segmentId: number;
1587
- /**
1588
- * The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
1589
- * @type {string}
1590
- * @memberof DynamicHlsApiGetHlsVideoSegment
1591
- */
1592
- readonly container: string;
1593
- /**
1594
- * The position of the requested segment in ticks.
1595
- * @type {number}
1596
- * @memberof DynamicHlsApiGetHlsVideoSegment
1597
- */
1598
- readonly runtimeTicks: number;
1599
- /**
1600
- * The length of the requested segment in ticks.
1601
- * @type {number}
1602
- * @memberof DynamicHlsApiGetHlsVideoSegment
1603
- */
1604
- readonly actualSegmentLengthTicks: number;
1605
- /**
1606
- * 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.
1607
- * @type {boolean}
1608
- * @memberof DynamicHlsApiGetHlsVideoSegment
1609
- */
1610
- readonly _static?: boolean;
1611
- /**
1612
- * The streaming parameters.
1613
- * @type {string}
1614
- * @memberof DynamicHlsApiGetHlsVideoSegment
1615
- */
1616
- readonly params?: string;
1617
- /**
1618
- * The tag.
1619
- * @type {string}
1620
- * @memberof DynamicHlsApiGetHlsVideoSegment
1621
- */
1622
- readonly tag?: string;
1623
- /**
1624
- * Optional. The dlna device profile id to utilize.
1625
- * @type {string}
1626
- * @memberof DynamicHlsApiGetHlsVideoSegment
1627
- */
1628
- readonly deviceProfileId?: string;
1629
- /**
1630
- * The play session id.
1631
- * @type {string}
1632
- * @memberof DynamicHlsApiGetHlsVideoSegment
1633
- */
1634
- readonly playSessionId?: string;
1635
- /**
1636
- * The segment container.
1637
- * @type {string}
1638
- * @memberof DynamicHlsApiGetHlsVideoSegment
1639
- */
1640
- readonly segmentContainer?: string;
1641
- /**
1642
- * The desired segment length.
1643
- * @type {number}
1644
- * @memberof DynamicHlsApiGetHlsVideoSegment
1645
- */
1646
- readonly segmentLength?: number;
1647
- /**
1648
- * The minimum number of segments.
1649
- * @type {number}
1650
- * @memberof DynamicHlsApiGetHlsVideoSegment
1651
- */
1652
- readonly minSegments?: number;
1653
- /**
1654
- * The media version id, if playing an alternate version.
1655
- * @type {string}
1656
- * @memberof DynamicHlsApiGetHlsVideoSegment
1657
- */
1658
- readonly mediaSourceId?: string;
1659
- /**
1660
- * The device id of the client requesting. Used to stop encoding processes when needed.
1661
- * @type {string}
1662
- * @memberof DynamicHlsApiGetHlsVideoSegment
1663
- */
1664
- readonly deviceId?: string;
1665
- /**
1666
- * Optional. Specify an audio codec to encode to, e.g. mp3.
1667
- * @type {string}
1668
- * @memberof DynamicHlsApiGetHlsVideoSegment
1669
- */
1670
- readonly audioCodec?: string;
1671
- /**
1672
- * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
1673
- * @type {boolean}
1674
- * @memberof DynamicHlsApiGetHlsVideoSegment
1675
- */
1676
- readonly enableAutoStreamCopy?: boolean;
1677
- /**
1678
- * Whether or not to allow copying of the video stream url.
1679
- * @type {boolean}
1680
- * @memberof DynamicHlsApiGetHlsVideoSegment
1681
- */
1682
- readonly allowVideoStreamCopy?: boolean;
1683
- /**
1684
- * Whether or not to allow copying of the audio stream url.
1685
- * @type {boolean}
1686
- * @memberof DynamicHlsApiGetHlsVideoSegment
1687
- */
1688
- readonly allowAudioStreamCopy?: boolean;
1689
- /**
1690
- * Optional. Whether to break on non key frames.
1691
- * @type {boolean}
1692
- * @memberof DynamicHlsApiGetHlsVideoSegment
1693
- */
1694
- readonly breakOnNonKeyFrames?: boolean;
1695
- /**
1696
- * Optional. Specify a specific audio sample rate, e.g. 44100.
1697
- * @type {number}
1698
- * @memberof DynamicHlsApiGetHlsVideoSegment
1699
- */
1700
- readonly audioSampleRate?: number;
1701
- /**
1702
- * Optional. The maximum audio bit depth.
1703
- * @type {number}
1704
- * @memberof DynamicHlsApiGetHlsVideoSegment
1705
- */
1706
- readonly maxAudioBitDepth?: number;
1707
- /**
1708
- * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
1709
- * @type {number}
1710
- * @memberof DynamicHlsApiGetHlsVideoSegment
1711
- */
1712
- readonly audioBitRate?: number;
1713
- /**
1714
- * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
1715
- * @type {number}
1716
- * @memberof DynamicHlsApiGetHlsVideoSegment
1717
- */
1718
- readonly audioChannels?: number;
1719
- /**
1720
- * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
1721
- * @type {number}
1722
- * @memberof DynamicHlsApiGetHlsVideoSegment
1723
- */
1724
- readonly maxAudioChannels?: number;
1725
- /**
1726
- * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
1727
- * @type {string}
1728
- * @memberof DynamicHlsApiGetHlsVideoSegment
1729
- */
1730
- readonly profile?: string;
1731
- /**
1732
- * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
1733
- * @type {string}
1734
- * @memberof DynamicHlsApiGetHlsVideoSegment
1735
- */
1736
- readonly level?: string;
1737
- /**
1738
- * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1739
- * @type {number}
1740
- * @memberof DynamicHlsApiGetHlsVideoSegment
1741
- */
1742
- readonly framerate?: number;
1743
- /**
1744
- * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
1745
- * @type {number}
1746
- * @memberof DynamicHlsApiGetHlsVideoSegment
1747
- */
1748
- readonly maxFramerate?: number;
1749
- /**
1750
- * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
1751
- * @type {boolean}
1752
- * @memberof DynamicHlsApiGetHlsVideoSegment
1753
- */
1754
- readonly copyTimestamps?: boolean;
1755
- /**
1756
- * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
1757
- * @type {number}
1758
- * @memberof DynamicHlsApiGetHlsVideoSegment
1759
- */
1760
- readonly startTimeTicks?: number;
1761
- /**
1762
- * Optional. The fixed horizontal resolution of the encoded video.
1763
- * @type {number}
1764
- * @memberof DynamicHlsApiGetHlsVideoSegment
1765
- */
1766
- readonly width?: number;
1767
- /**
1768
- * Optional. The fixed vertical resolution of the encoded video.
1769
- * @type {number}
1770
- * @memberof DynamicHlsApiGetHlsVideoSegment
1771
- */
1772
- readonly height?: number;
1773
- /**
1774
- * Optional. The maximum horizontal resolution of the encoded video.
1775
- * @type {number}
1776
- * @memberof DynamicHlsApiGetHlsVideoSegment
1777
- */
1778
- readonly maxWidth?: number;
1779
- /**
1780
- * Optional. The maximum vertical resolution of the encoded video.
1781
- * @type {number}
1782
- * @memberof DynamicHlsApiGetHlsVideoSegment
1783
- */
1784
- readonly maxHeight?: number;
1785
- /**
1786
- * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
1787
- * @type {number}
1788
- * @memberof DynamicHlsApiGetHlsVideoSegment
1789
- */
1790
- readonly videoBitRate?: number;
1791
- /**
1792
- * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
1793
- * @type {number}
1794
- * @memberof DynamicHlsApiGetHlsVideoSegment
1795
- */
1796
- readonly subtitleStreamIndex?: number;
1797
- /**
1798
- * Optional. Specify the subtitle delivery method.
1799
- * @type {SubtitleDeliveryMethod}
1800
- * @memberof DynamicHlsApiGetHlsVideoSegment
1801
- */
1802
- readonly subtitleMethod?: SubtitleDeliveryMethod;
1803
- /**
1804
- * Optional.
1805
- * @type {number}
1806
- * @memberof DynamicHlsApiGetHlsVideoSegment
1807
- */
1808
- readonly maxRefFrames?: number;
1809
- /**
1810
- * Optional. The maximum video bit depth.
1811
- * @type {number}
1812
- * @memberof DynamicHlsApiGetHlsVideoSegment
1813
- */
1814
- readonly maxVideoBitDepth?: number;
1815
- /**
1816
- * Optional. Whether to require avc.
1817
- * @type {boolean}
1818
- * @memberof DynamicHlsApiGetHlsVideoSegment
1819
- */
1820
- readonly requireAvc?: boolean;
1821
- /**
1822
- * Optional. Whether to deinterlace the video.
1823
- * @type {boolean}
1824
- * @memberof DynamicHlsApiGetHlsVideoSegment
1825
- */
1826
- readonly deInterlace?: boolean;
1827
- /**
1828
- * Optional. Whether to require a non anamorphic stream.
1829
- * @type {boolean}
1830
- * @memberof DynamicHlsApiGetHlsVideoSegment
1831
- */
1832
- readonly requireNonAnamorphic?: boolean;
1833
- /**
1834
- * Optional. The maximum number of audio channels to transcode.
1835
- * @type {number}
1836
- * @memberof DynamicHlsApiGetHlsVideoSegment
1837
- */
1838
- readonly transcodingMaxAudioChannels?: number;
1839
- /**
1840
- * Optional. The limit of how many cpu cores to use.
1841
- * @type {number}
1842
- * @memberof DynamicHlsApiGetHlsVideoSegment
1843
- */
1844
- readonly cpuCoreLimit?: number;
1845
- /**
1846
- * The live stream id.
1847
- * @type {string}
1848
- * @memberof DynamicHlsApiGetHlsVideoSegment
1849
- */
1850
- readonly liveStreamId?: string;
1851
- /**
1852
- * Optional. Whether to enable the MpegtsM2Ts mode.
1853
- * @type {boolean}
1854
- * @memberof DynamicHlsApiGetHlsVideoSegment
1855
- */
1856
- readonly enableMpegtsM2TsMode?: boolean;
1857
- /**
1858
- * Optional. Specify a video codec to encode to, e.g. h264.
1859
- * @type {string}
1860
- * @memberof DynamicHlsApiGetHlsVideoSegment
1861
- */
1862
- readonly videoCodec?: string;
1863
- /**
1864
- * Optional. Specify a subtitle codec to encode to.
1865
- * @type {string}
1866
- * @memberof DynamicHlsApiGetHlsVideoSegment
1867
- */
1868
- readonly subtitleCodec?: string;
1869
- /**
1870
- * Optional. The transcoding reason.
1871
- * @type {string}
1872
- * @memberof DynamicHlsApiGetHlsVideoSegment
1873
- */
1874
- readonly transcodeReasons?: string;
1875
- /**
1876
- * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
1877
- * @type {number}
1878
- * @memberof DynamicHlsApiGetHlsVideoSegment
1879
- */
1880
- readonly audioStreamIndex?: number;
1881
- /**
1882
- * Optional. The index of the video stream to use. If omitted the first video stream will be used.
1883
- * @type {number}
1884
- * @memberof DynamicHlsApiGetHlsVideoSegment
1885
- */
1886
- readonly videoStreamIndex?: number;
1887
- /**
1888
- * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
1889
- * @type {EncodingContext}
1890
- * @memberof DynamicHlsApiGetHlsVideoSegment
1891
- */
1892
- readonly context?: EncodingContext;
1893
- /**
1894
- * Optional. The streaming options.
1895
- * @type {{ [key: string]: string; }}
1896
- * @memberof DynamicHlsApiGetHlsVideoSegment
1897
- */
1898
- readonly streamOptions?: {
1899
- [key: string]: string;
1900
- };
1901
- /**
1902
- * Optional. Whether to enable Audio Encoding.
1903
- * @type {boolean}
1904
- * @memberof DynamicHlsApiGetHlsVideoSegment
1905
- */
1906
- readonly enableAudioVbrEncoding?: boolean;
1907
- /**
1908
- * Whether to always burn in subtitles when transcoding.
1909
- * @type {boolean}
1910
- * @memberof DynamicHlsApiGetHlsVideoSegment
1911
- */
1912
- readonly alwaysBurnInSubtitleWhenTranscoding?: boolean;
1913
- }
1914
- /**
1915
- * Request parameters for getLiveHlsStream operation in DynamicHlsApi.
1916
- * @export
1917
- * @interface DynamicHlsApiGetLiveHlsStreamRequest
1918
- */
1919
- export interface DynamicHlsApiGetLiveHlsStreamRequest {
1920
- /**
1921
- * The item id.
1922
- * @type {string}
1923
- * @memberof DynamicHlsApiGetLiveHlsStream
1924
- */
1925
- readonly itemId: string;
1926
- /**
1927
- * The audio container.
1928
- * @type {string}
1929
- * @memberof DynamicHlsApiGetLiveHlsStream
1930
- */
1931
- readonly container?: string;
1932
- /**
1933
- * 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.
1934
- * @type {boolean}
1935
- * @memberof DynamicHlsApiGetLiveHlsStream
1936
- */
1937
- readonly _static?: boolean;
1938
- /**
1939
- * The streaming parameters.
1940
- * @type {string}
1941
- * @memberof DynamicHlsApiGetLiveHlsStream
1942
- */
1943
- readonly params?: string;
1944
- /**
1945
- * The tag.
1946
- * @type {string}
1947
- * @memberof DynamicHlsApiGetLiveHlsStream
1948
- */
1949
- readonly tag?: string;
1950
- /**
1951
- * Optional. The dlna device profile id to utilize.
1952
- * @type {string}
1953
- * @memberof DynamicHlsApiGetLiveHlsStream
1954
- */
1955
- readonly deviceProfileId?: string;
1956
- /**
1957
- * The play session id.
1958
- * @type {string}
1959
- * @memberof DynamicHlsApiGetLiveHlsStream
1960
- */
1961
- readonly playSessionId?: string;
1962
- /**
1963
- * The segment container.
1964
- * @type {string}
1965
- * @memberof DynamicHlsApiGetLiveHlsStream
1966
- */
1967
- readonly segmentContainer?: string;
1968
- /**
1969
- * The segment length.
1970
- * @type {number}
1971
- * @memberof DynamicHlsApiGetLiveHlsStream
1972
- */
1973
- readonly segmentLength?: number;
1974
- /**
1975
- * The minimum number of segments.
1976
- * @type {number}
1977
- * @memberof DynamicHlsApiGetLiveHlsStream
1978
- */
1979
- readonly minSegments?: number;
1980
- /**
1981
- * The media version id, if playing an alternate version.
1982
- * @type {string}
1983
- * @memberof DynamicHlsApiGetLiveHlsStream
1984
- */
1985
- readonly mediaSourceId?: string;
1986
- /**
1987
- * The device id of the client requesting. Used to stop encoding processes when needed.
1988
- * @type {string}
1989
- * @memberof DynamicHlsApiGetLiveHlsStream
1990
- */
1991
- readonly deviceId?: string;
1992
- /**
1993
- * Optional. Specify an audio codec to encode to, e.g. mp3.
1994
- * @type {string}
1995
- * @memberof DynamicHlsApiGetLiveHlsStream
1996
- */
1997
- readonly audioCodec?: string;
1998
- /**
1999
- * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
2000
- * @type {boolean}
2001
- * @memberof DynamicHlsApiGetLiveHlsStream
2002
- */
2003
- readonly enableAutoStreamCopy?: boolean;
2004
- /**
2005
- * Whether or not to allow copying of the video stream url.
2006
- * @type {boolean}
2007
- * @memberof DynamicHlsApiGetLiveHlsStream
2008
- */
2009
- readonly allowVideoStreamCopy?: boolean;
2010
- /**
2011
- * Whether or not to allow copying of the audio stream url.
2012
- * @type {boolean}
2013
- * @memberof DynamicHlsApiGetLiveHlsStream
2014
- */
2015
- readonly allowAudioStreamCopy?: boolean;
2016
- /**
2017
- * Optional. Whether to break on non key frames.
2018
- * @type {boolean}
2019
- * @memberof DynamicHlsApiGetLiveHlsStream
2020
- */
2021
- readonly breakOnNonKeyFrames?: boolean;
2022
- /**
2023
- * Optional. Specify a specific audio sample rate, e.g. 44100.
2024
- * @type {number}
2025
- * @memberof DynamicHlsApiGetLiveHlsStream
2026
- */
2027
- readonly audioSampleRate?: number;
2028
- /**
2029
- * Optional. The maximum audio bit depth.
2030
- * @type {number}
2031
- * @memberof DynamicHlsApiGetLiveHlsStream
2032
- */
2033
- readonly maxAudioBitDepth?: number;
2034
- /**
2035
- * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
2036
- * @type {number}
2037
- * @memberof DynamicHlsApiGetLiveHlsStream
2038
- */
2039
- readonly audioBitRate?: number;
2040
- /**
2041
- * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
2042
- * @type {number}
2043
- * @memberof DynamicHlsApiGetLiveHlsStream
2044
- */
2045
- readonly audioChannels?: number;
2046
- /**
2047
- * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
2048
- * @type {number}
2049
- * @memberof DynamicHlsApiGetLiveHlsStream
2050
- */
2051
- readonly maxAudioChannels?: number;
2052
- /**
2053
- * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
2054
- * @type {string}
2055
- * @memberof DynamicHlsApiGetLiveHlsStream
2056
- */
2057
- readonly profile?: string;
2058
- /**
2059
- * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
2060
- * @type {string}
2061
- * @memberof DynamicHlsApiGetLiveHlsStream
2062
- */
2063
- readonly level?: string;
2064
- /**
2065
- * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
2066
- * @type {number}
2067
- * @memberof DynamicHlsApiGetLiveHlsStream
2068
- */
2069
- readonly framerate?: number;
2070
- /**
2071
- * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
2072
- * @type {number}
2073
- * @memberof DynamicHlsApiGetLiveHlsStream
2074
- */
2075
- readonly maxFramerate?: number;
2076
- /**
2077
- * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
2078
- * @type {boolean}
2079
- * @memberof DynamicHlsApiGetLiveHlsStream
2080
- */
2081
- readonly copyTimestamps?: boolean;
2082
- /**
2083
- * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
2084
- * @type {number}
2085
- * @memberof DynamicHlsApiGetLiveHlsStream
2086
- */
2087
- readonly startTimeTicks?: number;
2088
- /**
2089
- * Optional. The fixed horizontal resolution of the encoded video.
2090
- * @type {number}
2091
- * @memberof DynamicHlsApiGetLiveHlsStream
2092
- */
2093
- readonly width?: number;
2094
- /**
2095
- * Optional. The fixed vertical resolution of the encoded video.
2096
- * @type {number}
2097
- * @memberof DynamicHlsApiGetLiveHlsStream
2098
- */
2099
- readonly height?: number;
2100
- /**
2101
- * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
2102
- * @type {number}
2103
- * @memberof DynamicHlsApiGetLiveHlsStream
2104
- */
2105
- readonly videoBitRate?: number;
2106
- /**
2107
- * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
2108
- * @type {number}
2109
- * @memberof DynamicHlsApiGetLiveHlsStream
2110
- */
2111
- readonly subtitleStreamIndex?: number;
2112
- /**
2113
- * Optional. Specify the subtitle delivery method.
2114
- * @type {SubtitleDeliveryMethod}
2115
- * @memberof DynamicHlsApiGetLiveHlsStream
2116
- */
2117
- readonly subtitleMethod?: SubtitleDeliveryMethod;
2118
- /**
2119
- * Optional.
2120
- * @type {number}
2121
- * @memberof DynamicHlsApiGetLiveHlsStream
2122
- */
2123
- readonly maxRefFrames?: number;
2124
- /**
2125
- * Optional. The maximum video bit depth.
2126
- * @type {number}
2127
- * @memberof DynamicHlsApiGetLiveHlsStream
2128
- */
2129
- readonly maxVideoBitDepth?: number;
2130
- /**
2131
- * Optional. Whether to require avc.
2132
- * @type {boolean}
2133
- * @memberof DynamicHlsApiGetLiveHlsStream
2134
- */
2135
- readonly requireAvc?: boolean;
2136
- /**
2137
- * Optional. Whether to deinterlace the video.
2138
- * @type {boolean}
2139
- * @memberof DynamicHlsApiGetLiveHlsStream
2140
- */
2141
- readonly deInterlace?: boolean;
2142
- /**
2143
- * Optional. Whether to require a non anamorphic stream.
2144
- * @type {boolean}
2145
- * @memberof DynamicHlsApiGetLiveHlsStream
2146
- */
2147
- readonly requireNonAnamorphic?: boolean;
2148
- /**
2149
- * Optional. The maximum number of audio channels to transcode.
2150
- * @type {number}
2151
- * @memberof DynamicHlsApiGetLiveHlsStream
2152
- */
2153
- readonly transcodingMaxAudioChannels?: number;
2154
- /**
2155
- * Optional. The limit of how many cpu cores to use.
2156
- * @type {number}
2157
- * @memberof DynamicHlsApiGetLiveHlsStream
2158
- */
2159
- readonly cpuCoreLimit?: number;
2160
- /**
2161
- * The live stream id.
2162
- * @type {string}
2163
- * @memberof DynamicHlsApiGetLiveHlsStream
2164
- */
2165
- readonly liveStreamId?: string;
2166
- /**
2167
- * Optional. Whether to enable the MpegtsM2Ts mode.
2168
- * @type {boolean}
2169
- * @memberof DynamicHlsApiGetLiveHlsStream
2170
- */
2171
- readonly enableMpegtsM2TsMode?: boolean;
2172
- /**
2173
- * Optional. Specify a video codec to encode to, e.g. h264.
2174
- * @type {string}
2175
- * @memberof DynamicHlsApiGetLiveHlsStream
2176
- */
2177
- readonly videoCodec?: string;
2178
- /**
2179
- * Optional. Specify a subtitle codec to encode to.
2180
- * @type {string}
2181
- * @memberof DynamicHlsApiGetLiveHlsStream
2182
- */
2183
- readonly subtitleCodec?: string;
2184
- /**
2185
- * Optional. The transcoding reason.
2186
- * @type {string}
2187
- * @memberof DynamicHlsApiGetLiveHlsStream
2188
- */
2189
- readonly transcodeReasons?: string;
2190
- /**
2191
- * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
2192
- * @type {number}
2193
- * @memberof DynamicHlsApiGetLiveHlsStream
2194
- */
2195
- readonly audioStreamIndex?: number;
2196
- /**
2197
- * Optional. The index of the video stream to use. If omitted the first video stream will be used.
2198
- * @type {number}
2199
- * @memberof DynamicHlsApiGetLiveHlsStream
2200
- */
2201
- readonly videoStreamIndex?: number;
2202
- /**
2203
- * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
2204
- * @type {EncodingContext}
2205
- * @memberof DynamicHlsApiGetLiveHlsStream
2206
- */
2207
- readonly context?: EncodingContext;
2208
- /**
2209
- * Optional. The streaming options.
2210
- * @type {{ [key: string]: string; }}
2211
- * @memberof DynamicHlsApiGetLiveHlsStream
2212
- */
2213
- readonly streamOptions?: {
2214
- [key: string]: string;
2215
- };
2216
- /**
2217
- * Optional. The max width.
2218
- * @type {number}
2219
- * @memberof DynamicHlsApiGetLiveHlsStream
2220
- */
2221
- readonly maxWidth?: number;
2222
- /**
2223
- * Optional. The max height.
2224
- * @type {number}
2225
- * @memberof DynamicHlsApiGetLiveHlsStream
2226
- */
2227
- readonly maxHeight?: number;
2228
- /**
2229
- * Optional. Whether to enable subtitles in the manifest.
2230
- * @type {boolean}
2231
- * @memberof DynamicHlsApiGetLiveHlsStream
2232
- */
2233
- readonly enableSubtitlesInManifest?: boolean;
2234
- /**
2235
- * Optional. Whether to enable Audio Encoding.
2236
- * @type {boolean}
2237
- * @memberof DynamicHlsApiGetLiveHlsStream
2238
- */
2239
- readonly enableAudioVbrEncoding?: boolean;
2240
- /**
2241
- * Whether to always burn in subtitles when transcoding.
2242
- * @type {boolean}
2243
- * @memberof DynamicHlsApiGetLiveHlsStream
2244
- */
2245
- readonly alwaysBurnInSubtitleWhenTranscoding?: boolean;
2246
- }
2247
- /**
2248
- * Request parameters for getMasterHlsAudioPlaylist operation in DynamicHlsApi.
2249
- * @export
2250
- * @interface DynamicHlsApiGetMasterHlsAudioPlaylistRequest
2251
- */
2252
- export interface DynamicHlsApiGetMasterHlsAudioPlaylistRequest {
2253
- /**
2254
- * The item id.
2255
- * @type {string}
2256
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2257
- */
2258
- readonly itemId: string;
2259
- /**
2260
- * The media version id, if playing an alternate version.
2261
- * @type {string}
2262
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2263
- */
2264
- readonly mediaSourceId: string;
2265
- /**
2266
- * 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.
2267
- * @type {boolean}
2268
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2269
- */
2270
- readonly _static?: boolean;
2271
- /**
2272
- * The streaming parameters.
2273
- * @type {string}
2274
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2275
- */
2276
- readonly params?: string;
2277
- /**
2278
- * The tag.
2279
- * @type {string}
2280
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2281
- */
2282
- readonly tag?: string;
2283
- /**
2284
- * Optional. The dlna device profile id to utilize.
2285
- * @type {string}
2286
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2287
- */
2288
- readonly deviceProfileId?: string;
2289
- /**
2290
- * The play session id.
2291
- * @type {string}
2292
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2293
- */
2294
- readonly playSessionId?: string;
2295
- /**
2296
- * The segment container.
2297
- * @type {string}
2298
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2299
- */
2300
- readonly segmentContainer?: string;
2301
- /**
2302
- * The segment length.
2303
- * @type {number}
2304
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2305
- */
2306
- readonly segmentLength?: number;
2307
- /**
2308
- * The minimum number of segments.
2309
- * @type {number}
2310
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2311
- */
2312
- readonly minSegments?: number;
2313
- /**
2314
- * The device id of the client requesting. Used to stop encoding processes when needed.
2315
- * @type {string}
2316
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2317
- */
2318
- readonly deviceId?: string;
2319
- /**
2320
- * Optional. Specify an audio codec to encode to, e.g. mp3.
2321
- * @type {string}
2322
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2323
- */
2324
- readonly audioCodec?: string;
2325
- /**
2326
- * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
2327
- * @type {boolean}
2328
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2329
- */
2330
- readonly enableAutoStreamCopy?: boolean;
2331
- /**
2332
- * Whether or not to allow copying of the video stream url.
2333
- * @type {boolean}
2334
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2335
- */
2336
- readonly allowVideoStreamCopy?: boolean;
2337
- /**
2338
- * Whether or not to allow copying of the audio stream url.
2339
- * @type {boolean}
2340
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2341
- */
2342
- readonly allowAudioStreamCopy?: boolean;
2343
- /**
2344
- * Optional. Whether to break on non key frames.
2345
- * @type {boolean}
2346
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2347
- */
2348
- readonly breakOnNonKeyFrames?: boolean;
2349
- /**
2350
- * Optional. Specify a specific audio sample rate, e.g. 44100.
2351
- * @type {number}
2352
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2353
- */
2354
- readonly audioSampleRate?: number;
2355
- /**
2356
- * Optional. The maximum audio bit depth.
2357
- * @type {number}
2358
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2359
- */
2360
- readonly maxAudioBitDepth?: number;
2361
- /**
2362
- * Optional. The maximum streaming bitrate.
2363
- * @type {number}
2364
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2365
- */
2366
- readonly maxStreamingBitrate?: number;
2367
- /**
2368
- * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
2369
- * @type {number}
2370
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2371
- */
2372
- readonly audioBitRate?: number;
2373
- /**
2374
- * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
2375
- * @type {number}
2376
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2377
- */
2378
- readonly audioChannels?: number;
2379
- /**
2380
- * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
2381
- * @type {number}
2382
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2383
- */
2384
- readonly maxAudioChannels?: number;
2385
- /**
2386
- * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
2387
- * @type {string}
2388
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2389
- */
2390
- readonly profile?: string;
2391
- /**
2392
- * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
2393
- * @type {string}
2394
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2395
- */
2396
- readonly level?: string;
2397
- /**
2398
- * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
2399
- * @type {number}
2400
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2401
- */
2402
- readonly framerate?: number;
2403
- /**
2404
- * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
2405
- * @type {number}
2406
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2407
- */
2408
- readonly maxFramerate?: number;
2409
- /**
2410
- * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
2411
- * @type {boolean}
2412
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2413
- */
2414
- readonly copyTimestamps?: boolean;
2415
- /**
2416
- * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
2417
- * @type {number}
2418
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2419
- */
2420
- readonly startTimeTicks?: number;
2421
- /**
2422
- * Optional. The fixed horizontal resolution of the encoded video.
2423
- * @type {number}
2424
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2425
- */
2426
- readonly width?: number;
2427
- /**
2428
- * Optional. The fixed vertical resolution of the encoded video.
2429
- * @type {number}
2430
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2431
- */
2432
- readonly height?: number;
2433
- /**
2434
- * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
2435
- * @type {number}
2436
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2437
- */
2438
- readonly videoBitRate?: number;
2439
- /**
2440
- * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
2441
- * @type {number}
2442
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2443
- */
2444
- readonly subtitleStreamIndex?: number;
2445
- /**
2446
- * Optional. Specify the subtitle delivery method.
2447
- * @type {SubtitleDeliveryMethod}
2448
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2449
- */
2450
- readonly subtitleMethod?: SubtitleDeliveryMethod;
2451
- /**
2452
- * Optional.
2453
- * @type {number}
2454
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2455
- */
2456
- readonly maxRefFrames?: number;
2457
- /**
2458
- * Optional. The maximum video bit depth.
2459
- * @type {number}
2460
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2461
- */
2462
- readonly maxVideoBitDepth?: number;
2463
- /**
2464
- * Optional. Whether to require avc.
2465
- * @type {boolean}
2466
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2467
- */
2468
- readonly requireAvc?: boolean;
2469
- /**
2470
- * Optional. Whether to deinterlace the video.
2471
- * @type {boolean}
2472
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2473
- */
2474
- readonly deInterlace?: boolean;
2475
- /**
2476
- * Optional. Whether to require a non anamorphic stream.
2477
- * @type {boolean}
2478
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2479
- */
2480
- readonly requireNonAnamorphic?: boolean;
2481
- /**
2482
- * Optional. The maximum number of audio channels to transcode.
2483
- * @type {number}
2484
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2485
- */
2486
- readonly transcodingMaxAudioChannels?: number;
2487
- /**
2488
- * Optional. The limit of how many cpu cores to use.
2489
- * @type {number}
2490
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2491
- */
2492
- readonly cpuCoreLimit?: number;
2493
- /**
2494
- * The live stream id.
2495
- * @type {string}
2496
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2497
- */
2498
- readonly liveStreamId?: string;
2499
- /**
2500
- * Optional. Whether to enable the MpegtsM2Ts mode.
2501
- * @type {boolean}
2502
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2503
- */
2504
- readonly enableMpegtsM2TsMode?: boolean;
2505
- /**
2506
- * Optional. Specify a video codec to encode to, e.g. h264.
2507
- * @type {string}
2508
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2509
- */
2510
- readonly videoCodec?: string;
2511
- /**
2512
- * Optional. Specify a subtitle codec to encode to.
2513
- * @type {string}
2514
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2515
- */
2516
- readonly subtitleCodec?: string;
2517
- /**
2518
- * Optional. The transcoding reason.
2519
- * @type {string}
2520
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2521
- */
2522
- readonly transcodeReasons?: string;
2523
- /**
2524
- * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
2525
- * @type {number}
2526
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2527
- */
2528
- readonly audioStreamIndex?: number;
2529
- /**
2530
- * Optional. The index of the video stream to use. If omitted the first video stream will be used.
2531
- * @type {number}
2532
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2533
- */
2534
- readonly videoStreamIndex?: number;
2535
- /**
2536
- * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
2537
- * @type {EncodingContext}
2538
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2539
- */
2540
- readonly context?: EncodingContext;
2541
- /**
2542
- * Optional. The streaming options.
2543
- * @type {{ [key: string]: string; }}
2544
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2545
- */
2546
- readonly streamOptions?: {
2547
- [key: string]: string;
2548
- };
2549
- /**
2550
- * Enable adaptive bitrate streaming.
2551
- * @type {boolean}
2552
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2553
- */
2554
- readonly enableAdaptiveBitrateStreaming?: boolean;
2555
- /**
2556
- * Optional. Whether to enable Audio Encoding.
2557
- * @type {boolean}
2558
- * @memberof DynamicHlsApiGetMasterHlsAudioPlaylist
2559
- */
2560
- readonly enableAudioVbrEncoding?: boolean;
2561
- }
2562
- /**
2563
- * Request parameters for getMasterHlsVideoPlaylist operation in DynamicHlsApi.
2564
- * @export
2565
- * @interface DynamicHlsApiGetMasterHlsVideoPlaylistRequest
2566
- */
2567
- export interface DynamicHlsApiGetMasterHlsVideoPlaylistRequest {
2568
- /**
2569
- * The item id.
2570
- * @type {string}
2571
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2572
- */
2573
- readonly itemId: string;
2574
- /**
2575
- * The media version id, if playing an alternate version.
2576
- * @type {string}
2577
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2578
- */
2579
- readonly mediaSourceId: string;
2580
- /**
2581
- * 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.
2582
- * @type {boolean}
2583
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2584
- */
2585
- readonly _static?: boolean;
2586
- /**
2587
- * The streaming parameters.
2588
- * @type {string}
2589
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2590
- */
2591
- readonly params?: string;
2592
- /**
2593
- * The tag.
2594
- * @type {string}
2595
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2596
- */
2597
- readonly tag?: string;
2598
- /**
2599
- * Optional. The dlna device profile id to utilize.
2600
- * @type {string}
2601
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2602
- */
2603
- readonly deviceProfileId?: string;
2604
- /**
2605
- * The play session id.
2606
- * @type {string}
2607
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2608
- */
2609
- readonly playSessionId?: string;
2610
- /**
2611
- * The segment container.
2612
- * @type {string}
2613
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2614
- */
2615
- readonly segmentContainer?: string;
2616
- /**
2617
- * The segment length.
2618
- * @type {number}
2619
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2620
- */
2621
- readonly segmentLength?: number;
2622
- /**
2623
- * The minimum number of segments.
2624
- * @type {number}
2625
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2626
- */
2627
- readonly minSegments?: number;
2628
- /**
2629
- * The device id of the client requesting. Used to stop encoding processes when needed.
2630
- * @type {string}
2631
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2632
- */
2633
- readonly deviceId?: string;
2634
- /**
2635
- * Optional. Specify an audio codec to encode to, e.g. mp3.
2636
- * @type {string}
2637
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2638
- */
2639
- readonly audioCodec?: string;
2640
- /**
2641
- * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
2642
- * @type {boolean}
2643
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2644
- */
2645
- readonly enableAutoStreamCopy?: boolean;
2646
- /**
2647
- * Whether or not to allow copying of the video stream url.
2648
- * @type {boolean}
2649
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2650
- */
2651
- readonly allowVideoStreamCopy?: boolean;
2652
- /**
2653
- * Whether or not to allow copying of the audio stream url.
2654
- * @type {boolean}
2655
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2656
- */
2657
- readonly allowAudioStreamCopy?: boolean;
2658
- /**
2659
- * Optional. Whether to break on non key frames.
2660
- * @type {boolean}
2661
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2662
- */
2663
- readonly breakOnNonKeyFrames?: boolean;
2664
- /**
2665
- * Optional. Specify a specific audio sample rate, e.g. 44100.
2666
- * @type {number}
2667
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2668
- */
2669
- readonly audioSampleRate?: number;
2670
- /**
2671
- * Optional. The maximum audio bit depth.
2672
- * @type {number}
2673
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2674
- */
2675
- readonly maxAudioBitDepth?: number;
2676
- /**
2677
- * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
2678
- * @type {number}
2679
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2680
- */
2681
- readonly audioBitRate?: number;
2682
- /**
2683
- * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
2684
- * @type {number}
2685
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2686
- */
2687
- readonly audioChannels?: number;
2688
- /**
2689
- * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
2690
- * @type {number}
2691
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2692
- */
2693
- readonly maxAudioChannels?: number;
2694
- /**
2695
- * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
2696
- * @type {string}
2697
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2698
- */
2699
- readonly profile?: string;
2700
- /**
2701
- * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
2702
- * @type {string}
2703
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2704
- */
2705
- readonly level?: string;
2706
- /**
2707
- * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
2708
- * @type {number}
2709
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2710
- */
2711
- readonly framerate?: number;
2712
- /**
2713
- * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
2714
- * @type {number}
2715
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2716
- */
2717
- readonly maxFramerate?: number;
2718
- /**
2719
- * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
2720
- * @type {boolean}
2721
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2722
- */
2723
- readonly copyTimestamps?: boolean;
2724
- /**
2725
- * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
2726
- * @type {number}
2727
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2728
- */
2729
- readonly startTimeTicks?: number;
2730
- /**
2731
- * Optional. The fixed horizontal resolution of the encoded video.
2732
- * @type {number}
2733
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2734
- */
2735
- readonly width?: number;
2736
- /**
2737
- * Optional. The fixed vertical resolution of the encoded video.
2738
- * @type {number}
2739
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2740
- */
2741
- readonly height?: number;
2742
- /**
2743
- * Optional. The maximum horizontal resolution of the encoded video.
2744
- * @type {number}
2745
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2746
- */
2747
- readonly maxWidth?: number;
2748
- /**
2749
- * Optional. The maximum vertical resolution of the encoded video.
2750
- * @type {number}
2751
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2752
- */
2753
- readonly maxHeight?: number;
2754
- /**
2755
- * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
2756
- * @type {number}
2757
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2758
- */
2759
- readonly videoBitRate?: number;
2760
- /**
2761
- * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
2762
- * @type {number}
2763
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2764
- */
2765
- readonly subtitleStreamIndex?: number;
2766
- /**
2767
- * Optional. Specify the subtitle delivery method.
2768
- * @type {SubtitleDeliveryMethod}
2769
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2770
- */
2771
- readonly subtitleMethod?: SubtitleDeliveryMethod;
2772
- /**
2773
- * Optional.
2774
- * @type {number}
2775
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2776
- */
2777
- readonly maxRefFrames?: number;
2778
- /**
2779
- * Optional. The maximum video bit depth.
2780
- * @type {number}
2781
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2782
- */
2783
- readonly maxVideoBitDepth?: number;
2784
- /**
2785
- * Optional. Whether to require avc.
2786
- * @type {boolean}
2787
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2788
- */
2789
- readonly requireAvc?: boolean;
2790
- /**
2791
- * Optional. Whether to deinterlace the video.
2792
- * @type {boolean}
2793
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2794
- */
2795
- readonly deInterlace?: boolean;
2796
- /**
2797
- * Optional. Whether to require a non anamorphic stream.
2798
- * @type {boolean}
2799
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2800
- */
2801
- readonly requireNonAnamorphic?: boolean;
2802
- /**
2803
- * Optional. The maximum number of audio channels to transcode.
2804
- * @type {number}
2805
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2806
- */
2807
- readonly transcodingMaxAudioChannels?: number;
2808
- /**
2809
- * Optional. The limit of how many cpu cores to use.
2810
- * @type {number}
2811
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2812
- */
2813
- readonly cpuCoreLimit?: number;
2814
- /**
2815
- * The live stream id.
2816
- * @type {string}
2817
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2818
- */
2819
- readonly liveStreamId?: string;
2820
- /**
2821
- * Optional. Whether to enable the MpegtsM2Ts mode.
2822
- * @type {boolean}
2823
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2824
- */
2825
- readonly enableMpegtsM2TsMode?: boolean;
2826
- /**
2827
- * Optional. Specify a video codec to encode to, e.g. h264.
2828
- * @type {string}
2829
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2830
- */
2831
- readonly videoCodec?: string;
2832
- /**
2833
- * Optional. Specify a subtitle codec to encode to.
2834
- * @type {string}
2835
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2836
- */
2837
- readonly subtitleCodec?: string;
2838
- /**
2839
- * Optional. The transcoding reason.
2840
- * @type {string}
2841
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2842
- */
2843
- readonly transcodeReasons?: string;
2844
- /**
2845
- * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
2846
- * @type {number}
2847
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2848
- */
2849
- readonly audioStreamIndex?: number;
2850
- /**
2851
- * Optional. The index of the video stream to use. If omitted the first video stream will be used.
2852
- * @type {number}
2853
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2854
- */
2855
- readonly videoStreamIndex?: number;
2856
- /**
2857
- * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
2858
- * @type {EncodingContext}
2859
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2860
- */
2861
- readonly context?: EncodingContext;
2862
- /**
2863
- * Optional. The streaming options.
2864
- * @type {{ [key: string]: string; }}
2865
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2866
- */
2867
- readonly streamOptions?: {
2868
- [key: string]: string;
2869
- };
2870
- /**
2871
- * Enable adaptive bitrate streaming.
2872
- * @type {boolean}
2873
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2874
- */
2875
- readonly enableAdaptiveBitrateStreaming?: boolean;
2876
- /**
2877
- * Enable trickplay image playlists being added to master playlist.
2878
- * @type {boolean}
2879
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2880
- */
2881
- readonly enableTrickplay?: boolean;
2882
- /**
2883
- * Whether to enable Audio Encoding.
2884
- * @type {boolean}
2885
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2886
- */
2887
- readonly enableAudioVbrEncoding?: boolean;
2888
- /**
2889
- * Whether to always burn in subtitles when transcoding.
2890
- * @type {boolean}
2891
- * @memberof DynamicHlsApiGetMasterHlsVideoPlaylist
2892
- */
2893
- readonly alwaysBurnInSubtitleWhenTranscoding?: boolean;
2894
- }
2895
- /**
2896
- * Request parameters for getVariantHlsAudioPlaylist operation in DynamicHlsApi.
2897
- * @export
2898
- * @interface DynamicHlsApiGetVariantHlsAudioPlaylistRequest
2899
- */
2900
- export interface DynamicHlsApiGetVariantHlsAudioPlaylistRequest {
2901
- /**
2902
- * The item id.
2903
- * @type {string}
2904
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2905
- */
2906
- readonly itemId: string;
2907
- /**
2908
- * 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.
2909
- * @type {boolean}
2910
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2911
- */
2912
- readonly _static?: boolean;
2913
- /**
2914
- * The streaming parameters.
2915
- * @type {string}
2916
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2917
- */
2918
- readonly params?: string;
2919
- /**
2920
- * The tag.
2921
- * @type {string}
2922
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2923
- */
2924
- readonly tag?: string;
2925
- /**
2926
- * Optional. The dlna device profile id to utilize.
2927
- * @type {string}
2928
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2929
- */
2930
- readonly deviceProfileId?: string;
2931
- /**
2932
- * The play session id.
2933
- * @type {string}
2934
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2935
- */
2936
- readonly playSessionId?: string;
2937
- /**
2938
- * The segment container.
2939
- * @type {string}
2940
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2941
- */
2942
- readonly segmentContainer?: string;
2943
- /**
2944
- * The segment length.
2945
- * @type {number}
2946
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2947
- */
2948
- readonly segmentLength?: number;
2949
- /**
2950
- * The minimum number of segments.
2951
- * @type {number}
2952
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2953
- */
2954
- readonly minSegments?: number;
2955
- /**
2956
- * The media version id, if playing an alternate version.
2957
- * @type {string}
2958
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2959
- */
2960
- readonly mediaSourceId?: string;
2961
- /**
2962
- * The device id of the client requesting. Used to stop encoding processes when needed.
2963
- * @type {string}
2964
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2965
- */
2966
- readonly deviceId?: string;
2967
- /**
2968
- * Optional. Specify an audio codec to encode to, e.g. mp3.
2969
- * @type {string}
2970
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2971
- */
2972
- readonly audioCodec?: string;
2973
- /**
2974
- * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
2975
- * @type {boolean}
2976
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2977
- */
2978
- readonly enableAutoStreamCopy?: boolean;
2979
- /**
2980
- * Whether or not to allow copying of the video stream url.
2981
- * @type {boolean}
2982
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2983
- */
2984
- readonly allowVideoStreamCopy?: boolean;
2985
- /**
2986
- * Whether or not to allow copying of the audio stream url.
2987
- * @type {boolean}
2988
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2989
- */
2990
- readonly allowAudioStreamCopy?: boolean;
2991
- /**
2992
- * Optional. Whether to break on non key frames.
2993
- * @type {boolean}
2994
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
2995
- */
2996
- readonly breakOnNonKeyFrames?: boolean;
2997
- /**
2998
- * Optional. Specify a specific audio sample rate, e.g. 44100.
2999
- * @type {number}
3000
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3001
- */
3002
- readonly audioSampleRate?: number;
3003
- /**
3004
- * Optional. The maximum audio bit depth.
3005
- * @type {number}
3006
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3007
- */
3008
- readonly maxAudioBitDepth?: number;
3009
- /**
3010
- * Optional. The maximum streaming bitrate.
3011
- * @type {number}
3012
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3013
- */
3014
- readonly maxStreamingBitrate?: number;
3015
- /**
3016
- * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
3017
- * @type {number}
3018
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3019
- */
3020
- readonly audioBitRate?: number;
3021
- /**
3022
- * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
3023
- * @type {number}
3024
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3025
- */
3026
- readonly audioChannels?: number;
3027
- /**
3028
- * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
3029
- * @type {number}
3030
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3031
- */
3032
- readonly maxAudioChannels?: number;
3033
- /**
3034
- * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
3035
- * @type {string}
3036
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3037
- */
3038
- readonly profile?: string;
3039
- /**
3040
- * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
3041
- * @type {string}
3042
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3043
- */
3044
- readonly level?: string;
3045
- /**
3046
- * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
3047
- * @type {number}
3048
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3049
- */
3050
- readonly framerate?: number;
3051
- /**
3052
- * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
3053
- * @type {number}
3054
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3055
- */
3056
- readonly maxFramerate?: number;
3057
- /**
3058
- * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
3059
- * @type {boolean}
3060
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3061
- */
3062
- readonly copyTimestamps?: boolean;
3063
- /**
3064
- * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
3065
- * @type {number}
3066
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3067
- */
3068
- readonly startTimeTicks?: number;
3069
- /**
3070
- * Optional. The fixed horizontal resolution of the encoded video.
3071
- * @type {number}
3072
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3073
- */
3074
- readonly width?: number;
3075
- /**
3076
- * Optional. The fixed vertical resolution of the encoded video.
3077
- * @type {number}
3078
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3079
- */
3080
- readonly height?: number;
3081
- /**
3082
- * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
3083
- * @type {number}
3084
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3085
- */
3086
- readonly videoBitRate?: number;
3087
- /**
3088
- * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
3089
- * @type {number}
3090
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3091
- */
3092
- readonly subtitleStreamIndex?: number;
3093
- /**
3094
- * Optional. Specify the subtitle delivery method.
3095
- * @type {SubtitleDeliveryMethod}
3096
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3097
- */
3098
- readonly subtitleMethod?: SubtitleDeliveryMethod;
3099
- /**
3100
- * Optional.
3101
- * @type {number}
3102
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3103
- */
3104
- readonly maxRefFrames?: number;
3105
- /**
3106
- * Optional. The maximum video bit depth.
3107
- * @type {number}
3108
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3109
- */
3110
- readonly maxVideoBitDepth?: number;
3111
- /**
3112
- * Optional. Whether to require avc.
3113
- * @type {boolean}
3114
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3115
- */
3116
- readonly requireAvc?: boolean;
3117
- /**
3118
- * Optional. Whether to deinterlace the video.
3119
- * @type {boolean}
3120
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3121
- */
3122
- readonly deInterlace?: boolean;
3123
- /**
3124
- * Optional. Whether to require a non anamorphic stream.
3125
- * @type {boolean}
3126
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3127
- */
3128
- readonly requireNonAnamorphic?: boolean;
3129
- /**
3130
- * Optional. The maximum number of audio channels to transcode.
3131
- * @type {number}
3132
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3133
- */
3134
- readonly transcodingMaxAudioChannels?: number;
3135
- /**
3136
- * Optional. The limit of how many cpu cores to use.
3137
- * @type {number}
3138
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3139
- */
3140
- readonly cpuCoreLimit?: number;
3141
- /**
3142
- * The live stream id.
3143
- * @type {string}
3144
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3145
- */
3146
- readonly liveStreamId?: string;
3147
- /**
3148
- * Optional. Whether to enable the MpegtsM2Ts mode.
3149
- * @type {boolean}
3150
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3151
- */
3152
- readonly enableMpegtsM2TsMode?: boolean;
3153
- /**
3154
- * Optional. Specify a video codec to encode to, e.g. h264.
3155
- * @type {string}
3156
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3157
- */
3158
- readonly videoCodec?: string;
3159
- /**
3160
- * Optional. Specify a subtitle codec to encode to.
3161
- * @type {string}
3162
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3163
- */
3164
- readonly subtitleCodec?: string;
3165
- /**
3166
- * Optional. The transcoding reason.
3167
- * @type {string}
3168
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3169
- */
3170
- readonly transcodeReasons?: string;
3171
- /**
3172
- * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
3173
- * @type {number}
3174
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3175
- */
3176
- readonly audioStreamIndex?: number;
3177
- /**
3178
- * Optional. The index of the video stream to use. If omitted the first video stream will be used.
3179
- * @type {number}
3180
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3181
- */
3182
- readonly videoStreamIndex?: number;
3183
- /**
3184
- * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
3185
- * @type {EncodingContext}
3186
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3187
- */
3188
- readonly context?: EncodingContext;
3189
- /**
3190
- * Optional. The streaming options.
3191
- * @type {{ [key: string]: string; }}
3192
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3193
- */
3194
- readonly streamOptions?: {
3195
- [key: string]: string;
3196
- };
3197
- /**
3198
- * Optional. Whether to enable Audio Encoding.
3199
- * @type {boolean}
3200
- * @memberof DynamicHlsApiGetVariantHlsAudioPlaylist
3201
- */
3202
- readonly enableAudioVbrEncoding?: boolean;
3203
- }
3204
- /**
3205
- * Request parameters for getVariantHlsVideoPlaylist operation in DynamicHlsApi.
3206
- * @export
3207
- * @interface DynamicHlsApiGetVariantHlsVideoPlaylistRequest
3208
- */
3209
- export interface DynamicHlsApiGetVariantHlsVideoPlaylistRequest {
3210
- /**
3211
- * The item id.
3212
- * @type {string}
3213
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3214
- */
3215
- readonly itemId: string;
3216
- /**
3217
- * 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.
3218
- * @type {boolean}
3219
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3220
- */
3221
- readonly _static?: boolean;
3222
- /**
3223
- * The streaming parameters.
3224
- * @type {string}
3225
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3226
- */
3227
- readonly params?: string;
3228
- /**
3229
- * The tag.
3230
- * @type {string}
3231
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3232
- */
3233
- readonly tag?: string;
3234
- /**
3235
- * Optional. The dlna device profile id to utilize.
3236
- * @type {string}
3237
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3238
- */
3239
- readonly deviceProfileId?: string;
3240
- /**
3241
- * The play session id.
3242
- * @type {string}
3243
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3244
- */
3245
- readonly playSessionId?: string;
3246
- /**
3247
- * The segment container.
3248
- * @type {string}
3249
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3250
- */
3251
- readonly segmentContainer?: string;
3252
- /**
3253
- * The segment length.
3254
- * @type {number}
3255
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3256
- */
3257
- readonly segmentLength?: number;
3258
- /**
3259
- * The minimum number of segments.
3260
- * @type {number}
3261
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3262
- */
3263
- readonly minSegments?: number;
3264
- /**
3265
- * The media version id, if playing an alternate version.
3266
- * @type {string}
3267
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3268
- */
3269
- readonly mediaSourceId?: string;
3270
- /**
3271
- * The device id of the client requesting. Used to stop encoding processes when needed.
3272
- * @type {string}
3273
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3274
- */
3275
- readonly deviceId?: string;
3276
- /**
3277
- * Optional. Specify an audio codec to encode to, e.g. mp3.
3278
- * @type {string}
3279
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3280
- */
3281
- readonly audioCodec?: string;
3282
- /**
3283
- * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
3284
- * @type {boolean}
3285
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3286
- */
3287
- readonly enableAutoStreamCopy?: boolean;
3288
- /**
3289
- * Whether or not to allow copying of the video stream url.
3290
- * @type {boolean}
3291
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3292
- */
3293
- readonly allowVideoStreamCopy?: boolean;
3294
- /**
3295
- * Whether or not to allow copying of the audio stream url.
3296
- * @type {boolean}
3297
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3298
- */
3299
- readonly allowAudioStreamCopy?: boolean;
3300
- /**
3301
- * Optional. Whether to break on non key frames.
3302
- * @type {boolean}
3303
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3304
- */
3305
- readonly breakOnNonKeyFrames?: boolean;
3306
- /**
3307
- * Optional. Specify a specific audio sample rate, e.g. 44100.
3308
- * @type {number}
3309
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3310
- */
3311
- readonly audioSampleRate?: number;
3312
- /**
3313
- * Optional. The maximum audio bit depth.
3314
- * @type {number}
3315
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3316
- */
3317
- readonly maxAudioBitDepth?: number;
3318
- /**
3319
- * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
3320
- * @type {number}
3321
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3322
- */
3323
- readonly audioBitRate?: number;
3324
- /**
3325
- * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
3326
- * @type {number}
3327
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3328
- */
3329
- readonly audioChannels?: number;
3330
- /**
3331
- * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
3332
- * @type {number}
3333
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3334
- */
3335
- readonly maxAudioChannels?: number;
3336
- /**
3337
- * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
3338
- * @type {string}
3339
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3340
- */
3341
- readonly profile?: string;
3342
- /**
3343
- * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
3344
- * @type {string}
3345
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3346
- */
3347
- readonly level?: string;
3348
- /**
3349
- * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
3350
- * @type {number}
3351
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3352
- */
3353
- readonly framerate?: number;
3354
- /**
3355
- * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
3356
- * @type {number}
3357
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3358
- */
3359
- readonly maxFramerate?: number;
3360
- /**
3361
- * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
3362
- * @type {boolean}
3363
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3364
- */
3365
- readonly copyTimestamps?: boolean;
3366
- /**
3367
- * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
3368
- * @type {number}
3369
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3370
- */
3371
- readonly startTimeTicks?: number;
3372
- /**
3373
- * Optional. The fixed horizontal resolution of the encoded video.
3374
- * @type {number}
3375
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3376
- */
3377
- readonly width?: number;
3378
- /**
3379
- * Optional. The fixed vertical resolution of the encoded video.
3380
- * @type {number}
3381
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3382
- */
3383
- readonly height?: number;
3384
- /**
3385
- * Optional. The maximum horizontal resolution of the encoded video.
3386
- * @type {number}
3387
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3388
- */
3389
- readonly maxWidth?: number;
3390
- /**
3391
- * Optional. The maximum vertical resolution of the encoded video.
3392
- * @type {number}
3393
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3394
- */
3395
- readonly maxHeight?: number;
3396
- /**
3397
- * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
3398
- * @type {number}
3399
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3400
- */
3401
- readonly videoBitRate?: number;
3402
- /**
3403
- * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
3404
- * @type {number}
3405
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3406
- */
3407
- readonly subtitleStreamIndex?: number;
3408
- /**
3409
- * Optional. Specify the subtitle delivery method.
3410
- * @type {SubtitleDeliveryMethod}
3411
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3412
- */
3413
- readonly subtitleMethod?: SubtitleDeliveryMethod;
3414
- /**
3415
- * Optional.
3416
- * @type {number}
3417
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3418
- */
3419
- readonly maxRefFrames?: number;
3420
- /**
3421
- * Optional. The maximum video bit depth.
3422
- * @type {number}
3423
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3424
- */
3425
- readonly maxVideoBitDepth?: number;
3426
- /**
3427
- * Optional. Whether to require avc.
3428
- * @type {boolean}
3429
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3430
- */
3431
- readonly requireAvc?: boolean;
3432
- /**
3433
- * Optional. Whether to deinterlace the video.
3434
- * @type {boolean}
3435
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3436
- */
3437
- readonly deInterlace?: boolean;
3438
- /**
3439
- * Optional. Whether to require a non anamorphic stream.
3440
- * @type {boolean}
3441
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3442
- */
3443
- readonly requireNonAnamorphic?: boolean;
3444
- /**
3445
- * Optional. The maximum number of audio channels to transcode.
3446
- * @type {number}
3447
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3448
- */
3449
- readonly transcodingMaxAudioChannels?: number;
3450
- /**
3451
- * Optional. The limit of how many cpu cores to use.
3452
- * @type {number}
3453
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3454
- */
3455
- readonly cpuCoreLimit?: number;
3456
- /**
3457
- * The live stream id.
3458
- * @type {string}
3459
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3460
- */
3461
- readonly liveStreamId?: string;
3462
- /**
3463
- * Optional. Whether to enable the MpegtsM2Ts mode.
3464
- * @type {boolean}
3465
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3466
- */
3467
- readonly enableMpegtsM2TsMode?: boolean;
3468
- /**
3469
- * Optional. Specify a video codec to encode to, e.g. h264.
3470
- * @type {string}
3471
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3472
- */
3473
- readonly videoCodec?: string;
3474
- /**
3475
- * Optional. Specify a subtitle codec to encode to.
3476
- * @type {string}
3477
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3478
- */
3479
- readonly subtitleCodec?: string;
3480
- /**
3481
- * Optional. The transcoding reason.
3482
- * @type {string}
3483
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3484
- */
3485
- readonly transcodeReasons?: string;
3486
- /**
3487
- * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
3488
- * @type {number}
3489
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3490
- */
3491
- readonly audioStreamIndex?: number;
3492
- /**
3493
- * Optional. The index of the video stream to use. If omitted the first video stream will be used.
3494
- * @type {number}
3495
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3496
- */
3497
- readonly videoStreamIndex?: number;
3498
- /**
3499
- * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
3500
- * @type {EncodingContext}
3501
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3502
- */
3503
- readonly context?: EncodingContext;
3504
- /**
3505
- * Optional. The streaming options.
3506
- * @type {{ [key: string]: string; }}
3507
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3508
- */
3509
- readonly streamOptions?: {
3510
- [key: string]: string;
3511
- };
3512
- /**
3513
- * Optional. Whether to enable Audio Encoding.
3514
- * @type {boolean}
3515
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3516
- */
3517
- readonly enableAudioVbrEncoding?: boolean;
3518
- /**
3519
- * Whether to always burn in subtitles when transcoding.
3520
- * @type {boolean}
3521
- * @memberof DynamicHlsApiGetVariantHlsVideoPlaylist
3522
- */
3523
- readonly alwaysBurnInSubtitleWhenTranscoding?: boolean;
3524
- }
3525
- /**
3526
- * Request parameters for headMasterHlsAudioPlaylist operation in DynamicHlsApi.
3527
- * @export
3528
- * @interface DynamicHlsApiHeadMasterHlsAudioPlaylistRequest
3529
- */
3530
- export interface DynamicHlsApiHeadMasterHlsAudioPlaylistRequest {
3531
- /**
3532
- * The item id.
3533
- * @type {string}
3534
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3535
- */
3536
- readonly itemId: string;
3537
- /**
3538
- * The media version id, if playing an alternate version.
3539
- * @type {string}
3540
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3541
- */
3542
- readonly mediaSourceId: string;
3543
- /**
3544
- * 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.
3545
- * @type {boolean}
3546
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3547
- */
3548
- readonly _static?: boolean;
3549
- /**
3550
- * The streaming parameters.
3551
- * @type {string}
3552
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3553
- */
3554
- readonly params?: string;
3555
- /**
3556
- * The tag.
3557
- * @type {string}
3558
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3559
- */
3560
- readonly tag?: string;
3561
- /**
3562
- * Optional. The dlna device profile id to utilize.
3563
- * @type {string}
3564
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3565
- */
3566
- readonly deviceProfileId?: string;
3567
- /**
3568
- * The play session id.
3569
- * @type {string}
3570
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3571
- */
3572
- readonly playSessionId?: string;
3573
- /**
3574
- * The segment container.
3575
- * @type {string}
3576
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3577
- */
3578
- readonly segmentContainer?: string;
3579
- /**
3580
- * The segment length.
3581
- * @type {number}
3582
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3583
- */
3584
- readonly segmentLength?: number;
3585
- /**
3586
- * The minimum number of segments.
3587
- * @type {number}
3588
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3589
- */
3590
- readonly minSegments?: number;
3591
- /**
3592
- * The device id of the client requesting. Used to stop encoding processes when needed.
3593
- * @type {string}
3594
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3595
- */
3596
- readonly deviceId?: string;
3597
- /**
3598
- * Optional. Specify an audio codec to encode to, e.g. mp3.
3599
- * @type {string}
3600
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3601
- */
3602
- readonly audioCodec?: string;
3603
- /**
3604
- * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
3605
- * @type {boolean}
3606
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3607
- */
3608
- readonly enableAutoStreamCopy?: boolean;
3609
- /**
3610
- * Whether or not to allow copying of the video stream url.
3611
- * @type {boolean}
3612
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3613
- */
3614
- readonly allowVideoStreamCopy?: boolean;
3615
- /**
3616
- * Whether or not to allow copying of the audio stream url.
3617
- * @type {boolean}
3618
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3619
- */
3620
- readonly allowAudioStreamCopy?: boolean;
3621
- /**
3622
- * Optional. Whether to break on non key frames.
3623
- * @type {boolean}
3624
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3625
- */
3626
- readonly breakOnNonKeyFrames?: boolean;
3627
- /**
3628
- * Optional. Specify a specific audio sample rate, e.g. 44100.
3629
- * @type {number}
3630
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3631
- */
3632
- readonly audioSampleRate?: number;
3633
- /**
3634
- * Optional. The maximum audio bit depth.
3635
- * @type {number}
3636
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3637
- */
3638
- readonly maxAudioBitDepth?: number;
3639
- /**
3640
- * Optional. The maximum streaming bitrate.
3641
- * @type {number}
3642
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3643
- */
3644
- readonly maxStreamingBitrate?: number;
3645
- /**
3646
- * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
3647
- * @type {number}
3648
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3649
- */
3650
- readonly audioBitRate?: number;
3651
- /**
3652
- * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
3653
- * @type {number}
3654
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3655
- */
3656
- readonly audioChannels?: number;
3657
- /**
3658
- * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
3659
- * @type {number}
3660
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3661
- */
3662
- readonly maxAudioChannels?: number;
3663
- /**
3664
- * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
3665
- * @type {string}
3666
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3667
- */
3668
- readonly profile?: string;
3669
- /**
3670
- * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
3671
- * @type {string}
3672
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3673
- */
3674
- readonly level?: string;
3675
- /**
3676
- * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
3677
- * @type {number}
3678
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3679
- */
3680
- readonly framerate?: number;
3681
- /**
3682
- * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
3683
- * @type {number}
3684
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3685
- */
3686
- readonly maxFramerate?: number;
3687
- /**
3688
- * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
3689
- * @type {boolean}
3690
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3691
- */
3692
- readonly copyTimestamps?: boolean;
3693
- /**
3694
- * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
3695
- * @type {number}
3696
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3697
- */
3698
- readonly startTimeTicks?: number;
3699
- /**
3700
- * Optional. The fixed horizontal resolution of the encoded video.
3701
- * @type {number}
3702
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3703
- */
3704
- readonly width?: number;
3705
- /**
3706
- * Optional. The fixed vertical resolution of the encoded video.
3707
- * @type {number}
3708
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3709
- */
3710
- readonly height?: number;
3711
- /**
3712
- * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
3713
- * @type {number}
3714
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3715
- */
3716
- readonly videoBitRate?: number;
3717
- /**
3718
- * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
3719
- * @type {number}
3720
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3721
- */
3722
- readonly subtitleStreamIndex?: number;
3723
- /**
3724
- * Optional. Specify the subtitle delivery method.
3725
- * @type {SubtitleDeliveryMethod}
3726
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3727
- */
3728
- readonly subtitleMethod?: SubtitleDeliveryMethod;
3729
- /**
3730
- * Optional.
3731
- * @type {number}
3732
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3733
- */
3734
- readonly maxRefFrames?: number;
3735
- /**
3736
- * Optional. The maximum video bit depth.
3737
- * @type {number}
3738
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3739
- */
3740
- readonly maxVideoBitDepth?: number;
3741
- /**
3742
- * Optional. Whether to require avc.
3743
- * @type {boolean}
3744
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3745
- */
3746
- readonly requireAvc?: boolean;
3747
- /**
3748
- * Optional. Whether to deinterlace the video.
3749
- * @type {boolean}
3750
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3751
- */
3752
- readonly deInterlace?: boolean;
3753
- /**
3754
- * Optional. Whether to require a non anamorphic stream.
3755
- * @type {boolean}
3756
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3757
- */
3758
- readonly requireNonAnamorphic?: boolean;
3759
- /**
3760
- * Optional. The maximum number of audio channels to transcode.
3761
- * @type {number}
3762
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3763
- */
3764
- readonly transcodingMaxAudioChannels?: number;
3765
- /**
3766
- * Optional. The limit of how many cpu cores to use.
3767
- * @type {number}
3768
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3769
- */
3770
- readonly cpuCoreLimit?: number;
3771
- /**
3772
- * The live stream id.
3773
- * @type {string}
3774
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3775
- */
3776
- readonly liveStreamId?: string;
3777
- /**
3778
- * Optional. Whether to enable the MpegtsM2Ts mode.
3779
- * @type {boolean}
3780
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3781
- */
3782
- readonly enableMpegtsM2TsMode?: boolean;
3783
- /**
3784
- * Optional. Specify a video codec to encode to, e.g. h264.
3785
- * @type {string}
3786
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3787
- */
3788
- readonly videoCodec?: string;
3789
- /**
3790
- * Optional. Specify a subtitle codec to encode to.
3791
- * @type {string}
3792
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3793
- */
3794
- readonly subtitleCodec?: string;
3795
- /**
3796
- * Optional. The transcoding reason.
3797
- * @type {string}
3798
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3799
- */
3800
- readonly transcodeReasons?: string;
3801
- /**
3802
- * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
3803
- * @type {number}
3804
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3805
- */
3806
- readonly audioStreamIndex?: number;
3807
- /**
3808
- * Optional. The index of the video stream to use. If omitted the first video stream will be used.
3809
- * @type {number}
3810
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3811
- */
3812
- readonly videoStreamIndex?: number;
3813
- /**
3814
- * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
3815
- * @type {EncodingContext}
3816
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3817
- */
3818
- readonly context?: EncodingContext;
3819
- /**
3820
- * Optional. The streaming options.
3821
- * @type {{ [key: string]: string; }}
3822
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3823
- */
3824
- readonly streamOptions?: {
3825
- [key: string]: string;
3826
- };
3827
- /**
3828
- * Enable adaptive bitrate streaming.
3829
- * @type {boolean}
3830
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3831
- */
3832
- readonly enableAdaptiveBitrateStreaming?: boolean;
3833
- /**
3834
- * Optional. Whether to enable Audio Encoding.
3835
- * @type {boolean}
3836
- * @memberof DynamicHlsApiHeadMasterHlsAudioPlaylist
3837
- */
3838
- readonly enableAudioVbrEncoding?: boolean;
3839
- }
3840
- /**
3841
- * Request parameters for headMasterHlsVideoPlaylist operation in DynamicHlsApi.
3842
- * @export
3843
- * @interface DynamicHlsApiHeadMasterHlsVideoPlaylistRequest
3844
- */
3845
- export interface DynamicHlsApiHeadMasterHlsVideoPlaylistRequest {
3846
- /**
3847
- * The item id.
3848
- * @type {string}
3849
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3850
- */
3851
- readonly itemId: string;
3852
- /**
3853
- * The media version id, if playing an alternate version.
3854
- * @type {string}
3855
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3856
- */
3857
- readonly mediaSourceId: string;
3858
- /**
3859
- * 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.
3860
- * @type {boolean}
3861
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3862
- */
3863
- readonly _static?: boolean;
3864
- /**
3865
- * The streaming parameters.
3866
- * @type {string}
3867
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3868
- */
3869
- readonly params?: string;
3870
- /**
3871
- * The tag.
3872
- * @type {string}
3873
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3874
- */
3875
- readonly tag?: string;
3876
- /**
3877
- * Optional. The dlna device profile id to utilize.
3878
- * @type {string}
3879
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3880
- */
3881
- readonly deviceProfileId?: string;
3882
- /**
3883
- * The play session id.
3884
- * @type {string}
3885
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3886
- */
3887
- readonly playSessionId?: string;
3888
- /**
3889
- * The segment container.
3890
- * @type {string}
3891
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3892
- */
3893
- readonly segmentContainer?: string;
3894
- /**
3895
- * The segment length.
3896
- * @type {number}
3897
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3898
- */
3899
- readonly segmentLength?: number;
3900
- /**
3901
- * The minimum number of segments.
3902
- * @type {number}
3903
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3904
- */
3905
- readonly minSegments?: number;
3906
- /**
3907
- * The device id of the client requesting. Used to stop encoding processes when needed.
3908
- * @type {string}
3909
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3910
- */
3911
- readonly deviceId?: string;
3912
- /**
3913
- * Optional. Specify an audio codec to encode to, e.g. mp3.
3914
- * @type {string}
3915
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3916
- */
3917
- readonly audioCodec?: string;
3918
- /**
3919
- * Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
3920
- * @type {boolean}
3921
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3922
- */
3923
- readonly enableAutoStreamCopy?: boolean;
3924
- /**
3925
- * Whether or not to allow copying of the video stream url.
3926
- * @type {boolean}
3927
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3928
- */
3929
- readonly allowVideoStreamCopy?: boolean;
3930
- /**
3931
- * Whether or not to allow copying of the audio stream url.
3932
- * @type {boolean}
3933
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3934
- */
3935
- readonly allowAudioStreamCopy?: boolean;
3936
- /**
3937
- * Optional. Whether to break on non key frames.
3938
- * @type {boolean}
3939
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3940
- */
3941
- readonly breakOnNonKeyFrames?: boolean;
3942
- /**
3943
- * Optional. Specify a specific audio sample rate, e.g. 44100.
3944
- * @type {number}
3945
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3946
- */
3947
- readonly audioSampleRate?: number;
3948
- /**
3949
- * Optional. The maximum audio bit depth.
3950
- * @type {number}
3951
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3952
- */
3953
- readonly maxAudioBitDepth?: number;
3954
- /**
3955
- * Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
3956
- * @type {number}
3957
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3958
- */
3959
- readonly audioBitRate?: number;
3960
- /**
3961
- * Optional. Specify a specific number of audio channels to encode to, e.g. 2.
3962
- * @type {number}
3963
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3964
- */
3965
- readonly audioChannels?: number;
3966
- /**
3967
- * Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
3968
- * @type {number}
3969
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3970
- */
3971
- readonly maxAudioChannels?: number;
3972
- /**
3973
- * Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
3974
- * @type {string}
3975
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3976
- */
3977
- readonly profile?: string;
3978
- /**
3979
- * Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
3980
- * @type {string}
3981
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3982
- */
3983
- readonly level?: string;
3984
- /**
3985
- * Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
3986
- * @type {number}
3987
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3988
- */
3989
- readonly framerate?: number;
3990
- /**
3991
- * Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
3992
- * @type {number}
3993
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
3994
- */
3995
- readonly maxFramerate?: number;
3996
- /**
3997
- * Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
3998
- * @type {boolean}
3999
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4000
- */
4001
- readonly copyTimestamps?: boolean;
4002
- /**
4003
- * Optional. Specify a starting offset, in ticks. 1 tick &#x3D; 10000 ms.
4004
- * @type {number}
4005
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4006
- */
4007
- readonly startTimeTicks?: number;
4008
- /**
4009
- * Optional. The fixed horizontal resolution of the encoded video.
4010
- * @type {number}
4011
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4012
- */
4013
- readonly width?: number;
4014
- /**
4015
- * Optional. The fixed vertical resolution of the encoded video.
4016
- * @type {number}
4017
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4018
- */
4019
- readonly height?: number;
4020
- /**
4021
- * Optional. The maximum horizontal resolution of the encoded video.
4022
- * @type {number}
4023
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4024
- */
4025
- readonly maxWidth?: number;
4026
- /**
4027
- * Optional. The maximum vertical resolution of the encoded video.
4028
- * @type {number}
4029
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4030
- */
4031
- readonly maxHeight?: number;
4032
- /**
4033
- * Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
4034
- * @type {number}
4035
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4036
- */
4037
- readonly videoBitRate?: number;
4038
- /**
4039
- * Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
4040
- * @type {number}
4041
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4042
- */
4043
- readonly subtitleStreamIndex?: number;
4044
- /**
4045
- * Optional. Specify the subtitle delivery method.
4046
- * @type {SubtitleDeliveryMethod}
4047
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4048
- */
4049
- readonly subtitleMethod?: SubtitleDeliveryMethod;
4050
- /**
4051
- * Optional.
4052
- * @type {number}
4053
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4054
- */
4055
- readonly maxRefFrames?: number;
4056
- /**
4057
- * Optional. The maximum video bit depth.
4058
- * @type {number}
4059
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4060
- */
4061
- readonly maxVideoBitDepth?: number;
4062
- /**
4063
- * Optional. Whether to require avc.
4064
- * @type {boolean}
4065
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4066
- */
4067
- readonly requireAvc?: boolean;
4068
- /**
4069
- * Optional. Whether to deinterlace the video.
4070
- * @type {boolean}
4071
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4072
- */
4073
- readonly deInterlace?: boolean;
4074
- /**
4075
- * Optional. Whether to require a non anamorphic stream.
4076
- * @type {boolean}
4077
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4078
- */
4079
- readonly requireNonAnamorphic?: boolean;
4080
- /**
4081
- * Optional. The maximum number of audio channels to transcode.
4082
- * @type {number}
4083
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4084
- */
4085
- readonly transcodingMaxAudioChannels?: number;
4086
- /**
4087
- * Optional. The limit of how many cpu cores to use.
4088
- * @type {number}
4089
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4090
- */
4091
- readonly cpuCoreLimit?: number;
4092
- /**
4093
- * The live stream id.
4094
- * @type {string}
4095
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4096
- */
4097
- readonly liveStreamId?: string;
4098
- /**
4099
- * Optional. Whether to enable the MpegtsM2Ts mode.
4100
- * @type {boolean}
4101
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4102
- */
4103
- readonly enableMpegtsM2TsMode?: boolean;
4104
- /**
4105
- * Optional. Specify a video codec to encode to, e.g. h264.
4106
- * @type {string}
4107
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4108
- */
4109
- readonly videoCodec?: string;
4110
- /**
4111
- * Optional. Specify a subtitle codec to encode to.
4112
- * @type {string}
4113
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4114
- */
4115
- readonly subtitleCodec?: string;
4116
- /**
4117
- * Optional. The transcoding reason.
4118
- * @type {string}
4119
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4120
- */
4121
- readonly transcodeReasons?: string;
4122
- /**
4123
- * Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
4124
- * @type {number}
4125
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4126
- */
4127
- readonly audioStreamIndex?: number;
4128
- /**
4129
- * Optional. The index of the video stream to use. If omitted the first video stream will be used.
4130
- * @type {number}
4131
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4132
- */
4133
- readonly videoStreamIndex?: number;
4134
- /**
4135
- * Optional. The MediaBrowser.Model.Dlna.EncodingContext.
4136
- * @type {EncodingContext}
4137
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4138
- */
4139
- readonly context?: EncodingContext;
4140
- /**
4141
- * Optional. The streaming options.
4142
- * @type {{ [key: string]: string; }}
4143
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4144
- */
4145
- readonly streamOptions?: {
4146
- [key: string]: string;
4147
- };
4148
- /**
4149
- * Enable adaptive bitrate streaming.
4150
- * @type {boolean}
4151
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4152
- */
4153
- readonly enableAdaptiveBitrateStreaming?: boolean;
4154
- /**
4155
- * Enable trickplay image playlists being added to master playlist.
4156
- * @type {boolean}
4157
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4158
- */
4159
- readonly enableTrickplay?: boolean;
4160
- /**
4161
- * Whether to enable Audio Encoding.
4162
- * @type {boolean}
4163
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4164
- */
4165
- readonly enableAudioVbrEncoding?: boolean;
4166
- /**
4167
- * Whether to always burn in subtitles when transcoding.
4168
- * @type {boolean}
4169
- * @memberof DynamicHlsApiHeadMasterHlsVideoPlaylist
4170
- */
4171
- readonly alwaysBurnInSubtitleWhenTranscoding?: boolean;
4172
- }
4173
- /**
4174
- * DynamicHlsApi - object-oriented interface
4175
- * @export
4176
- * @class DynamicHlsApi
4177
- * @extends {BaseAPI}
4178
- */
4179
- export declare class DynamicHlsApi extends BaseAPI {
4180
- /**
4181
- *
4182
- * @summary Gets a video stream using HTTP live streaming.
4183
- * @param {DynamicHlsApiGetHlsAudioSegmentRequest} requestParameters Request parameters.
4184
- * @param {*} [options] Override http request option.
4185
- * @throws {RequiredError}
4186
- * @memberof DynamicHlsApi
4187
- */
4188
- getHlsAudioSegment(requestParameters: DynamicHlsApiGetHlsAudioSegmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4189
- /**
4190
- *
4191
- * @summary Gets a video stream using HTTP live streaming.
4192
- * @param {DynamicHlsApiGetHlsVideoSegmentRequest} requestParameters Request parameters.
4193
- * @param {*} [options] Override http request option.
4194
- * @throws {RequiredError}
4195
- * @memberof DynamicHlsApi
4196
- */
4197
- getHlsVideoSegment(requestParameters: DynamicHlsApiGetHlsVideoSegmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4198
- /**
4199
- *
4200
- * @summary Gets a hls live stream.
4201
- * @param {DynamicHlsApiGetLiveHlsStreamRequest} requestParameters Request parameters.
4202
- * @param {*} [options] Override http request option.
4203
- * @throws {RequiredError}
4204
- * @memberof DynamicHlsApi
4205
- */
4206
- getLiveHlsStream(requestParameters: DynamicHlsApiGetLiveHlsStreamRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4207
- /**
4208
- *
4209
- * @summary Gets an audio hls playlist stream.
4210
- * @param {DynamicHlsApiGetMasterHlsAudioPlaylistRequest} requestParameters Request parameters.
4211
- * @param {*} [options] Override http request option.
4212
- * @throws {RequiredError}
4213
- * @memberof DynamicHlsApi
4214
- */
4215
- getMasterHlsAudioPlaylist(requestParameters: DynamicHlsApiGetMasterHlsAudioPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4216
- /**
4217
- *
4218
- * @summary Gets a video hls playlist stream.
4219
- * @param {DynamicHlsApiGetMasterHlsVideoPlaylistRequest} requestParameters Request parameters.
4220
- * @param {*} [options] Override http request option.
4221
- * @throws {RequiredError}
4222
- * @memberof DynamicHlsApi
4223
- */
4224
- getMasterHlsVideoPlaylist(requestParameters: DynamicHlsApiGetMasterHlsVideoPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4225
- /**
4226
- *
4227
- * @summary Gets an audio stream using HTTP live streaming.
4228
- * @param {DynamicHlsApiGetVariantHlsAudioPlaylistRequest} requestParameters Request parameters.
4229
- * @param {*} [options] Override http request option.
4230
- * @throws {RequiredError}
4231
- * @memberof DynamicHlsApi
4232
- */
4233
- getVariantHlsAudioPlaylist(requestParameters: DynamicHlsApiGetVariantHlsAudioPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4234
- /**
4235
- *
4236
- * @summary Gets a video stream using HTTP live streaming.
4237
- * @param {DynamicHlsApiGetVariantHlsVideoPlaylistRequest} requestParameters Request parameters.
4238
- * @param {*} [options] Override http request option.
4239
- * @throws {RequiredError}
4240
- * @memberof DynamicHlsApi
4241
- */
4242
- getVariantHlsVideoPlaylist(requestParameters: DynamicHlsApiGetVariantHlsVideoPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4243
- /**
4244
- *
4245
- * @summary Gets an audio hls playlist stream.
4246
- * @param {DynamicHlsApiHeadMasterHlsAudioPlaylistRequest} requestParameters Request parameters.
4247
- * @param {*} [options] Override http request option.
4248
- * @throws {RequiredError}
4249
- * @memberof DynamicHlsApi
4250
- */
4251
- headMasterHlsAudioPlaylist(requestParameters: DynamicHlsApiHeadMasterHlsAudioPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4252
- /**
4253
- *
4254
- * @summary Gets a video hls playlist stream.
4255
- * @param {DynamicHlsApiHeadMasterHlsVideoPlaylistRequest} requestParameters Request parameters.
4256
- * @param {*} [options] Override http request option.
4257
- * @throws {RequiredError}
4258
- * @memberof DynamicHlsApi
4259
- */
4260
- headMasterHlsVideoPlaylist(requestParameters: DynamicHlsApiHeadMasterHlsVideoPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
4261
- }