Description

Macro properties are temporary values available in the context of a macro depending on what types of conditions and actions are being used.
You can assign those values to variables for later use or occasionally directly use them in other action types.

Examples

• This example macro will change the text being displayed by a text source to the file name of the file currently being displayed by a image slide show source.
  
• This example will store follower id of a new Twitch follower in a variable and use this information to query the profile picture URL of the follower, which is then stored in a variable.
  

List of supported macro properties

Please note that this list might not always be fully up to date.

Actions

Clipboard

• Primary clipboard item MIME type

  Highest priority MIME type of the current item stored in clipboard, if available.

• All clipboard item MIME types

  All MIME types of the current item stored in clipboard separated with space, if available.

HTTP

• Status code

• Message body

• Error

  Empty when no error occurred.
  Other possible values:

  • Could not establish connection
  • Failed to bind IP address
  • Failed to read connection
  • Failed to write connection
  • Maximum redirect count exceeded
  • Connection handling canceled
  • SSL connection failed
  • SSL certificate loading failed
  • SSL server verification failed
  • Unsupported HTTP multipart boundary characters
  • Compression failed
  • Connection timed out
  • Proxy connection failed
  • Unknown

Twitch

Get channel points reward information

• Reward title
• Reward description
• Reward cost
• Reward background color
• Reward is enabled
• Reward requires user input
• Reward is paused
• Reward is in stock
• Redemptions skip request queue
• Redemption count
• Reward cooldown expiration
• Maximum redemptions per stream enabled
• Maximum redemptions per stream
• Maximum redemptions per user per stream enabled
• Maximum redemptions per user per stream
• Global cooldown enabled
• Global cooldown
• Reward image URL
• Reward default image URL

Get user information

• User ID
• User login
• User name
• User type
• Broadcaster type
• Description
• Profile image URL
• Offline image URL
• Account creation date

Get channel information

• Twitch stream language code
• Game ID
• Game name
• Twitch stream title
• Stream delay
• Stream tags
• Twitch stream classification labels
• Is branded content

Conditions

Audio

• Output volume
• Configured volume
• Source muted
• Source audio sync offset
• Source audio monitor type
• Source audio balance

Clipboard

• Primary clipboard item MIME type

  Highest priority MIME type of the current item stored in clipboard, if available.

• All clipboard item MIME types

  All MIME types of the current item stored in clipboard separated with space, if available.

Cursor

• Cursor position (X)
• Cursor position (Y)

Date

• Year
• Month
• Day
• Hour
• Minute
• Second
• Day of week

Display

• Display name
• Display count
• Display width
• Display height

File

• File content
• File basename
• File basename (complete)
• File suffix
• File suffix (complete)
• File name
• Absolute file path
• Absolute path
• Path is absolute

Filter

• Settings string
• Setting value

Folder watch

• New files
• Changed files
• Removed files
• New directories
• Removed directories

Game capture

• Title
• Class
• Executable

HTTP

• Status code

• Message body

• Error

  Empty when no error occurred.
  Other possible values:

  • Could not establish connection
  • Failed to bind IP address
  • Failed to read connection
  • Failed to write connection
  • Maximum redirect count exceeded
  • Connection handling canceled
  • SSL connection failed
  • SSL certificate loading failed
  • SSL server verification failed
  • Unsupported HTTP multipart boundary characters
  • Compression failed
  • Connection timed out
  • Proxy connection failed
  • Unknown

Media

• Source (When using "Any" or "All")

• State

  The current media state represented as an integer value:

  • 0 being 'None'
  • 1 being 'Playing'
  • 2 being 'Opening'
  • 3 being 'Buffering'
  • 4 being 'Paused'
  • 5 being 'Stopped'
  • 6 being 'Ended'
  • 7 being 'Error'"

• Current time

  Elapsed time in milliseconds since media playback began. If the source supports playlists, this time is respective to the current playlist item being played and not the overall playlist. Note that this value might not be exactly zero if the playback is stopped or ended.

• Duration

  The duration of the media file being played in milliseconds. If the source supports playlists, this time is respective to the current playlist item being played and not the overall playlist.

VLC Source specific

• Title
• Artist
• Genre
• Copyright
• Album
• Track number
• Description
• Rating
• Date
• Setting
• URL
• Language
• Now playing
• Publisher
• Encoded by
• Artwork URL
• Track id
• Director
• Season
• Episode
• Show name
• Actors
• Album artist
• Disc number
• Disc total

MIDI

• Message type
• Channel
• Note
• Value 1
• Value 2

MQTT

• Message

Process

• Process name

Queue

• Size
• Is running

Recording

• Last save path
• Recording duration

Replay buffer

• Last save path

Run

• Process ID
• Process exit code
• Process standard output stream
• Process standard error stream

Scene

• Current scene
• Previous scene
• Preview scene
• Position in scenes list

Scene item transform

• Settings string
• Setting value

Screenshot

• Last screenshot path

Slide Show

• Slide index
• Slide path
• Slide file name

Source

• Source height
• Source width
• Settings string
• Setting value

Stream Deck

• Key pressed
• Key row
• Key column
• Data

Streaming

• Stream keyframe interval
• Stream key
• Stream duration
• Service

Timer

• Seconds
• Minutes
• Hours
• Days

Twitch

