MixEffect
  • Welcome
  • Getting Started
  • Explore
    • Switcher
      • Mix Effect Buses
    • Audio
      • Audio Section
      • Audio Source Details
      • Mixer Monitor
      • Switcher Audio Settings
    • Media
    • Macros
      • Shortcut Macros
    • Transitions
    • Upstream Keyers
    • Downstream Keyers
    • SuperSource
      • Interface
        • Presets Tab
        • Art Tab
        • Copy Tab
        • View All Presets
      • Editing Presets
        • Naming Presets
        • Use Box Sources
        • Custom Animation Speed
        • Custom Animation Style
        • Bulk Editing Presets
      • SuperSource and Macros
      • Importing and Exporting
      • SuperSource and Shortcuts
      • SuperSource Settings
        • Show Transition Speed Menu
        • Sticky Current Preset
        • Differentiate Box Colors
      • SuperSource and Simulator
    • Color Generators
    • HyperDecks
    • Camera Control
    • Auxiliary
    • Output
    • Run in Background
    • Switcher Settings
  • Automate
    • Automations Overview
    • OSC
      • Enabling OSC in MixEffect
      • Companion
        • Generic OSC Module
        • Native Module
        • 32 Button Profiles
        • Sample Configuration Files
        • Saving Preset Icons
        • Adding Thumbnails
      • Messages
        • MixEffect
          • Connect
          • Remote Webview
          • Run Shortcut
          • Run Shortcut and Return
          • Send Companion Feedback
          • Send Companion Feedback Filtered
          • Switcher Page
          • Switcher Section
          • Video Follows Audio
          • View Only Mode
        • Auxiliary/Output
          • Aux/Output Source
        • Color Generators
          • Color Generator Parameter Adjust
          • Color Generator Parameter Set
          • Set Color Generator
        • Counter Overlay
          • Counter Enable
          • Counter Full
          • Counter Position Size Opacity
          • Counter Hide When Elapsed
          • Counter Mode
          • Counter Opacity
          • Counter Opacity Adjust
          • Counter Opacity Set
          • Counter Position
          • Counter Position Adjust
          • Counter Position Set
          • Counter Size
          • Counter Size Adjust
          • Counter Size Set
          • Counter Reset
          • Counter Run
          • Counter Time
        • Downstream Keyers
          • DSK Auto
          • DSK Full
          • DSK Key
          • DSK Key Clip Adjust
          • DSK Key Clip Set
          • DSK Key Clip Gain
          • DSK Key Gain Adjust
          • DSK Key Gain Set
          • DSK Key Invert
          • DSK Key Pre Multiplied
          • DSK Inputs
          • DSK Mask Adjust
          • DSK Mask Enable
          • DSK Mask Set
          • DSK Mask
          • DSK On Air
          • DSK Rate
          • DSK Tie
        • Fairlight Audio
          • Dynamics Compressor Parameter Adjust
          • Dynamics Compressor Parameter Set
          • Dynamics Compressor
          • Dynamics Expander Parameter Adjust
          • Dynamics Expander Parameter Set
          • Dynamics Expander
          • Dynamics Gain Adjust
          • Dynamics Gain Set
          • Dynamics Limiter Parameter Adjust
          • Dynamics Limiter Parameter Set
          • Dynamics Limiter
          • Dynamics Reset
          • Equalizer Band Parameter Adjust
          • Equalizer Band Parameter Set
          • Equalizer Band
          • Equalizer Enable
          • Equalizer Gain Adjust
          • Equalizer Gain Set
          • Equalizer Reset
          • Frame Delay
          • Fader Gain Adjust
          • Fader Gain Set
          • Input Audio Follow Video
          • Input Gain Adjust
          • Input Gain Set
          • Input Mix Option
          • Input State
          • Master Dynamics Compressor Parameter Adjust
          • Master Dynamics Compressor Parameter Set
          • Master Dynamics Compressor
          • Master Dynamics Gain Adjust
          • Master Dynamics Gain Set
          • Master Dynamics Limiter Parameter Adjust
          • Master Dynamics Limiter Parameter Set
          • Master Dynamics Limiter
          • Master Dynamics Reset
          • Master Equalizer Band Parameter Adjust
          • Master Equalizer Band Parameter Set
          • Master Equalizer Band
          • Master Equalizer Enable
          • Master Equalizer Gain Adjust
          • Master Equalizer Gain Set
          • Master Equalizer Reset
          • Master Gain Adjust
          • Master Gain Set
          • Monitor Enable
          • Monitor Gain Adjust
          • Monitor Gain Set
          • Reset Peaks
          • Reset Source Peaks
          • Solo
        • Legacy Audio
          • Input Audio Follow Video
          • Input Gain Adjust
          • Input Gain Set
          • Input Mix Option
          • Input State
          • Master Gain Adjust
          • Master Gain Set
          • Monitor Enable
          • Monitor Gain Adjust
          • Monitor Gain Set
          • Headphones Gain Adjust
          • Headphones Gain Set
          • Solo
        • Macros
          • Macro Continue
          • Macro Loop
          • Macro Pause
          • Macro Stop
          • Run Macro
        • Mix Effects Bus
          • Auto
          • Cut
          • Fade to Black Auto
          • Fade to Black Rate
          • Set Preview Input
          • Set Program Input
          • T-Bar
        • Media Players
          • Capture Still
          • Clip
          • Clip Cycle
          • Clip Cycle Reverse
          • Delete Clip
          • Delete Still
          • Still
          • Still Cycle
          • Still Cycle Reverse
        • Output
          • ISO Record All Inputs
          • Low Latency
          • Record In All Cameras
          • Recording Set Filename
          • Recording Start or Stop
          • Recording Switch Disk
          • Streaming Set Service
          • Streaming Start or Stop
        • SuperSource
          • Animation Speed
          • Animation Style
          • Art
          • Art Border
          • Art Border Enable
          • Art Border Parameter Adjust
          • Art Border Parameter Set
          • Art Key
          • Art Key Clip Adjust
          • Art Key Clip Set
          • Art Key Clip Gain
          • Art Key Gain Adjust
          • Art Key Gain Set
          • Art Key Invert
          • Art Key Pre Multiplied
          • Art Place In
          • Art Preview
          • Art Preview URL
          • Auto
          • Box Crop Adjust
          • Box Crop Full
          • Box Crop Set
          • Box Enable
          • Box Full
          • Box Position Adjust
          • Box Position Full
          • Box Position Set
          • Box Position Size Crop
          • Box Size Adjust
          • Box Size Set
          • Box Source
          • Cascade Presets
          • Cascade
          • Cut
          • Cycle Animation Speed
          • Cycle Animation Style
          • Grow Highlighted Box By
          • Grow Highlighted Box
          • Highlight
          • Next Preset
          • Preset
          • Preset Clear
          • Previous Preset
          • Shrink Other Boxes By
          • Shrink Other Boxes
          • Swap Boxes
          • Swap
        • Switcher
          • Set Multiview Layout
          • Set Multiview Layout Advanced
          • Set Multiview Window
          • Startup State Clear
          • Startup State Save
        • Transitions
          • Dip
          • Dip Source
          • DVE
          • DVE Flip Flop
          • DVE Inputs
          • DVE Key
          • DVE Key Clip Adjust
          • DVE Key Clip Set
          • DVE Key Clip Gain
          • DVE Key Gain Adjust
          • DVE Key Gain Set
          • DVE Key Enable
          • DVE Key Invert
          • DVE Key Pre Multiplied
          • DVE Reverse
          • DVE Style
          • DVE Style Cycle
          • Mix
          • Next
          • Preview
          • Rate
          • Sting
          • Sting Key
          • Sting Key Clip Adjust
          • Sting Key Clip Set
          • Sting Key Clip Gain
          • Sting Key Gain Adjust
          • Sting Key Gain Set
          • Sting Key Invert Key
          • Sting Key Pre-Multiplied
          • Sting Rate
          • Sting Rate Clip Duration
          • Sting Rate Trigger Point
          • Sting Rate Mix
          • Sting Rate Pre Roll
          • Sting Source
          • Style
          • Wipe
          • Wipe Border
          • Wipe Border Parameter Adjust
          • Wipe Border Parameter Set
          • Wipe Flip Flop
          • Wipe Pattern
          • Wipe Pattern Cycle
          • Wipe Position
          • Wipe Position Adjust
          • Wipe Position Set
          • Wipe Reverse
          • Wipe Source
          • Wipe Symmetry
          • Wipe Symmetry Adjust
        • Upstream Keyers
          • Chroma
          • Chroma Advanced
          • Chroma Advanced Full
          • Chroma Advanced Parameter Adjust
          • Chroma Advanced Parameter Set
          • Chroma Advanced Sample
          • Chroma Narrow
          • Chroma Parameter Adjust
          • Chroma Parameter Set
          • DVE Full
          • DVE Border
          • DVE Border Enable
          • DVE Border Parameter Adjust
          • DVE Border Parameter Set
          • DVE Mask Adjust
          • DVE Mask Set
          • DVE Mask
          • USK DVE Position Adjust
          • DVE Position Set
          • DVE Position
          • DVE Rotation
          • DVE Rotation Adjust
          • DVE Size Adjust
          • DVE Size Set
          • DVE Size
          • DVE Size Position Rotation
          • DVE Mask Enable
          • DVE Shadow
          • DVE Shadow Parameter Adjust
          • DVE Shadow Enable
          • DVE Shadow Parameter Set
          • Luma Full
          • Luma Key
          • Luma Key Clip Adjust
          • Luma Key Clip Set
          • Luma Key Clip Gain
          • Luma Key Gain Adjust
          • Luma Key Gain Set
          • Luma Key Invert
          • Luma Key Pre Multiplied
          • Mask
          • Mask Adjust
          • Mask Enable
          • Mask Set
          • Pattern
          • Pattern Cycle
          • Pattern Full
          • Pattern Invert
          • Pattern Position
          • Pattern Position Adjust
          • Pattern Position
          • Pattern Size
          • Pattern Size Adjust
          • Pattern Size Symmetry Softness Position
          • Pattern Softness
          • Pattern Softness Adjust
          • Pattern Style
          • Pattern Symmetry
          • Pattern Symmetry Adjust
          • Flying Key Enable
          • Flying Key KeyFrame
          • Flying Key Rate
          • Flying Key Run
          • Inputs
          • On Air
          • Style
    • Shortcuts
      • Sample Shortcuts
      • Actions
        • Auto
        • Change Aux Source
        • Change Bus Source
        • Change Layout
        • Change Switcher Section
        • Change Transition
        • Connect to Switcher
        • Control SuperSource
        • Cut
        • Cycle Media Player
        • Delete Media
        • Export Streaming XML
        • Export SuperSource Presets
        • Fade to Black
        • Find Macro
        • Find Media Clip
        • Find Media Still
        • Find Streaming Server
        • Find Streaming Service
        • Find SuperSource Preset
        • Find Switcher
        • Get Advanced Chroma Keyer
        • Get Advanced Chroma Sample
        • Get ATEM Network Interfaces
        • Get ATEM Setup Details
        • Get Audio Source
        • Get Audio Sources
        • Get Aux Outputs
        • Get Aux Source
        • Get Bus Source
        • Get Chroma Keyer
        • Get Details of Current Switcher
        • Get Details of Streaming Configuration
        • Get Details of Video Source
        • Get DSK Details
        • Get Counter Overlay
        • Get Dip Transition
        • Get DVE Keyer
        • Get DVE Transition
        • Get Luma Keyer
        • Get Master Audio Source
        • Get Pattern Keyer
        • Get Macros (Deprecated)
        • Get Media Clips (Deprecated)
        • Get Media Player Details
        • Get Media Stills (Deprecated)
        • Get Mix Transition
        • Get My Streaming Services (Deprecated)
        • Get My Switchers (Deprecated)
        • Get Recording Filename
        • Get Stinger Transition
        • Get Streaming Configuration
        • Get Streaming Servers
        • Get SuperSource Art
        • Get SuperSource Boxes
        • Get SuperSource Presets (Deprecated)
        • Get Transition Details
        • Get Wipe Transition
        • Get USK Details
        • Get Video Source
        • Get Video Sources
        • Is Recording
        • Is Streaming
        • Is Switcher Active
        • Macro Loop
        • Macro Pause
        • New Streaming Server
        • New Streaming Service
        • New Switcher
        • Next SuperSource Preset
        • Open MixEffect
        • Preview Transition
        • Previous SuperSource Preset
        • Reset Audio Source Dynamics
        • Reset Audio Source Equalizer
        • Reset Counter Overlay
        • Reset Master Audio Dynamics
        • Reset Master Audio Equalizer
        • Record Macro
        • Run Counter Overlay
        • Run Flying Key
        • Run Macro
        • Save Startup State
        • Send ATEM Setup Command (Deprecated)
        • Send BMD Ethernet Protocol Command
        • Send HyperDeck Command (Deprecated)
        • Send OSC Command
        • Send Web Presenter Command (Deprecated)
        • Set Active Switcher for Shortcuts
        • Set Advanced Chroma Keyer
        • Set Advanced Chroma Sample
        • Set Advanced Multiview
        • Set Audio Solo
        • Set Audio Source
        • Set Audio Source Dynamics
        • Set Audio Source Equalizer
        • Set Chroma Keyer
        • Set Master Audio Source
        • Set Master Audio Dynamics
        • Set Master Audio Equalizer
        • Set DSK Details
        • Set Counter Overlay
        • Set Flying Key Frame
        • Set Flying Key Rate
        • Set Dip Transition
        • Set DVE Keyer
        • Set DVE Transition
        • Set Luma Keyer
        • Set Mix Transition
        • Set Pattern Keyer
        • Set Media Player
        • Set Multiview
        • Set Stinger Transition
        • Set Source Name
        • Set Source Images
        • Set Streaming Configuration
        • Set SuperSource Art
        • Set SuperSource Art Preview
        • Set SuperSource Art Preview URL
        • Set SuperSource Box
        • Set SuperSource Cascade
        • Set SuperSource Cascade Presets
        • Set SuperSource Transition Speed
        • Set Transition Rate
        • Set USK
        • Set USK Background
        • Set Wipe Transition
        • Start Recording
        • Start Streaming
        • Stop Recording
        • Stop Streaming
        • Switch Disk
        • Upload Still
        • Update Switcher Page Layout
    • Video Follows Audio
  • Configure
    • Switcher Connections
    • Switcher Pages
      • Panels and Buttons
        • Audio
        • Audio Monitor
        • Aux
        • Camera Controls
        • Compact Controls
        • Cut / Auto
        • DSK
        • Fader Bar
        • Fade to Black
        • Flying Key
        • HyperDecks
        • Macros
        • Media Players
        • Media Player (Individual)
        • Multiview Switcher
        • Next Transition
        • Output
        • Preview
        • Program
        • Program / Preview
        • Remote Webview
        • Select Bus
        • SuperSource
        • SuperSource Boxes
        • Transition Style
        • Transition Rate
        • USB View
    • Streaming Services
    • Keyboard Shortcuts
    • Remote Webview
    • External Camera Support
    • Simulator
    • Settings
  • Support
    • Connection Help
    • Compatibility
    • Security
    • Troubleshooting
    • Version History
      • Version 2.1.1
      • Version 2.1.0
      • Version 2.0.1
      • Version 2.0.0
      • Version 1.9.1
      • Version 1.9.0
      • Version 1.8.1
      • Version 1.8.0
      • Version 1.7.2
      • Version 1.7.1
      • Version 1.7.0
      • Version 1.6.7
      • Version 1.6.6
      • Version 1.6.5
      • Version 1.6.4
      • Version 1.6.3
      • Version 1.6.2
      • Version 1.6.1
      • Version 1.6.0
      • Version 1.5.1
      • Version 1.5.0
      • Version 1.4.4
      • Version 1.4.3
      • Version 1.4.2
      • Version 1.4.1
      • Version 1.4.0
      • Version 1.3.0
      • Version 1.2.4
      • Version 1.2.3
      • Version 1.2.2
      • Version 1.2.1
      • Version 1.2.0
      • Version 1.1.3
      • Version 1.1.2
      • Version 1.1.1
      • Version 1.1.0
      • Version 1.0.10
      • Version 1.0.9
      • Version 1.0.8
      • Version 1.0.7
      • Version 1.0.6
      • Version 1.0.5
      • Version 1.0.4
      • Version 1.0.3
      • Version 1.0.2
  • Links
    • Get MixEffect
    • MixEffect Newsletter
    • MixEffect Community
Powered by GitBook
On this page

Was this helpful?

Parameters

  • Index: The 1-based USK index for the keyer.

  • Mix Effect Block Index: The Mix Effect Block to change. Default is M/E 1.

Returns

Pattern details.

Last updated 1 year ago

  • Parameters
  • Returns
PreviousGet Master Audio SourceNextGet Macros (Deprecated)
  1. Automate
  2. Shortcuts
  3. Actions

Get Pattern Keyer

Retrieves details about the pattern keyer.