# Pattern

| Message                  | Description                                           | Arguments |
| ------------------------ | ----------------------------------------------------- | --------- |
| `/mixeffect/usk/pattern` | Sets all the settings for the Pattern upstream keyer. | Multiple  |

| Argument       | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| -------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Pattern        | Integer | <p>0 = Left To Right Bar<br>1 = Top To BottomBar<br>2 = Horizontal Barn Door<br>3 = Vertical Barn Door<br>4 = Corners In Four Box<br>5 = Rectangle Iris<br>6 = Diamond Iris<br>7 = Circle Iris<br>8 = Top Left Box<br>9 = Top Right Box<br>10 = Bottom Right Box<br>11 = Bottom Left Box<br>12 = Top Center Box<br>13 = Right Center Box<br>14 = Bottom Center Box<br>15 = Left Center Box<br>16 = Top Left Diagonal<br>17 = Top Right Diagonal</p> |
| Size           | Float   | Float from 0.0 to 100.0                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Symmetry       | Float   | Float from 0.0 to 100.0                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Softness       | Float   | Float from 0.0 to 100.0                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Position X     | Float   | Float from 0.0 to 1.0000                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Position Y     | Float   | Float from 0.0 to 1.0000                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Invert Pattern | Integer | <p>0 = Off<br>1 = On<br>2 = Toggle</p>                                                                                                                                                                                                                                                                                                                                                                                                              |
| USK            | Integer | One-based index of the Upstream Keyer. Default is 1.                                                                                                                                                                                                                                                                                                                                                                                                |
| M/E            | Integer | One-based index of the Mix Effect Bus. Default is 1.                                                                                                                                                                                                                                                                                                                                                                                                |
| Duration       | Integer | <p>(Optional)<br>0 = Off<br>1-10000 = Number of milliseconds to tween the parameters. Default is 0.</p>                                                                                                                                                                                                                                                                                                                                             |
| Style          | Integer | <p>(Optional)<br>0 = Cosine<br>1 = Cubed<br>2 = Inverse Cubed<br>3 = Inverse Squared<br>4 = Linear<br>5 = Sine<br>6 = Smooth Step<br>7 = Smoother Step<br>8 = Squared<br>9 = Ease In Out Elastic<br>10 = Ease Out Bounce<br>11 = Ease Out Elastic</p>                                                                                                                                                                                               |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mixeffect.app/automate/osc/messages/upstream-keyers/pattern.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.