Presonus::ContextInfo Namespace Reference

Enumerations
enum	ChannelType {   kTrack = 0 , kBus , kFX , kSynth ,   kIn , kOut }
enum	ChannelIndexMode { kFlatIndex = 0 , kPerTypeIndex }

Variables
const Steinberg::FIDString	kID = "id"
	(R) channel identifier, use to compare identity (string)
const Steinberg::FIDString	kName = "name"
	(R/W) channel name, can be displayed to the user (string)
const Steinberg::FIDString	kType = "type"
	(R) channel type (int32, see ChannelType enumeration)
const Steinberg::FIDString	kMain = "main"
	(R) channel is main output (int32, 0: false, 1: true)
const Steinberg::FIDString	kIndex = "index"
	(R) channel index (int32, starts at zero)
const Steinberg::FIDString	kColor = "color"
	(R/W) channel color (int32: RGBA)
const Steinberg::FIDString	kVisibility = "visibility"
	(R) channel visibility (int32, 0: false, 1: true)
const Steinberg::FIDString	kSelected = "selected"
	(R/W) selection state, channel is selected exlusively and scrolled into view on write (int32, 0: false, 1: true)
const Steinberg::FIDString	kMultiSelect = "multiselect"
	(W) select channel without unselecting others (int32, 0: false, 1: true)
const Steinberg::FIDString	kFocused = "focused"
	(R) focus for user input when multiple channels are selected (int32, 0: false, 1: true)
const Steinberg::FIDString	kRegionName = "regionName"
	(R) name of region/event for region/event-based effects (string)
const Steinberg::FIDString	kRegionSelected = "regionSelected"
	(R) selection state of region/event for region/event-based effects (int32, 0: false, 1: true)
const Steinberg::FIDString	kVolume = "volume"
	(R/W) volume factor [float, 0. = -oo dB, 1. = 0dB, etc.], also available as string
const Steinberg::FIDString	kMaxVolume = "maxVolume"
	(R) maximum volume factor [float, 1. = 0dB], also available as string
const Steinberg::FIDString	kPan = "pan"
	(R/W) stereo panning [float, < 0.5 = (L), 0.5 = (C), > 0.5 = (R)], also available as string
const Steinberg::FIDString	kMute = "mute"
	(R/W) mute (int32, 0: false, 1: true)
const Steinberg::FIDString	kSolo = "solo"
	(R/W) solo (int32, 0: false, 1: true)
const Steinberg::FIDString	kSendCount = "sendcount"
	(R) send count [int]
const Steinberg::FIDString	kSendLevel = "sendlevel"
	(R/W) send level factor, index is appended to id (e.g. "sendlevel0" for first), also available as string
const Steinberg::FIDString	kMaxSendLevel = "maxSendlevel"
	(R) maximum send level factor, also available as string
const Steinberg::FIDString	kActiveDocumentID = "activeDocumentID"
	(R) active document identifier, use to get identity of the active document (string)
const Steinberg::FIDString	kDocumentID = "documentID"
	(R) document identifier, use to compare identity (string)
const Steinberg::FIDString	kDocumentName = "documentName"
	(R) document name, can be displayed to user (string)
const Steinberg::FIDString	kDocumentFolder = "documentFolder"
	(R) document folder (string)
const Steinberg::FIDString	kAudioFolder = "audioFolder"
	(R) folder for audio files (string)
const Steinberg::FIDString	kIndexMode = "indexMode"
	(R) channel index mode (default is flat, see ChannelIndexMode enumeration)

Enumeration Type Documentation

ChannelIndexMode

enum Presonus::ContextInfo::ChannelIndexMode

Channel index mode.

Enumerator
kFlatIndex	channel indices are contiguous (example: track 1, track 2, bus 3, bus 4)
kPerTypeIndex	channel indices restarts at zero for each type (example: track 1, track 2, bus 1, bus 2)

ChannelType

enum Presonus::ContextInfo::ChannelType

Channel types.

Enumerator
kTrack	audio track
kBus	audio bus
kFX	FX channel.
kSynth	output of virtual instrument
kIn	input from audio driver
kOut	output to audio driver (main or sub-out)

Variable Documentation

kActiveDocumentID

