ControlTextureSlot.svg

The Control Texture Slots plug-in exposes the slots of a Texture Slot plug-in as image controls in the control clients.

Control Texture Slots must be placed on the same container as the Texture Slot plug-in whose slots it controls.

All exposed slots are grouped under one field (the Field Identifier), with one sub-field per slot, similar to Control Container. This lets one control plug-in drive several texture slots, for example a background image and a logo, from one template.

Note: This plug-in is located in: Plugins → Container plug-ins → Control

Control Texture Slots Properties

  • Exposed Slots (empty = all): A comma separated list of the slot names to expose, for example Overlay,Logo. Every listed slot that exists in the Texture Slot plug-in becomes a sub-field. The slots appear in the order of this list. If the list is empty, all slots are exposed in the order of the Texture Slot plug-in. Names that do not match a slot are skipped and a warning is written to the console.

  • Expose UV Offset: Allows the user to change the UV offset (position) of the image in each exposed slot.

  • Expose UV Scaling: Allows the user to change the UV scaling of the image in each exposed slot.

  • Image location Prefix: If the full path to a folder is entered, the image location exposed to the control clients can be a simple string instead of a full path. Works the same way as in Control Image: if the prefix points to a folder of flag images and the control client sends US, the image is loaded from "image location prefix + US". Full paths sent by the control client are used as they are and ignore the prefix.

  • Use shared memory placeholders: Exposes the slot images as text instead of image fields. The text may contain shared memory placeholders such as Logos/${team|default}, the same as in Control Image. The images are updated automatically whenever a used shared memory variable changes. See Shared Memory placeholders.

  • Refresh: Re-reads the slots of the Texture Slot plug-in and updates the exposed fields. Use it after adding, renaming or removing slots in the Texture Slot plug-in. The fields are also updated whenever a property of Control Texture Slots changes.

Configured Image location Prefix written without prefix “IMAGE*/” loads images correctly but is never removed from Trio field values.

Exposed Fields

For each exposed slot the following fields are created, where <field_id> is the Field Identifier and <slot> is the slot name:

Field

Type

Description

Created when

<field_id>.<slot>

Image (Text with shared memory placeholders)

The image of the slot. An empty value clears the image.

Always

<field_id>.<slot>.image_position

Duplet (U V)

UV offset of the slot, range -1000 to 1000.

Expose UV Offset is enabled

<field_id>.<slot>.image_scaling

Duplet (U V)

UV scaling of the slot, range 0 to 1000.

Expose UV Scaling is enabled

The slot name is used as the label of the field in the control client.

Note: In the field identifier, any character of the slot name other than letters, digits, _ and - is replaced by _. For example, the slot Lower Third is exposed as <field_id>.Lower_Third. If two slot names map to the same field identifier, only the first one is exposed.

If an image cannot be found, an error is reported on the Control Object.

Example

A Texture Slot plug-in has the slots Background, Overlay and Logo. Control Texture Slots is set up with:

  • Field Identifier: slots

  • Exposed Slots: Overlay,Logo

  • Expose UV Offset: enabled

The control client then shows the fields:

  • slots.Overlay

  • slots.Overlay.image_position

  • slots.Logo

  • slots.Logo.image_position

The Background slot is not exposed.

See Also