From 95f52987ef6a0f34fc80f1e0f9705eb8ce81906d Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Mon, 24 Dec 2018 01:09:18 +0000 Subject: [PATCH] docs(travis): Update protocol.md - 82b8c66 [skip ci] --- docs/generated/comments.json | 714 ++++++++++++++++++++++++----------- docs/generated/protocol.md | 237 ++++++++---- 2 files changed, 651 insertions(+), 300 deletions(-) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 6695b0b5..3f1da83f 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -2804,6 +2804,162 @@ "lead": "", "type": "class", "examples": [] + }, + { + "subheads": [], + "description": "Deletes a scene item.", + "param": [ + "{String (optional)} `scene` Name of the scene the source belongs to. Defaults to the current scene.", + "{Object} `item` item to delete (required)", + "{String} `item.name` name of the scene item (prefer `id`, including both is acceptable).", + "{int} `item.id` id of the scene item." + ], + "api": "requests", + "name": "DeleteSceneItem", + "category": "scene items", + "since": "4.5.0", + "params": [ + { + "type": "String (optional)", + "name": "scene", + "description": "Name of the scene the source belongs to. Defaults to the current scene." + }, + { + "type": "Object", + "name": "item", + "description": "item to delete (required)" + }, + { + "type": "String", + "name": "item.name", + "description": "name of the scene item (prefer `id`, including both is acceptable)." + }, + { + "type": "int", + "name": "item.id", + "description": "id of the scene item." + } + ], + "names": [ + { + "name": "", + "description": "DeleteSceneItem" + } + ], + "categories": [ + { + "name": "", + "description": "scene items" + } + ], + "sinces": [ + { + "name": "", + "description": "4.5.0" + } + ], + "heading": { + "level": 2, + "text": "DeleteSceneItem" + }, + "lead": "", + "type": "class", + "examples": [] + }, + { + "subheads": [], + "description": "Duplicates a scene item.", + "param": [ + "{String (optional)} `fromScene` Name of the scene to copy the item from. Defaults to the current scene.", + "{String (optional)} `toScene` Name of the scene to create the item in. Defaults to the current scene.", + "{Object} `item` item to duplicate (required)", + "{String} `item.name` name of the scene item (prefer `id`, including both is acceptable).", + "{int} `item.id` id of the scene item." + ], + "return": [ + "{String} `scene` Name of the scene where the new item was created", + "{Object} `item` New item info", + "{int} `̀item.id` New item ID", + "{String} `item.name` New item name" + ], + "api": "requests", + "name": "DuplicateSceneItem", + "category": "scene items", + "since": "4.5.0", + "returns": [ + { + "type": "String", + "name": "scene", + "description": "Name of the scene where the new item was created" + }, + { + "type": "Object", + "name": "item", + "description": "New item info" + }, + { + "type": "int", + "name": "̀item.id", + "description": "New item ID" + }, + { + "type": "String", + "name": "item.name", + "description": "New item name" + } + ], + "params": [ + { + "type": "String (optional)", + "name": "fromScene", + "description": "Name of the scene to copy the item from. Defaults to the current scene." + }, + { + "type": "String (optional)", + "name": "toScene", + "description": "Name of the scene to create the item in. Defaults to the current scene." + }, + { + "type": "Object", + "name": "item", + "description": "item to duplicate (required)" + }, + { + "type": "String", + "name": "item.name", + "description": "name of the scene item (prefer `id`, including both is acceptable)." + }, + { + "type": "int", + "name": "item.id", + "description": "id of the scene item." + } + ], + "names": [ + { + "name": "", + "description": "DuplicateSceneItem" + } + ], + "categories": [ + { + "name": "", + "description": "scene items" + } + ], + "sinces": [ + { + "name": "", + "description": "4.5.0" + } + ], + "heading": { + "level": 2, + "text": "DuplicateSceneItem" + }, + "lead": "", + "type": "class", + "examples": [] } ], "scenes": [ @@ -3127,11 +3283,11 @@ { "subheads": [], "description": "Get the volume of the specified source.", - "param": "{String} `source` Name of the source.", + "param": "{String} `source` Source name.", "return": [ - "{String} `name` Name of the source.", + "{String} `name` Source name.", "{double} `volume` Volume of the source. Between `0.0` and `1.0`.", - "{boolean} `mute` Indicates whether the source is muted." + "{boolean} `muted` Indicates whether the source is muted." ], "api": "requests", "name": "GetVolume", @@ -3141,7 +3297,7 @@ { "type": "String", "name": "name", - "description": "Name of the source." + "description": "Source name." }, { "type": "double", @@ -3150,7 +3306,7 @@ }, { "type": "boolean", - "name": "mute", + "name": "muted", "description": "Indicates whether the source is muted." } ], @@ -3158,7 +3314,7 @@ { "type": "String", "name": "source", - "description": "Name of the source." + "description": "Source name." } ], "names": [ @@ -3191,7 +3347,7 @@ "subheads": [], "description": "Set the volume of the specified source.", "param": [ - "{String} `source` Name of the source.", + "{String} `source` Source name.", "{double} `volume` Desired volume. Must be between `0.0` and `1.0`." ], "api": "requests", @@ -3202,7 +3358,7 @@ { "type": "String", "name": "source", - "description": "Name of the source." + "description": "Source name." }, { "type": "double", @@ -3239,9 +3395,9 @@ { "subheads": [], "description": "Get the mute status of a specified source.", - "param": "{String} `source` The name of the source.", + "param": "{String} `source` Source name.", "return": [ - "{String} `name` The name of the source.", + "{String} `name` Source name.", "{boolean} `muted` Mute status of the source." ], "api": "requests", @@ -3252,7 +3408,7 @@ { "type": "String", "name": "name", - "description": "The name of the source." + "description": "Source name." }, { "type": "boolean", @@ -3264,7 +3420,7 @@ { "type": "String", "name": "source", - "description": "The name of the source." + "description": "Source name." } ], "names": [ @@ -3297,7 +3453,7 @@ "subheads": [], "description": "Sets the mute status of a specified source.", "param": [ - "{String} `source` The name of the source.", + "{String} `source` Source name.", "{boolean} `mute` Desired mute status." ], "api": "requests", @@ -3308,7 +3464,7 @@ { "type": "String", "name": "source", - "description": "The name of the source." + "description": "Source name." }, { "type": "boolean", @@ -3345,7 +3501,7 @@ { "subheads": [], "description": "Inverts the mute status of a specified source.", - "param": "{String} `source` The name of the source.", + "param": "{String} `source` Source name.", "api": "requests", "name": "ToggleMute", "category": "sources", @@ -3354,7 +3510,7 @@ { "type": "String", "name": "source", - "description": "The name of the source." + "description": "Source name." } ], "names": [ @@ -3387,7 +3543,7 @@ "subheads": [], "description": "Set the audio sync offset of a specified source.", "param": [ - "{String} `source` The name of the source.", + "{String} `source` Source name.", "{int} `offset` The desired audio sync offset (in nanoseconds)." ], "api": "requests", @@ -3398,7 +3554,7 @@ { "type": "String", "name": "source", - "description": "The name of the source." + "description": "Source name." }, { "type": "int", @@ -3435,9 +3591,9 @@ { "subheads": [], "description": "Get the audio sync offset of a specified source.", - "param": "{String} `source` The name of the source.", + "param": "{String} `source` Source name.", "return": [ - "{String} `name` The name of the source.", + "{String} `name` Source name.", "{int} `offset` The audio sync offset (in nanoseconds)." ], "api": "requests", @@ -3448,7 +3604,7 @@ { "type": "String", "name": "name", - "description": "The name of the source." + "description": "Source name." }, { "type": "int", @@ -3460,7 +3616,7 @@ { "type": "String", "name": "source", - "description": "The name of the source." + "description": "Source name." } ], "names": [ @@ -3493,13 +3649,13 @@ "subheads": [], "description": "Get settings of the specified source", "param": [ - "{String} `sourceName` Name of the source item.", + "{String} `sourceName` Source name.", "{String (optional)} `sourceType` Type of the specified source. Useful for type-checking if you expect a specific settings schema." ], "return": [ "{String} `sourceName` Source name", "{String} `sourceType` Type of the specified source", - "{Object} `sourceSettings` Source settings. Varying between source types." + "{Object} `sourceSettings` Source settings (varies between source types, may require some probing around)." ], "api": "requests", "name": "GetSourceSettings", @@ -3519,14 +3675,14 @@ { "type": "Object", "name": "sourceSettings", - "description": "Source settings. Varying between source types." + "description": "Source settings (varies between source types, may require some probing around)." } ], "params": [ { "type": "String", "name": "sourceName", - "description": "Name of the source item." + "description": "Source name." }, { "type": "String (optional)", @@ -3564,14 +3720,14 @@ "subheads": [], "description": "Set settings of the specified source.", "param": [ - "{String} `sourceName` Name of the source item.", + "{String} `sourceName` Source name.", "{String (optional)} `sourceType` Type of the specified source. Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type.", - "{Object} `sourceSettings` Source settings. Varying between source types." + "{Object} `sourceSettings` Source settings (varies between source types, may require some probing around)." ], "return": [ "{String} `sourceName` Source name", "{String} `sourceType` Type of the specified source", - "{Object} `sourceSettings` Source settings. Varying between source types." + "{Object} `sourceSettings` Updated source settings" ], "api": "requests", "name": "SetSourceSettings", @@ -3591,14 +3747,14 @@ { "type": "Object", "name": "sourceSettings", - "description": "Source settings. Varying between source types." + "description": "Updated source settings" } ], "params": [ { "type": "String", "name": "sourceName", - "description": "Name of the source item." + "description": "Source name." }, { "type": "String (optional)", @@ -3608,7 +3764,7 @@ { "type": "Object", "name": "sourceSettings", - "description": "Source settings. Varying between source types." + "description": "Source settings (varies between source types, may require some probing around)." } ], "names": [ @@ -3640,11 +3796,9 @@ { "subheads": [], "description": "Get the current properties of a Text GDI Plus source.", - "param": [ - "{String (optional)} `scene-name` Name of the scene to retrieve. Defaults to the current scene.", - "{String} `source` Name of the source." - ], + "param": "{String} `source` Source name.", "return": [ + "{String} `source` Source name.", "{String} `align` Text Alignment (\"left\", \"center\", \"right\").", "{int} `bk-color` Background color.", "{int} `bk-opacity` Background opacity (0-100).", @@ -3671,14 +3825,18 @@ "{int} `outline_opacity` Outline opacity (0-100).", "{String} `text` Text content to be displayed.", "{String} `valign` Text vertical alignment (\"top\", \"center\", \"bottom\").", - "{boolean} `vertical` Vertical text enabled.", - "{boolean} `render` Visibility of the scene item." + "{boolean} `vertical` Vertical text enabled." ], "api": "requests", "name": "GetTextGDIPlusProperties", "category": "sources", "since": "4.1.0", "returns": [ + { + "type": "String", + "name": "source", + "description": "Source name." + }, { "type": "String", "name": "align", @@ -3813,23 +3971,13 @@ "type": "boolean", "name": "vertical", "description": "Vertical text enabled." - }, - { - "type": "boolean", - "name": "render", - "description": "Visibility of the scene item." } ], "params": [ - { - "type": "String (optional)", - "name": "scene-name", - "description": "Name of the scene to retrieve. Defaults to the current scene." - }, { "type": "String", "name": "source", - "description": "Name of the source." + "description": "Source name." } ], "names": [ @@ -3860,9 +4008,8 @@ }, { "subheads": [], - "description": "Get the current properties of a Text GDI Plus source.", + "description": "Set the current properties of a Text GDI Plus source.", "param": [ - "{String (optional)} `scene-name` Name of the scene to retrieve. Defaults to the current scene.", "{String} `source` Name of the source.", "{String (optional)} `align` Text Alignment (\"left\", \"center\", \"right\").", "{int (optional)} `bk-color` Background color.", @@ -3898,11 +4045,6 @@ "category": "sources", "since": "4.1.0", "params": [ - { - "type": "String (optional)", - "name": "scene-name", - "description": "Name of the scene to retrieve. Defaults to the current scene." - }, { "type": "String", "name": "source", @@ -4077,12 +4219,284 @@ }, { "subheads": [], - "description": "Get current properties for a Browser Source.", - "param": [ - "{String (optional)} `scene-name` Name of the scene that the source belongs to. Defaults to the current scene.", - "{String} `source` Name of the source." - ], + "description": "Get the current properties of a Text Freetype 2 source.", + "param": "{String} `source` Source name.", "return": [ + "{String} `source` Source name", + "{int} `color1` Gradient top color.", + "{int} `color2` Gradient bottom color.", + "{int} `custom_width` Custom width (0 to disable).", + "{boolean} `drop_shadow` Drop shadow.", + "{Object} `font` Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`", + "{String} `font.face` Font face.", + "{int} `font.flags` Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`", + "{int} `font.size` Font text size.", + "{String} `font.style` Font Style (unknown function).", + "{boolean} `from_file` Read text from the specified file.", + "{boolean} `log_mode` Chat log.", + "{boolean} `outline` Outline.", + "{String} `text` Text content to be displayed.", + "{String} `text_file` File path.", + "{boolean} `word_wrap` Word wrap." + ], + "api": "requests", + "name": "GetTextFreetype2Properties", + "category": "sources", + "since": "4.5.0", + "returns": [ + { + "type": "String", + "name": "source", + "description": "Source name" + }, + { + "type": "int", + "name": "color1", + "description": "Gradient top color." + }, + { + "type": "int", + "name": "color2", + "description": "Gradient bottom color." + }, + { + "type": "int", + "name": "custom_width", + "description": "Custom width (0 to disable)." + }, + { + "type": "boolean", + "name": "drop_shadow", + "description": "Drop shadow." + }, + { + "type": "Object", + "name": "font", + "description": "Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`" + }, + { + "type": "String", + "name": "font.face", + "description": "Font face." + }, + { + "type": "int", + "name": "font.flags", + "description": "Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`" + }, + { + "type": "int", + "name": "font.size", + "description": "Font text size." + }, + { + "type": "String", + "name": "font.style", + "description": "Font Style (unknown function)." + }, + { + "type": "boolean", + "name": "from_file", + "description": "Read text from the specified file." + }, + { + "type": "boolean", + "name": "log_mode", + "description": "Chat log." + }, + { + "type": "boolean", + "name": "outline", + "description": "Outline." + }, + { + "type": "String", + "name": "text", + "description": "Text content to be displayed." + }, + { + "type": "String", + "name": "text_file", + "description": "File path." + }, + { + "type": "boolean", + "name": "word_wrap", + "description": "Word wrap." + } + ], + "params": [ + { + "type": "String", + "name": "source", + "description": "Source name." + } + ], + "names": [ + { + "name": "", + "description": "GetTextFreetype2Properties" + } + ], + "categories": [ + { + "name": "", + "description": "sources" + } + ], + "sinces": [ + { + "name": "", + "description": "4.5.0" + } + ], + "heading": { + "level": 2, + "text": "GetTextFreetype2Properties" + }, + "lead": "", + "type": "class", + "examples": [] + }, + { + "subheads": [], + "description": "Set the current properties of a Text Freetype 2 source.", + "param": [ + "{String} `source` Source name.", + "{int (optional)} `color1` Gradient top color.", + "{int (optional)} `color2` Gradient bottom color.", + "{int (optional)} `custom_width` Custom width (0 to disable).", + "{boolean (optional)} `drop_shadow` Drop shadow.", + "{Object (optional)} `font` Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`", + "{String (optional)} `font.face` Font face.", + "{int (optional)} `font.flags` Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`", + "{int (optional)} `font.size` Font text size.", + "{String (optional)} `font.style` Font Style (unknown function).", + "{boolean (optional)} `from_file` Read text from the specified file.", + "{boolean (optional)} `log_mode` Chat log.", + "{boolean (optional)} `outline` Outline.", + "{String (optional)} `text` Text content to be displayed.", + "{String (optional)} `text_file` File path.", + "{boolean (optional)} `word_wrap` Word wrap." + ], + "api": "requests", + "name": "SetTextFreetype2Properties", + "category": "sources", + "since": "4.5.0", + "params": [ + { + "type": "String", + "name": "source", + "description": "Source name." + }, + { + "type": "int (optional)", + "name": "color1", + "description": "Gradient top color." + }, + { + "type": "int (optional)", + "name": "color2", + "description": "Gradient bottom color." + }, + { + "type": "int (optional)", + "name": "custom_width", + "description": "Custom width (0 to disable)." + }, + { + "type": "boolean (optional)", + "name": "drop_shadow", + "description": "Drop shadow." + }, + { + "type": "Object (optional)", + "name": "font", + "description": "Holds data for the font. Ex: `\"font\": { \"face\": \"Arial\", \"flags\": 0, \"size\": 150, \"style\": \"\" }`" + }, + { + "type": "String (optional)", + "name": "font.face", + "description": "Font face." + }, + { + "type": "int (optional)", + "name": "font.flags", + "description": "Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8`" + }, + { + "type": "int (optional)", + "name": "font.size", + "description": "Font text size." + }, + { + "type": "String (optional)", + "name": "font.style", + "description": "Font Style (unknown function)." + }, + { + "type": "boolean (optional)", + "name": "from_file", + "description": "Read text from the specified file." + }, + { + "type": "boolean (optional)", + "name": "log_mode", + "description": "Chat log." + }, + { + "type": "boolean (optional)", + "name": "outline", + "description": "Outline." + }, + { + "type": "String (optional)", + "name": "text", + "description": "Text content to be displayed." + }, + { + "type": "String (optional)", + "name": "text_file", + "description": "File path." + }, + { + "type": "boolean (optional)", + "name": "word_wrap", + "description": "Word wrap." + } + ], + "names": [ + { + "name": "", + "description": "SetTextFreetype2Properties" + } + ], + "categories": [ + { + "name": "", + "description": "sources" + } + ], + "sinces": [ + { + "name": "", + "description": "4.5.0" + } + ], + "heading": { + "level": 2, + "text": "SetTextFreetype2Properties" + }, + "lead": "", + "type": "class", + "examples": [] + }, + { + "subheads": [], + "description": "Get current properties for a Browser Source.", + "param": "{String} `source` Source name.", + "return": [ + "{String} `source` Source name.", "{boolean} `is_local_file` Indicates that a local file is in use.", "{String} `local_file` file path.", "{String} `url` Url.", @@ -4090,14 +4504,18 @@ "{int} `width` Width.", "{int} `height` Height.", "{int} `fps` Framerate.", - "{boolean} `shutdown` Indicates whether the source should be shutdown when not visible.", - "{boolean (optional)} `render` Visibility of the scene item." + "{boolean} `shutdown` Indicates whether the source should be shutdown when not visible." ], "api": "requests", "name": "GetBrowserSourceProperties", "category": "sources", "since": "4.1.0", "returns": [ + { + "type": "String", + "name": "source", + "description": "Source name." + }, { "type": "boolean", "name": "is_local_file", @@ -4137,23 +4555,13 @@ "type": "boolean", "name": "shutdown", "description": "Indicates whether the source should be shutdown when not visible." - }, - { - "type": "boolean (optional)", - "name": "render", - "description": "Visibility of the scene item." } ], "params": [ - { - "type": "String (optional)", - "name": "scene-name", - "description": "Name of the scene that the source belongs to. Defaults to the current scene." - }, { "type": "String", "name": "source", - "description": "Name of the source." + "description": "Source name." } ], "names": [ @@ -4186,7 +4594,6 @@ "subheads": [], "description": "Set current properties for a Browser Source.", "param": [ - "{String (optional)} `scene-name` Name of the scene that the source belongs to. Defaults to the current scene.", "{String} `source` Name of the source.", "{boolean (optional)} `is_local_file` Indicates that a local file is in use.", "{String (optional)} `local_file` file path.", @@ -4203,11 +4610,6 @@ "category": "sources", "since": "4.1.0", "params": [ - { - "type": "String (optional)", - "name": "scene-name", - "description": "Name of the scene that the source belongs to. Defaults to the current scene." - }, { "type": "String", "name": "source", @@ -4285,134 +4687,6 @@ "type": "class", "examples": [] }, - { - "subheads": [], - "description": "Deletes a scene item.", - "param": [ - "{String (optional)} `scene` Name of the scene the source belongs to. Defaults to the current scene.", - "{Object} `item` item to delete (required)", - "{String} `item.name` name of the scene item (prefer `id`, including both is acceptable).", - "{int} `item.id` id of the scene item." - ], - "api": "requests", - "name": "DeleteSceneItem", - "category": "sources", - "since": "unreleased", - "params": [ - { - "type": "String (optional)", - "name": "scene", - "description": "Name of the scene the source belongs to. Defaults to the current scene." - }, - { - "type": "Object", - "name": "item", - "description": "item to delete (required)" - }, - { - "type": "String", - "name": "item.name", - "description": "name of the scene item (prefer `id`, including both is acceptable)." - }, - { - "type": "int", - "name": "item.id", - "description": "id of the scene item." - } - ], - "names": [ - { - "name": "", - "description": "DeleteSceneItem" - } - ], - "categories": [ - { - "name": "", - "description": "sources" - } - ], - "sinces": [ - { - "name": "", - "description": "unreleased" - } - ], - "heading": { - "level": 2, - "text": "DeleteSceneItem" - }, - "lead": "", - "type": "class", - "examples": [] - }, - { - "subheads": [], - "description": "Duplicates a scene item.", - "param": [ - "{String (optional)} `fromScene` Name of the scene to copy the item from. Defaults to the current scene.", - "{String (optional)} `toScene` Name of the scene to create the item in. Defaults to the current scene.", - "{Object} `item` item to delete (required)", - "{String} `item.name` name of the scene item (prefer `id`, including both is acceptable).", - "{int} `item.id` id of the scene item." - ], - "api": "requests", - "name": "DuplicateSceneItem", - "category": "sources", - "since": "unreleased", - "params": [ - { - "type": "String (optional)", - "name": "fromScene", - "description": "Name of the scene to copy the item from. Defaults to the current scene." - }, - { - "type": "String (optional)", - "name": "toScene", - "description": "Name of the scene to create the item in. Defaults to the current scene." - }, - { - "type": "Object", - "name": "item", - "description": "item to delete (required)" - }, - { - "type": "String", - "name": "item.name", - "description": "name of the scene item (prefer `id`, including both is acceptable)." - }, - { - "type": "int", - "name": "item.id", - "description": "id of the scene item." - } - ], - "names": [ - { - "name": "", - "description": "DuplicateSceneItem" - } - ], - "categories": [ - { - "name": "", - "description": "sources" - } - ], - "sinces": [ - { - "name": "", - "description": "unreleased" - } - ], - "heading": { - "level": 2, - "text": "DuplicateSceneItem" - }, - "lead": "", - "type": "class", - "examples": [] - }, { "subheads": [], "description": "Get configured special sources like Desktop Audio and Mic/Aux sources.", @@ -4493,7 +4767,7 @@ "api": "requests", "name": "GetSourceFilters", "category": "sources", - "since": "unreleased", + "since": "4.5.0", "returns": [ { "type": "Array", @@ -4538,7 +4812,7 @@ "sinces": [ { "name": "", - "description": "unreleased" + "description": "4.5.0" } ], "heading": { @@ -4561,7 +4835,7 @@ "api": "requests", "name": "AddFilterToSource", "category": "sources", - "since": "unreleased", + "since": "4.5.0", "params": [ { "type": "String", @@ -4599,7 +4873,7 @@ "sinces": [ { "name": "", - "description": "unreleased" + "description": "4.5.0" } ], "heading": { @@ -4620,7 +4894,7 @@ "api": "requests", "name": "RemoveFilterFromSource", "category": "sources", - "since": "unreleased", + "since": "4.5.0", "params": [ { "type": "String", @@ -4648,7 +4922,7 @@ "sinces": [ { "name": "", - "description": "unreleased" + "description": "4.5.0" } ], "heading": { @@ -4670,7 +4944,7 @@ "api": "requests", "name": "ReorderSourceFilter", "category": "sources", - "since": "unreleased", + "since": "4.5.0", "params": [ { "type": "String", @@ -4703,7 +4977,7 @@ "sinces": [ { "name": "", - "description": "unreleased" + "description": "4.5.0" } ], "heading": { @@ -4725,7 +4999,7 @@ "api": "requests", "name": "MoveSourceFilter", "category": "sources", - "since": "unreleased", + "since": "4.5.0", "params": [ { "type": "String", @@ -4758,7 +5032,7 @@ "sinces": [ { "name": "", - "description": "unreleased" + "description": "4.5.0" } ], "heading": { @@ -4780,7 +5054,7 @@ "api": "requests", "name": "SetSourceFilterSettings", "category": "sources", - "since": "unreleased", + "since": "4.5.0", "params": [ { "type": "String", @@ -4813,7 +5087,7 @@ "sinces": [ { "name": "", - "description": "unreleased" + "description": "4.5.0" } ], "heading": { diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index dffbaf01..830c7c76 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -123,6 +123,8 @@ auth_response = base64_encode(auth_response_hash) + [SetSceneItemPosition](#setsceneitemposition) + [SetSceneItemTransform](#setsceneitemtransform) + [SetSceneItemCrop](#setsceneitemcrop) + + [DeleteSceneItem](#deletesceneitem) + + [DuplicateSceneItem](#duplicatesceneitem) * [Scenes](#scenes-1) + [SetCurrentScene](#setcurrentscene) + [GetCurrentScene](#getcurrentscene) @@ -141,10 +143,10 @@ auth_response = base64_encode(auth_response_hash) + [SetSourceSettings](#setsourcesettings) + [GetTextGDIPlusProperties](#gettextgdiplusproperties) + [SetTextGDIPlusProperties](#settextgdiplusproperties) + + [GetTextFreetype2Properties](#gettextfreetype2properties) + + [SetTextFreetype2Properties](#settextfreetype2properties) + [GetBrowserSourceProperties](#getbrowsersourceproperties) + [SetBrowserSourceProperties](#setbrowsersourceproperties) - + [DeleteSceneItem](#deletesceneitem) - + [DuplicateSceneItem](#duplicatesceneitem) + [GetSpecialSources](#getspecialsources) + [GetSourceFilters](#getsourcefilters) + [AddFilterToSource](#addfiltertosource) @@ -1344,6 +1346,59 @@ Sets the crop coordinates of the specified source item. _No additional response items._ +--- + +### DeleteSceneItem + + +- Added in v4.5.0 + +Deletes a scene item. + +**Request Fields:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `scene` | _String (optional)_ | Name of the scene the source belongs to. Defaults to the current scene. | +| `item` | _Object_ | item to delete (required) | +| `item.name` | _String_ | name of the scene item (prefer `id`, including both is acceptable). | +| `item.id` | _int_ | id of the scene item. | + + +**Response Items:** + +_No additional response items._ + +--- + +### DuplicateSceneItem + + +- Added in v4.5.0 + +Duplicates a scene item. + +**Request Fields:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `fromScene` | _String (optional)_ | Name of the scene to copy the item from. Defaults to the current scene. | +| `toScene` | _String (optional)_ | Name of the scene to create the item in. Defaults to the current scene. | +| `item` | _Object_ | item to duplicate (required) | +| `item.name` | _String_ | name of the scene item (prefer `id`, including both is acceptable). | +| `item.id` | _int_ | id of the scene item. | + + +**Response Items:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `scene` | _String_ | Name of the scene where the new item was created | +| `item` | _Object_ | New item info | +| `̀item.id` | _int_ | New item ID | +| `item.name` | _String_ | New item name | + + --- ## Scenes @@ -1478,16 +1533,16 @@ Get the volume of the specified source. | Name | Type | Description | | ---- | :---: | ------------| -| `source` | _String_ | Name of the source. | +| `source` | _String_ | Source name. | **Response Items:** | Name | Type | Description | | ---- | :---: | ------------| -| `name` | _String_ | Name of the source. | +| `name` | _String_ | Source name. | | `volume` | _double_ | Volume of the source. Between `0.0` and `1.0`. | -| `mute` | _boolean_ | Indicates whether the source is muted. | +| `muted` | _boolean_ | Indicates whether the source is muted. | --- @@ -1503,7 +1558,7 @@ Set the volume of the specified source. | Name | Type | Description | | ---- | :---: | ------------| -| `source` | _String_ | Name of the source. | +| `source` | _String_ | Source name. | | `volume` | _double_ | Desired volume. Must be between `0.0` and `1.0`. | @@ -1524,14 +1579,14 @@ Get the mute status of a specified source. | Name | Type | Description | | ---- | :---: | ------------| -| `source` | _String_ | The name of the source. | +| `source` | _String_ | Source name. | **Response Items:** | Name | Type | Description | | ---- | :---: | ------------| -| `name` | _String_ | The name of the source. | +| `name` | _String_ | Source name. | | `muted` | _boolean_ | Mute status of the source. | @@ -1548,7 +1603,7 @@ Sets the mute status of a specified source. | Name | Type | Description | | ---- | :---: | ------------| -| `source` | _String_ | The name of the source. | +| `source` | _String_ | Source name. | | `mute` | _boolean_ | Desired mute status. | @@ -1569,7 +1624,7 @@ Inverts the mute status of a specified source. | Name | Type | Description | | ---- | :---: | ------------| -| `source` | _String_ | The name of the source. | +| `source` | _String_ | Source name. | **Response Items:** @@ -1589,7 +1644,7 @@ Set the audio sync offset of a specified source. | Name | Type | Description | | ---- | :---: | ------------| -| `source` | _String_ | The name of the source. | +| `source` | _String_ | Source name. | | `offset` | _int_ | The desired audio sync offset (in nanoseconds). | @@ -1610,14 +1665,14 @@ Get the audio sync offset of a specified source. | Name | Type | Description | | ---- | :---: | ------------| -| `source` | _String_ | The name of the source. | +| `source` | _String_ | Source name. | **Response Items:** | Name | Type | Description | | ---- | :---: | ------------| -| `name` | _String_ | The name of the source. | +| `name` | _String_ | Source name. | | `offset` | _int_ | The audio sync offset (in nanoseconds). | @@ -1634,7 +1689,7 @@ Get settings of the specified source | Name | Type | Description | | ---- | :---: | ------------| -| `sourceName` | _String_ | Name of the source item. | +| `sourceName` | _String_ | Source name. | | `sourceType` | _String (optional)_ | Type of the specified source. Useful for type-checking if you expect a specific settings schema. | @@ -1644,7 +1699,7 @@ Get settings of the specified source | ---- | :---: | ------------| | `sourceName` | _String_ | Source name | | `sourceType` | _String_ | Type of the specified source | -| `sourceSettings` | _Object_ | Source settings. Varying between source types. | +| `sourceSettings` | _Object_ | Source settings (varies between source types, may require some probing around). | --- @@ -1660,9 +1715,9 @@ Set settings of the specified source. | Name | Type | Description | | ---- | :---: | ------------| -| `sourceName` | _String_ | Name of the source item. | +| `sourceName` | _String_ | Source name. | | `sourceType` | _String (optional)_ | Type of the specified source. Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type. | -| `sourceSettings` | _Object_ | Source settings. Varying between source types. | +| `sourceSettings` | _Object_ | Source settings (varies between source types, may require some probing around). | **Response Items:** @@ -1671,7 +1726,7 @@ Set settings of the specified source. | ---- | :---: | ------------| | `sourceName` | _String_ | Source name | | `sourceType` | _String_ | Type of the specified source | -| `sourceSettings` | _Object_ | Source settings. Varying between source types. | +| `sourceSettings` | _Object_ | Updated source settings | --- @@ -1687,14 +1742,14 @@ Get the current properties of a Text GDI Plus source. | Name | Type | Description | | ---- | :---: | ------------| -| `scene-name` | _String (optional)_ | Name of the scene to retrieve. Defaults to the current scene. | -| `source` | _String_ | Name of the source. | +| `source` | _String_ | Source name. | **Response Items:** | Name | Type | Description | | ---- | :---: | ------------| +| `source` | _String_ | Source name. | | `align` | _String_ | Text Alignment ("left", "center", "right"). | | `bk-color` | _int_ | Background color. | | `bk-opacity` | _int_ | Background opacity (0-100). | @@ -1722,7 +1777,6 @@ Get the current properties of a Text GDI Plus source. | `text` | _String_ | Text content to be displayed. | | `valign` | _String_ | Text vertical alignment ("top", "center", "bottom"). | | `vertical` | _boolean_ | Vertical text enabled. | -| `render` | _boolean_ | Visibility of the scene item. | --- @@ -1732,13 +1786,12 @@ Get the current properties of a Text GDI Plus source. - Added in v4.1.0 -Get the current properties of a Text GDI Plus source. +Set the current properties of a Text GDI Plus source. **Request Fields:** | Name | Type | Description | | ---- | :---: | ------------| -| `scene-name` | _String (optional)_ | Name of the scene to retrieve. Defaults to the current scene. | | `source` | _String_ | Name of the source. | | `align` | _String (optional)_ | Text Alignment ("left", "center", "right"). | | `bk-color` | _int (optional)_ | Background color. | @@ -1770,6 +1823,79 @@ Get the current properties of a Text GDI Plus source. | `render` | _boolean (optional)_ | Visibility of the scene item. | +**Response Items:** + +_No additional response items._ + +--- + +### GetTextFreetype2Properties + + +- Added in v4.5.0 + +Get the current properties of a Text Freetype 2 source. + +**Request Fields:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `source` | _String_ | Source name. | + + +**Response Items:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `source` | _String_ | Source name | +| `color1` | _int_ | Gradient top color. | +| `color2` | _int_ | Gradient bottom color. | +| `custom_width` | _int_ | Custom width (0 to disable). | +| `drop_shadow` | _boolean_ | Drop shadow. | +| `font` | _Object_ | Holds data for the font. Ex: `"font": { "face": "Arial", "flags": 0, "size": 150, "style": "" }` | +| `font.face` | _String_ | Font face. | +| `font.flags` | _int_ | Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8` | +| `font.size` | _int_ | Font text size. | +| `font.style` | _String_ | Font Style (unknown function). | +| `from_file` | _boolean_ | Read text from the specified file. | +| `log_mode` | _boolean_ | Chat log. | +| `outline` | _boolean_ | Outline. | +| `text` | _String_ | Text content to be displayed. | +| `text_file` | _String_ | File path. | +| `word_wrap` | _boolean_ | Word wrap. | + + +--- + +### SetTextFreetype2Properties + + +- Added in v4.5.0 + +Set the current properties of a Text Freetype 2 source. + +**Request Fields:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `source` | _String_ | Source name. | +| `color1` | _int (optional)_ | Gradient top color. | +| `color2` | _int (optional)_ | Gradient bottom color. | +| `custom_width` | _int (optional)_ | Custom width (0 to disable). | +| `drop_shadow` | _boolean (optional)_ | Drop shadow. | +| `font` | _Object (optional)_ | Holds data for the font. Ex: `"font": { "face": "Arial", "flags": 0, "size": 150, "style": "" }` | +| `font.face` | _String (optional)_ | Font face. | +| `font.flags` | _int (optional)_ | Font text styling flag. `Bold=1, Italic=2, Bold Italic=3, Underline=5, Strikeout=8` | +| `font.size` | _int (optional)_ | Font text size. | +| `font.style` | _String (optional)_ | Font Style (unknown function). | +| `from_file` | _boolean (optional)_ | Read text from the specified file. | +| `log_mode` | _boolean (optional)_ | Chat log. | +| `outline` | _boolean (optional)_ | Outline. | +| `text` | _String (optional)_ | Text content to be displayed. | +| `text_file` | _String (optional)_ | File path. | +| `word_wrap` | _boolean (optional)_ | Word wrap. | + + **Response Items:** _No additional response items._ @@ -1787,14 +1913,14 @@ Get current properties for a Browser Source. | Name | Type | Description | | ---- | :---: | ------------| -| `scene-name` | _String (optional)_ | Name of the scene that the source belongs to. Defaults to the current scene. | -| `source` | _String_ | Name of the source. | +| `source` | _String_ | Source name. | **Response Items:** | Name | Type | Description | | ---- | :---: | ------------| +| `source` | _String_ | Source name. | | `is_local_file` | _boolean_ | Indicates that a local file is in use. | | `local_file` | _String_ | file path. | | `url` | _String_ | Url. | @@ -1803,7 +1929,6 @@ Get current properties for a Browser Source. | `height` | _int_ | Height. | | `fps` | _int_ | Framerate. | | `shutdown` | _boolean_ | Indicates whether the source should be shutdown when not visible. | -| `render` | _boolean (optional)_ | Visibility of the scene item. | --- @@ -1819,7 +1944,6 @@ Set current properties for a Browser Source. | Name | Type | Description | | ---- | :---: | ------------| -| `scene-name` | _String (optional)_ | Name of the scene that the source belongs to. Defaults to the current scene. | | `source` | _String_ | Name of the source. | | `is_local_file` | _boolean (optional)_ | Indicates that a local file is in use. | | `local_file` | _String (optional)_ | file path. | @@ -1832,53 +1956,6 @@ Set current properties for a Browser Source. | `render` | _boolean (optional)_ | Visibility of the scene item. | -**Response Items:** - -_No additional response items._ - ---- - -### DeleteSceneItem - - -- Unreleased - -Deletes a scene item. - -**Request Fields:** - -| Name | Type | Description | -| ---- | :---: | ------------| -| `scene` | _String (optional)_ | Name of the scene the source belongs to. Defaults to the current scene. | -| `item` | _Object_ | item to delete (required) | -| `item.name` | _String_ | name of the scene item (prefer `id`, including both is acceptable). | -| `item.id` | _int_ | id of the scene item. | - - -**Response Items:** - -_No additional response items._ - ---- - -### DuplicateSceneItem - - -- Unreleased - -Duplicates a scene item. - -**Request Fields:** - -| Name | Type | Description | -| ---- | :---: | ------------| -| `fromScene` | _String (optional)_ | Name of the scene to copy the item from. Defaults to the current scene. | -| `toScene` | _String (optional)_ | Name of the scene to create the item in. Defaults to the current scene. | -| `item` | _Object_ | item to delete (required) | -| `item.name` | _String_ | name of the scene item (prefer `id`, including both is acceptable). | -| `item.id` | _int_ | id of the scene item. | - - **Response Items:** _No additional response items._ @@ -1912,7 +1989,7 @@ _No specified parameters._ ### GetSourceFilters -- Unreleased +- Added in v4.5.0 List filters applied to a source @@ -1938,7 +2015,7 @@ List filters applied to a source ### AddFilterToSource -- Unreleased +- Added in v4.5.0 Add a new filter to a source. Available source types along with their settings properties are available from `GetSourceTypesList`. @@ -1961,7 +2038,7 @@ _No additional response items._ ### RemoveFilterFromSource -- Unreleased +- Added in v4.5.0 Remove a filter from a source @@ -1982,7 +2059,7 @@ _No additional response items._ ### ReorderSourceFilter -- Unreleased +- Added in v4.5.0 Move a filter in the chain (absolute index positioning) @@ -2004,7 +2081,7 @@ _No additional response items._ ### MoveSourceFilter -- Unreleased +- Added in v4.5.0 Move a filter in the chain (relative positioning) @@ -2026,7 +2103,7 @@ _No additional response items._ ### SetSourceFilterSettings -- Unreleased +- Added in v4.5.0 Update settings of a filter