skin_mgr_add
Back to SOAP Architecture Method Reference
Description
The skin_mgr_add method adds a frame to your domain.
Note: Frames require affiliation with day parts and, in turn, display units to be of use. For more information, see Add Display Units (SOAP).
Parameters
| Parameter | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| domain_id |
The unique ID# of your domain. |
bstypes:ResourceId | R |
| geometry_type | The frame's geometry type:
|
bstypes:GeometryType | R |
| height | The height of the frame, according to geometry type. | int | R |
| loop_policy_id | The unique ID# of the affiliated loop policy. | bstypes:ResourceId | R |
| name | The frame's name. | string | R |
| parent_id | The unique ID# of the day part to which the frame is associated. | bstypes:ResourceId | R |
| screen_no | The number of screens. | int | R |
| width | The width of the frame, according to geometry type. | int | 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 |
| interactivity_timeout | The amount of time to elapse on an interactive display before a timeout occurs. | int | O |
| interactivity_trigger_id | The unique ID# of the trigger associated with the frame. | bstypes:ResourceId | O |
| z | The z-coordinate of the frame, in relation to the full screen. | int | O |
Return Values
| Value | Description | Type | Required (R) or Optional (O) |
|---|---|---|---|
| id | The unique ID# of the frame added. | bstypes:ResourceId | R |