Add transcoding profile debug plugin

2021-01-29 13:57:32 +01:00
parent 768597e645
commit 57cd1168bb
3 changed files with 209 additions and 0 deletions
--- a/peertube-plugin-transcoding-profile-debug/README.md
+++ b/peertube-plugin-transcoding-profile-debug/README.md
@ -0,0 +1,96 @@
+# Debug PeerTube transcoding profiles
+
+Allow admins to create custom transcoding profiles using the plugin settings.
+
+## Settings format
+
+### Profiles
+
+**Don't forget the double quotes for fields and values**
+
+```
+{
+  "vod": [
+    {
+      "encoderName": string,
+      "profileName": string,
+      "outputOptions": string[]
+    }
+  ]
+
+  "live": [
+    {
+      "encoderName": string,
+      "profileName": string,
+      "outputOptions": string[]
+    }
+  ]
+}
+```
+
+For example:
+
+```
+{
+  "vod": [
+    {
+      "encoderName": "libopus",
+      "profileName": "test",
+      "outputOptions": []
+    },
+    {
+      "encoderName": "libvpx-vp9",
+      "profileName": "test",
+      "outputOptions": []
+    }
+  ],
+
+  "live": []
+}
+```
+
+
+### Encoders priorities
+
+**Don't forget the double quotes for fields and values**
+
+```
+{
+  "vod": [
+    {
+      "encoderName": string,
+      "streamType": 'audio' | 'video',
+      "priority": number
+    }
+  ]
+
+  "live": [
+    {
+      "encoderName": string,
+      "streamType": 'audio' | 'video',
+      "priority": number
+    }
+  ]
+}
+```
+
+For example:
+
+```
+{
+  "vod": [
+    {
+      "encoderName": "libopus",
+      "streamType": "audio",
+      "priority": 1000
+    },
+   {
+      "encoderName": "libvpx-vp9",
+      "streamType": "video",
+      "priority": 1000
+    }
+  ],
+
+  "live": [ ]
+}
+```