|
Wwise SDK 2024.1.0
|
Registers a new layout from a JSON format.
| Name | Type | Description |
|---|---|---|
| name * | string | The name of the layout to register. |
| layout * | object | The layout description in JSON format. A layout entity. |
| layout.Layout * | object | The layout description in JSON format. |
| layout.Layout.AudioDeviceLastTabPositions | array | List of last view positions. |
| layout.Layout.AudioDeviceLastTabPositions [...] | object | Information of the positions of a window of a view. |
| layout.Layout.AudioDeviceLastTabPositions[...].@type * | string | The type of ViewPosition. Possible values:
|
| layout.Layout.AudioDeviceLastTabPositions[...].Name * | string | The name of the view. |
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_Flags * | string | The flags of the window placement. |
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_ShowCmd | string | The last showCmd for the window placement. Possible values:
|
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_MinPos_X * | string | The minimum X position of the window. |
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_MinPos_Y * | string | The minimum Y position of the window. |
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_MaxPos_X * | string | The maximum X position of the window. |
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_MaxPos_Y * | string | The maximum Y position of the window. |
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_NormalPos_Left * | string | The normal left position of the window. |
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_NormalPos_Top * | string | The normal top position of the window. |
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_NormalPos_Right * | string | The normal right position of the window. |
| layout.Layout.AudioDeviceLastTabPositions[...].WindowPlacement_NormalPos_Bottom * | string | The normal bottom position of the window. |
| layout.Layout.EffectLastTabPositions | array | List of last tab positions for effects. |
| layout.Layout.EffectLastTabPositions [...] | object | Information of the positions of a window of a view. |
| layout.Layout.EffectLastTabPositions[...].@type * | string | The type of ViewPosition. Possible values:
|
| layout.Layout.EffectLastTabPositions[...].Name * | string | The name of the view. |
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_Flags * | string | The flags of the window placement. |
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_ShowCmd | string | The last showCmd for the window placement. Possible values:
|
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_MinPos_X * | string | The minimum X position of the window. |
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_MinPos_Y * | string | The minimum Y position of the window. |
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_MaxPos_X * | string | The maximum X position of the window. |
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_MaxPos_Y * | string | The maximum Y position of the window. |
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_NormalPos_Left * | string | The normal left position of the window. |
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_NormalPos_Top * | string | The normal top position of the window. |
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_NormalPos_Right * | string | The normal right position of the window. |
| layout.Layout.EffectLastTabPositions[...].WindowPlacement_NormalPos_Bottom * | string | The normal bottom position of the window. |
| layout.Layout.FallbackLastTabPositions | array | Fallback of the list of last tab position. |
| layout.Layout.FallbackLastTabPositions [...] | object | Information of the positions of a window of a view. |
| layout.Layout.FallbackLastTabPositions[...].@type * | string | The type of ViewPosition. Possible values:
|
| layout.Layout.FallbackLastTabPositions[...].Name * | string | The name of the view. |
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_Flags * | string | The flags of the window placement. |
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_ShowCmd | string | The last showCmd for the window placement. Possible values:
|
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_MinPos_X * | string | The minimum X position of the window. |
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_MinPos_Y * | string | The minimum Y position of the window. |
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_MaxPos_X * | string | The maximum X position of the window. |
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_MaxPos_Y * | string | The maximum Y position of the window. |
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_NormalPos_Left * | string | The normal left position of the window. |
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_NormalPos_Top * | string | The normal top position of the window. |
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_NormalPos_Right * | string | The normal right position of the window. |
| layout.Layout.FallbackLastTabPositions[...].WindowPlacement_NormalPos_Bottom * | string | The normal bottom position of the window. |
| layout.Layout.LastPositions | array | List of last tab position. |
| layout.Layout.LastPositions [...] | object | Information of the positions of a window of a view. |
| layout.Layout.LastPositions[...].@type * | string | The type of ViewPosition. Possible values:
|
| layout.Layout.LastPositions[...].Name * | string | The name of the view. |
| layout.Layout.LastPositions[...].WindowPlacement_Flags * | string | The flags of the window placement. |
| layout.Layout.LastPositions[...].WindowPlacement_ShowCmd | string | The last showCmd for the window placement. Possible values:
|
| layout.Layout.LastPositions[...].WindowPlacement_MinPos_X * | string | The minimum X position of the window. |
| layout.Layout.LastPositions[...].WindowPlacement_MinPos_Y * | string | The minimum Y position of the window. |
| layout.Layout.LastPositions[...].WindowPlacement_MaxPos_X * | string | The maximum X position of the window. |
| layout.Layout.LastPositions[...].WindowPlacement_MaxPos_Y * | string | The maximum Y position of the window. |
| layout.Layout.LastPositions[...].WindowPlacement_NormalPos_Left * | string | The normal left position of the window. |
| layout.Layout.LastPositions[...].WindowPlacement_NormalPos_Top * | string | The normal top position of the window. |
| layout.Layout.LastPositions[...].WindowPlacement_NormalPos_Right * | string | The normal right position of the window. |
| layout.Layout.LastPositions[...].WindowPlacement_NormalPos_Bottom * | string | The normal bottom position of the window. |
| layout.Layout.MetadataLastTabPositions | array | List of last tab position for metadata. |
| layout.Layout.MetadataLastTabPositions [...] | object | Information of the positions of a window of a view. |
| layout.Layout.MetadataLastTabPositions[...].@type * | string | The type of ViewPosition. Possible values:
|
| layout.Layout.MetadataLastTabPositions[...].Name * | string | The name of the view. |
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_Flags * | string | The flags of the window placement. |
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_ShowCmd | string | The last showCmd for the window placement. Possible values:
|
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_MinPos_X * | string | The minimum X position of the window. |
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_MinPos_Y * | string | The minimum Y position of the window. |
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_MaxPos_X * | string | The maximum X position of the window. |
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_MaxPos_Y * | string | The maximum Y position of the window. |
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_NormalPos_Left * | string | The normal left position of the window. |
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_NormalPos_Top * | string | The normal top position of the window. |
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_NormalPos_Right * | string | The normal right position of the window. |
| layout.Layout.MetadataLastTabPositions[...].WindowPlacement_NormalPos_Bottom * | string | The normal bottom position of the window. |
| layout.Layout.Name * | string | Name of the layout. |
| layout.Layout.ObjectTypeLastTabPositions | array | List of last positions for object type. |
| layout.Layout.ObjectTypeLastTabPositions [...] | object | Information of the positions of a window of a view. |
| layout.Layout.ObjectTypeLastTabPositions[...].@type * | string | The type of ViewPosition. Possible values:
|
| layout.Layout.ObjectTypeLastTabPositions[...].Name * | string | The name of the view. |
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_Flags * | string | The flags of the window placement. |
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_ShowCmd | string | The last showCmd for the window placement. Possible values:
|
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_MinPos_X * | string | The minimum X position of the window. |
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_MinPos_Y * | string | The minimum Y position of the window. |
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_MaxPos_X * | string | The maximum X position of the window. |
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_MaxPos_Y * | string | The maximum Y position of the window. |
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_NormalPos_Left * | string | The normal left position of the window. |
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_NormalPos_Top * | string | The normal top position of the window. |
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_NormalPos_Right * | string | The normal right position of the window. |
| layout.Layout.ObjectTypeLastTabPositions[...].WindowPlacement_NormalPos_Bottom * | string | The normal bottom position of the window. |
| layout.Layout.PluginInnerObjectLastTabPositions | array | List of last position for plugin inner object. |
| layout.Layout.PluginInnerObjectLastTabPositions [...] | object | Information of the positions of a window of a view. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].@type * | string | The type of ViewPosition. Possible values:
|
| layout.Layout.PluginInnerObjectLastTabPositions[...].Name * | string | The name of the view. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_Flags * | string | The flags of the window placement. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_ShowCmd | string | The last showCmd for the window placement. Possible values:
|
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_MinPos_X * | string | The minimum X position of the window. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_MinPos_Y * | string | The minimum Y position of the window. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_MaxPos_X * | string | The maximum X position of the window. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_MaxPos_Y * | string | The maximum Y position of the window. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_NormalPos_Left * | string | The normal left position of the window. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_NormalPos_Top * | string | The normal top position of the window. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_NormalPos_Right * | string | The normal right position of the window. |
| layout.Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_NormalPos_Bottom * | string | The normal bottom position of the window. |
| layout.Layout.SourcePluginLastTabPositions | array | List of last tab positions for source plugin. |
| layout.Layout.SourcePluginLastTabPositions [...] | object | Information of the positions of a window of a view. |
| layout.Layout.SourcePluginLastTabPositions[...].@type * | string | The type of ViewPosition. Possible values:
|
| layout.Layout.SourcePluginLastTabPositions[...].Name * | string | The name of the view. |
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_Flags * | string | The flags of the window placement. |
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_ShowCmd | string | The last showCmd for the window placement. Possible values:
|
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_MinPos_X * | string | The minimum X position of the window. |
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_MinPos_Y * | string | The minimum Y position of the window. |
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_MaxPos_X * | string | The maximum X position of the window. |
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_MaxPos_Y * | string | The maximum Y position of the window. |
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_NormalPos_Left * | string | The normal left position of the window. |
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_NormalPos_Top * | string | The normal top position of the window. |
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_NormalPos_Right * | string | The normal right position of the window. |
| layout.Layout.SourcePluginLastTabPositions[...].WindowPlacement_NormalPos_Bottom * | string | The normal bottom position of the window. |
| layout.Layout.StackPanel | object | Stack panel in a layout. |
| layout.Layout.StackPanel.@type | string | The type of StackPanel. Possible values:
|
| layout.Layout.StackPanel.Name * | string | The name of the stack panel. |
| layout.Layout.StackPanel.ID * | string | The identifier of the stack panel. |
| layout.Layout.StackPanel.Width | string | The width of the stack panel. |
| layout.Layout.StackPanel.Height | string | The height of the stack panel. |
| layout.Layout.StackPanel.@Children * | array | UI element in the stack panel. |
| layout.Layout.StackPanel.@Children [...] | UI Element. | |
| layout.Layout.StackPanel.Orientation * | string | The orientation of the stack panel. Possible values:
|
| layout.Layout.Undocked | array | List of undocked views. |
| layout.Layout.Undocked [...] | object | View holder for flotting window. |
| layout.Layout.Undocked[...].@type * | string | The type of ViewHolder Possible values:
|
| layout.Layout.Undocked[...].StackPanel | object | Stack panel in a layout. |
| layout.Layout.Undocked[...].StackPanel.@type | string | The type of StackPanel. Possible values:
|
| layout.Layout.Undocked[...].StackPanel.Name * | string | The name of the stack panel. |
| layout.Layout.Undocked[...].StackPanel.ID * | string | The identifier of the stack panel. |
| layout.Layout.Undocked[...].StackPanel.Width | string | The width of the stack panel. |
| layout.Layout.Undocked[...].StackPanel.Height | string | The height of the stack panel. |
| layout.Layout.Undocked[...].StackPanel.@Children * | array | UI element in the stack panel. |
| layout.Layout.Undocked[...].StackPanel.@Children [...] | UI Element. | |
| layout.Layout.Undocked[...].StackPanel.Orientation * | string | The orientation of the stack panel. Possible values:
|
| layout.Layout.Undocked[...].WindowPlacement_Flags * | string | Flags of WindowPlacement. |
| layout.Layout.Undocked[...].WindowPlacement_ShowCmd | string | Last ShowCmd of the WindowPlacement. Possible values:
|
| layout.Layout.Undocked[...].WindowPlacement_MinPos_X * | string | Minimum X position of the window. |
| layout.Layout.Undocked[...].WindowPlacement_MinPos_Y * | string | Minimum Y position of the window. |
| layout.Layout.Undocked[...].WindowPlacement_MaxPos_X * | string | Maximum X position of the window. |
| layout.Layout.Undocked[...].WindowPlacement_MaxPos_Y * | string | Maximum Y position of the window. |
| layout.Layout.Undocked[...].WindowPlacement_NormalPos_Left * | string | Normal left position of the window. |
| layout.Layout.Undocked[...].WindowPlacement_NormalPos_Top * | string | Normal left position of the window. |
| layout.Layout.Undocked[...].WindowPlacement_NormalPos_Right * | string | Normal right position of the window. |
| layout.Layout.Undocked[...].WindowPlacement_NormalPos_Bottom * | string | Normal bottom position of the window. |
(Required *)
Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise