aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2018-06-12 20:04:58 +0200
committerChocobozzz <me@florianbigard.com>2018-06-12 20:37:51 +0200
commit2186386cca113506791583cb07d6ccacba7af4e0 (patch)
tree3c214c0b5fbd64332624267fa6e51fd4a9cf6474 /support/doc
parent6ccdf3a23ecec5ba2eeaf487fd1fafdc7606b4bf (diff)
downloadPeerTube-2186386cca113506791583cb07d6ccacba7af4e0.tar.gz
PeerTube-2186386cca113506791583cb07d6ccacba7af4e0.tar.zst
PeerTube-2186386cca113506791583cb07d6ccacba7af4e0.zip
Add concept of video state, and add ability to wait transcoding before
publishing a video
Diffstat (limited to 'support/doc')
-rw-r--r--support/doc/api/html/index.html26
-rw-r--r--support/doc/api/openapi.yaml8
-rw-r--r--support/doc/tools.md9
3 files changed, 41 insertions, 2 deletions
diff --git a/support/doc/api/html/index.html b/support/doc/api/html/index.html
index b75a2a8ba..e1bf61b06 100644
--- a/support/doc/api/html/index.html
+++ b/support/doc/api/html/index.html
@@ -3437,6 +3437,19 @@
3437 </div> 3437 </div>
3438 <div class="prop-row prop-group"> 3438 <div class="prop-row prop-group">
3439 <div class="prop-name"> 3439 <div class="prop-name">
3440 <div class="prop-title">waitTranscoding</div>
3441 <div class="prop-subtitle"> in formData </div>
3442 <div class="prop-subtitle">
3443 <span class="json-property-type">boolean</span>
3444 <span class="json-property-range" title="Value limits"></span>
3445 </div>
3446 </div>
3447 <div class="prop-value">
3448 <p>Whether or not we wait transcoding before publish the video</p>
3449 </div>
3450 </div>
3451 <div class="prop-row prop-group">
3452 <div class="prop-name">
3440 <div class="prop-title">support</div> 3453 <div class="prop-title">support</div>
3441 <div class="prop-subtitle"> in formData </div> 3454 <div class="prop-subtitle"> in formData </div>
3442 <div class="prop-subtitle"> 3455 <div class="prop-subtitle">
@@ -4011,6 +4024,19 @@
4011 </div> 4024 </div>
4012 <div class="prop-row prop-group"> 4025 <div class="prop-row prop-group">
4013 <div class="prop-name"> 4026 <div class="prop-name">
4027 <div class="prop-title">waitTranscoding</div>
4028 <div class="prop-subtitle"> in formData </div>
4029 <div class="prop-subtitle">
4030 <span class="json-property-type">boolean</span>
4031 <span class="json-property-range" title="Value limits"></span>
4032 </div>
4033 </div>
4034 <div class="prop-value">
4035 <p>Whether or not we wait transcoding before publish the video</p>
4036 </div>
4037 </div>
4038 <div class="prop-row prop-group">
4039 <div class="prop-name">
4014 <div class="prop-title">licence</div> 4040 <div class="prop-title">licence</div>
4015 <div class="prop-subtitle"> in formData </div> 4041 <div class="prop-subtitle"> in formData </div>
4016 <div class="prop-subtitle"> 4042 <div class="prop-subtitle">
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index a1e286973..be40af570 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -682,6 +682,10 @@ paths:
682 in: formData 682 in: formData
683 type: string 683 type: string
684 description: 'Video description' 684 description: 'Video description'
685 - name: waitTranscoding
686 in: formData
687 type: boolean
688 description: 'Whether or not we wait transcoding before publish the video'
685 - name: support 689 - name: support
686 in: formData 690 in: formData
687 type: string 691 type: string
@@ -814,6 +818,10 @@ paths:
814 in: formData 818 in: formData
815 type: number 819 type: number
816 description: 'Video category' 820 description: 'Video category'
821 - name: waitTranscoding
822 in: formData
823 type: boolean
824 description: 'Whether or not we wait transcoding before publish the video'
817 - name: licence 825 - name: licence
818 in: formData 826 in: formData
819 type: number 827 type: number
diff --git a/support/doc/tools.md b/support/doc/tools.md
index 85ce0428d..26b44c835 100644
--- a/support/doc/tools.md
+++ b/support/doc/tools.md
@@ -63,13 +63,18 @@ $ node dist/server/tools/import-videos.js \
63 * Vimeo: https://vimeo.com/xxxxxx 63 * Vimeo: https://vimeo.com/xxxxxx
64 * Dailymotion: https://www.dailymotion.com/xxxxx 64 * Dailymotion: https://www.dailymotion.com/xxxxx
65 65
66 The script will get all public videos from Youtube, download them and upload to PeerTube. 66The script will get all public videos from Youtube, download them and upload to PeerTube.
67 Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection... 67Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
68
69Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
70
68 71
69### upload.js 72### upload.js
70 73
71You can use this script to import videos directly from the CLI. 74You can use this script to import videos directly from the CLI.
72 75
76Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
77
73``` 78```
74$ cd ${CLONE} 79$ cd ${CLONE}
75$ node dist/server/tools/upload.js --help 80$ node dist/server/tools/upload.js --help