Version
menu_open
Wwise SDK 2024.1.0
ak.wwise.ui.layout.getLayout

Serializes a specific layout into a JSON format.

Arguments

Name Type Description
name * string The name of the layout to serialize.

(Required *)

Arguments Schema

Result

Name Type Description
Layout object The layout description in JSON format.
Layout.AudioDeviceLastTabPositions array List of last view positions.
Layout.AudioDeviceLastTabPositions [...] object Information of the positions of a window of a view.
Layout.AudioDeviceLastTabPositions[...].@type * string The type of ViewPosition. Possible values:
  • ViewPosition
Layout.AudioDeviceLastTabPositions[...].Name * string The name of the view.
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_Flags * string The flags of the window placement.
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_ShowCmd string The last showCmd for the window placement. Possible values:
  • Normal
  • Maximized
  • Minimized
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_MinPos_X * string The minimum X position of the window.
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_MinPos_Y * string The minimum Y position of the window.
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_MaxPos_X * string The maximum X position of the window.
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_MaxPos_Y * string The maximum Y position of the window.
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_NormalPos_Left * string The normal left position of the window.
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_NormalPos_Top * string The normal top position of the window.
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_NormalPos_Right * string The normal right position of the window.
Layout.AudioDeviceLastTabPositions[...].WindowPlacement_NormalPos_Bottom * string The normal bottom position of the window.
Layout.EffectLastTabPositions array List of last tab positions for effects.
Layout.EffectLastTabPositions [...] object Information of the positions of a window of a view.
Layout.EffectLastTabPositions[...].@type * string The type of ViewPosition. Possible values:
  • ViewPosition
Layout.EffectLastTabPositions[...].Name * string The name of the view.
Layout.EffectLastTabPositions[...].WindowPlacement_Flags * string The flags of the window placement.
Layout.EffectLastTabPositions[...].WindowPlacement_ShowCmd string The last showCmd for the window placement. Possible values:
  • Normal
  • Maximized
  • Minimized
Layout.EffectLastTabPositions[...].WindowPlacement_MinPos_X * string The minimum X position of the window.
Layout.EffectLastTabPositions[...].WindowPlacement_MinPos_Y * string The minimum Y position of the window.
Layout.EffectLastTabPositions[...].WindowPlacement_MaxPos_X * string The maximum X position of the window.
Layout.EffectLastTabPositions[...].WindowPlacement_MaxPos_Y * string The maximum Y position of the window.
Layout.EffectLastTabPositions[...].WindowPlacement_NormalPos_Left * string The normal left position of the window.
Layout.EffectLastTabPositions[...].WindowPlacement_NormalPos_Top * string The normal top position of the window.
Layout.EffectLastTabPositions[...].WindowPlacement_NormalPos_Right * string The normal right position of the window.
Layout.EffectLastTabPositions[...].WindowPlacement_NormalPos_Bottom * string The normal bottom position of the window.
Layout.FallbackLastTabPositions array Fallback of the list of last tab position.
Layout.FallbackLastTabPositions [...] object Information of the positions of a window of a view.
Layout.FallbackLastTabPositions[...].@type * string The type of ViewPosition. Possible values:
  • ViewPosition
Layout.FallbackLastTabPositions[...].Name * string The name of the view.
Layout.FallbackLastTabPositions[...].WindowPlacement_Flags * string The flags of the window placement.
Layout.FallbackLastTabPositions[...].WindowPlacement_ShowCmd string The last showCmd for the window placement. Possible values:
  • Normal
  • Maximized
  • Minimized
Layout.FallbackLastTabPositions[...].WindowPlacement_MinPos_X * string The minimum X position of the window.
Layout.FallbackLastTabPositions[...].WindowPlacement_MinPos_Y * string The minimum Y position of the window.
Layout.FallbackLastTabPositions[...].WindowPlacement_MaxPos_X * string The maximum X position of the window.
Layout.FallbackLastTabPositions[...].WindowPlacement_MaxPos_Y * string The maximum Y position of the window.
Layout.FallbackLastTabPositions[...].WindowPlacement_NormalPos_Left * string The normal left position of the window.
Layout.FallbackLastTabPositions[...].WindowPlacement_NormalPos_Top * string The normal top position of the window.
Layout.FallbackLastTabPositions[...].WindowPlacement_NormalPos_Right * string The normal right position of the window.
Layout.FallbackLastTabPositions[...].WindowPlacement_NormalPos_Bottom * string The normal bottom position of the window.
Layout.LastPositions array List of last tab position.
Layout.LastPositions [...] object Information of the positions of a window of a view.
Layout.LastPositions[...].@type * string The type of ViewPosition. Possible values:
  • ViewPosition
