skin_mgr_list

Back to SOAP Architecture Method Reference

Description

The skin_mgr_list method lists all frames on your domain.

Parameters

Parameter Description Type Required (R) or Optional (O)
domain_id The unique ID# of your domain. bstypes:ResourceId R

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of the frame. bstypes:ResourceId R
name The frame's name. string R
active Indicates whether or not the resource is active. boolean R
domain_id The unique ID# of your domain. bstypes:ResourceId R
loop_policy_id The unique ID# of the affiliated loop policy. bstypes:ResourceId R
x The x-coordinate of the frame, in relation to the full screen. int R
y The y-coordinate of the frame, in relation to the full screen. int R
z The z-coordinate of the frame, in relation to the full screen. int R
width The width of the frame, according to geometry type. int R
height The height of the frame, according to geometry type. int R
screen_no The number of screens. int R
geometry_type The frame's geometry type:
  • 1 = Percent Geometry
  • 2 = Pixel Geometry
bstypes:GeometryType R
parent_id The unique ID# of the day part to which the frame is associated. bstypes:ResourceId R
interactivity_trigger_id The unique ID# of the trigger associated with the frame. bstypes:ResourceId R
interactivity_timeout The amount of time to elapse on an interactive display before a timeout occurs. int R