const Steinberg::FIDString Presonus::ContextInfo::kActiveDocumentID = "activeDocumentID"

(R) active document identifier, use to get identity of the active document (string)

kAudioFolder

const Steinberg::FIDString Presonus::ContextInfo::kAudioFolder = "audioFolder"

(R) folder for audio files (string)

kColor

const Steinberg::FIDString Presonus::ContextInfo::kColor = "color"

(R/W) channel color (int32: RGBA)

kDocumentFolder

const Steinberg::FIDString Presonus::ContextInfo::kDocumentFolder = "documentFolder"

(R) document folder (string)

kDocumentID

const Steinberg::FIDString Presonus::ContextInfo::kDocumentID = "documentID"

(R) document identifier, use to compare identity (string)

kDocumentName

const Steinberg::FIDString Presonus::ContextInfo::kDocumentName = "documentName"

(R) document name, can be displayed to user (string)

kFocused

const Steinberg::FIDString Presonus::ContextInfo::kFocused = "focused"

(R) focus for user input when multiple channels are selected (int32, 0: false, 1: true)

kID

const Steinberg::FIDString Presonus::ContextInfo::kID = "id"

(R) channel identifier, use to compare identity (string)

kIndex

const Steinberg::FIDString Presonus::ContextInfo::kIndex = "index"

(R) channel index (int32, starts at zero)

kIndexMode

const Steinberg::FIDString Presonus::ContextInfo::kIndexMode = "indexMode"

(R) channel index mode (default is flat, see ChannelIndexMode enumeration)

kMain

const Steinberg::FIDString Presonus::ContextInfo::kMain = "main"

(R) channel is main output (int32, 0: false, 1: true)

kMaxSendLevel

const Steinberg::FIDString Presonus::ContextInfo::kMaxSendLevel = "maxSendlevel"

(R) maximum send level factor, also available as string

kMaxVolume

const Steinberg::FIDString Presonus::ContextInfo::kMaxVolume = "maxVolume"

(R) maximum volume factor [float, 1. = 0dB], also available as string

kMultiSelect

const Steinberg::FIDString Presonus::ContextInfo::kMultiSelect = "multiselect"

(W) select channel without unselecting others (int32, 0: false, 1: true)

kMute

const Steinberg::FIDString Presonus::ContextInfo::kMute = "mute"

(R/W) mute (int32, 0: false, 1: true)

kName

const Steinberg::FIDString Presonus::ContextInfo::kName = "name"

(R/W) channel name, can be displayed to the user (string)

kPan

const Steinberg::FIDString Presonus::ContextInfo::kPan = "pan"

(R/W) stereo panning [float, < 0.5 = (L), 0.5 = (C), > 0.5 = (R)], also available as string

kRegionName

const Steinberg::FIDString Presonus::ContextInfo::kRegionName = "regionName"

(R) name of region/event for region/event-based effects (string)

kRegionSelected

const Steinberg::FIDString Presonus::ContextInfo::kRegionSelected = "regionSelected"

(R) selection state of region/event for region/event-based effects (int32, 0: false, 1: true)

kSelected

const Steinberg::FIDString Presonus::ContextInfo::kSelected = "selected"

(R/W) selection state, channel is selected exlusively and scrolled into view on write (int32, 0: false, 1: true)

kSendCount

const Steinberg::FIDString Presonus::ContextInfo::kSendCount = "sendcount"

(R) send count [int]

kSendLevel

const Steinberg::FIDString Presonus::ContextInfo::kSendLevel = "sendlevel"

(R/W) send level factor, index is appended to id (e.g. "sendlevel0" for first), also available as string

kSolo

const Steinberg::FIDString Presonus::ContextInfo::kSolo = "solo"

(R/W) solo (int32, 0: false, 1: true)

kType

const Steinberg::FIDString Presonus::ContextInfo::kType = "type"

(R) channel type (int32, see ChannelType enumeration)

kVisibility

const Steinberg::FIDString Presonus::ContextInfo::kVisibility = "visibility"

(R) channel visibility (int32, 0: false, 1: true)

kVolume

const Steinberg::FIDString Presonus::ContextInfo::kVolume = "volume"

(R/W) volume factor [float, 0. = -oo dB, 1. = 0dB, etc.], also available as string