Layout.LastPositions[...].Name * string The name of the view.
Layout.LastPositions[...].WindowPlacement_Flags * string The flags of the window placement.
Layout.LastPositions[...].WindowPlacement_ShowCmd string The last showCmd for the window placement. Possible values:
  • Normal
  • Maximized
  • Minimized
Layout.LastPositions[...].WindowPlacement_MinPos_X * string The minimum X position of the window.
Layout.LastPositions[...].WindowPlacement_MinPos_Y * string The minimum Y position of the window.
Layout.LastPositions[...].WindowPlacement_MaxPos_X * string The maximum X position of the window.
Layout.LastPositions[...].WindowPlacement_MaxPos_Y * string The maximum Y position of the window.
Layout.LastPositions[...].WindowPlacement_NormalPos_Left * string The normal left position of the window.
Layout.LastPositions[...].WindowPlacement_NormalPos_Top * string The normal top position of the window.
Layout.LastPositions[...].WindowPlacement_NormalPos_Right * string The normal right position of the window.
Layout.LastPositions[...].WindowPlacement_NormalPos_Bottom * string The normal bottom position of the window.
Layout.MetadataLastTabPositions array List of last tab position for metadata.
Layout.MetadataLastTabPositions [...] object Information of the positions of a window of a view.
Layout.MetadataLastTabPositions[...].@type * string The type of ViewPosition. Possible values:
  • ViewPosition
Layout.MetadataLastTabPositions[...].Name * string The name of the view.
Layout.MetadataLastTabPositions[...].WindowPlacement_Flags * string The flags of the window placement.
Layout.MetadataLastTabPositions[...].WindowPlacement_ShowCmd string The last showCmd for the window placement. Possible values:
  • Normal
  • Maximized
  • Minimized
Layout.MetadataLastTabPositions[...].WindowPlacement_MinPos_X * string The minimum X position of the window.
Layout.MetadataLastTabPositions[...].WindowPlacement_MinPos_Y * string The minimum Y position of the window.
Layout.MetadataLastTabPositions[...].WindowPlacement_MaxPos_X * string The maximum X position of the window.
Layout.MetadataLastTabPositions[...].WindowPlacement_MaxPos_Y * string The maximum Y position of the window.
Layout.MetadataLastTabPositions[...].WindowPlacement_NormalPos_Left * string The normal left position of the window.
Layout.MetadataLastTabPositions[...].WindowPlacement_NormalPos_Top * string The normal top position of the window.
Layout.MetadataLastTabPositions[...].WindowPlacement_NormalPos_Right * string The normal right position of the window.
Layout.MetadataLastTabPositions[...].WindowPlacement_NormalPos_Bottom * string The normal bottom position of the window.
Layout.Name * string Name of the layout.
Layout.ObjectTypeLastTabPositions array List of last positions for object type.
Layout.ObjectTypeLastTabPositions [...] object Information of the positions of a window of a view.
Layout.ObjectTypeLastTabPositions[...].@type * string The type of ViewPosition. Possible values:
  • ViewPosition
Layout.ObjectTypeLastTabPositions[...].Name * string The name of the view.
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_Flags * string The flags of the window placement.
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_ShowCmd string The last showCmd for the window placement. Possible values:
  • Normal
  • Maximized
  • Minimized
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_MinPos_X * string The minimum X position of the window.
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_MinPos_Y * string The minimum Y position of the window.
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_MaxPos_X * string The maximum X position of the window.
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_MaxPos_Y * string The maximum Y position of the window.
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_NormalPos_Left * string The normal left position of the window.
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_NormalPos_Top * string The normal top position of the window.
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_NormalPos_Right * string The normal right position of the window.
Layout.ObjectTypeLastTabPositions[...].WindowPlacement_NormalPos_Bottom * string The normal bottom position of the window.
Layout.PluginInnerObjectLastTabPositions array List of last position for plugin inner object.
Layout.PluginInnerObjectLastTabPositions [...] object Information of the positions of a window of a view.
Layout.PluginInnerObjectLastTabPositions[...].@type * string The type of ViewPosition. Possible values:
  • ViewPosition
