Cluster API 設定¶
設定の Cluster API 解説書
設定¶
-
GET
/settings/default
¶ デフォルト設定を取得する
応答 JSON オブジェクト: - info.name (string) – ストリーム名。
- info.game (string) – プレイするゲーム。
- info.description (string) – ストリームの説明。
- ntp.server (string) – NTP サーバーのホスト名。AWS には、169.254.169.123のサーバーのご使用をお勧めします。
- ntp.polling (integer) – 2 つの同期のインターバル。
- encode.stream.service (string) – ライブ配信サービスのタイプ。
- encode.stream.addr (string) – ビデオストリームを受信するライブ配信サーバーのアドレス (通常は RTMP URL)。
- encode.stream.channel (string) – user-specific チャンネル識別子。
- encode.stream.key (string) – 『addr』 にデータを送る user-specific ライブ配信キー。
- encode.stream.delayoffset (string) – ゲームストリームに対してビデオストリームのオフセットを可能にするディレイ (オプション)。
- encode.stream.extradelay (number) – スタンドアロンプレイヤーの配信のオフセットを可能にする遅延 (オプション)。
- encode.input.width (integer) – ゲームフレームの横幅 (ピクセル)。
- encode.input.height (integer) – ゲームフレームの高さ (ピクセル)。
- encode.input.silent (boolean) – オーディオストリームを無効化。
- encode.input.stamp_timecode (boolean) – 毎フレーム、タイムコードを有効にする (右下)。
- encode.output.width (integer) – 最終ビデオの横幅 (ピクセル)。
- encode.output.height (integer) – 最終ビデオの高さ (ピクセル)。
- encode.output.abitrate (integer) – 最終ビデオで使用するオーディオビットレート。
- encode.output.vbitrate (integer) – 最終ビデオで使用するビデオビットレート。
- encode.output.stamp_timecode (boolean) – 最終ビデオストリームで、ビデオタイムコードを有効にする (左上)。
- encode.composition.enabled (boolean) – コンポジション機能を有効にする
- encode.composition.has_monitor (boolean) – コンポジションパネルにモニタ画面を表示する
- encode.composition.width (integer) – モニタビデオの横幅 (ピクセル)。
- encode.composition.height (integer) – モニタビデオの高さ (ピクセル)。
- encode.composition.abitrate (integer) – モニタで使用するオーディオビットレート。
- encode.composition.vbitrate (integer) – モニタで使用するビデオビットレート。
- dataStreams.minimumDataCacheAge (integer) – 初期化のためにキャッシュされるデータの最小有効期限 (秒)。 この有効期限より新しいデータは保持されます。
- dataStreams.maximumDataCacheAge (integer) – 新しいデータが到着すると、この設定 (秒) より古いデータは、キャッシュから削除されます。
- services.leaf.compression (boolean) – 圧縮の有効無効
- services.leaf.bufferSize (integer) – Web ソケットの読み込み、書き出しのバッファサイズ
- services.leaf.maxConnections (integer) – leafd サービスごとの同時接続の最大数。
- services.leaf.websocketURLSuffix (string) – leaf の Web ソケットエンドポイント。
- services.studio.enable (boolean) – studio サービスを開始する。
false
の場合、studio サービスは開始しない。 - broadcast.enable (boolean) – ストリームを on-air モードで開始します。この設定は、スタンドアロンモードには影響しません。
false
の場合、ストリームは即座に送信されず、Studio で開始する必要があります。詳細は YouTube または Twitch でストリーミングする際の配信開始方法 を参照してください。
応答例 :
{ "broadcast": { "enable": true }, "dataStreams": { "maximumDataCacheAge": 35, "minimumDataCacheAge": 30 }, "encode": { "composition": { "abitrate": 128000, "enabled": false, "has_monitor": false, "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 オブジェクト: - info.name (string) – ストリーム名。
- info.game (string) – プレイするゲーム。
- info.description (string) – ストリームの説明。
- ntp.server (string) – NTP サーバーのホスト名。AWS には、169.254.169.123のサーバーのご使用をお勧めします。
- ntp.polling (integer) – 2 つの同期のインターバル。
- encode.stream.service (string) – ライブ配信サービスのタイプ。
- encode.stream.addr (string) – ビデオストリームを受信するライブ配信サーバーのアドレス (通常は RTMP URL)。
- encode.stream.channel (string) – user-specific チャンネル識別子。
- encode.stream.key (string) – 『addr』 にデータを送る user-specific ライブ配信キー。
- encode.stream.delayoffset (string) – ゲームストリームに対してビデオストリームのオフセットを可能にするディレイ (オプション)。
- encode.stream.extradelay (number) – スタンドアロンプレイヤーの配信のオフセットを可能にする遅延 (オプション)。
- encode.input.width (integer) – ゲームフレームの横幅 (ピクセル)。
- encode.input.height (integer) – ゲームフレームの高さ (ピクセル)。
- encode.input.silent (boolean) – オーディオストリームを無効化。
- encode.input.stamp_timecode (boolean) – 毎フレーム、タイムコードを有効にする (右下)。
- encode.output.width (integer) – 最終ビデオの横幅 (ピクセル)。
- encode.output.height (integer) – 最終ビデオの高さ (ピクセル)。
- encode.output.abitrate (integer) – 最終ビデオで使用するオーディオビットレート。
- encode.output.vbitrate (integer) – 最終ビデオで使用するビデオビットレート。
- encode.output.stamp_timecode (boolean) – 最終ビデオストリームで、ビデオタイムコードを有効にする (左上)。
- encode.composition.enabled (boolean) – コンポジション機能を有効にする
- encode.composition.has_monitor (boolean) – コンポジションパネルにモニタ画面を表示する
- encode.composition.width (integer) – モニタビデオの横幅 (ピクセル)。
- encode.composition.height (integer) – モニタビデオの高さ (ピクセル)。
- encode.composition.abitrate (integer) – モニタで使用するオーディオビットレート。
- encode.composition.vbitrate (integer) – モニタで使用するビデオビットレート。
- dataStreams.minimumDataCacheAge (integer) – 初期化のためにキャッシュされるデータの最小有効期限 (秒)。 この有効期限より新しいデータは保持されます。
- dataStreams.maximumDataCacheAge (integer) – 新しいデータが到着すると、この設定 (秒) より古いデータは、キャッシュから削除されます。
- services.leaf.compression (boolean) – 圧縮の有効無効
- services.leaf.bufferSize (integer) – Web ソケットの読み込み、書き出しのバッファサイズ
- services.leaf.maxConnections (integer) – leafd サービスごとの同時接続の最大数。
- services.leaf.websocketURLSuffix (string) – leaf の Web ソケットエンドポイント。
- services.studio.enable (boolean) – studio サービスを開始する。
false
の場合、studio サービスは開始しない。 - broadcast.enable (boolean) – ストリームを on-air モードで開始します。この設定は、スタンドアロンモードには影響しません。
false
の場合、ストリームは即座に送信されず、Studio で開始する必要があります。詳細は YouTube または Twitch でストリーミングする際の配信開始方法 を参照してください。
応答例 :
{ "broadcast": { "enable": true }, "dataStreams": { "maximumDataCacheAge": 35, "minimumDataCacheAge": 30 }, "encode": { "composition": { "abitrate": 128000, "enabled": false, "has_monitor": false, "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 オブジェクト: - info.name (string) – ストリーム名。
- info.game (string) – プレイするゲーム。
- info.description (string) – ストリームの説明。
- ntp.server (string) – NTP サーバーのホスト名。AWS には、169.254.169.123のサーバーのご使用をお勧めします。
- ntp.polling (integer) – 2 つの同期のインターバル。
- encode.stream.service (string) – ライブ配信サービスのタイプ。
- encode.stream.addr (string) – ビデオストリームを受信するライブ配信サーバーのアドレス (通常は RTMP URL)。
- encode.stream.channel (string) – user-specific チャンネル識別子。
- encode.stream.key (string) – 『addr』 にデータを送る user-specific ライブ配信キー。
- encode.stream.delayoffset (string) – ゲームストリームに対してビデオストリームのオフセットを可能にするディレイ (オプション)。
- encode.stream.extradelay (number) – スタンドアロンプレイヤーの配信のオフセットを可能にする遅延 (オプション)。
- encode.input.width (integer) – ゲームフレームの横幅 (ピクセル)。
- encode.input.height (integer) – ゲームフレームの高さ (ピクセル)。
- encode.input.silent (boolean) – オーディオストリームを無効化。
- encode.input.stamp_timecode (boolean) – 毎フレーム、タイムコードを有効にする (右下)。
- encode.output.width (integer) – 最終ビデオの横幅 (ピクセル)。
- encode.output.height (integer) – 最終ビデオの高さ (ピクセル)。
- encode.output.abitrate (integer) – 最終ビデオで使用するオーディオビットレート。
- encode.output.vbitrate (integer) – 最終ビデオで使用するビデオビットレート。
- encode.output.stamp_timecode (boolean) – 最終ビデオストリームで、ビデオタイムコードを有効にする (左上)。
- encode.composition.enabled (boolean) – コンポジション機能を有効にする
- encode.composition.has_monitor (boolean) – コンポジションパネルにモニタ画面を表示する
- encode.composition.width (integer) – モニタビデオの横幅 (ピクセル)。
- encode.composition.height (integer) – モニタビデオの高さ (ピクセル)。
- encode.composition.abitrate (integer) – モニタで使用するオーディオビットレート。
- encode.composition.vbitrate (integer) – モニタで使用するビデオビットレート。
- dataStreams.minimumDataCacheAge (integer) – 初期化のためにキャッシュされるデータの最小有効期限 (秒)。 この有効期限より新しいデータは保持されます。
- dataStreams.maximumDataCacheAge (integer) – 新しいデータが到着すると、この設定 (秒) より古いデータは、キャッシュから削除されます。
- services.leaf.compression (boolean) – 圧縮の有効無効
- services.leaf.bufferSize (integer) – Web ソケットの読み込み、書き出しのバッファサイズ
- services.leaf.maxConnections (integer) – leafd サービスごとの同時接続の最大数。
- services.leaf.websocketURLSuffix (string) – leaf の Web ソケットエンドポイント。
- services.studio.enable (boolean) – studio サービスを開始する。
false
の場合、studio サービスは開始しない。 - broadcast.enable (boolean) – ストリームを on-air モードで開始します。この設定は、スタンドアロンモードには影響しません。
false
の場合、ストリームは即座に送信されず、Studio で開始する必要があります。詳細は YouTube または Twitch でストリーミングする際の配信開始方法 を参照してください。
クエリ例 :
{ "broadcast": { "enable": true }, "dataStreams": { "maximumDataCacheAge": 35, "minimumDataCacheAge": 30 }, "encode": { "composition": { "abitrate": 128000, "enabled": false, "has_monitor": false, "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