Version
menu_open
Wwise SDK 2024.1.1
ak.wwise.ui.layout.setLayout Arguments Schema

Schema

{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the layout to register."
},
"layout": {
"type": "object",
"description": "The layout description in JSON format.\\n A layout entity.",
"properties": {
"Layout": {
"type": "object",
"description": "The layout description in JSON format.",
"properties": {
"AudioDeviceLastTabPositions": {
"type": "array",
"description": "List of last view positions.",
"items": {
"type": "object",
"description": "Information of the positions of a window of a view.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ViewPosition.",
"enum": [
"ViewPosition"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"WindowPlacement_Flags": {
"type": "string",
"description": "The flags of the window placement."
},
"WindowPlacement_ShowCmd": {
"type": "string",
"description": "The last showCmd for the window placement.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"WindowPlacement_MinPos_X": {
"type": "string",
"description": "The minimum X position of the window."
},
"WindowPlacement_MinPos_Y": {
"type": "string",
"description": "The minimum Y position of the window."
},
"WindowPlacement_MaxPos_X": {
"type": "string",
"description": "The maximum X position of the window."
},
"WindowPlacement_MaxPos_Y": {
"type": "string",
"description": "The maximum Y position of the window."
},
"WindowPlacement_NormalPos_Left": {
"type": "string",
"description": "The normal left position of the window."
},
"WindowPlacement_NormalPos_Top": {
"type": "string",
"description": "The normal top position of the window."
},
"WindowPlacement_NormalPos_Right": {
"type": "string",
"description": "The normal right position of the window."
},
"WindowPlacement_NormalPos_Bottom": {
"type": "string",
"description": "The normal bottom position of the window."
}
},
"required": [
"@type",
"Name",
"WindowPlacement_Flags",
"WindowPlacement_MinPos_X",
"WindowPlacement_MinPos_Y",
"WindowPlacement_MaxPos_X",
"WindowPlacement_MaxPos_Y",
"WindowPlacement_NormalPos_Left",
"WindowPlacement_NormalPos_Top",
"WindowPlacement_NormalPos_Right",
"WindowPlacement_NormalPos_Bottom"
],
"additionalProperties": false
}
},
"EffectLastTabPositions": {
"type": "array",
"description": "List of last tab positions for effects.",
"items": {
"type": "object",
"description": "Information of the positions of a window of a view.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ViewPosition.",
"enum": [
"ViewPosition"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"WindowPlacement_Flags": {
"type": "string",
"description": "The flags of the window placement."
},
"WindowPlacement_ShowCmd": {
"type": "string",
"description": "The last showCmd for the window placement.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"WindowPlacement_MinPos_X": {
"type": "string",
"description": "The minimum X position of the window."
},
"WindowPlacement_MinPos_Y": {
"type": "string",
"description": "The minimum Y position of the window."
},
"WindowPlacement_MaxPos_X": {
"type": "string",
"description": "The maximum X position of the window."
},
"WindowPlacement_MaxPos_Y": {
"type": "string",
"description": "The maximum Y position of the window."
},
"WindowPlacement_NormalPos_Left": {
"type": "string",
"description": "The normal left position of the window."
},
"WindowPlacement_NormalPos_Top": {
"type": "string",
"description": "The normal top position of the window."
},
"WindowPlacement_NormalPos_Right": {
"type": "string",
"description": "The normal right position of the window."
},
"WindowPlacement_NormalPos_Bottom": {
"type": "string",
"description": "The normal bottom position of the window."
}
},
"required": [
"@type",
"Name",
"WindowPlacement_Flags",
"WindowPlacement_MinPos_X",
"WindowPlacement_MinPos_Y",
"WindowPlacement_MaxPos_X",
"WindowPlacement_MaxPos_Y",
"WindowPlacement_NormalPos_Left",
"WindowPlacement_NormalPos_Top",
"WindowPlacement_NormalPos_Right",
"WindowPlacement_NormalPos_Bottom"
],
"additionalProperties": false
}
},
"FallbackLastTabPositions": {
"type": "array",
"description": "Fallback of the list of last tab position.",
"items": {
"type": "object",
"description": "Information of the positions of a window of a view.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ViewPosition.",
"enum": [
"ViewPosition"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"WindowPlacement_Flags": {
"type": "string",
"description": "The flags of the window placement."
},
"WindowPlacement_ShowCmd": {
"type": "string",
"description": "The last showCmd for the window placement.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"WindowPlacement_MinPos_X": {
"type": "string",
"description": "The minimum X position of the window."
},
"WindowPlacement_MinPos_Y": {
"type": "string",
"description": "The minimum Y position of the window."
},
"WindowPlacement_MaxPos_X": {
"type": "string",
"description": "The maximum X position of the window."
},
"WindowPlacement_MaxPos_Y": {
"type": "string",
"description": "The maximum Y position of the window."
},
"WindowPlacement_NormalPos_Left": {
"type": "string",
"description": "The normal left position of the window."
},
"WindowPlacement_NormalPos_Top": {
"type": "string",
"description": "The normal top position of the window."
},
"WindowPlacement_NormalPos_Right": {
"type": "string",
"description": "The normal right position of the window."
},
"WindowPlacement_NormalPos_Bottom": {
"type": "string",
"description": "The normal bottom position of the window."
}
},
"required": [
"@type",
"Name",
"WindowPlacement_Flags",
"WindowPlacement_MinPos_X",
"WindowPlacement_MinPos_Y",
"WindowPlacement_MaxPos_X",
"WindowPlacement_MaxPos_Y",
"WindowPlacement_NormalPos_Left",
"WindowPlacement_NormalPos_Top",
"WindowPlacement_NormalPos_Right",
"WindowPlacement_NormalPos_Bottom"
],
"additionalProperties": false
}
},
"LastPositions": {
"type": "array",
"description": "List of last tab position.",
"items": {
"type": "object",
"description": "Information of the positions of a window of a view.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ViewPosition.",
"enum": [
"ViewPosition"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"WindowPlacement_Flags": {
"type": "string",
"description": "The flags of the window placement."
},
"WindowPlacement_ShowCmd": {
"type": "string",
"description": "The last showCmd for the window placement.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"WindowPlacement_MinPos_X": {
"type": "string",
"description": "The minimum X position of the window."
},
"WindowPlacement_MinPos_Y": {
"type": "string",
"description": "The minimum Y position of the window."
},
"WindowPlacement_MaxPos_X": {
"type": "string",
"description": "The maximum X position of the window."
},
"WindowPlacement_MaxPos_Y": {
"type": "string",
"description": "The maximum Y position of the window."
},
"WindowPlacement_NormalPos_Left": {
"type": "string",
"description": "The normal left position of the window."
},
"WindowPlacement_NormalPos_Top": {
"type": "string",
"description": "The normal top position of the window."
},
"WindowPlacement_NormalPos_Right": {
"type": "string",
"description": "The normal right position of the window."
},
"WindowPlacement_NormalPos_Bottom": {
"type": "string",
"description": "The normal bottom position of the window."
}
},
"required": [
"@type",
"Name",
"WindowPlacement_Flags",
"WindowPlacement_MinPos_X",
"WindowPlacement_MinPos_Y",
"WindowPlacement_MaxPos_X",
"WindowPlacement_MaxPos_Y",
"WindowPlacement_NormalPos_Left",
"WindowPlacement_NormalPos_Top",
"WindowPlacement_NormalPos_Right",
"WindowPlacement_NormalPos_Bottom"
],
"additionalProperties": false
}
},
"MetadataLastTabPositions": {
"type": "array",
"description": "List of last tab position for metadata.",
"items": {
"type": "object",
"description": "Information of the positions of a window of a view.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ViewPosition.",
"enum": [
"ViewPosition"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"WindowPlacement_Flags": {
"type": "string",
"description": "The flags of the window placement."
},
"WindowPlacement_ShowCmd": {
"type": "string",
"description": "The last showCmd for the window placement.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"WindowPlacement_MinPos_X": {
"type": "string",
"description": "The minimum X position of the window."
},
"WindowPlacement_MinPos_Y": {
"type": "string",
"description": "The minimum Y position of the window."
},
"WindowPlacement_MaxPos_X": {
"type": "string",
"description": "The maximum X position of the window."
},
"WindowPlacement_MaxPos_Y": {
"type": "string",
"description": "The maximum Y position of the window."
},
"WindowPlacement_NormalPos_Left": {
"type": "string",
"description": "The normal left position of the window."
},
"WindowPlacement_NormalPos_Top": {
"type": "string",
"description": "The normal top position of the window."
},
"WindowPlacement_NormalPos_Right": {
"type": "string",
"description": "The normal right position of the window."
},
"WindowPlacement_NormalPos_Bottom": {
"type": "string",
"description": "The normal bottom position of the window."
}
},
"required": [
"@type",
"Name",
"WindowPlacement_Flags",
"WindowPlacement_MinPos_X",
"WindowPlacement_MinPos_Y",
"WindowPlacement_MaxPos_X",
"WindowPlacement_MaxPos_Y",
"WindowPlacement_NormalPos_Left",
"WindowPlacement_NormalPos_Top",
"WindowPlacement_NormalPos_Right",
"WindowPlacement_NormalPos_Bottom"
],
"additionalProperties": false
}
},
"Name": {
"type": "string",
"description": "Name of the layout."
},
"ObjectTypeLastTabPositions": {
"type": "array",
"description": "List of last positions for object type.",
"items": {
"type": "object",
"description": "Information of the positions of a window of a view.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ViewPosition.",
"enum": [
"ViewPosition"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"WindowPlacement_Flags": {
"type": "string",
"description": "The flags of the window placement."
},
"WindowPlacement_ShowCmd": {
"type": "string",
"description": "The last showCmd for the window placement.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"WindowPlacement_MinPos_X": {
"type": "string",
"description": "The minimum X position of the window."
},
"WindowPlacement_MinPos_Y": {
"type": "string",
"description": "The minimum Y position of the window."
},
"WindowPlacement_MaxPos_X": {
"type": "string",
"description": "The maximum X position of the window."
},
"WindowPlacement_MaxPos_Y": {
"type": "string",
"description": "The maximum Y position of the window."
},
"WindowPlacement_NormalPos_Left": {
"type": "string",
"description": "The normal left position of the window."
},
"WindowPlacement_NormalPos_Top": {
"type": "string",
"description": "The normal top position of the window."
},
"WindowPlacement_NormalPos_Right": {
"type": "string",
"description": "The normal right position of the window."
},
"WindowPlacement_NormalPos_Bottom": {
"type": "string",
"description": "The normal bottom position of the window."
}
},
"required": [
"@type",
"Name",
"WindowPlacement_Flags",
"WindowPlacement_MinPos_X",
"WindowPlacement_MinPos_Y",
"WindowPlacement_MaxPos_X",
"WindowPlacement_MaxPos_Y",
"WindowPlacement_NormalPos_Left",
"WindowPlacement_NormalPos_Top",
"WindowPlacement_NormalPos_Right",
"WindowPlacement_NormalPos_Bottom"
],
"additionalProperties": false
}
},
"PluginInnerObjectLastTabPositions": {
"type": "array",
"description": "List of last position for plugin inner object.",
"items": {
"type": "object",
"description": "Information of the positions of a window of a view.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ViewPosition.",
"enum": [
"ViewPosition"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"WindowPlacement_Flags": {
"type": "string",
"description": "The flags of the window placement."
},
"WindowPlacement_ShowCmd": {
"type": "string",
"description": "The last showCmd for the window placement.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"WindowPlacement_MinPos_X": {
"type": "string",
"description": "The minimum X position of the window."
},
"WindowPlacement_MinPos_Y": {
"type": "string",
"description": "The minimum Y position of the window."
},
"WindowPlacement_MaxPos_X": {
"type": "string",
"description": "The maximum X position of the window."
},
"WindowPlacement_MaxPos_Y": {
"type": "string",
"description": "The maximum Y position of the window."
},
"WindowPlacement_NormalPos_Left": {
"type": "string",
"description": "The normal left position of the window."
},
"WindowPlacement_NormalPos_Top": {
"type": "string",
"description": "The normal top position of the window."
},
"WindowPlacement_NormalPos_Right": {
"type": "string",
"description": "The normal right position of the window."
},
"WindowPlacement_NormalPos_Bottom": {
"type": "string",
"description": "The normal bottom position of the window."
}
},
"required": [
"@type",
"Name",
"WindowPlacement_Flags",
"WindowPlacement_MinPos_X",
"WindowPlacement_MinPos_Y",
"WindowPlacement_MaxPos_X",
"WindowPlacement_MaxPos_Y",
"WindowPlacement_NormalPos_Left",
"WindowPlacement_NormalPos_Top",
"WindowPlacement_NormalPos_Right",
"WindowPlacement_NormalPos_Bottom"
],
"additionalProperties": false
}
},
"SourcePluginLastTabPositions": {
"type": "array",
"description": "List of last tab positions for source plugin.",
"items": {
"type": "object",
"description": "Information of the positions of a window of a view.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ViewPosition.",
"enum": [
"ViewPosition"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"WindowPlacement_Flags": {
"type": "string",
"description": "The flags of the window placement."
},
"WindowPlacement_ShowCmd": {
"type": "string",
"description": "The last showCmd for the window placement.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"WindowPlacement_MinPos_X": {
"type": "string",
"description": "The minimum X position of the window."
},
"WindowPlacement_MinPos_Y": {
"type": "string",
"description": "The minimum Y position of the window."
},
"WindowPlacement_MaxPos_X": {
"type": "string",
"description": "The maximum X position of the window."
},
"WindowPlacement_MaxPos_Y": {
"type": "string",
"description": "The maximum Y position of the window."
},
"WindowPlacement_NormalPos_Left": {
"type": "string",
"description": "The normal left position of the window."
},
"WindowPlacement_NormalPos_Top": {
"type": "string",
"description": "The normal top position of the window."
},
"WindowPlacement_NormalPos_Right": {
"type": "string",
"description": "The normal right position of the window."
},
"WindowPlacement_NormalPos_Bottom": {
"type": "string",
"description": "The normal bottom position of the window."
}
},
"required": [
"@type",
"Name",
"WindowPlacement_Flags",
"WindowPlacement_MinPos_X",
"WindowPlacement_MinPos_Y",
"WindowPlacement_MaxPos_X",
"WindowPlacement_MaxPos_Y",
"WindowPlacement_NormalPos_Left",
"WindowPlacement_NormalPos_Top",
"WindowPlacement_NormalPos_Right",
"WindowPlacement_NormalPos_Bottom"
],
"additionalProperties": false
}
},
"StackPanel": {
"type": "object",
"description": "Stack panel in a layout.",
"properties": {
"@type": {
"type": "string",
"description": "The type of StackPanel.",
"enum": [
"StackPanel"
]
},
"Name": {
"type": "string",
"description": "The name of the stack panel."
},
"ID": {
"type": "string",
"description": "The identifier of the stack panel."
},
"Width": {
"type": "string",
"description": "The width of the stack panel."
},
"Height": {
"type": "string",
"description": "The height of the stack panel."
},
"@Children": {
"type": "array",
"description": "UI element in the stack panel.",
"items": {
"description": "UI Element.",
"OneOf": [
{
"type": "object",
"description": "View in a layout.",
"properties": {
"@type": {
"type": "string",
"description": "The type of View.",
"enum": [
"View"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"ID": {
"type": "string",
"description": "The identifier of the view."
},
"Width": {
"type": "string",
"description": "The width of the view."
},
"Height": {
"type": "string",
"description": "The height of the view."
},
"SelectionChannel": {
"type": "string",
"description": "The selection chanel of the view."
},
"ViewData": {
"type": "object",
"description": "Extra view data.",
"additionalProperties": true
}
},
"required": [
"Name",
"ID",
"SelectionChannel"
],
"additionalProperties": false
},
{
"type": "object",
"description": "The splitter.",
"properties": {
"@type": {
"type": "string",
"description": "The type of Splitter.",
"enum": [
"Splitter"
]
},
"Name": {
"type": "string",
"description": "The name of the splitter."
},
"ID": {
"type": "string",
"description": "The identifier of the splitter."
},
"Width": {
"type": "string",
"description": "The width of the splitter."
},
"Height": {
"type": "string",
"description": "The height of the splitter."
}
},
"required": [
"ID",
"Name",
"@Children"
],
"additionalProperties": false
},
{
"type": "object",
"description": "An object panel.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ObjectPanel.",
"enum": [
"ObjectPanel"
]
},
"Name": {
"type": "string",
"description": "The name of the object panel."
},
"ID": {
"type": "string",
"description": "The identifier of the object panel."
},
"Width": {
"type": "string",
"description": "The width of the object panel."
},
"Height": {
"type": "string",
"description": "The height of the object panel."
},
"EditorState": {
"type": "string",
"description": "State of an editor.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"BottomEditorState": {
"type": "string",
"description": "The state of the bottom editor.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"EditorPriority": {
"type": "array",
"description": "Liste of editors by priority.",
"items": {
"type": "object",
"description": "Identifier of an editor.",
"properties": {
"@type": {
"type": "string",
"description": "Type of EditorId.",
"enum": [
"EditorId"
]
},
"UniqueViewId": {
"type": "string",
"description": "View ID of the editor."
},
"PluginId": {
"type": "string",
"description": "Plugin ID of the Editor."
},
"EffectIndex": {
"type": "string",
"description": "Index of the effect."
}
},
"required": [
"UniqueViewId",
"PluginId",
"EffectIndex"
],
"additionalProperties": false
}
},
"PreferredHeights": {
"type": "array",
"description": "List of preferred height of editors.",
"items": {
"type": "object",
"description": "The preferred height for an editor.",
"properties": {
"@type": {
"type": "string",
"description": "The type of PreferredHeight.",
"enum": [
"PreferredHeight"
]
},
"UniqueViewId": {
"type": "string",
"description": "The view identifier of the editor."
},
"PluginId": {
"type": "string",
"description": "The plugin identifier of the editor."
},
"EffectIndex": {
"type": "string",
"description": "The effect index."
},
"Height": {
"type": "string",
"description": "The preferred height of the editor."
}
},
"required": [
"@type",
"UniqueViewId",
"PluginId",
"EffectIndex",
"Height"
],
"additionalProperties": false
}
},
"SideBar": {
"type": "object",
"description": "The side bar.",
"properties": {
"@type": {
"type": "string",
"description": "The type of SideBar.",
"enum": "SideBar"
},
"Width": {
"type": "string",
"description": "The width of the side bar."
},
"CollapseState": {
"type": "string",
"description": "The state of the side bar."
}
},
"required": [
"@type",
"Width",
"CollapseState"
],
"additionalProperties": false
}
},
"required": [
"@type",
"Name",
"ID"
],
"additionalProperties": false
},
{
"type": "object",
"description": "The object tab panel.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ObjectTabPanel.",
"enum": [
"ObjectTabPanel"
]
},
"Name": {
"type": "string",
"description": "The name of the object tab panel."
},
"ID": {
"type": "string",
"description": "The identifer of the object tab panel."
},
"Width": {
"type": "string",
"description": "The width of the the object tab panel."
},
"Height": {
"type": "string",
"description": "The height of the the object tab panel."
}
},
"required": [
"@type",
"Name",
"ID"
],
"additionalProperties": false
},
{
"$ref": "#/definitions/StackPanel"
}
]
}
},
"Orientation": {
"type": "string",
"description": "The orientation of the stack panel.",
"enum": [
"Vertical",
"Horizontal"
]
}
},
"required": [
"ID",
"Name",
"@Children",
"Orientation"
],
"additionalProperties": true
},
"Undocked": {
"type": "array",
"description": "List of undocked views.",
"items": {
"allOf": [
{
"description": "UI Element.",
"OneOf": [
{
"type": "object",
"description": "View in a layout.",
"properties": {
"@type": {
"type": "string",
"description": "The type of View.",
"enum": [
"View"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"ID": {
"type": "string",
"description": "The identifier of the view."
},
"Width": {
"type": "string",
"description": "The width of the view."
},
"Height": {
"type": "string",
"description": "The height of the view."
},
"SelectionChannel": {
"type": "string",
"description": "The selection chanel of the view."
},
"ViewData": {
"type": "object",
"description": "Extra view data.",
"additionalProperties": true
}
},
"required": [
"Name",
"ID",
"SelectionChannel"
],
"additionalProperties": false
},
{
"type": "object",
"description": "The splitter.",
"properties": {
"@type": {
"type": "string",
"description": "The type of Splitter.",
"enum": [
"Splitter"
]
},
"Name": {
"type": "string",
"description": "The name of the splitter."
},
"ID": {
"type": "string",
"description": "The identifier of the splitter."
},
"Width": {
"type": "string",
"description": "The width of the splitter."
},
"Height": {
"type": "string",
"description": "The height of the splitter."
}
},
"required": [
"ID",
"Name",
"@Children"
],
"additionalProperties": false
},
{
"type": "object",
"description": "An object panel.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ObjectPanel.",
"enum": [
"ObjectPanel"
]
},
"Name": {
"type": "string",
"description": "The name of the object panel."
},
"ID": {
"type": "string",
"description": "The identifier of the object panel."
},
"Width": {
"type": "string",
"description": "The width of the object panel."
},
"Height": {
"type": "string",
"description": "The height of the object panel."
},
"EditorState": {
"type": "string",
"description": "State of an editor.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"BottomEditorState": {
"type": "string",
"description": "The state of the bottom editor.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"EditorPriority": {
"type": "array",
"description": "Liste of editors by priority.",
"items": {
"type": "object",
"description": "Identifier of an editor.",
"properties": {
"@type": {
"type": "string",
"description": "Type of EditorId.",
"enum": [
"EditorId"
]
},
"UniqueViewId": {
"type": "string",
"description": "View ID of the editor."
},
"PluginId": {
"type": "string",
"description": "Plugin ID of the Editor."
},
"EffectIndex": {
"type": "string",
"description": "Index of the effect."
}
},
"required": [
"UniqueViewId",
"PluginId",
"EffectIndex"
],
"additionalProperties": false
}
},
"PreferredHeights": {
"type": "array",
"description": "List of preferred height of editors.",
"items": {
"type": "object",
"description": "The preferred height for an editor.",
"properties": {
"@type": {
"type": "string",
"description": "The type of PreferredHeight.",
"enum": [
"PreferredHeight"
]
},
"UniqueViewId": {
"type": "string",
"description": "The view identifier of the editor."
},
"PluginId": {
"type": "string",
"description": "The plugin identifier of the editor."
},
"EffectIndex": {
"type": "string",
"description": "The effect index."
},
"Height": {
"type": "string",
"description": "The preferred height of the editor."
}
},
"required": [
"@type",
"UniqueViewId",
"PluginId",
"EffectIndex",
"Height"
],
"additionalProperties": false
}
},
"SideBar": {
"type": "object",
"description": "The side bar.",
"properties": {
"@type": {
"type": "string",
"description": "The type of SideBar.",
"enum": "SideBar"
},
"Width": {
"type": "string",
"description": "The width of the side bar."
},
"CollapseState": {
"type": "string",
"description": "The state of the side bar."
}
},
"required": [
"@type",
"Width",
"CollapseState"
],
"additionalProperties": false
}
},
"required": [
"@type",
"Name",
"ID"
],
"additionalProperties": false
},
{
"type": "object",
"description": "The object tab panel.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ObjectTabPanel.",
"enum": [
"ObjectTabPanel"
]
},
"Name": {
"type": "string",
"description": "The name of the object tab panel."
},
"ID": {
"type": "string",
"description": "The identifer of the object tab panel."
},
"Width": {
"type": "string",
"description": "The width of the the object tab panel."
},
"Height": {
"type": "string",
"description": "The height of the the object tab panel."
}
},
"required": [
"@type",
"Name",
"ID"
],
"additionalProperties": false
},
{
"type": "object",
"description": "Stack panel in a layout.",
"properties": {
"@type": {
"type": "string",
"description": "The type of StackPanel.",
"enum": [
"StackPanel"
]
},
"Name": {
"type": "string",
"description": "The name of the stack panel."
},
"ID": {
"type": "string",
"description": "The identifier of the stack panel."
},
"Width": {
"type": "string",
"description": "The width of the stack panel."
},
"Height": {
"type": "string",
"description": "The height of the stack panel."
},
"@Children": {
"type": "array",
"description": "UI element in the stack panel.",
"items": {
"$ref": "#/definitions/Element"
}
},
"Orientation": {
"type": "string",
"description": "The orientation of the stack panel.",
"enum": [
"Vertical",
"Horizontal"
]
}
},
"required": [
"ID",
"Name",
"@Children",
"Orientation"
],
"additionalProperties": true
}
]
}
],
"type": "object",
"description": "View holder for flotting window.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ViewHolder",
"enum": [
"ViewHolder"
]
},
"StackPanel": {
"type": "object",
"description": "Stack panel in a layout.",
"properties": {
"@type": {
"type": "string",
"description": "The type of StackPanel.",
"enum": [
"StackPanel"
]
},
"Name": {
"type": "string",
"description": "The name of the stack panel."
},
"ID": {
"type": "string",
"description": "The identifier of the stack panel."
},
"Width": {
"type": "string",
"description": "The width of the stack panel."
},
"Height": {
"type": "string",
"description": "The height of the stack panel."
},
"@Children": {
"type": "array",
"description": "UI element in the stack panel.",
"items": {
"description": "UI Element.",
"OneOf": [
{
"type": "object",
"description": "View in a layout.",
"properties": {
"@type": {
"type": "string",
"description": "The type of View.",
"enum": [
"View"
]
},
"Name": {
"type": "string",
"description": "The name of the view."
},
"ID": {
"type": "string",
"description": "The identifier of the view."
},
"Width": {
"type": "string",
"description": "The width of the view."
},
"Height": {
"type": "string",
"description": "The height of the view."
},
"SelectionChannel": {
"type": "string",
"description": "The selection chanel of the view."
},
"ViewData": {
"type": "object",
"description": "Extra view data.",
"additionalProperties": true
}
},
"required": [
"Name",
"ID",
"SelectionChannel"
],
"additionalProperties": false
},
{
"type": "object",
"description": "The splitter.",
"properties": {
"@type": {
"type": "string",
"description": "The type of Splitter.",
"enum": [
"Splitter"
]
},
"Name": {
"type": "string",
"description": "The name of the splitter."
},
"ID": {
"type": "string",
"description": "The identifier of the splitter."
},
"Width": {
"type": "string",
"description": "The width of the splitter."
},
"Height": {
"type": "string",
"description": "The height of the splitter."
}
},
"required": [
"ID",
"Name",
"@Children"
],
"additionalProperties": false
},
{
"type": "object",
"description": "An object panel.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ObjectPanel.",
"enum": [
"ObjectPanel"
]
},
"Name": {
"type": "string",
"description": "The name of the object panel."
},
"ID": {
"type": "string",
"description": "The identifier of the object panel."
},
"Width": {
"type": "string",
"description": "The width of the object panel."
},
"Height": {
"type": "string",
"description": "The height of the object panel."
},
"EditorState": {
"type": "string",
"description": "State of an editor.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"BottomEditorState": {
"type": "string",
"description": "The state of the bottom editor.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"EditorPriority": {
"type": "array",
"description": "Liste of editors by priority.",
"items": {
"type": "object",
"description": "Identifier of an editor.",
"properties": {
"@type": {
"type": "string",
"description": "Type of EditorId.",
"enum": [
"EditorId"
]
},
"UniqueViewId": {
"type": "string",
"description": "View ID of the editor."
},
"PluginId": {
"type": "string",
"description": "Plugin ID of the Editor."
},
"EffectIndex": {
"type": "string",
"description": "Index of the effect."
}
},
"required": [
"UniqueViewId",
"PluginId",
"EffectIndex"
],
"additionalProperties": false
}
},
"PreferredHeights": {
"type": "array",
"description": "List of preferred height of editors.",
"items": {
"type": "object",
"description": "The preferred height for an editor.",
"properties": {
"@type": {
"type": "string",
"description": "The type of PreferredHeight.",
"enum": [
"PreferredHeight"
]
},
"UniqueViewId": {
"type": "string",
"description": "The view identifier of the editor."
},
"PluginId": {
"type": "string",
"description": "The plugin identifier of the editor."
},
"EffectIndex": {
"type": "string",
"description": "The effect index."
},
"Height": {
"type": "string",
"description": "The preferred height of the editor."
}
},
"required": [
"@type",
"UniqueViewId",
"PluginId",
"EffectIndex",
"Height"
],
"additionalProperties": false
}
},
"SideBar": {
"type": "object",
"description": "The side bar.",
"properties": {
"@type": {
"type": "string",
"description": "The type of SideBar.",
"enum": "SideBar"
},
"Width": {
"type": "string",
"description": "The width of the side bar."
},
"CollapseState": {
"type": "string",
"description": "The state of the side bar."
}
},
"required": [
"@type",
"Width",
"CollapseState"
],
"additionalProperties": false
}
},
"required": [
"@type",
"Name",
"ID"
],
"additionalProperties": false
},
{
"type": "object",
"description": "The object tab panel.",
"properties": {
"@type": {
"type": "string",
"description": "The type of ObjectTabPanel.",
"enum": [
"ObjectTabPanel"
]
},
"Name": {
"type": "string",
"description": "The name of the object tab panel."
},
"ID": {
"type": "string",
"description": "The identifer of the object tab panel."
},
"Width": {
"type": "string",
"description": "The width of the the object tab panel."
},
"Height": {
"type": "string",
"description": "The height of the the object tab panel."
}
},
"required": [
"@type",
"Name",
"ID"
],
"additionalProperties": false
},
{
"$ref": "#/definitions/StackPanel"
}
]
}
},
"Orientation": {
"type": "string",
"description": "The orientation of the stack panel.",
"enum": [
"Vertical",
"Horizontal"
]
}
},
"required": [
"ID",
"Name",
"@Children",
"Orientation"
],
"additionalProperties": true
},
"WindowPlacement_Flags": {
"type": "string",
"description": "Flags of WindowPlacement."
},
"WindowPlacement_ShowCmd": {
"type": "string",
"description": "Last ShowCmd of the WindowPlacement.",
"enum": [
"Normal",
"Maximized",
"Minimized"
]
},
"WindowPlacement_MinPos_X": {
"type": "string",
"description": "Minimum X position of the window."
},
"WindowPlacement_MinPos_Y": {
"type": "string",
"description": "Minimum Y position of the window."
},
"WindowPlacement_MaxPos_X": {
"type": "string",
"description": "Maximum X position of the window."
},
"WindowPlacement_MaxPos_Y": {
"type": "string",
"description": "Maximum Y position of the window."
},
"WindowPlacement_NormalPos_Left": {
"type": "string",
"description": "Normal left position of the window."
},
"WindowPlacement_NormalPos_Top": {
"type": "string",
"description": "Normal left position of the window."
},
"WindowPlacement_NormalPos_Right": {
"type": "string",
"description": "Normal right position of the window."
},
"WindowPlacement_NormalPos_Bottom": {
"type": "string",
"description": "Normal bottom position of the window."
}
},
"required": [
"@type",
"WindowPlacement_Flags",
"WindowPlacement_MinPos_X",
"WindowPlacement_MinPos_Y",
"WindowPlacement_MaxPos_X",
"WindowPlacement_MaxPos_Y",
"WindowPlacement_NormalPos_Left",
"WindowPlacement_NormalPos_Top",
"WindowPlacement_NormalPos_Right",
"WindowPlacement_NormalPos_Bottom"
],
"additionalProperties": false
}
}
},
"required": [
"Name"
],
"additionalProperties": false
}
},
"required": [
"Layout"
],
"additionalProperties": false
}
},
"required": [
"name",
"layout"
],
"additionalProperties": false
}

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise