Note: This function requires an API license.

Selects a layout. A layout is a set of panels that is displayed on a monitor. The layout is identified by layoutid. The layout is displayed on the monitor identified by monitorindex on the system identified by divaid. If the divaid is omitted, this command is sent to all viewers that will all switch this layout if possible..


parameter type remarks
divaid [UID] Unique diva id. Determines the viewer, if omitted or -1 all viewers are addressed
monitorindex [0..] index of the monitor
layoutid [UID] unique layout id


error code description remarks
0 Ok Ok, no error
-18 General error An undefined error occured

See Also


  • 2.1.2   – Fixed dispatching to viewers
  • 1.10.2 – Added