Cluster API 設定

設定の Cluster API 解説書

設定

GET /settings/default

デフォルト設定を取得する

応答 JSON オブジェクト

• [key] (undefined) --

応答例 :

{
  "broadcast": {
    "enable": true
  },
  "dataStreams": {
    "maximumDataCacheAge": 35,
    "minimumDataCacheAge": 30
  },
  "encode": {
    "composition": {
      "abitrate": 128000,
      "enabled": true,
      "has_monitor": true,
      "height": 720,
      "vbitrate": 2500000,
      "width": 1280
    },
    "input": {
      "height": 720,
      "silent": true,
      "stamp_timecode": false,
      "width": 1280
    },
    "output": {
      "abitrate": 128000,
      "height": 720,
      "stamp_timecode": false,
      "vbitrate": 2500000,
      "width": 1280
    },
    "stream": {
      "addr": "",
      "channel": "",
      "delayoffset": "0ms",
      "extradelay": 10,
      "key": "",
      "service": "standalone"
    }
  },
  "info": {
    "description": "Sample to demonstrate genvid",
    "game": "Tutorial",
    "name": "Tutorial Sample"
  },
  "ntp": {
    "polling": 300,
    "server": "pool.ntp.org"
  },
  "services": {
    "leaf": {
      "bufferSize": 4096,
      "compression": false,
      "maxConnections": 500
    }
  }
}

GET /settings

セッティングを取得する

応答 JSON オブジェクト

• [key] (undefined) --

応答例 :

{
  "broadcast": {
    "enable": true
  },
  "dataStreams": {
    "maximumDataCacheAge": 35,
    "minimumDataCacheAge": 30
  },
  "encode": {
    "composition": {
      "abitrate": 128000,
      "enabled": true,
      "has_monitor": true,
      "height": 720,
      "vbitrate": 2500000,
      "width": 1280
    },
    "input": {
      "height": 720,
      "silent": true,
      "stamp_timecode": false,
      "width": 1280
    },
    "output": {
      "abitrate": 128000,
      "height": 720,
      "stamp_timecode": false,
      "vbitrate": 2500000,
      "width": 1280
    },
    "stream": {
      "addr": "",
      "channel": "",
      "delayoffset": "0ms",
      "extradelay": 10,
      "key": "",
      "service": "standalone"
    }
  },
  "info": {
    "description": "Sample to demonstrate genvid",
    "game": "Tutorial",
    "name": "Tutorial Sample"
  },
  "ntp": {
    "polling": 300,
    "server": "pool.ntp.org"
  },
  "services": {
    "leaf": {
      "bufferSize": 4096,
      "compression": false,
      "maxConnections": 500
    }
  }
}

POST /settings

設定を検証して設定します。欠損値は、デフォルト値に置き換えられます。ジョブサービスが実行されている場合、サーバーはステータス 500 を返します。

リクエスト JSON オブジェクト

• [key] (undefined) --

クエリ例 :

{
  "broadcast": {
    "enable": true
  },
  "dataStreams": {
    "maximumDataCacheAge": 35,
    "minimumDataCacheAge": 30
  },
  "encode": {
    "composition": {
      "abitrate": 128000,
      "enabled": true,
      "has_monitor": true,
      "height": 720,
      "vbitrate": 2500000,
      "width": 1280
    },
    "input": {
      "height": 720,
      "silent": true,
      "stamp_timecode": false,
      "width": 1280
    },
    "output": {
      "abitrate": 128000,
      "height": 720,
      "stamp_timecode": false,
      "vbitrate": 2500000,
      "width": 1280
    },
    "stream": {
      "addr": "",
      "channel": "",
      "delayoffset": "0ms",
      "extradelay": 10,
      "key": "",
      "service": "standalone"
    }
  },
  "info": {
    "description": "Sample to demonstrate genvid",
    "game": "Tutorial",
    "name": "Tutorial Sample"
  },
  "ntp": {
    "polling": 300,
    "server": "pool.ntp.org"
  },
  "services": {
    "leaf": {
      "bufferSize": 4096,
      "compression": false,
      "maxConnections": 500
    }
  }
}

GET /settings/schema

このスキーマは、設定の検証に使用します。

バージョン 1.26.0 で変更: 今後の拡張のための新しい API

PUT /settings/schema

このスキーマは、設定の検証に使用します。

バージョン 1.41.0 で追加.