PeerTube · Example Payload

Getchannelplayersettings

Get player settings for a video channel.

Player Settings

Getchannelplayersettings is an example object payload from PeerTube, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

Raw ↑ 
{
  "operationId": "getChannelPlayerSettings",
  "method": "GET",
  "path": "/api/v1/player-settings/video-channels/{channelHandle}",
  "summary": "Get channel player settings",
  "description": "Get player settings for a video channel.",
  "tags": [
    "Player Settings"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": "raw",
      "in": "query",
      "required": false,
      "description": "Return raw settings without applying instance defaults",
      "schema": {
        "type": "boolean",
        "default": false
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    },
    "404": {
      "description": "video channel not found",
      "examples": {}
    }
  }
}