• Twitch broadcaster user ID
• Twitch broadcaster user login
• Twitch broadcaster user name
• Follower Twitch user ID
• Follower Twitch user login
• Follower Twitch user name
• Twitch follow timestamp
• Twitch stream ID
• Twitch stream type
• Twitch stream start timestamp
• Twitch stream title
• Twitch stream language code
• Twitch stream category ID
• Twitch stream category name
• Twitch stream classification labels
• Subscriber Twitch user ID
• Subscriber Twitch user login
• Subscriber Twitch user name
• Twitch subscriber tier
• Is gifted Twitch subscription
• Subscriber Twitch user ID
• Subscriber Twitch user login
• Subscriber Twitch user name
• Was gifted Twitch subscription
• Subscriber Twitch user ID
• Subscriber Twitch user login
• Subscriber Twitch user name
• Number of subscriptions
• Total gifted subscriptions
• Was anonymous Twitch subscription gift
• Subscriber Twitch user ID
• Subscriber Twitch user login
• Subscriber Twitch user name
• Subscription message
• Number of months subscribed
• Subscription streak
• Subscription duration
• Cheerer Twitch user ID
• Cheerer Twitch user login
• Cheerer Twitch user name
• Is anonymous cheer
• Cheer message
• Bits amount
• Poll ID
• Poll title
• Choices
• Choices
• Poll start time
• Poll end time
• Poll status
• Prediction ID
• Prediction title
• Prediction outcomes
• Prediction start time
• Prediction lock time
• Prediction end time
• Prediction status
• Goal ID
• Goal type
• Goal description
• Goal is achieved
• Goal current amount
• Goal target amount
• Goal start time
• Goal end time
• Hype train ID
• Hype train total points
• Hype train progress
• Hype train goal
• Hype train top contributors
• Hype train last contributor
• Hype train level
• Hype train start time
• Hype train expiration time
• Hype train end time
• Hype train cooldown
• User ID (shouted out)
• User login (shouted out)
• User name (shouted out)
• User ID triggering shouting out
• User login triggering shouting out
• User name triggering shouting out
• Viewer count
• Shoutout start time
• Shoutout cooldown end time
• Shoutout target cooldown end time
• User ID shouting out
• User login shouting out
• User name shouting out
• Viewer count
• Shoutout time
• Reward ID
• Redemption ID
• User ID redeeming the reward
• User login redeeming the reward
• User name redeeming the reward
• User input for reward
• Reward Information (JSON)
• Reward ID
• Reward title
• Reward prompt
• Reward cost
• Reward status
• Redemption time
• Reward is enabled
• Reward is paused
• Reward is in stock
• Reward title
• Reward cost
• Reward description
• Reward requires user input
• Reward background color
• Reward image (JSON)
• Reward image URL
• Reward default image (JSON)
• Reward default image URL
• Redemption count
• Redemptions skip request queue
• Maximum redemptions per stream (JSON)
• Maximum redemptions per stream enabled
• Maximum redemptions per stream
• Reward maximum per user per stream (JSON)
• Maximum redemptions per user per stream enabled
• Maximum redemptions per user per stream
• Global cooldown (JSON)
• Global cooldown enabled
• Global cooldown
• Reward cooldown expiration
• Charity name
• Charity logo
• Charity ID
• Donor user ID
• Donor login name
• Donor user name
• Donation amount
• Current donation amount
• Charity target amount
• Charity start date
• Charity start date
• Moderator user ID
• Moderator login name
• Moderator user name
• Shield Mode start time
• Shield Mode end time
• Game name
• Game ID
• Stream delay
• Stream tags
• Is mature content
• Is branded content
• Thumbnail URL
• Viewer count
• Banned user ID
• Banned login name
• Banned user name
• Moderator user ID
• Moderator login name
• Moderator user name
• Ban reason
• Ban end date
• Is permanent ban
• Banned user ID
• Banned login name
• Banned user name
• Moderator user ID
• Moderator login name
• Moderator user name
• User ID
• Login name
• User name
• User ID
• Login name
• User name
• Chat message ID
• Chat message body
• User ID
• User login
• User name
• User type
• Reply parent message ID
• Reply parent message body
• Reply parent user ID
• Reply parent user login
• Reply parent user name
• Root parent message ID
• Root parent user login
• Chatter badges' info
• Chatter badges
• Chat message bits
• Chatter color
• Chatter badges
• Chat message timestamp
• Is using only emotes
• Is chatter's first message
• Is chatter a moderator
• Is chatter a subscriber
• Is chatter a Turbo user
• Is chatter a VIP
• User login
• Chat message
• Chat message ID
• Chat message timestamp
• User login
• User ID
• Ban duration
• Timestamp
• User login
• User login
• Raid creator user ID
• Raid creator user login
• Raid creator user name
• Raid receiver user ID
• Raid receiver user login
• Raid receiver user name
• Raid participants
• User ID
• User login
• User name
• User type
• Broadcaster type
• Description
• Profile image URL
• Offline image URL
• Account creation date
• Duration
• Started at
• Was automatic
• Requester user ID
• Requester user login
• Requester user name

USB

• Vendor Name
• Product Name
• Vendor ID
• Product ID
• Bus Number
• Device Address
• Serial Number

Video

Matches pattern

• Pattern count

  The number of times the given pattern has been found in a given video input frame.

Contains object

• Object count

  The number of objects the given model has identified in a given video input frame.

Brightness

• Average brightness

  The average brightness in a given video input frame in a range from 0 to 1 (dark to bright).

OCR

• OCR text

Color

• Average color

  The average RGB color in a given video input frame in HexArgb format.

Websocket

• Received websocket message

Window

• Window title
• Window class (Windows)
• Window text (Windows)