diff options
author | Chocobozzz <me@florianbigard.com> | 2023-07-11 09:21:13 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2023-07-11 09:21:13 +0200 |
commit | 784e2ad5c34bcfef36a3f69e9e9acd7cbb3d6428 (patch) | |
tree | 29c46cfd6344065eb805680ed080cb05592ee1d4 /support/doc | |
parent | c3030e944ad03c7fd7b5d668a2d88ff03e4cdf19 (diff) | |
download | PeerTube-784e2ad5c34bcfef36a3f69e9e9acd7cbb3d6428.tar.gz PeerTube-784e2ad5c34bcfef36a3f69e9e9acd7cbb3d6428.tar.zst PeerTube-784e2ad5c34bcfef36a3f69e9e9acd7cbb3d6428.zip |
Prefer web videos in favour of webtorrent
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/embeds.md | 2 | ||||
-rw-r--r-- | support/doc/api/openapi.yaml | 46 | ||||
-rw-r--r-- | support/doc/tools.md | 2 |
3 files changed, 25 insertions, 25 deletions
diff --git a/support/doc/api/embeds.md b/support/doc/api/embeds.md index 493268c6e..fd5507e38 100644 --- a/support/doc/api/embeds.md +++ b/support/doc/api/embeds.md | |||
@@ -146,7 +146,7 @@ Value must be a valid color (`red` or `rgba(100, 100, 100, 0.5)`). | |||
146 | 146 | ||
147 | Force a specific player engine. | 147 | Force a specific player engine. |
148 | 148 | ||
149 | Value must be a valid mode (`webtorrent` or `p2p-media-loader`). | 149 | Value must be a valid mode (`web-video` or `p2p-media-loader`). |
150 | 150 | ||
151 | ### api | 151 | ### api |
152 | 152 | ||
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index edf9990e3..e1a21fb5c 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -370,7 +370,7 @@ paths: | |||
370 | get: | 370 | get: |
371 | tags: | 371 | tags: |
372 | - Static Video Files | 372 | - Static Video Files |
373 | summary: Get public WebTorrent video file | 373 | summary: Get public Web Video file |
374 | parameters: | 374 | parameters: |
375 | - $ref: '#/components/parameters/staticFilename' | 375 | - $ref: '#/components/parameters/staticFilename' |
376 | responses: | 376 | responses: |
@@ -382,7 +382,7 @@ paths: | |||
382 | get: | 382 | get: |
383 | tags: | 383 | tags: |
384 | - Static Video Files | 384 | - Static Video Files |
385 | summary: Get private WebTorrent video file | 385 | summary: Get private Web Video video file |
386 | parameters: | 386 | parameters: |
387 | - $ref: '#/components/parameters/staticFilename' | 387 | - $ref: '#/components/parameters/staticFilename' |
388 | - $ref: '#/components/parameters/videoFileToken' | 388 | - $ref: '#/components/parameters/videoFileToken' |
@@ -574,7 +574,7 @@ paths: | |||
574 | - $ref: '#/components/parameters/include' | 574 | - $ref: '#/components/parameters/include' |
575 | - $ref: '#/components/parameters/privacyOneOf' | 575 | - $ref: '#/components/parameters/privacyOneOf' |
576 | - $ref: '#/components/parameters/hasHLSFiles' | 576 | - $ref: '#/components/parameters/hasHLSFiles' |
577 | - $ref: '#/components/parameters/hasWebtorrentFiles' | 577 | - $ref: '#/components/parameters/hasWebVideoFiles' |
578 | responses: | 578 | responses: |
579 | '200': | 579 | '200': |
580 | description: successful operation | 580 | description: successful operation |
@@ -658,7 +658,7 @@ paths: | |||
658 | - $ref: '#/components/parameters/include' | 658 | - $ref: '#/components/parameters/include' |
659 | - $ref: '#/components/parameters/privacyOneOf' | 659 | - $ref: '#/components/parameters/privacyOneOf' |
660 | - $ref: '#/components/parameters/hasHLSFiles' | 660 | - $ref: '#/components/parameters/hasHLSFiles' |
661 | - $ref: '#/components/parameters/hasWebtorrentFiles' | 661 | - $ref: '#/components/parameters/hasWebVideoFiles' |
662 | responses: | 662 | responses: |
663 | '200': | 663 | '200': |
664 | description: successful operation | 664 | description: successful operation |
@@ -748,7 +748,7 @@ paths: | |||
748 | - $ref: '#/components/parameters/include' | 748 | - $ref: '#/components/parameters/include' |
749 | - $ref: '#/components/parameters/privacyOneOf' | 749 | - $ref: '#/components/parameters/privacyOneOf' |
750 | - $ref: '#/components/parameters/hasHLSFiles' | 750 | - $ref: '#/components/parameters/hasHLSFiles' |
751 | - $ref: '#/components/parameters/hasWebtorrentFiles' | 751 | - $ref: '#/components/parameters/hasWebVideoFiles' |
752 | - $ref: '#/components/parameters/skipCount' | 752 | - $ref: '#/components/parameters/skipCount' |
753 | - $ref: '#/components/parameters/start' | 753 | - $ref: '#/components/parameters/start' |
754 | - $ref: '#/components/parameters/count' | 754 | - $ref: '#/components/parameters/count' |
@@ -918,7 +918,7 @@ paths: | |||
918 | description: > | 918 | description: > |
919 | Arises when: | 919 | Arises when: |
920 | - the emailer is disabled and the instance is open to registrations | 920 | - the emailer is disabled and the instance is open to registrations |
921 | - webtorrent and hls are disabled with transcoding enabled - you need at least one enabled | 921 | - web videos and hls are disabled with transcoding enabled - you need at least one enabled |
922 | delete: | 922 | delete: |
923 | summary: Delete instance runtime configuration | 923 | summary: Delete instance runtime configuration |
924 | operationId: delCustomConfig | 924 | operationId: delCustomConfig |
@@ -1873,7 +1873,7 @@ paths: | |||
1873 | - $ref: '#/components/parameters/include' | 1873 | - $ref: '#/components/parameters/include' |
1874 | - $ref: '#/components/parameters/privacyOneOf' | 1874 | - $ref: '#/components/parameters/privacyOneOf' |
1875 | - $ref: '#/components/parameters/hasHLSFiles' | 1875 | - $ref: '#/components/parameters/hasHLSFiles' |
1876 | - $ref: '#/components/parameters/hasWebtorrentFiles' | 1876 | - $ref: '#/components/parameters/hasWebVideoFiles' |
1877 | - $ref: '#/components/parameters/skipCount' | 1877 | - $ref: '#/components/parameters/skipCount' |
1878 | - $ref: '#/components/parameters/start' | 1878 | - $ref: '#/components/parameters/start' |
1879 | - $ref: '#/components/parameters/count' | 1879 | - $ref: '#/components/parameters/count' |
@@ -2418,7 +2418,7 @@ paths: | |||
2418 | - $ref: '#/components/parameters/include' | 2418 | - $ref: '#/components/parameters/include' |
2419 | - $ref: '#/components/parameters/privacyOneOf' | 2419 | - $ref: '#/components/parameters/privacyOneOf' |
2420 | - $ref: '#/components/parameters/hasHLSFiles' | 2420 | - $ref: '#/components/parameters/hasHLSFiles' |
2421 | - $ref: '#/components/parameters/hasWebtorrentFiles' | 2421 | - $ref: '#/components/parameters/hasWebVideoFiles' |
2422 | - $ref: '#/components/parameters/skipCount' | 2422 | - $ref: '#/components/parameters/skipCount' |
2423 | - $ref: '#/components/parameters/start' | 2423 | - $ref: '#/components/parameters/start' |
2424 | - $ref: '#/components/parameters/count' | 2424 | - $ref: '#/components/parameters/count' |
@@ -3799,7 +3799,7 @@ paths: | |||
3799 | type: object | 3799 | type: object |
3800 | properties: | 3800 | properties: |
3801 | passwords: | 3801 | passwords: |
3802 | $ref: '#/components/schemas/AddVideoPasswords' | 3802 | $ref: '#/components/schemas/AddVideoPasswords' |
3803 | responses: | 3803 | responses: |
3804 | '204': | 3804 | '204': |
3805 | description: successful operation | 3805 | description: successful operation |
@@ -3933,7 +3933,7 @@ paths: | |||
3933 | - $ref: '#/components/parameters/include' | 3933 | - $ref: '#/components/parameters/include' |
3934 | - $ref: '#/components/parameters/privacyOneOf' | 3934 | - $ref: '#/components/parameters/privacyOneOf' |
3935 | - $ref: '#/components/parameters/hasHLSFiles' | 3935 | - $ref: '#/components/parameters/hasHLSFiles' |
3936 | - $ref: '#/components/parameters/hasWebtorrentFiles' | 3936 | - $ref: '#/components/parameters/hasWebVideoFiles' |
3937 | - $ref: '#/components/parameters/skipCount' | 3937 | - $ref: '#/components/parameters/skipCount' |
3938 | - $ref: '#/components/parameters/start' | 3938 | - $ref: '#/components/parameters/start' |
3939 | - $ref: '#/components/parameters/count' | 3939 | - $ref: '#/components/parameters/count' |
@@ -4804,15 +4804,15 @@ paths: | |||
4804 | description: successful operation | 4804 | description: successful operation |
4805 | '404': | 4805 | '404': |
4806 | description: video does not exist | 4806 | description: video does not exist |
4807 | '/api/v1/videos/{id}/webtorrent': | 4807 | '/api/v1/videos/{id}/web-videos': |
4808 | delete: | 4808 | delete: |
4809 | summary: Delete video WebTorrent files | 4809 | summary: Delete video Web Video files |
4810 | security: | 4810 | security: |
4811 | - OAuth2: | 4811 | - OAuth2: |
4812 | - admin | 4812 | - admin |
4813 | tags: | 4813 | tags: |
4814 | - Video Files | 4814 | - Video Files |
4815 | operationId: delVideoWebTorrent | 4815 | operationId: delVideoWebVideos |
4816 | parameters: | 4816 | parameters: |
4817 | - $ref: '#/components/parameters/idOrUUID' | 4817 | - $ref: '#/components/parameters/idOrUUID' |
4818 | responses: | 4818 | responses: |
@@ -4842,7 +4842,7 @@ paths: | |||
4842 | type: string | 4842 | type: string |
4843 | enum: | 4843 | enum: |
4844 | - hls | 4844 | - hls |
4845 | - webtorrent | 4845 | - web-video |
4846 | required: | 4846 | required: |
4847 | - transcodingType | 4847 | - transcodingType |
4848 | responses: | 4848 | responses: |
@@ -4880,7 +4880,7 @@ paths: | |||
4880 | - $ref: '#/components/parameters/privacyOneOf' | 4880 | - $ref: '#/components/parameters/privacyOneOf' |
4881 | - $ref: '#/components/parameters/uuids' | 4881 | - $ref: '#/components/parameters/uuids' |
4882 | - $ref: '#/components/parameters/hasHLSFiles' | 4882 | - $ref: '#/components/parameters/hasHLSFiles' |
4883 | - $ref: '#/components/parameters/hasWebtorrentFiles' | 4883 | - $ref: '#/components/parameters/hasWebVideoFiles' |
4884 | - $ref: '#/components/parameters/skipCount' | 4884 | - $ref: '#/components/parameters/skipCount' |
4885 | - $ref: '#/components/parameters/start' | 4885 | - $ref: '#/components/parameters/start' |
4886 | - $ref: '#/components/parameters/count' | 4886 | - $ref: '#/components/parameters/count' |
@@ -6471,13 +6471,13 @@ components: | |||
6471 | schema: | 6471 | schema: |
6472 | type: boolean | 6472 | type: boolean |
6473 | description: '**PeerTube >= 4.0** Display only videos that have HLS files' | 6473 | description: '**PeerTube >= 4.0** Display only videos that have HLS files' |
6474 | hasWebtorrentFiles: | 6474 | hasWebVideoFiles: |
6475 | name: hasWebtorrentFiles | 6475 | name: hasWebVideoFiles |
6476 | in: query | 6476 | in: query |
6477 | required: false | 6477 | required: false |
6478 | schema: | 6478 | schema: |
6479 | type: boolean | 6479 | type: boolean |
6480 | description: '**PeerTube >= 4.0** Display only videos that have WebTorrent files' | 6480 | description: '**PeerTube >= 4.0** Display only videos that have Web Video files' |
6481 | privacyOneOf: | 6481 | privacyOneOf: |
6482 | name: privacyOneOf | 6482 | name: privacyOneOf |
6483 | in: query | 6483 | in: query |
@@ -7222,7 +7222,7 @@ components: | |||
7222 | items: | 7222 | items: |
7223 | $ref: '#/components/schemas/VideoFile' | 7223 | $ref: '#/components/schemas/VideoFile' |
7224 | description: | | 7224 | description: | |
7225 | WebTorrent/raw video files. If WebTorrent is disabled on the server: | 7225 | Web compatible video files. If Web Video is disabled on the server: |
7226 | 7226 | ||
7227 | - field will be empty | 7227 | - field will be empty |
7228 | - video files will be found in `streamingPlaylists[].files` field | 7228 | - video files will be found in `streamingPlaylists[].files` field |
@@ -8136,13 +8136,13 @@ components: | |||
8136 | type: boolean | 8136 | type: boolean |
8137 | webtorrent: | 8137 | webtorrent: |
8138 | type: object | 8138 | type: object |
8139 | description: WebTorrent-specific settings | 8139 | description: Web Video specific settings |
8140 | properties: | 8140 | properties: |
8141 | enabled: | 8141 | enabled: |
8142 | type: boolean | 8142 | type: boolean |
8143 | hls: | 8143 | hls: |
8144 | type: object | 8144 | type: object |
8145 | description: HLS-specific settings | 8145 | description: HLS specific settings |
8146 | properties: | 8146 | properties: |
8147 | enabled: | 8147 | enabled: |
8148 | type: boolean | 8148 | type: boolean |
@@ -9521,7 +9521,7 @@ components: | |||
9521 | type: string | 9521 | type: string |
9522 | enum: | 9522 | enum: |
9523 | - 'p2p-media-loader' | 9523 | - 'p2p-media-loader' |
9524 | - 'webtorrent' | 9524 | - 'web-video' |
9525 | resolution: | 9525 | resolution: |
9526 | type: number | 9526 | type: number |
9527 | description: Current player video resolution | 9527 | description: Current player video resolution |
@@ -9753,7 +9753,7 @@ components: | |||
9753 | password: | 9753 | password: |
9754 | type: string | 9754 | type: string |
9755 | minLength: 2 | 9755 | minLength: 2 |
9756 | videoId: | 9756 | videoId: |
9757 | $ref: '#/components/schemas/id' | 9757 | $ref: '#/components/schemas/id' |
9758 | VideoPasswordList: | 9758 | VideoPasswordList: |
9759 | properties: | 9759 | properties: |
diff --git a/support/doc/tools.md b/support/doc/tools.md index 0c08cd200..d30ff56b3 100644 --- a/support/doc/tools.md +++ b/support/doc/tools.md | |||
@@ -227,7 +227,7 @@ docker-compose exec -u peertube peertube npm run regenerate-thumbnails | |||
227 | 227 | ||
228 | ### create-import-video-file-job.js | 228 | ### create-import-video-file-job.js |
229 | 229 | ||
230 | You can use this script to import a video file to replace an already uploaded file or to add a new webtorrent resolution to a video. PeerTube needs to be running. | 230 | You can use this script to import a video file to replace an already uploaded file or to add a new web compatible resolution to a video. PeerTube needs to be running. |
231 | You can then create a transcoding job using the web interface if you need to optimize your file or create an HLS version of it. | 231 | You can then create a transcoding job using the web interface if you need to optimize your file or create an HLS version of it. |
232 | 232 | ||
233 | ```bash | 233 | ```bash |