States

setTitle

Used to set the title of an instance.

Sent by: Plugin

{
	event: string = "setTitle",
	context: string,
	payload: {
		title: string,
		// 0: Both hardware and software, 1: Hardware only, 2: Software only
		target: number = 0,
		// 0-based index specifying the state to be modified.
		// If not set, the title will be applied to all states.
		state: number | null
	}
}

setImage

Used to set the image of an instance.

Sent by: Plugin

{
	event: string = "setImage",
	context: string,
	payload: {
		// A base-64 data URL encoded image.
		image: string,
		// 0: Both hardware and software, 1: Hardware only, 2: Software only
		target: number = 0,
		// 0-based index specifying the state to be modified.
		// If not set, the image will be applied to all states.
		state: number | null
	}
}

setState

Used to switch an action to a state.

Sent by: Plugin

{
	event: string = "logMessage",
	payload: {
		// 0-based index specifying the state to be switched to.
		state: number
	}
}

setFeedback

Used to set the feedback of an instance’s encoder layout.

See the Stream Deck SDK documentation for more information on encoder layouts.

Sent by: Plugin

{
	event: string = "setFeedback",
	context: string,
	payload: any
}

setFeedbackLayout

Used to set the encoder layout of an instance.

Sent by: Plugin

{
	event: string = "setFeedbackLayout",
	context: string,
	payload: {
		// A path to the layout file relative to the plugin directory or an ID of a built-in layout.
		layout: string
	}
}