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