@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,2205 @@
|
|
|
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 { BaseItemDtoQueryResult } from '../models';
|
|
15
|
+
import { EncodingContext } from '../models';
|
|
16
|
+
import { SubtitleDeliveryMethod } from '../models';
|
|
17
|
+
/**
|
|
18
|
+
* VideosApi - axios parameter creator
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
export declare const VideosApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @summary Removes alternate video sources.
|
|
25
|
+
* @param {string} itemId The item id.
|
|
26
|
+
* @param {*} [options] Override http request option.
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
deleteAlternateSources: (itemId: string, options?: any) => Promise<RequestArgs>;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @summary Gets additional parts for a video.
|
|
33
|
+
* @param {string} itemId The item id.
|
|
34
|
+
* @param {string} [userId] Optional. Filter by user id, and attach user data.
|
|
35
|
+
* @param {*} [options] Override http request option.
|
|
36
|
+
* @throws {RequiredError}
|
|
37
|
+
*/
|
|
38
|
+
getAdditionalPart: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @summary Gets a video stream.
|
|
42
|
+
* @param {string} itemId The item id.
|
|
43
|
+
* @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.
|
|
44
|
+
* @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.
|
|
45
|
+
* @param {string} [params] The streaming parameters.
|
|
46
|
+
* @param {string} [tag] The tag.
|
|
47
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
48
|
+
* @param {string} [playSessionId] The play session id.
|
|
49
|
+
* @param {string} [segmentContainer] The segment container.
|
|
50
|
+
* @param {number} [segmentLength] The segment length.
|
|
51
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
52
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
53
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
54
|
+
* @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.
|
|
55
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
56
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
57
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
58
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
59
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
60
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
61
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
62
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
63
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
64
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
65
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
66
|
+
* @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.
|
|
67
|
+
* @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.
|
|
68
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
69
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
70
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
71
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
72
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
73
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
74
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
75
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
76
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
77
|
+
* @param {number} [maxRefFrames] Optional.
|
|
78
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
79
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
80
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
81
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
82
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
83
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
84
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
85
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
86
|
+
* @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.
|
|
87
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
88
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
89
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
90
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
91
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
92
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
93
|
+
* @param {*} [options] Override http request option.
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
*/
|
|
96
|
+
getVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
97
|
+
[key: string]: string;
|
|
98
|
+
} | undefined, options?: any) => Promise<RequestArgs>;
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @summary Gets a video stream.
|
|
102
|
+
* @param {string} itemId The item id.
|
|
103
|
+
* @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.
|
|
104
|
+
* @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.
|
|
105
|
+
* @param {string} [params] The streaming parameters.
|
|
106
|
+
* @param {string} [tag] The tag.
|
|
107
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
108
|
+
* @param {string} [playSessionId] The play session id.
|
|
109
|
+
* @param {string} [segmentContainer] The segment container.
|
|
110
|
+
* @param {number} [segmentLength] The segment length.
|
|
111
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
112
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
113
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
114
|
+
* @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.
|
|
115
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
116
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
117
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
118
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
119
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
120
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
121
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
122
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
123
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
124
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
125
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
126
|
+
* @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.
|
|
127
|
+
* @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.
|
|
128
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
129
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
130
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
131
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
132
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
133
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
134
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
135
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
136
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
137
|
+
* @param {number} [maxRefFrames] Optional.
|
|
138
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
139
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
140
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
141
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
142
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
143
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
144
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
145
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
146
|
+
* @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.
|
|
147
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
148
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
149
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
150
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
151
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
152
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
153
|
+
* @param {*} [options] Override http request option.
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
*/
|
|
156
|
+
getVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
157
|
+
[key: string]: string;
|
|
158
|
+
} | undefined, options?: any) => Promise<RequestArgs>;
|
|
159
|
+
/**
|
|
160
|
+
*
|
|
161
|
+
* @summary Gets a video stream.
|
|
162
|
+
* @param {string} itemId The item id.
|
|
163
|
+
* @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.
|
|
164
|
+
* @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.
|
|
165
|
+
* @param {string} [params] The streaming parameters.
|
|
166
|
+
* @param {string} [tag] The tag.
|
|
167
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
168
|
+
* @param {string} [playSessionId] The play session id.
|
|
169
|
+
* @param {string} [segmentContainer] The segment container.
|
|
170
|
+
* @param {number} [segmentLength] The segment length.
|
|
171
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
172
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
173
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
174
|
+
* @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.
|
|
175
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
176
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
177
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
178
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
179
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
180
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
181
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
182
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
183
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
184
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
185
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
186
|
+
* @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.
|
|
187
|
+
* @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.
|
|
188
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
189
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
190
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
191
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
192
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
193
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
194
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
195
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
196
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
197
|
+
* @param {number} [maxRefFrames] Optional.
|
|
198
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
199
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
200
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
201
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
202
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
203
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
204
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
205
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
206
|
+
* @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.
|
|
207
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
208
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
209
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
210
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
211
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
212
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
213
|
+
* @param {*} [options] Override http request option.
|
|
214
|
+
* @throws {RequiredError}
|
|
215
|
+
*/
|
|
216
|
+
headVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
217
|
+
[key: string]: string;
|
|
218
|
+
} | undefined, options?: any) => Promise<RequestArgs>;
|
|
219
|
+
/**
|
|
220
|
+
*
|
|
221
|
+
* @summary Gets a video stream.
|
|
222
|
+
* @param {string} itemId The item id.
|
|
223
|
+
* @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.
|
|
224
|
+
* @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.
|
|
225
|
+
* @param {string} [params] The streaming parameters.
|
|
226
|
+
* @param {string} [tag] The tag.
|
|
227
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
228
|
+
* @param {string} [playSessionId] The play session id.
|
|
229
|
+
* @param {string} [segmentContainer] The segment container.
|
|
230
|
+
* @param {number} [segmentLength] The segment length.
|
|
231
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
232
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
233
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
234
|
+
* @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.
|
|
235
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
236
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
237
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
238
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
239
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
240
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
241
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
242
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
243
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
244
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
245
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
246
|
+
* @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.
|
|
247
|
+
* @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.
|
|
248
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
249
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
250
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
251
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
252
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
253
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
254
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
255
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
256
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
257
|
+
* @param {number} [maxRefFrames] Optional.
|
|
258
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
259
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
260
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
261
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
262
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
263
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
264
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
265
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
266
|
+
* @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.
|
|
267
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
268
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
269
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
270
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
271
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
272
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
273
|
+
* @param {*} [options] Override http request option.
|
|
274
|
+
* @throws {RequiredError}
|
|
275
|
+
*/
|
|
276
|
+
headVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
277
|
+
[key: string]: string;
|
|
278
|
+
} | undefined, options?: any) => Promise<RequestArgs>;
|
|
279
|
+
/**
|
|
280
|
+
*
|
|
281
|
+
* @summary Merges videos into a single record.
|
|
282
|
+
* @param {Array<string>} ids Item id list. This allows multiple, comma delimited.
|
|
283
|
+
* @param {*} [options] Override http request option.
|
|
284
|
+
* @throws {RequiredError}
|
|
285
|
+
*/
|
|
286
|
+
mergeVersions: (ids: Array<string>, options?: any) => Promise<RequestArgs>;
|
|
287
|
+
};
|
|
288
|
+
/**
|
|
289
|
+
* VideosApi - functional programming interface
|
|
290
|
+
* @export
|
|
291
|
+
*/
|
|
292
|
+
export declare const VideosApiFp: (configuration?: Configuration) => {
|
|
293
|
+
/**
|
|
294
|
+
*
|
|
295
|
+
* @summary Removes alternate video sources.
|
|
296
|
+
* @param {string} itemId The item id.
|
|
297
|
+
* @param {*} [options] Override http request option.
|
|
298
|
+
* @throws {RequiredError}
|
|
299
|
+
*/
|
|
300
|
+
deleteAlternateSources(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
301
|
+
/**
|
|
302
|
+
*
|
|
303
|
+
* @summary Gets additional parts for a video.
|
|
304
|
+
* @param {string} itemId The item id.
|
|
305
|
+
* @param {string} [userId] Optional. Filter by user id, and attach user data.
|
|
306
|
+
* @param {*} [options] Override http request option.
|
|
307
|
+
* @throws {RequiredError}
|
|
308
|
+
*/
|
|
309
|
+
getAdditionalPart(itemId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>;
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
* @summary Gets a video stream.
|
|
313
|
+
* @param {string} itemId The item id.
|
|
314
|
+
* @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.
|
|
315
|
+
* @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.
|
|
316
|
+
* @param {string} [params] The streaming parameters.
|
|
317
|
+
* @param {string} [tag] The tag.
|
|
318
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
319
|
+
* @param {string} [playSessionId] The play session id.
|
|
320
|
+
* @param {string} [segmentContainer] The segment container.
|
|
321
|
+
* @param {number} [segmentLength] The segment length.
|
|
322
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
323
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
324
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
325
|
+
* @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.
|
|
326
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
327
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
328
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
329
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
330
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
331
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
332
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
333
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
334
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
335
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
336
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
337
|
+
* @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.
|
|
338
|
+
* @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.
|
|
339
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
340
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
341
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
342
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
343
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
344
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
345
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
346
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
347
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
348
|
+
* @param {number} [maxRefFrames] Optional.
|
|
349
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
350
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
351
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
352
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
353
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
354
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
355
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
356
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
357
|
+
* @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.
|
|
358
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
359
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
360
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
361
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
362
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
363
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
364
|
+
* @param {*} [options] Override http request option.
|
|
365
|
+
* @throws {RequiredError}
|
|
366
|
+
*/
|
|
367
|
+
getVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
368
|
+
[key: string]: string;
|
|
369
|
+
} | undefined, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
370
|
+
/**
|
|
371
|
+
*
|
|
372
|
+
* @summary Gets a video stream.
|
|
373
|
+
* @param {string} itemId The item id.
|
|
374
|
+
* @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.
|
|
375
|
+
* @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.
|
|
376
|
+
* @param {string} [params] The streaming parameters.
|
|
377
|
+
* @param {string} [tag] The tag.
|
|
378
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
379
|
+
* @param {string} [playSessionId] The play session id.
|
|
380
|
+
* @param {string} [segmentContainer] The segment container.
|
|
381
|
+
* @param {number} [segmentLength] The segment length.
|
|
382
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
383
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
384
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
385
|
+
* @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.
|
|
386
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
387
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
388
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
389
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
390
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
391
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
392
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
393
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
394
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
395
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
396
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
397
|
+
* @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.
|
|
398
|
+
* @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.
|
|
399
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
400
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
401
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
402
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
403
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
404
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
405
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
406
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
407
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
408
|
+
* @param {number} [maxRefFrames] Optional.
|
|
409
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
410
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
411
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
412
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
413
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
414
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
415
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
416
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
417
|
+
* @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.
|
|
418
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
419
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
420
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
421
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
422
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
423
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
424
|
+
* @param {*} [options] Override http request option.
|
|
425
|
+
* @throws {RequiredError}
|
|
426
|
+
*/
|
|
427
|
+
getVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
428
|
+
[key: string]: string;
|
|
429
|
+
} | undefined, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
430
|
+
/**
|
|
431
|
+
*
|
|
432
|
+
* @summary Gets a video stream.
|
|
433
|
+
* @param {string} itemId The item id.
|
|
434
|
+
* @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.
|
|
435
|
+
* @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.
|
|
436
|
+
* @param {string} [params] The streaming parameters.
|
|
437
|
+
* @param {string} [tag] The tag.
|
|
438
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
439
|
+
* @param {string} [playSessionId] The play session id.
|
|
440
|
+
* @param {string} [segmentContainer] The segment container.
|
|
441
|
+
* @param {number} [segmentLength] The segment length.
|
|
442
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
443
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
444
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
445
|
+
* @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.
|
|
446
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
447
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
448
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
449
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
450
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
451
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
452
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
453
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
454
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
455
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
456
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
457
|
+
* @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.
|
|
458
|
+
* @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.
|
|
459
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
460
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
461
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
462
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
463
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
464
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
465
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
466
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
467
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
468
|
+
* @param {number} [maxRefFrames] Optional.
|
|
469
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
470
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
471
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
472
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
473
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
474
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
475
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
476
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
477
|
+
* @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.
|
|
478
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
479
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
480
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
481
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
482
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
483
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
484
|
+
* @param {*} [options] Override http request option.
|
|
485
|
+
* @throws {RequiredError}
|
|
486
|
+
*/
|
|
487
|
+
headVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
488
|
+
[key: string]: string;
|
|
489
|
+
} | undefined, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
490
|
+
/**
|
|
491
|
+
*
|
|
492
|
+
* @summary Gets a video stream.
|
|
493
|
+
* @param {string} itemId The item id.
|
|
494
|
+
* @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.
|
|
495
|
+
* @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.
|
|
496
|
+
* @param {string} [params] The streaming parameters.
|
|
497
|
+
* @param {string} [tag] The tag.
|
|
498
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
499
|
+
* @param {string} [playSessionId] The play session id.
|
|
500
|
+
* @param {string} [segmentContainer] The segment container.
|
|
501
|
+
* @param {number} [segmentLength] The segment length.
|
|
502
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
503
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
504
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
505
|
+
* @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.
|
|
506
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
507
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
508
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
509
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
510
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
511
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
512
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
513
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
514
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
515
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
516
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
517
|
+
* @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.
|
|
518
|
+
* @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.
|
|
519
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
520
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
521
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
522
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
523
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
524
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
525
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
526
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
527
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
528
|
+
* @param {number} [maxRefFrames] Optional.
|
|
529
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
530
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
531
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
532
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
533
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
534
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
535
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
536
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
537
|
+
* @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.
|
|
538
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
539
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
540
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
541
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
542
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
543
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
544
|
+
* @param {*} [options] Override http request option.
|
|
545
|
+
* @throws {RequiredError}
|
|
546
|
+
*/
|
|
547
|
+
headVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
548
|
+
[key: string]: string;
|
|
549
|
+
} | undefined, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
550
|
+
/**
|
|
551
|
+
*
|
|
552
|
+
* @summary Merges videos into a single record.
|
|
553
|
+
* @param {Array<string>} ids Item id list. This allows multiple, comma delimited.
|
|
554
|
+
* @param {*} [options] Override http request option.
|
|
555
|
+
* @throws {RequiredError}
|
|
556
|
+
*/
|
|
557
|
+
mergeVersions(ids: Array<string>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
558
|
+
};
|
|
559
|
+
/**
|
|
560
|
+
* VideosApi - factory interface
|
|
561
|
+
* @export
|
|
562
|
+
*/
|
|
563
|
+
export declare const VideosApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
564
|
+
/**
|
|
565
|
+
*
|
|
566
|
+
* @summary Removes alternate video sources.
|
|
567
|
+
* @param {string} itemId The item id.
|
|
568
|
+
* @param {*} [options] Override http request option.
|
|
569
|
+
* @throws {RequiredError}
|
|
570
|
+
*/
|
|
571
|
+
deleteAlternateSources(itemId: string, options?: any): AxiosPromise<void>;
|
|
572
|
+
/**
|
|
573
|
+
*
|
|
574
|
+
* @summary Gets additional parts for a video.
|
|
575
|
+
* @param {string} itemId The item id.
|
|
576
|
+
* @param {string} [userId] Optional. Filter by user id, and attach user data.
|
|
577
|
+
* @param {*} [options] Override http request option.
|
|
578
|
+
* @throws {RequiredError}
|
|
579
|
+
*/
|
|
580
|
+
getAdditionalPart(itemId: string, userId?: string, options?: any): AxiosPromise<BaseItemDtoQueryResult>;
|
|
581
|
+
/**
|
|
582
|
+
*
|
|
583
|
+
* @summary Gets a video stream.
|
|
584
|
+
* @param {string} itemId The item id.
|
|
585
|
+
* @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.
|
|
586
|
+
* @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.
|
|
587
|
+
* @param {string} [params] The streaming parameters.
|
|
588
|
+
* @param {string} [tag] The tag.
|
|
589
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
590
|
+
* @param {string} [playSessionId] The play session id.
|
|
591
|
+
* @param {string} [segmentContainer] The segment container.
|
|
592
|
+
* @param {number} [segmentLength] The segment length.
|
|
593
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
594
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
595
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
596
|
+
* @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.
|
|
597
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
598
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
599
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
600
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
601
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
602
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
603
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
604
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
605
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
606
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
607
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
608
|
+
* @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.
|
|
609
|
+
* @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.
|
|
610
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
611
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
612
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
613
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
614
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
615
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
616
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
617
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
618
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
619
|
+
* @param {number} [maxRefFrames] Optional.
|
|
620
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
621
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
622
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
623
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
624
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
625
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
626
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
627
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
628
|
+
* @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.
|
|
629
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
630
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
631
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
632
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
633
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
634
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
635
|
+
* @param {*} [options] Override http request option.
|
|
636
|
+
* @throws {RequiredError}
|
|
637
|
+
*/
|
|
638
|
+
getVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
639
|
+
[key: string]: string;
|
|
640
|
+
} | undefined, options?: any): AxiosPromise<any>;
|
|
641
|
+
/**
|
|
642
|
+
*
|
|
643
|
+
* @summary Gets a video stream.
|
|
644
|
+
* @param {string} itemId The item id.
|
|
645
|
+
* @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.
|
|
646
|
+
* @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.
|
|
647
|
+
* @param {string} [params] The streaming parameters.
|
|
648
|
+
* @param {string} [tag] The tag.
|
|
649
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
650
|
+
* @param {string} [playSessionId] The play session id.
|
|
651
|
+
* @param {string} [segmentContainer] The segment container.
|
|
652
|
+
* @param {number} [segmentLength] The segment length.
|
|
653
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
654
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
655
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
656
|
+
* @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.
|
|
657
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
658
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
659
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
660
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
661
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
662
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
663
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
664
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
665
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
666
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
667
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
668
|
+
* @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.
|
|
669
|
+
* @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.
|
|
670
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
671
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
672
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
673
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
674
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
675
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
676
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
677
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
678
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
679
|
+
* @param {number} [maxRefFrames] Optional.
|
|
680
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
681
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
682
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
683
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
684
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
685
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
686
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
687
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
688
|
+
* @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.
|
|
689
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
690
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
691
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
692
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
693
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
694
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
695
|
+
* @param {*} [options] Override http request option.
|
|
696
|
+
* @throws {RequiredError}
|
|
697
|
+
*/
|
|
698
|
+
getVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
699
|
+
[key: string]: string;
|
|
700
|
+
} | undefined, options?: any): AxiosPromise<any>;
|
|
701
|
+
/**
|
|
702
|
+
*
|
|
703
|
+
* @summary Gets a video stream.
|
|
704
|
+
* @param {string} itemId The item id.
|
|
705
|
+
* @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.
|
|
706
|
+
* @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.
|
|
707
|
+
* @param {string} [params] The streaming parameters.
|
|
708
|
+
* @param {string} [tag] The tag.
|
|
709
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
710
|
+
* @param {string} [playSessionId] The play session id.
|
|
711
|
+
* @param {string} [segmentContainer] The segment container.
|
|
712
|
+
* @param {number} [segmentLength] The segment length.
|
|
713
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
714
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
715
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
716
|
+
* @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.
|
|
717
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
718
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
719
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
720
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
721
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
722
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
723
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
724
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
725
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
726
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
727
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
728
|
+
* @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.
|
|
729
|
+
* @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.
|
|
730
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
731
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
732
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
733
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
734
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
735
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
736
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
737
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
738
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
739
|
+
* @param {number} [maxRefFrames] Optional.
|
|
740
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
741
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
742
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
743
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
744
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
745
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
746
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
747
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
748
|
+
* @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.
|
|
749
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
750
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
751
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
752
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
753
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
754
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
755
|
+
* @param {*} [options] Override http request option.
|
|
756
|
+
* @throws {RequiredError}
|
|
757
|
+
*/
|
|
758
|
+
headVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
759
|
+
[key: string]: string;
|
|
760
|
+
} | undefined, options?: any): AxiosPromise<any>;
|
|
761
|
+
/**
|
|
762
|
+
*
|
|
763
|
+
* @summary Gets a video stream.
|
|
764
|
+
* @param {string} itemId The item id.
|
|
765
|
+
* @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.
|
|
766
|
+
* @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.
|
|
767
|
+
* @param {string} [params] The streaming parameters.
|
|
768
|
+
* @param {string} [tag] The tag.
|
|
769
|
+
* @param {string} [deviceProfileId] Optional. The dlna device profile id to utilize.
|
|
770
|
+
* @param {string} [playSessionId] The play session id.
|
|
771
|
+
* @param {string} [segmentContainer] The segment container.
|
|
772
|
+
* @param {number} [segmentLength] The segment length.
|
|
773
|
+
* @param {number} [minSegments] The minimum number of segments.
|
|
774
|
+
* @param {string} [mediaSourceId] The media version id, if playing an alternate version.
|
|
775
|
+
* @param {string} [deviceId] The device id of the client requesting. Used to stop encoding processes when needed.
|
|
776
|
+
* @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.
|
|
777
|
+
* @param {boolean} [enableAutoStreamCopy] Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
778
|
+
* @param {boolean} [allowVideoStreamCopy] Whether or not to allow copying of the video stream url.
|
|
779
|
+
* @param {boolean} [allowAudioStreamCopy] Whether or not to allow copying of the audio stream url.
|
|
780
|
+
* @param {boolean} [breakOnNonKeyFrames] Optional. Whether to break on non key frames.
|
|
781
|
+
* @param {number} [audioSampleRate] Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
782
|
+
* @param {number} [maxAudioBitDepth] Optional. The maximum audio bit depth.
|
|
783
|
+
* @param {number} [audioBitRate] Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
784
|
+
* @param {number} [audioChannels] Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
785
|
+
* @param {number} [maxAudioChannels] Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
786
|
+
* @param {string} [profile] Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
787
|
+
* @param {string} [level] Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
788
|
+
* @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.
|
|
789
|
+
* @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.
|
|
790
|
+
* @param {boolean} [copyTimestamps] Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
791
|
+
* @param {number} [startTimeTicks] Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
792
|
+
* @param {number} [width] Optional. The fixed horizontal resolution of the encoded video.
|
|
793
|
+
* @param {number} [height] Optional. The fixed vertical resolution of the encoded video.
|
|
794
|
+
* @param {number} [maxWidth] Optional. The maximum horizontal resolution of the encoded video.
|
|
795
|
+
* @param {number} [maxHeight] Optional. The maximum vertical resolution of the encoded video.
|
|
796
|
+
* @param {number} [videoBitRate] Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
797
|
+
* @param {number} [subtitleStreamIndex] Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
798
|
+
* @param {SubtitleDeliveryMethod} [subtitleMethod] Optional. Specify the subtitle delivery method.
|
|
799
|
+
* @param {number} [maxRefFrames] Optional.
|
|
800
|
+
* @param {number} [maxVideoBitDepth] Optional. The maximum video bit depth.
|
|
801
|
+
* @param {boolean} [requireAvc] Optional. Whether to require avc.
|
|
802
|
+
* @param {boolean} [deInterlace] Optional. Whether to deinterlace the video.
|
|
803
|
+
* @param {boolean} [requireNonAnamorphic] Optional. Whether to require a non anamorphic stream.
|
|
804
|
+
* @param {number} [transcodingMaxAudioChannels] Optional. The maximum number of audio channels to transcode.
|
|
805
|
+
* @param {number} [cpuCoreLimit] Optional. The limit of how many cpu cores to use.
|
|
806
|
+
* @param {string} [liveStreamId] The live stream id.
|
|
807
|
+
* @param {boolean} [enableMpegtsM2TsMode] Optional. Whether to enable the MpegtsM2Ts mode.
|
|
808
|
+
* @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.
|
|
809
|
+
* @param {string} [subtitleCodec] Optional. Specify a subtitle codec to encode to.
|
|
810
|
+
* @param {string} [transcodeReasons] Optional. The transcoding reason.
|
|
811
|
+
* @param {number} [audioStreamIndex] Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
812
|
+
* @param {number} [videoStreamIndex] Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
813
|
+
* @param {EncodingContext} [context] Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
814
|
+
* @param {{ [key: string]: string; }} [streamOptions] Optional. The streaming options.
|
|
815
|
+
* @param {*} [options] Override http request option.
|
|
816
|
+
* @throws {RequiredError}
|
|
817
|
+
*/
|
|
818
|
+
headVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, maxWidth?: number, maxHeight?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {
|
|
819
|
+
[key: string]: string;
|
|
820
|
+
} | undefined, options?: any): AxiosPromise<any>;
|
|
821
|
+
/**
|
|
822
|
+
*
|
|
823
|
+
* @summary Merges videos into a single record.
|
|
824
|
+
* @param {Array<string>} ids Item id list. This allows multiple, comma delimited.
|
|
825
|
+
* @param {*} [options] Override http request option.
|
|
826
|
+
* @throws {RequiredError}
|
|
827
|
+
*/
|
|
828
|
+
mergeVersions(ids: Array<string>, options?: any): AxiosPromise<void>;
|
|
829
|
+
};
|
|
830
|
+
/**
|
|
831
|
+
* Request parameters for deleteAlternateSources operation in VideosApi.
|
|
832
|
+
* @export
|
|
833
|
+
* @interface VideosApiDeleteAlternateSourcesRequest
|
|
834
|
+
*/
|
|
835
|
+
export interface VideosApiDeleteAlternateSourcesRequest {
|
|
836
|
+
/**
|
|
837
|
+
* The item id.
|
|
838
|
+
* @type {string}
|
|
839
|
+
* @memberof VideosApiDeleteAlternateSources
|
|
840
|
+
*/
|
|
841
|
+
readonly itemId: string;
|
|
842
|
+
}
|
|
843
|
+
/**
|
|
844
|
+
* Request parameters for getAdditionalPart operation in VideosApi.
|
|
845
|
+
* @export
|
|
846
|
+
* @interface VideosApiGetAdditionalPartRequest
|
|
847
|
+
*/
|
|
848
|
+
export interface VideosApiGetAdditionalPartRequest {
|
|
849
|
+
/**
|
|
850
|
+
* The item id.
|
|
851
|
+
* @type {string}
|
|
852
|
+
* @memberof VideosApiGetAdditionalPart
|
|
853
|
+
*/
|
|
854
|
+
readonly itemId: string;
|
|
855
|
+
/**
|
|
856
|
+
* Optional. Filter by user id, and attach user data.
|
|
857
|
+
* @type {string}
|
|
858
|
+
* @memberof VideosApiGetAdditionalPart
|
|
859
|
+
*/
|
|
860
|
+
readonly userId?: string;
|
|
861
|
+
}
|
|
862
|
+
/**
|
|
863
|
+
* Request parameters for getVideoStream operation in VideosApi.
|
|
864
|
+
* @export
|
|
865
|
+
* @interface VideosApiGetVideoStreamRequest
|
|
866
|
+
*/
|
|
867
|
+
export interface VideosApiGetVideoStreamRequest {
|
|
868
|
+
/**
|
|
869
|
+
* The item id.
|
|
870
|
+
* @type {string}
|
|
871
|
+
* @memberof VideosApiGetVideoStream
|
|
872
|
+
*/
|
|
873
|
+
readonly itemId: string;
|
|
874
|
+
/**
|
|
875
|
+
* The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
|
|
876
|
+
* @type {string}
|
|
877
|
+
* @memberof VideosApiGetVideoStream
|
|
878
|
+
*/
|
|
879
|
+
readonly container?: string;
|
|
880
|
+
/**
|
|
881
|
+
* 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
|
+
* @type {boolean}
|
|
883
|
+
* @memberof VideosApiGetVideoStream
|
|
884
|
+
*/
|
|
885
|
+
readonly _static?: boolean;
|
|
886
|
+
/**
|
|
887
|
+
* The streaming parameters.
|
|
888
|
+
* @type {string}
|
|
889
|
+
* @memberof VideosApiGetVideoStream
|
|
890
|
+
*/
|
|
891
|
+
readonly params?: string;
|
|
892
|
+
/**
|
|
893
|
+
* The tag.
|
|
894
|
+
* @type {string}
|
|
895
|
+
* @memberof VideosApiGetVideoStream
|
|
896
|
+
*/
|
|
897
|
+
readonly tag?: string;
|
|
898
|
+
/**
|
|
899
|
+
* Optional. The dlna device profile id to utilize.
|
|
900
|
+
* @type {string}
|
|
901
|
+
* @memberof VideosApiGetVideoStream
|
|
902
|
+
*/
|
|
903
|
+
readonly deviceProfileId?: string;
|
|
904
|
+
/**
|
|
905
|
+
* The play session id.
|
|
906
|
+
* @type {string}
|
|
907
|
+
* @memberof VideosApiGetVideoStream
|
|
908
|
+
*/
|
|
909
|
+
readonly playSessionId?: string;
|
|
910
|
+
/**
|
|
911
|
+
* The segment container.
|
|
912
|
+
* @type {string}
|
|
913
|
+
* @memberof VideosApiGetVideoStream
|
|
914
|
+
*/
|
|
915
|
+
readonly segmentContainer?: string;
|
|
916
|
+
/**
|
|
917
|
+
* The segment length.
|
|
918
|
+
* @type {number}
|
|
919
|
+
* @memberof VideosApiGetVideoStream
|
|
920
|
+
*/
|
|
921
|
+
readonly segmentLength?: number;
|
|
922
|
+
/**
|
|
923
|
+
* The minimum number of segments.
|
|
924
|
+
* @type {number}
|
|
925
|
+
* @memberof VideosApiGetVideoStream
|
|
926
|
+
*/
|
|
927
|
+
readonly minSegments?: number;
|
|
928
|
+
/**
|
|
929
|
+
* The media version id, if playing an alternate version.
|
|
930
|
+
* @type {string}
|
|
931
|
+
* @memberof VideosApiGetVideoStream
|
|
932
|
+
*/
|
|
933
|
+
readonly mediaSourceId?: string;
|
|
934
|
+
/**
|
|
935
|
+
* The device id of the client requesting. Used to stop encoding processes when needed.
|
|
936
|
+
* @type {string}
|
|
937
|
+
* @memberof VideosApiGetVideoStream
|
|
938
|
+
*/
|
|
939
|
+
readonly deviceId?: string;
|
|
940
|
+
/**
|
|
941
|
+
* 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.
|
|
942
|
+
* @type {string}
|
|
943
|
+
* @memberof VideosApiGetVideoStream
|
|
944
|
+
*/
|
|
945
|
+
readonly audioCodec?: string;
|
|
946
|
+
/**
|
|
947
|
+
* Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
948
|
+
* @type {boolean}
|
|
949
|
+
* @memberof VideosApiGetVideoStream
|
|
950
|
+
*/
|
|
951
|
+
readonly enableAutoStreamCopy?: boolean;
|
|
952
|
+
/**
|
|
953
|
+
* Whether or not to allow copying of the video stream url.
|
|
954
|
+
* @type {boolean}
|
|
955
|
+
* @memberof VideosApiGetVideoStream
|
|
956
|
+
*/
|
|
957
|
+
readonly allowVideoStreamCopy?: boolean;
|
|
958
|
+
/**
|
|
959
|
+
* Whether or not to allow copying of the audio stream url.
|
|
960
|
+
* @type {boolean}
|
|
961
|
+
* @memberof VideosApiGetVideoStream
|
|
962
|
+
*/
|
|
963
|
+
readonly allowAudioStreamCopy?: boolean;
|
|
964
|
+
/**
|
|
965
|
+
* Optional. Whether to break on non key frames.
|
|
966
|
+
* @type {boolean}
|
|
967
|
+
* @memberof VideosApiGetVideoStream
|
|
968
|
+
*/
|
|
969
|
+
readonly breakOnNonKeyFrames?: boolean;
|
|
970
|
+
/**
|
|
971
|
+
* Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
972
|
+
* @type {number}
|
|
973
|
+
* @memberof VideosApiGetVideoStream
|
|
974
|
+
*/
|
|
975
|
+
readonly audioSampleRate?: number;
|
|
976
|
+
/**
|
|
977
|
+
* Optional. The maximum audio bit depth.
|
|
978
|
+
* @type {number}
|
|
979
|
+
* @memberof VideosApiGetVideoStream
|
|
980
|
+
*/
|
|
981
|
+
readonly maxAudioBitDepth?: number;
|
|
982
|
+
/**
|
|
983
|
+
* Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
984
|
+
* @type {number}
|
|
985
|
+
* @memberof VideosApiGetVideoStream
|
|
986
|
+
*/
|
|
987
|
+
readonly audioBitRate?: number;
|
|
988
|
+
/**
|
|
989
|
+
* Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
990
|
+
* @type {number}
|
|
991
|
+
* @memberof VideosApiGetVideoStream
|
|
992
|
+
*/
|
|
993
|
+
readonly audioChannels?: number;
|
|
994
|
+
/**
|
|
995
|
+
* Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
996
|
+
* @type {number}
|
|
997
|
+
* @memberof VideosApiGetVideoStream
|
|
998
|
+
*/
|
|
999
|
+
readonly maxAudioChannels?: number;
|
|
1000
|
+
/**
|
|
1001
|
+
* Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
1002
|
+
* @type {string}
|
|
1003
|
+
* @memberof VideosApiGetVideoStream
|
|
1004
|
+
*/
|
|
1005
|
+
readonly profile?: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
1008
|
+
* @type {string}
|
|
1009
|
+
* @memberof VideosApiGetVideoStream
|
|
1010
|
+
*/
|
|
1011
|
+
readonly level?: string;
|
|
1012
|
+
/**
|
|
1013
|
+
* Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
|
|
1014
|
+
* @type {number}
|
|
1015
|
+
* @memberof VideosApiGetVideoStream
|
|
1016
|
+
*/
|
|
1017
|
+
readonly framerate?: number;
|
|
1018
|
+
/**
|
|
1019
|
+
* Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
|
|
1020
|
+
* @type {number}
|
|
1021
|
+
* @memberof VideosApiGetVideoStream
|
|
1022
|
+
*/
|
|
1023
|
+
readonly maxFramerate?: number;
|
|
1024
|
+
/**
|
|
1025
|
+
* Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
1026
|
+
* @type {boolean}
|
|
1027
|
+
* @memberof VideosApiGetVideoStream
|
|
1028
|
+
*/
|
|
1029
|
+
readonly copyTimestamps?: boolean;
|
|
1030
|
+
/**
|
|
1031
|
+
* Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
1032
|
+
* @type {number}
|
|
1033
|
+
* @memberof VideosApiGetVideoStream
|
|
1034
|
+
*/
|
|
1035
|
+
readonly startTimeTicks?: number;
|
|
1036
|
+
/**
|
|
1037
|
+
* Optional. The fixed horizontal resolution of the encoded video.
|
|
1038
|
+
* @type {number}
|
|
1039
|
+
* @memberof VideosApiGetVideoStream
|
|
1040
|
+
*/
|
|
1041
|
+
readonly width?: number;
|
|
1042
|
+
/**
|
|
1043
|
+
* Optional. The fixed vertical resolution of the encoded video.
|
|
1044
|
+
* @type {number}
|
|
1045
|
+
* @memberof VideosApiGetVideoStream
|
|
1046
|
+
*/
|
|
1047
|
+
readonly height?: number;
|
|
1048
|
+
/**
|
|
1049
|
+
* Optional. The maximum horizontal resolution of the encoded video.
|
|
1050
|
+
* @type {number}
|
|
1051
|
+
* @memberof VideosApiGetVideoStream
|
|
1052
|
+
*/
|
|
1053
|
+
readonly maxWidth?: number;
|
|
1054
|
+
/**
|
|
1055
|
+
* Optional. The maximum vertical resolution of the encoded video.
|
|
1056
|
+
* @type {number}
|
|
1057
|
+
* @memberof VideosApiGetVideoStream
|
|
1058
|
+
*/
|
|
1059
|
+
readonly maxHeight?: number;
|
|
1060
|
+
/**
|
|
1061
|
+
* Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
1062
|
+
* @type {number}
|
|
1063
|
+
* @memberof VideosApiGetVideoStream
|
|
1064
|
+
*/
|
|
1065
|
+
readonly videoBitRate?: number;
|
|
1066
|
+
/**
|
|
1067
|
+
* Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
1068
|
+
* @type {number}
|
|
1069
|
+
* @memberof VideosApiGetVideoStream
|
|
1070
|
+
*/
|
|
1071
|
+
readonly subtitleStreamIndex?: number;
|
|
1072
|
+
/**
|
|
1073
|
+
* Optional. Specify the subtitle delivery method.
|
|
1074
|
+
* @type {SubtitleDeliveryMethod}
|
|
1075
|
+
* @memberof VideosApiGetVideoStream
|
|
1076
|
+
*/
|
|
1077
|
+
readonly subtitleMethod?: SubtitleDeliveryMethod;
|
|
1078
|
+
/**
|
|
1079
|
+
* Optional.
|
|
1080
|
+
* @type {number}
|
|
1081
|
+
* @memberof VideosApiGetVideoStream
|
|
1082
|
+
*/
|
|
1083
|
+
readonly maxRefFrames?: number;
|
|
1084
|
+
/**
|
|
1085
|
+
* Optional. The maximum video bit depth.
|
|
1086
|
+
* @type {number}
|
|
1087
|
+
* @memberof VideosApiGetVideoStream
|
|
1088
|
+
*/
|
|
1089
|
+
readonly maxVideoBitDepth?: number;
|
|
1090
|
+
/**
|
|
1091
|
+
* Optional. Whether to require avc.
|
|
1092
|
+
* @type {boolean}
|
|
1093
|
+
* @memberof VideosApiGetVideoStream
|
|
1094
|
+
*/
|
|
1095
|
+
readonly requireAvc?: boolean;
|
|
1096
|
+
/**
|
|
1097
|
+
* Optional. Whether to deinterlace the video.
|
|
1098
|
+
* @type {boolean}
|
|
1099
|
+
* @memberof VideosApiGetVideoStream
|
|
1100
|
+
*/
|
|
1101
|
+
readonly deInterlace?: boolean;
|
|
1102
|
+
/**
|
|
1103
|
+
* Optional. Whether to require a non anamorphic stream.
|
|
1104
|
+
* @type {boolean}
|
|
1105
|
+
* @memberof VideosApiGetVideoStream
|
|
1106
|
+
*/
|
|
1107
|
+
readonly requireNonAnamorphic?: boolean;
|
|
1108
|
+
/**
|
|
1109
|
+
* Optional. The maximum number of audio channels to transcode.
|
|
1110
|
+
* @type {number}
|
|
1111
|
+
* @memberof VideosApiGetVideoStream
|
|
1112
|
+
*/
|
|
1113
|
+
readonly transcodingMaxAudioChannels?: number;
|
|
1114
|
+
/**
|
|
1115
|
+
* Optional. The limit of how many cpu cores to use.
|
|
1116
|
+
* @type {number}
|
|
1117
|
+
* @memberof VideosApiGetVideoStream
|
|
1118
|
+
*/
|
|
1119
|
+
readonly cpuCoreLimit?: number;
|
|
1120
|
+
/**
|
|
1121
|
+
* The live stream id.
|
|
1122
|
+
* @type {string}
|
|
1123
|
+
* @memberof VideosApiGetVideoStream
|
|
1124
|
+
*/
|
|
1125
|
+
readonly liveStreamId?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* Optional. Whether to enable the MpegtsM2Ts mode.
|
|
1128
|
+
* @type {boolean}
|
|
1129
|
+
* @memberof VideosApiGetVideoStream
|
|
1130
|
+
*/
|
|
1131
|
+
readonly enableMpegtsM2TsMode?: boolean;
|
|
1132
|
+
/**
|
|
1133
|
+
* 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.
|
|
1134
|
+
* @type {string}
|
|
1135
|
+
* @memberof VideosApiGetVideoStream
|
|
1136
|
+
*/
|
|
1137
|
+
readonly videoCodec?: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* Optional. Specify a subtitle codec to encode to.
|
|
1140
|
+
* @type {string}
|
|
1141
|
+
* @memberof VideosApiGetVideoStream
|
|
1142
|
+
*/
|
|
1143
|
+
readonly subtitleCodec?: string;
|
|
1144
|
+
/**
|
|
1145
|
+
* Optional. The transcoding reason.
|
|
1146
|
+
* @type {string}
|
|
1147
|
+
* @memberof VideosApiGetVideoStream
|
|
1148
|
+
*/
|
|
1149
|
+
readonly transcodeReasons?: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
1152
|
+
* @type {number}
|
|
1153
|
+
* @memberof VideosApiGetVideoStream
|
|
1154
|
+
*/
|
|
1155
|
+
readonly audioStreamIndex?: number;
|
|
1156
|
+
/**
|
|
1157
|
+
* Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
1158
|
+
* @type {number}
|
|
1159
|
+
* @memberof VideosApiGetVideoStream
|
|
1160
|
+
*/
|
|
1161
|
+
readonly videoStreamIndex?: number;
|
|
1162
|
+
/**
|
|
1163
|
+
* Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
1164
|
+
* @type {EncodingContext}
|
|
1165
|
+
* @memberof VideosApiGetVideoStream
|
|
1166
|
+
*/
|
|
1167
|
+
readonly context?: EncodingContext;
|
|
1168
|
+
/**
|
|
1169
|
+
* Optional. The streaming options.
|
|
1170
|
+
* @type {{ [key: string]: string; }}
|
|
1171
|
+
* @memberof VideosApiGetVideoStream
|
|
1172
|
+
*/
|
|
1173
|
+
readonly streamOptions?: {
|
|
1174
|
+
[key: string]: string;
|
|
1175
|
+
};
|
|
1176
|
+
}
|
|
1177
|
+
/**
|
|
1178
|
+
* Request parameters for getVideoStreamByContainer operation in VideosApi.
|
|
1179
|
+
* @export
|
|
1180
|
+
* @interface VideosApiGetVideoStreamByContainerRequest
|
|
1181
|
+
*/
|
|
1182
|
+
export interface VideosApiGetVideoStreamByContainerRequest {
|
|
1183
|
+
/**
|
|
1184
|
+
* The item id.
|
|
1185
|
+
* @type {string}
|
|
1186
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1187
|
+
*/
|
|
1188
|
+
readonly itemId: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
|
|
1191
|
+
* @type {string}
|
|
1192
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1193
|
+
*/
|
|
1194
|
+
readonly container: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* 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.
|
|
1197
|
+
* @type {boolean}
|
|
1198
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1199
|
+
*/
|
|
1200
|
+
readonly _static?: boolean;
|
|
1201
|
+
/**
|
|
1202
|
+
* The streaming parameters.
|
|
1203
|
+
* @type {string}
|
|
1204
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1205
|
+
*/
|
|
1206
|
+
readonly params?: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* The tag.
|
|
1209
|
+
* @type {string}
|
|
1210
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1211
|
+
*/
|
|
1212
|
+
readonly tag?: string;
|
|
1213
|
+
/**
|
|
1214
|
+
* Optional. The dlna device profile id to utilize.
|
|
1215
|
+
* @type {string}
|
|
1216
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1217
|
+
*/
|
|
1218
|
+
readonly deviceProfileId?: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* The play session id.
|
|
1221
|
+
* @type {string}
|
|
1222
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1223
|
+
*/
|
|
1224
|
+
readonly playSessionId?: string;
|
|
1225
|
+
/**
|
|
1226
|
+
* The segment container.
|
|
1227
|
+
* @type {string}
|
|
1228
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1229
|
+
*/
|
|
1230
|
+
readonly segmentContainer?: string;
|
|
1231
|
+
/**
|
|
1232
|
+
* The segment length.
|
|
1233
|
+
* @type {number}
|
|
1234
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1235
|
+
*/
|
|
1236
|
+
readonly segmentLength?: number;
|
|
1237
|
+
/**
|
|
1238
|
+
* The minimum number of segments.
|
|
1239
|
+
* @type {number}
|
|
1240
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1241
|
+
*/
|
|
1242
|
+
readonly minSegments?: number;
|
|
1243
|
+
/**
|
|
1244
|
+
* The media version id, if playing an alternate version.
|
|
1245
|
+
* @type {string}
|
|
1246
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1247
|
+
*/
|
|
1248
|
+
readonly mediaSourceId?: string;
|
|
1249
|
+
/**
|
|
1250
|
+
* The device id of the client requesting. Used to stop encoding processes when needed.
|
|
1251
|
+
* @type {string}
|
|
1252
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1253
|
+
*/
|
|
1254
|
+
readonly deviceId?: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* 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.
|
|
1257
|
+
* @type {string}
|
|
1258
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1259
|
+
*/
|
|
1260
|
+
readonly audioCodec?: string;
|
|
1261
|
+
/**
|
|
1262
|
+
* Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
1263
|
+
* @type {boolean}
|
|
1264
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1265
|
+
*/
|
|
1266
|
+
readonly enableAutoStreamCopy?: boolean;
|
|
1267
|
+
/**
|
|
1268
|
+
* Whether or not to allow copying of the video stream url.
|
|
1269
|
+
* @type {boolean}
|
|
1270
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1271
|
+
*/
|
|
1272
|
+
readonly allowVideoStreamCopy?: boolean;
|
|
1273
|
+
/**
|
|
1274
|
+
* Whether or not to allow copying of the audio stream url.
|
|
1275
|
+
* @type {boolean}
|
|
1276
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1277
|
+
*/
|
|
1278
|
+
readonly allowAudioStreamCopy?: boolean;
|
|
1279
|
+
/**
|
|
1280
|
+
* Optional. Whether to break on non key frames.
|
|
1281
|
+
* @type {boolean}
|
|
1282
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1283
|
+
*/
|
|
1284
|
+
readonly breakOnNonKeyFrames?: boolean;
|
|
1285
|
+
/**
|
|
1286
|
+
* Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
1287
|
+
* @type {number}
|
|
1288
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1289
|
+
*/
|
|
1290
|
+
readonly audioSampleRate?: number;
|
|
1291
|
+
/**
|
|
1292
|
+
* Optional. The maximum audio bit depth.
|
|
1293
|
+
* @type {number}
|
|
1294
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1295
|
+
*/
|
|
1296
|
+
readonly maxAudioBitDepth?: number;
|
|
1297
|
+
/**
|
|
1298
|
+
* Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
1299
|
+
* @type {number}
|
|
1300
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1301
|
+
*/
|
|
1302
|
+
readonly audioBitRate?: number;
|
|
1303
|
+
/**
|
|
1304
|
+
* Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
1305
|
+
* @type {number}
|
|
1306
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1307
|
+
*/
|
|
1308
|
+
readonly audioChannels?: number;
|
|
1309
|
+
/**
|
|
1310
|
+
* Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
1311
|
+
* @type {number}
|
|
1312
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1313
|
+
*/
|
|
1314
|
+
readonly maxAudioChannels?: number;
|
|
1315
|
+
/**
|
|
1316
|
+
* Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
1317
|
+
* @type {string}
|
|
1318
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1319
|
+
*/
|
|
1320
|
+
readonly profile?: string;
|
|
1321
|
+
/**
|
|
1322
|
+
* Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
1323
|
+
* @type {string}
|
|
1324
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1325
|
+
*/
|
|
1326
|
+
readonly level?: string;
|
|
1327
|
+
/**
|
|
1328
|
+
* Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
|
|
1329
|
+
* @type {number}
|
|
1330
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1331
|
+
*/
|
|
1332
|
+
readonly framerate?: number;
|
|
1333
|
+
/**
|
|
1334
|
+
* Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
|
|
1335
|
+
* @type {number}
|
|
1336
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1337
|
+
*/
|
|
1338
|
+
readonly maxFramerate?: number;
|
|
1339
|
+
/**
|
|
1340
|
+
* Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
1341
|
+
* @type {boolean}
|
|
1342
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1343
|
+
*/
|
|
1344
|
+
readonly copyTimestamps?: boolean;
|
|
1345
|
+
/**
|
|
1346
|
+
* Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
1347
|
+
* @type {number}
|
|
1348
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1349
|
+
*/
|
|
1350
|
+
readonly startTimeTicks?: number;
|
|
1351
|
+
/**
|
|
1352
|
+
* Optional. The fixed horizontal resolution of the encoded video.
|
|
1353
|
+
* @type {number}
|
|
1354
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1355
|
+
*/
|
|
1356
|
+
readonly width?: number;
|
|
1357
|
+
/**
|
|
1358
|
+
* Optional. The fixed vertical resolution of the encoded video.
|
|
1359
|
+
* @type {number}
|
|
1360
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1361
|
+
*/
|
|
1362
|
+
readonly height?: number;
|
|
1363
|
+
/**
|
|
1364
|
+
* Optional. The maximum horizontal resolution of the encoded video.
|
|
1365
|
+
* @type {number}
|
|
1366
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1367
|
+
*/
|
|
1368
|
+
readonly maxWidth?: number;
|
|
1369
|
+
/**
|
|
1370
|
+
* Optional. The maximum vertical resolution of the encoded video.
|
|
1371
|
+
* @type {number}
|
|
1372
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1373
|
+
*/
|
|
1374
|
+
readonly maxHeight?: number;
|
|
1375
|
+
/**
|
|
1376
|
+
* Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
1377
|
+
* @type {number}
|
|
1378
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1379
|
+
*/
|
|
1380
|
+
readonly videoBitRate?: number;
|
|
1381
|
+
/**
|
|
1382
|
+
* Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
1383
|
+
* @type {number}
|
|
1384
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1385
|
+
*/
|
|
1386
|
+
readonly subtitleStreamIndex?: number;
|
|
1387
|
+
/**
|
|
1388
|
+
* Optional. Specify the subtitle delivery method.
|
|
1389
|
+
* @type {SubtitleDeliveryMethod}
|
|
1390
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1391
|
+
*/
|
|
1392
|
+
readonly subtitleMethod?: SubtitleDeliveryMethod;
|
|
1393
|
+
/**
|
|
1394
|
+
* Optional.
|
|
1395
|
+
* @type {number}
|
|
1396
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1397
|
+
*/
|
|
1398
|
+
readonly maxRefFrames?: number;
|
|
1399
|
+
/**
|
|
1400
|
+
* Optional. The maximum video bit depth.
|
|
1401
|
+
* @type {number}
|
|
1402
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1403
|
+
*/
|
|
1404
|
+
readonly maxVideoBitDepth?: number;
|
|
1405
|
+
/**
|
|
1406
|
+
* Optional. Whether to require avc.
|
|
1407
|
+
* @type {boolean}
|
|
1408
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1409
|
+
*/
|
|
1410
|
+
readonly requireAvc?: boolean;
|
|
1411
|
+
/**
|
|
1412
|
+
* Optional. Whether to deinterlace the video.
|
|
1413
|
+
* @type {boolean}
|
|
1414
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1415
|
+
*/
|
|
1416
|
+
readonly deInterlace?: boolean;
|
|
1417
|
+
/**
|
|
1418
|
+
* Optional. Whether to require a non anamorphic stream.
|
|
1419
|
+
* @type {boolean}
|
|
1420
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1421
|
+
*/
|
|
1422
|
+
readonly requireNonAnamorphic?: boolean;
|
|
1423
|
+
/**
|
|
1424
|
+
* Optional. The maximum number of audio channels to transcode.
|
|
1425
|
+
* @type {number}
|
|
1426
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1427
|
+
*/
|
|
1428
|
+
readonly transcodingMaxAudioChannels?: number;
|
|
1429
|
+
/**
|
|
1430
|
+
* Optional. The limit of how many cpu cores to use.
|
|
1431
|
+
* @type {number}
|
|
1432
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1433
|
+
*/
|
|
1434
|
+
readonly cpuCoreLimit?: number;
|
|
1435
|
+
/**
|
|
1436
|
+
* The live stream id.
|
|
1437
|
+
* @type {string}
|
|
1438
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1439
|
+
*/
|
|
1440
|
+
readonly liveStreamId?: string;
|
|
1441
|
+
/**
|
|
1442
|
+
* Optional. Whether to enable the MpegtsM2Ts mode.
|
|
1443
|
+
* @type {boolean}
|
|
1444
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1445
|
+
*/
|
|
1446
|
+
readonly enableMpegtsM2TsMode?: boolean;
|
|
1447
|
+
/**
|
|
1448
|
+
* 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.
|
|
1449
|
+
* @type {string}
|
|
1450
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1451
|
+
*/
|
|
1452
|
+
readonly videoCodec?: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* Optional. Specify a subtitle codec to encode to.
|
|
1455
|
+
* @type {string}
|
|
1456
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1457
|
+
*/
|
|
1458
|
+
readonly subtitleCodec?: string;
|
|
1459
|
+
/**
|
|
1460
|
+
* Optional. The transcoding reason.
|
|
1461
|
+
* @type {string}
|
|
1462
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1463
|
+
*/
|
|
1464
|
+
readonly transcodeReasons?: string;
|
|
1465
|
+
/**
|
|
1466
|
+
* Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
1467
|
+
* @type {number}
|
|
1468
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1469
|
+
*/
|
|
1470
|
+
readonly audioStreamIndex?: number;
|
|
1471
|
+
/**
|
|
1472
|
+
* Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
1473
|
+
* @type {number}
|
|
1474
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1475
|
+
*/
|
|
1476
|
+
readonly videoStreamIndex?: number;
|
|
1477
|
+
/**
|
|
1478
|
+
* Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
1479
|
+
* @type {EncodingContext}
|
|
1480
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1481
|
+
*/
|
|
1482
|
+
readonly context?: EncodingContext;
|
|
1483
|
+
/**
|
|
1484
|
+
* Optional. The streaming options.
|
|
1485
|
+
* @type {{ [key: string]: string; }}
|
|
1486
|
+
* @memberof VideosApiGetVideoStreamByContainer
|
|
1487
|
+
*/
|
|
1488
|
+
readonly streamOptions?: {
|
|
1489
|
+
[key: string]: string;
|
|
1490
|
+
};
|
|
1491
|
+
}
|
|
1492
|
+
/**
|
|
1493
|
+
* Request parameters for headVideoStream operation in VideosApi.
|
|
1494
|
+
* @export
|
|
1495
|
+
* @interface VideosApiHeadVideoStreamRequest
|
|
1496
|
+
*/
|
|
1497
|
+
export interface VideosApiHeadVideoStreamRequest {
|
|
1498
|
+
/**
|
|
1499
|
+
* The item id.
|
|
1500
|
+
* @type {string}
|
|
1501
|
+
* @memberof VideosApiHeadVideoStream
|
|
1502
|
+
*/
|
|
1503
|
+
readonly itemId: string;
|
|
1504
|
+
/**
|
|
1505
|
+
* The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
|
|
1506
|
+
* @type {string}
|
|
1507
|
+
* @memberof VideosApiHeadVideoStream
|
|
1508
|
+
*/
|
|
1509
|
+
readonly container?: string;
|
|
1510
|
+
/**
|
|
1511
|
+
* 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.
|
|
1512
|
+
* @type {boolean}
|
|
1513
|
+
* @memberof VideosApiHeadVideoStream
|
|
1514
|
+
*/
|
|
1515
|
+
readonly _static?: boolean;
|
|
1516
|
+
/**
|
|
1517
|
+
* The streaming parameters.
|
|
1518
|
+
* @type {string}
|
|
1519
|
+
* @memberof VideosApiHeadVideoStream
|
|
1520
|
+
*/
|
|
1521
|
+
readonly params?: string;
|
|
1522
|
+
/**
|
|
1523
|
+
* The tag.
|
|
1524
|
+
* @type {string}
|
|
1525
|
+
* @memberof VideosApiHeadVideoStream
|
|
1526
|
+
*/
|
|
1527
|
+
readonly tag?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* Optional. The dlna device profile id to utilize.
|
|
1530
|
+
* @type {string}
|
|
1531
|
+
* @memberof VideosApiHeadVideoStream
|
|
1532
|
+
*/
|
|
1533
|
+
readonly deviceProfileId?: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* The play session id.
|
|
1536
|
+
* @type {string}
|
|
1537
|
+
* @memberof VideosApiHeadVideoStream
|
|
1538
|
+
*/
|
|
1539
|
+
readonly playSessionId?: string;
|
|
1540
|
+
/**
|
|
1541
|
+
* The segment container.
|
|
1542
|
+
* @type {string}
|
|
1543
|
+
* @memberof VideosApiHeadVideoStream
|
|
1544
|
+
*/
|
|
1545
|
+
readonly segmentContainer?: string;
|
|
1546
|
+
/**
|
|
1547
|
+
* The segment length.
|
|
1548
|
+
* @type {number}
|
|
1549
|
+
* @memberof VideosApiHeadVideoStream
|
|
1550
|
+
*/
|
|
1551
|
+
readonly segmentLength?: number;
|
|
1552
|
+
/**
|
|
1553
|
+
* The minimum number of segments.
|
|
1554
|
+
* @type {number}
|
|
1555
|
+
* @memberof VideosApiHeadVideoStream
|
|
1556
|
+
*/
|
|
1557
|
+
readonly minSegments?: number;
|
|
1558
|
+
/**
|
|
1559
|
+
* The media version id, if playing an alternate version.
|
|
1560
|
+
* @type {string}
|
|
1561
|
+
* @memberof VideosApiHeadVideoStream
|
|
1562
|
+
*/
|
|
1563
|
+
readonly mediaSourceId?: string;
|
|
1564
|
+
/**
|
|
1565
|
+
* The device id of the client requesting. Used to stop encoding processes when needed.
|
|
1566
|
+
* @type {string}
|
|
1567
|
+
* @memberof VideosApiHeadVideoStream
|
|
1568
|
+
*/
|
|
1569
|
+
readonly deviceId?: string;
|
|
1570
|
+
/**
|
|
1571
|
+
* 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.
|
|
1572
|
+
* @type {string}
|
|
1573
|
+
* @memberof VideosApiHeadVideoStream
|
|
1574
|
+
*/
|
|
1575
|
+
readonly audioCodec?: string;
|
|
1576
|
+
/**
|
|
1577
|
+
* Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
1578
|
+
* @type {boolean}
|
|
1579
|
+
* @memberof VideosApiHeadVideoStream
|
|
1580
|
+
*/
|
|
1581
|
+
readonly enableAutoStreamCopy?: boolean;
|
|
1582
|
+
/**
|
|
1583
|
+
* Whether or not to allow copying of the video stream url.
|
|
1584
|
+
* @type {boolean}
|
|
1585
|
+
* @memberof VideosApiHeadVideoStream
|
|
1586
|
+
*/
|
|
1587
|
+
readonly allowVideoStreamCopy?: boolean;
|
|
1588
|
+
/**
|
|
1589
|
+
* Whether or not to allow copying of the audio stream url.
|
|
1590
|
+
* @type {boolean}
|
|
1591
|
+
* @memberof VideosApiHeadVideoStream
|
|
1592
|
+
*/
|
|
1593
|
+
readonly allowAudioStreamCopy?: boolean;
|
|
1594
|
+
/**
|
|
1595
|
+
* Optional. Whether to break on non key frames.
|
|
1596
|
+
* @type {boolean}
|
|
1597
|
+
* @memberof VideosApiHeadVideoStream
|
|
1598
|
+
*/
|
|
1599
|
+
readonly breakOnNonKeyFrames?: boolean;
|
|
1600
|
+
/**
|
|
1601
|
+
* Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
1602
|
+
* @type {number}
|
|
1603
|
+
* @memberof VideosApiHeadVideoStream
|
|
1604
|
+
*/
|
|
1605
|
+
readonly audioSampleRate?: number;
|
|
1606
|
+
/**
|
|
1607
|
+
* Optional. The maximum audio bit depth.
|
|
1608
|
+
* @type {number}
|
|
1609
|
+
* @memberof VideosApiHeadVideoStream
|
|
1610
|
+
*/
|
|
1611
|
+
readonly maxAudioBitDepth?: number;
|
|
1612
|
+
/**
|
|
1613
|
+
* Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
1614
|
+
* @type {number}
|
|
1615
|
+
* @memberof VideosApiHeadVideoStream
|
|
1616
|
+
*/
|
|
1617
|
+
readonly audioBitRate?: number;
|
|
1618
|
+
/**
|
|
1619
|
+
* Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
1620
|
+
* @type {number}
|
|
1621
|
+
* @memberof VideosApiHeadVideoStream
|
|
1622
|
+
*/
|
|
1623
|
+
readonly audioChannels?: number;
|
|
1624
|
+
/**
|
|
1625
|
+
* Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
1626
|
+
* @type {number}
|
|
1627
|
+
* @memberof VideosApiHeadVideoStream
|
|
1628
|
+
*/
|
|
1629
|
+
readonly maxAudioChannels?: number;
|
|
1630
|
+
/**
|
|
1631
|
+
* Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
1632
|
+
* @type {string}
|
|
1633
|
+
* @memberof VideosApiHeadVideoStream
|
|
1634
|
+
*/
|
|
1635
|
+
readonly profile?: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
1638
|
+
* @type {string}
|
|
1639
|
+
* @memberof VideosApiHeadVideoStream
|
|
1640
|
+
*/
|
|
1641
|
+
readonly level?: string;
|
|
1642
|
+
/**
|
|
1643
|
+
* Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
|
|
1644
|
+
* @type {number}
|
|
1645
|
+
* @memberof VideosApiHeadVideoStream
|
|
1646
|
+
*/
|
|
1647
|
+
readonly framerate?: number;
|
|
1648
|
+
/**
|
|
1649
|
+
* Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
|
|
1650
|
+
* @type {number}
|
|
1651
|
+
* @memberof VideosApiHeadVideoStream
|
|
1652
|
+
*/
|
|
1653
|
+
readonly maxFramerate?: number;
|
|
1654
|
+
/**
|
|
1655
|
+
* Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
1656
|
+
* @type {boolean}
|
|
1657
|
+
* @memberof VideosApiHeadVideoStream
|
|
1658
|
+
*/
|
|
1659
|
+
readonly copyTimestamps?: boolean;
|
|
1660
|
+
/**
|
|
1661
|
+
* Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
1662
|
+
* @type {number}
|
|
1663
|
+
* @memberof VideosApiHeadVideoStream
|
|
1664
|
+
*/
|
|
1665
|
+
readonly startTimeTicks?: number;
|
|
1666
|
+
/**
|
|
1667
|
+
* Optional. The fixed horizontal resolution of the encoded video.
|
|
1668
|
+
* @type {number}
|
|
1669
|
+
* @memberof VideosApiHeadVideoStream
|
|
1670
|
+
*/
|
|
1671
|
+
readonly width?: number;
|
|
1672
|
+
/**
|
|
1673
|
+
* Optional. The fixed vertical resolution of the encoded video.
|
|
1674
|
+
* @type {number}
|
|
1675
|
+
* @memberof VideosApiHeadVideoStream
|
|
1676
|
+
*/
|
|
1677
|
+
readonly height?: number;
|
|
1678
|
+
/**
|
|
1679
|
+
* Optional. The maximum horizontal resolution of the encoded video.
|
|
1680
|
+
* @type {number}
|
|
1681
|
+
* @memberof VideosApiHeadVideoStream
|
|
1682
|
+
*/
|
|
1683
|
+
readonly maxWidth?: number;
|
|
1684
|
+
/**
|
|
1685
|
+
* Optional. The maximum vertical resolution of the encoded video.
|
|
1686
|
+
* @type {number}
|
|
1687
|
+
* @memberof VideosApiHeadVideoStream
|
|
1688
|
+
*/
|
|
1689
|
+
readonly maxHeight?: number;
|
|
1690
|
+
/**
|
|
1691
|
+
* Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
1692
|
+
* @type {number}
|
|
1693
|
+
* @memberof VideosApiHeadVideoStream
|
|
1694
|
+
*/
|
|
1695
|
+
readonly videoBitRate?: number;
|
|
1696
|
+
/**
|
|
1697
|
+
* Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
1698
|
+
* @type {number}
|
|
1699
|
+
* @memberof VideosApiHeadVideoStream
|
|
1700
|
+
*/
|
|
1701
|
+
readonly subtitleStreamIndex?: number;
|
|
1702
|
+
/**
|
|
1703
|
+
* Optional. Specify the subtitle delivery method.
|
|
1704
|
+
* @type {SubtitleDeliveryMethod}
|
|
1705
|
+
* @memberof VideosApiHeadVideoStream
|
|
1706
|
+
*/
|
|
1707
|
+
readonly subtitleMethod?: SubtitleDeliveryMethod;
|
|
1708
|
+
/**
|
|
1709
|
+
* Optional.
|
|
1710
|
+
* @type {number}
|
|
1711
|
+
* @memberof VideosApiHeadVideoStream
|
|
1712
|
+
*/
|
|
1713
|
+
readonly maxRefFrames?: number;
|
|
1714
|
+
/**
|
|
1715
|
+
* Optional. The maximum video bit depth.
|
|
1716
|
+
* @type {number}
|
|
1717
|
+
* @memberof VideosApiHeadVideoStream
|
|
1718
|
+
*/
|
|
1719
|
+
readonly maxVideoBitDepth?: number;
|
|
1720
|
+
/**
|
|
1721
|
+
* Optional. Whether to require avc.
|
|
1722
|
+
* @type {boolean}
|
|
1723
|
+
* @memberof VideosApiHeadVideoStream
|
|
1724
|
+
*/
|
|
1725
|
+
readonly requireAvc?: boolean;
|
|
1726
|
+
/**
|
|
1727
|
+
* Optional. Whether to deinterlace the video.
|
|
1728
|
+
* @type {boolean}
|
|
1729
|
+
* @memberof VideosApiHeadVideoStream
|
|
1730
|
+
*/
|
|
1731
|
+
readonly deInterlace?: boolean;
|
|
1732
|
+
/**
|
|
1733
|
+
* Optional. Whether to require a non anamorphic stream.
|
|
1734
|
+
* @type {boolean}
|
|
1735
|
+
* @memberof VideosApiHeadVideoStream
|
|
1736
|
+
*/
|
|
1737
|
+
readonly requireNonAnamorphic?: boolean;
|
|
1738
|
+
/**
|
|
1739
|
+
* Optional. The maximum number of audio channels to transcode.
|
|
1740
|
+
* @type {number}
|
|
1741
|
+
* @memberof VideosApiHeadVideoStream
|
|
1742
|
+
*/
|
|
1743
|
+
readonly transcodingMaxAudioChannels?: number;
|
|
1744
|
+
/**
|
|
1745
|
+
* Optional. The limit of how many cpu cores to use.
|
|
1746
|
+
* @type {number}
|
|
1747
|
+
* @memberof VideosApiHeadVideoStream
|
|
1748
|
+
*/
|
|
1749
|
+
readonly cpuCoreLimit?: number;
|
|
1750
|
+
/**
|
|
1751
|
+
* The live stream id.
|
|
1752
|
+
* @type {string}
|
|
1753
|
+
* @memberof VideosApiHeadVideoStream
|
|
1754
|
+
*/
|
|
1755
|
+
readonly liveStreamId?: string;
|
|
1756
|
+
/**
|
|
1757
|
+
* Optional. Whether to enable the MpegtsM2Ts mode.
|
|
1758
|
+
* @type {boolean}
|
|
1759
|
+
* @memberof VideosApiHeadVideoStream
|
|
1760
|
+
*/
|
|
1761
|
+
readonly enableMpegtsM2TsMode?: boolean;
|
|
1762
|
+
/**
|
|
1763
|
+
* 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.
|
|
1764
|
+
* @type {string}
|
|
1765
|
+
* @memberof VideosApiHeadVideoStream
|
|
1766
|
+
*/
|
|
1767
|
+
readonly videoCodec?: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* Optional. Specify a subtitle codec to encode to.
|
|
1770
|
+
* @type {string}
|
|
1771
|
+
* @memberof VideosApiHeadVideoStream
|
|
1772
|
+
*/
|
|
1773
|
+
readonly subtitleCodec?: string;
|
|
1774
|
+
/**
|
|
1775
|
+
* Optional. The transcoding reason.
|
|
1776
|
+
* @type {string}
|
|
1777
|
+
* @memberof VideosApiHeadVideoStream
|
|
1778
|
+
*/
|
|
1779
|
+
readonly transcodeReasons?: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
1782
|
+
* @type {number}
|
|
1783
|
+
* @memberof VideosApiHeadVideoStream
|
|
1784
|
+
*/
|
|
1785
|
+
readonly audioStreamIndex?: number;
|
|
1786
|
+
/**
|
|
1787
|
+
* Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
1788
|
+
* @type {number}
|
|
1789
|
+
* @memberof VideosApiHeadVideoStream
|
|
1790
|
+
*/
|
|
1791
|
+
readonly videoStreamIndex?: number;
|
|
1792
|
+
/**
|
|
1793
|
+
* Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
1794
|
+
* @type {EncodingContext}
|
|
1795
|
+
* @memberof VideosApiHeadVideoStream
|
|
1796
|
+
*/
|
|
1797
|
+
readonly context?: EncodingContext;
|
|
1798
|
+
/**
|
|
1799
|
+
* Optional. The streaming options.
|
|
1800
|
+
* @type {{ [key: string]: string; }}
|
|
1801
|
+
* @memberof VideosApiHeadVideoStream
|
|
1802
|
+
*/
|
|
1803
|
+
readonly streamOptions?: {
|
|
1804
|
+
[key: string]: string;
|
|
1805
|
+
};
|
|
1806
|
+
}
|
|
1807
|
+
/**
|
|
1808
|
+
* Request parameters for headVideoStreamByContainer operation in VideosApi.
|
|
1809
|
+
* @export
|
|
1810
|
+
* @interface VideosApiHeadVideoStreamByContainerRequest
|
|
1811
|
+
*/
|
|
1812
|
+
export interface VideosApiHeadVideoStreamByContainerRequest {
|
|
1813
|
+
/**
|
|
1814
|
+
* The item id.
|
|
1815
|
+
* @type {string}
|
|
1816
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1817
|
+
*/
|
|
1818
|
+
readonly itemId: string;
|
|
1819
|
+
/**
|
|
1820
|
+
* The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
|
|
1821
|
+
* @type {string}
|
|
1822
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1823
|
+
*/
|
|
1824
|
+
readonly container: string;
|
|
1825
|
+
/**
|
|
1826
|
+
* 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.
|
|
1827
|
+
* @type {boolean}
|
|
1828
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1829
|
+
*/
|
|
1830
|
+
readonly _static?: boolean;
|
|
1831
|
+
/**
|
|
1832
|
+
* The streaming parameters.
|
|
1833
|
+
* @type {string}
|
|
1834
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1835
|
+
*/
|
|
1836
|
+
readonly params?: string;
|
|
1837
|
+
/**
|
|
1838
|
+
* The tag.
|
|
1839
|
+
* @type {string}
|
|
1840
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1841
|
+
*/
|
|
1842
|
+
readonly tag?: string;
|
|
1843
|
+
/**
|
|
1844
|
+
* Optional. The dlna device profile id to utilize.
|
|
1845
|
+
* @type {string}
|
|
1846
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1847
|
+
*/
|
|
1848
|
+
readonly deviceProfileId?: string;
|
|
1849
|
+
/**
|
|
1850
|
+
* The play session id.
|
|
1851
|
+
* @type {string}
|
|
1852
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1853
|
+
*/
|
|
1854
|
+
readonly playSessionId?: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* The segment container.
|
|
1857
|
+
* @type {string}
|
|
1858
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1859
|
+
*/
|
|
1860
|
+
readonly segmentContainer?: string;
|
|
1861
|
+
/**
|
|
1862
|
+
* The segment length.
|
|
1863
|
+
* @type {number}
|
|
1864
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1865
|
+
*/
|
|
1866
|
+
readonly segmentLength?: number;
|
|
1867
|
+
/**
|
|
1868
|
+
* The minimum number of segments.
|
|
1869
|
+
* @type {number}
|
|
1870
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1871
|
+
*/
|
|
1872
|
+
readonly minSegments?: number;
|
|
1873
|
+
/**
|
|
1874
|
+
* The media version id, if playing an alternate version.
|
|
1875
|
+
* @type {string}
|
|
1876
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1877
|
+
*/
|
|
1878
|
+
readonly mediaSourceId?: string;
|
|
1879
|
+
/**
|
|
1880
|
+
* The device id of the client requesting. Used to stop encoding processes when needed.
|
|
1881
|
+
* @type {string}
|
|
1882
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1883
|
+
*/
|
|
1884
|
+
readonly deviceId?: string;
|
|
1885
|
+
/**
|
|
1886
|
+
* 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.
|
|
1887
|
+
* @type {string}
|
|
1888
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1889
|
+
*/
|
|
1890
|
+
readonly audioCodec?: string;
|
|
1891
|
+
/**
|
|
1892
|
+
* Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.
|
|
1893
|
+
* @type {boolean}
|
|
1894
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1895
|
+
*/
|
|
1896
|
+
readonly enableAutoStreamCopy?: boolean;
|
|
1897
|
+
/**
|
|
1898
|
+
* Whether or not to allow copying of the video stream url.
|
|
1899
|
+
* @type {boolean}
|
|
1900
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1901
|
+
*/
|
|
1902
|
+
readonly allowVideoStreamCopy?: boolean;
|
|
1903
|
+
/**
|
|
1904
|
+
* Whether or not to allow copying of the audio stream url.
|
|
1905
|
+
* @type {boolean}
|
|
1906
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1907
|
+
*/
|
|
1908
|
+
readonly allowAudioStreamCopy?: boolean;
|
|
1909
|
+
/**
|
|
1910
|
+
* Optional. Whether to break on non key frames.
|
|
1911
|
+
* @type {boolean}
|
|
1912
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1913
|
+
*/
|
|
1914
|
+
readonly breakOnNonKeyFrames?: boolean;
|
|
1915
|
+
/**
|
|
1916
|
+
* Optional. Specify a specific audio sample rate, e.g. 44100.
|
|
1917
|
+
* @type {number}
|
|
1918
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1919
|
+
*/
|
|
1920
|
+
readonly audioSampleRate?: number;
|
|
1921
|
+
/**
|
|
1922
|
+
* Optional. The maximum audio bit depth.
|
|
1923
|
+
* @type {number}
|
|
1924
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1925
|
+
*/
|
|
1926
|
+
readonly maxAudioBitDepth?: number;
|
|
1927
|
+
/**
|
|
1928
|
+
* Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.
|
|
1929
|
+
* @type {number}
|
|
1930
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1931
|
+
*/
|
|
1932
|
+
readonly audioBitRate?: number;
|
|
1933
|
+
/**
|
|
1934
|
+
* Optional. Specify a specific number of audio channels to encode to, e.g. 2.
|
|
1935
|
+
* @type {number}
|
|
1936
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1937
|
+
*/
|
|
1938
|
+
readonly audioChannels?: number;
|
|
1939
|
+
/**
|
|
1940
|
+
* Optional. Specify a maximum number of audio channels to encode to, e.g. 2.
|
|
1941
|
+
* @type {number}
|
|
1942
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1943
|
+
*/
|
|
1944
|
+
readonly maxAudioChannels?: number;
|
|
1945
|
+
/**
|
|
1946
|
+
* Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.
|
|
1947
|
+
* @type {string}
|
|
1948
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1949
|
+
*/
|
|
1950
|
+
readonly profile?: string;
|
|
1951
|
+
/**
|
|
1952
|
+
* Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.
|
|
1953
|
+
* @type {string}
|
|
1954
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1955
|
+
*/
|
|
1956
|
+
readonly level?: string;
|
|
1957
|
+
/**
|
|
1958
|
+
* Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
|
|
1959
|
+
* @type {number}
|
|
1960
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1961
|
+
*/
|
|
1962
|
+
readonly framerate?: number;
|
|
1963
|
+
/**
|
|
1964
|
+
* Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.
|
|
1965
|
+
* @type {number}
|
|
1966
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1967
|
+
*/
|
|
1968
|
+
readonly maxFramerate?: number;
|
|
1969
|
+
/**
|
|
1970
|
+
* Whether or not to copy timestamps when transcoding with an offset. Defaults to false.
|
|
1971
|
+
* @type {boolean}
|
|
1972
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1973
|
+
*/
|
|
1974
|
+
readonly copyTimestamps?: boolean;
|
|
1975
|
+
/**
|
|
1976
|
+
* Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.
|
|
1977
|
+
* @type {number}
|
|
1978
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1979
|
+
*/
|
|
1980
|
+
readonly startTimeTicks?: number;
|
|
1981
|
+
/**
|
|
1982
|
+
* Optional. The fixed horizontal resolution of the encoded video.
|
|
1983
|
+
* @type {number}
|
|
1984
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1985
|
+
*/
|
|
1986
|
+
readonly width?: number;
|
|
1987
|
+
/**
|
|
1988
|
+
* Optional. The fixed vertical resolution of the encoded video.
|
|
1989
|
+
* @type {number}
|
|
1990
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1991
|
+
*/
|
|
1992
|
+
readonly height?: number;
|
|
1993
|
+
/**
|
|
1994
|
+
* Optional. The maximum horizontal resolution of the encoded video.
|
|
1995
|
+
* @type {number}
|
|
1996
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
1997
|
+
*/
|
|
1998
|
+
readonly maxWidth?: number;
|
|
1999
|
+
/**
|
|
2000
|
+
* Optional. The maximum vertical resolution of the encoded video.
|
|
2001
|
+
* @type {number}
|
|
2002
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2003
|
+
*/
|
|
2004
|
+
readonly maxHeight?: number;
|
|
2005
|
+
/**
|
|
2006
|
+
* Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.
|
|
2007
|
+
* @type {number}
|
|
2008
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2009
|
+
*/
|
|
2010
|
+
readonly videoBitRate?: number;
|
|
2011
|
+
/**
|
|
2012
|
+
* Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.
|
|
2013
|
+
* @type {number}
|
|
2014
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2015
|
+
*/
|
|
2016
|
+
readonly subtitleStreamIndex?: number;
|
|
2017
|
+
/**
|
|
2018
|
+
* Optional. Specify the subtitle delivery method.
|
|
2019
|
+
* @type {SubtitleDeliveryMethod}
|
|
2020
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2021
|
+
*/
|
|
2022
|
+
readonly subtitleMethod?: SubtitleDeliveryMethod;
|
|
2023
|
+
/**
|
|
2024
|
+
* Optional.
|
|
2025
|
+
* @type {number}
|
|
2026
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2027
|
+
*/
|
|
2028
|
+
readonly maxRefFrames?: number;
|
|
2029
|
+
/**
|
|
2030
|
+
* Optional. The maximum video bit depth.
|
|
2031
|
+
* @type {number}
|
|
2032
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2033
|
+
*/
|
|
2034
|
+
readonly maxVideoBitDepth?: number;
|
|
2035
|
+
/**
|
|
2036
|
+
* Optional. Whether to require avc.
|
|
2037
|
+
* @type {boolean}
|
|
2038
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2039
|
+
*/
|
|
2040
|
+
readonly requireAvc?: boolean;
|
|
2041
|
+
/**
|
|
2042
|
+
* Optional. Whether to deinterlace the video.
|
|
2043
|
+
* @type {boolean}
|
|
2044
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2045
|
+
*/
|
|
2046
|
+
readonly deInterlace?: boolean;
|
|
2047
|
+
/**
|
|
2048
|
+
* Optional. Whether to require a non anamorphic stream.
|
|
2049
|
+
* @type {boolean}
|
|
2050
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2051
|
+
*/
|
|
2052
|
+
readonly requireNonAnamorphic?: boolean;
|
|
2053
|
+
/**
|
|
2054
|
+
* Optional. The maximum number of audio channels to transcode.
|
|
2055
|
+
* @type {number}
|
|
2056
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2057
|
+
*/
|
|
2058
|
+
readonly transcodingMaxAudioChannels?: number;
|
|
2059
|
+
/**
|
|
2060
|
+
* Optional. The limit of how many cpu cores to use.
|
|
2061
|
+
* @type {number}
|
|
2062
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2063
|
+
*/
|
|
2064
|
+
readonly cpuCoreLimit?: number;
|
|
2065
|
+
/**
|
|
2066
|
+
* The live stream id.
|
|
2067
|
+
* @type {string}
|
|
2068
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2069
|
+
*/
|
|
2070
|
+
readonly liveStreamId?: string;
|
|
2071
|
+
/**
|
|
2072
|
+
* Optional. Whether to enable the MpegtsM2Ts mode.
|
|
2073
|
+
* @type {boolean}
|
|
2074
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2075
|
+
*/
|
|
2076
|
+
readonly enableMpegtsM2TsMode?: boolean;
|
|
2077
|
+
/**
|
|
2078
|
+
* 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.
|
|
2079
|
+
* @type {string}
|
|
2080
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2081
|
+
*/
|
|
2082
|
+
readonly videoCodec?: string;
|
|
2083
|
+
/**
|
|
2084
|
+
* Optional. Specify a subtitle codec to encode to.
|
|
2085
|
+
* @type {string}
|
|
2086
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2087
|
+
*/
|
|
2088
|
+
readonly subtitleCodec?: string;
|
|
2089
|
+
/**
|
|
2090
|
+
* Optional. The transcoding reason.
|
|
2091
|
+
* @type {string}
|
|
2092
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2093
|
+
*/
|
|
2094
|
+
readonly transcodeReasons?: string;
|
|
2095
|
+
/**
|
|
2096
|
+
* Optional. The index of the audio stream to use. If omitted the first audio stream will be used.
|
|
2097
|
+
* @type {number}
|
|
2098
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2099
|
+
*/
|
|
2100
|
+
readonly audioStreamIndex?: number;
|
|
2101
|
+
/**
|
|
2102
|
+
* Optional. The index of the video stream to use. If omitted the first video stream will be used.
|
|
2103
|
+
* @type {number}
|
|
2104
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2105
|
+
*/
|
|
2106
|
+
readonly videoStreamIndex?: number;
|
|
2107
|
+
/**
|
|
2108
|
+
* Optional. The MediaBrowser.Model.Dlna.EncodingContext.
|
|
2109
|
+
* @type {EncodingContext}
|
|
2110
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2111
|
+
*/
|
|
2112
|
+
readonly context?: EncodingContext;
|
|
2113
|
+
/**
|
|
2114
|
+
* Optional. The streaming options.
|
|
2115
|
+
* @type {{ [key: string]: string; }}
|
|
2116
|
+
* @memberof VideosApiHeadVideoStreamByContainer
|
|
2117
|
+
*/
|
|
2118
|
+
readonly streamOptions?: {
|
|
2119
|
+
[key: string]: string;
|
|
2120
|
+
};
|
|
2121
|
+
}
|
|
2122
|
+
/**
|
|
2123
|
+
* Request parameters for mergeVersions operation in VideosApi.
|
|
2124
|
+
* @export
|
|
2125
|
+
* @interface VideosApiMergeVersionsRequest
|
|
2126
|
+
*/
|
|
2127
|
+
export interface VideosApiMergeVersionsRequest {
|
|
2128
|
+
/**
|
|
2129
|
+
* Item id list. This allows multiple, comma delimited.
|
|
2130
|
+
* @type {Array<string>}
|
|
2131
|
+
* @memberof VideosApiMergeVersions
|
|
2132
|
+
*/
|
|
2133
|
+
readonly ids: Array<string>;
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* VideosApi - object-oriented interface
|
|
2137
|
+
* @export
|
|
2138
|
+
* @class VideosApi
|
|
2139
|
+
* @extends {BaseAPI}
|
|
2140
|
+
*/
|
|
2141
|
+
export declare class VideosApi extends BaseAPI {
|
|
2142
|
+
/**
|
|
2143
|
+
*
|
|
2144
|
+
* @summary Removes alternate video sources.
|
|
2145
|
+
* @param {VideosApiDeleteAlternateSourcesRequest} requestParameters Request parameters.
|
|
2146
|
+
* @param {*} [options] Override http request option.
|
|
2147
|
+
* @throws {RequiredError}
|
|
2148
|
+
* @memberof VideosApi
|
|
2149
|
+
*/
|
|
2150
|
+
deleteAlternateSources(requestParameters: VideosApiDeleteAlternateSourcesRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2151
|
+
/**
|
|
2152
|
+
*
|
|
2153
|
+
* @summary Gets additional parts for a video.
|
|
2154
|
+
* @param {VideosApiGetAdditionalPartRequest} requestParameters Request parameters.
|
|
2155
|
+
* @param {*} [options] Override http request option.
|
|
2156
|
+
* @throws {RequiredError}
|
|
2157
|
+
* @memberof VideosApi
|
|
2158
|
+
*/
|
|
2159
|
+
getAdditionalPart(requestParameters: VideosApiGetAdditionalPartRequest, options?: any): Promise<import("axios").AxiosResponse<BaseItemDtoQueryResult, any>>;
|
|
2160
|
+
/**
|
|
2161
|
+
*
|
|
2162
|
+
* @summary Gets a video stream.
|
|
2163
|
+
* @param {VideosApiGetVideoStreamRequest} requestParameters Request parameters.
|
|
2164
|
+
* @param {*} [options] Override http request option.
|
|
2165
|
+
* @throws {RequiredError}
|
|
2166
|
+
* @memberof VideosApi
|
|
2167
|
+
*/
|
|
2168
|
+
getVideoStream(requestParameters: VideosApiGetVideoStreamRequest, options?: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
2169
|
+
/**
|
|
2170
|
+
*
|
|
2171
|
+
* @summary Gets a video stream.
|
|
2172
|
+
* @param {VideosApiGetVideoStreamByContainerRequest} requestParameters Request parameters.
|
|
2173
|
+
* @param {*} [options] Override http request option.
|
|
2174
|
+
* @throws {RequiredError}
|
|
2175
|
+
* @memberof VideosApi
|
|
2176
|
+
*/
|
|
2177
|
+
getVideoStreamByContainer(requestParameters: VideosApiGetVideoStreamByContainerRequest, options?: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
2178
|
+
/**
|
|
2179
|
+
*
|
|
2180
|
+
* @summary Gets a video stream.
|
|
2181
|
+
* @param {VideosApiHeadVideoStreamRequest} requestParameters Request parameters.
|
|
2182
|
+
* @param {*} [options] Override http request option.
|
|
2183
|
+
* @throws {RequiredError}
|
|
2184
|
+
* @memberof VideosApi
|
|
2185
|
+
*/
|
|
2186
|
+
headVideoStream(requestParameters: VideosApiHeadVideoStreamRequest, options?: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
2187
|
+
/**
|
|
2188
|
+
*
|
|
2189
|
+
* @summary Gets a video stream.
|
|
2190
|
+
* @param {VideosApiHeadVideoStreamByContainerRequest} requestParameters Request parameters.
|
|
2191
|
+
* @param {*} [options] Override http request option.
|
|
2192
|
+
* @throws {RequiredError}
|
|
2193
|
+
* @memberof VideosApi
|
|
2194
|
+
*/
|
|
2195
|
+
headVideoStreamByContainer(requestParameters: VideosApiHeadVideoStreamByContainerRequest, options?: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
2196
|
+
/**
|
|
2197
|
+
*
|
|
2198
|
+
* @summary Merges videos into a single record.
|
|
2199
|
+
* @param {VideosApiMergeVersionsRequest} requestParameters Request parameters.
|
|
2200
|
+
* @param {*} [options] Override http request option.
|
|
2201
|
+
* @throws {RequiredError}
|
|
2202
|
+
* @memberof VideosApi
|
|
2203
|
+
*/
|
|
2204
|
+
mergeVersions(requestParameters: VideosApiMergeVersionsRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2205
|
+
}
|