Layout.PluginInnerObjectLastTabPositions[...].Name * string The name of the view.
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_Flags * string The flags of the window placement.
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_ShowCmd string The last showCmd for the window placement. Possible values:
  • Normal
  • Maximized
  • Minimized
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_MinPos_X * string The minimum X position of the window.
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_MinPos_Y * string The minimum Y position of the window.
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_MaxPos_X * string The maximum X position of the window.
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_MaxPos_Y * string The maximum Y position of the window.
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_NormalPos_Left * string The normal left position of the window.
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_NormalPos_Top * string The normal top position of the window.
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_NormalPos_Right * string The normal right position of the window.
Layout.PluginInnerObjectLastTabPositions[...].WindowPlacement_NormalPos_Bottom * string The normal bottom position of the window.
Layout.SourcePluginLastTabPositions array List of last tab positions for source plugin.
Layout.SourcePluginLastTabPositions [...] object Information of the positions of a window of a view.
Layout.SourcePluginLastTabPositions[...].@type * string The type of ViewPosition. Possible values:
  • ViewPosition
Layout.SourcePluginLastTabPositions[...].Name * string The name of the view.
Layout.SourcePluginLastTabPositions[...].WindowPlacement_Flags * string The flags of the window placement.
Layout.SourcePluginLastTabPositions[...].WindowPlacement_ShowCmd string The last showCmd for the window placement. Possible values:
  • Normal
  • Maximized
  • Minimized
Layout.SourcePluginLastTabPositions[...].WindowPlacement_MinPos_X * string The minimum X position of the window.
Layout.SourcePluginLastTabPositions[...].WindowPlacement_MinPos_Y * string The minimum Y position of the window.
Layout.SourcePluginLastTabPositions[...].WindowPlacement_MaxPos_X * string The maximum X position of the window.
Layout.SourcePluginLastTabPositions[...].WindowPlacement_MaxPos_Y * string The maximum Y position of the window.
Layout.SourcePluginLastTabPositions[...].WindowPlacement_NormalPos_Left * string The normal left position of the window.
Layout.SourcePluginLastTabPositions[...].WindowPlacement_NormalPos_Top * string The normal top position of the window.
Layout.SourcePluginLastTabPositions[...].WindowPlacement_NormalPos_Right * string The normal right position of the window.
Layout.SourcePluginLastTabPositions[...].WindowPlacement_NormalPos_Bottom * string The normal bottom position of the window.
Layout.StackPanel object Stack panel in a layout.
Layout.StackPanel.@type string The type of StackPanel. Possible values:
  • StackPanel
Layout.StackPanel.Name * string The name of the stack panel.
Layout.StackPanel.ID * string The identifier of the stack panel.
Layout.StackPanel.Width string The width of the stack panel.
Layout.StackPanel.Height string The height of the stack panel.
Layout.StackPanel.@Children * array UI element in the stack panel.
Layout.StackPanel.@Children [...] UI Element.
Layout.StackPanel.Orientation * string The orientation of the stack panel. Possible values:
  • Vertical
  • Horizontal
Layout.Undocked array List of undocked views.
Layout.Undocked [...] object View holder for flotting window.
Layout.Undocked[...].@type * string The type of ViewHolder Possible values:
  • ViewHolder
Layout.Undocked[...].StackPanel object Stack panel in a layout.
Layout.Undocked[...].StackPanel.@type string The type of StackPanel. Possible values:
  • StackPanel
Layout.Undocked[...].StackPanel.Name * string The name of the stack panel.
Layout.Undocked[...].StackPanel.ID * string The identifier of the stack panel.
Layout.Undocked[...].StackPanel.Width string The width of the stack panel.
Layout.Undocked[...].StackPanel.Height string The height of the stack panel.
Layout.Undocked[...].StackPanel.@Children * array UI element in the stack panel.
Layout.Undocked[...].StackPanel.@Children [...] UI Element.
Layout.Undocked[...].StackPanel.Orientation * string The orientation of the stack panel. Possible values:
  • Vertical
  • Horizontal
Layout.Undocked[...].WindowPlacement_Flags * string Flags of WindowPlacement.
Layout.Undocked[...].WindowPlacement_ShowCmd string Last ShowCmd of the WindowPlacement. Possible values:
  • Normal
  • Maximized
  • Minimized
Layout.Undocked[...].WindowPlacement_MinPos_X * string Minimum X position of the window.
Layout.Undocked[...].WindowPlacement_MinPos_Y * string Minimum Y position of the window.
Layout.Undocked[...].WindowPlacement_MaxPos_X * string Maximum X position of the window.
Layout.Undocked[...].WindowPlacement_MaxPos_Y * string Maximum Y position of the window.
Layout.Undocked[...].WindowPlacement_NormalPos_Left * string Normal left position of the window.
Layout.Undocked[...].WindowPlacement_NormalPos_Top * string Normal left position of the window.
Layout.Undocked[...].WindowPlacement_NormalPos_Right * string Normal right position of the window.
Layout.Undocked[...].WindowPlacement_NormalPos_Bottom * string Normal bottom position of the window.

Result Schema

See Also

Examples

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.

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