Switcher Data Types Basic Switcher Data Types
2.2.4 Switcher Video Mode
SECTION
37
SDK Software Developers Kit
2.2.4 Switcher Video Mode
BMDSwitcherVideoMode enumerates the video standards employed by the switcher.
bmdSwitcherVideoMode525i5994NTSC 525 pixels high, interlaced at 59.94Hz (NTSC).
bmdSwitcherVideoMode625i50PAL 625 pixels high, interlaced at 50Hz (PAL).
bmdSwitcherVideoMode525i5994Anamorphic 525 pixels high, interlaced at 59.94Hz (anamorphic 16:9 widescreen).
bmdSwitcherVideoMode625i50Anamorphic 625 pixels high, interlaced at 50Hz (anamorphic 16:9 widescreen).
bmdSwitcherVideoMode720p50 720 pixels high, progressively scanned at 50Hz.
bmdSwitcherVideoMode720p5994 720 pixels high, progressively scanned at 59.94Hz.
bmdSwitcherVideoMode1080i50 1080 pixels high, interlaced at 50Hz.
bmdSwitcherVideoMode1080i5994 1080 pixels high, interlaced at 59.94Hz.
bmdSwitcherVideoMode1080p2398 1080 pixels high, progressively scanned at 23.98Hz.
bmdSwitcherVideoMode1080p24 1080 pixels high, progressively scanned at 24Hz.
bmdSwitcherVideoMode1080p25 1080 pixels high, progressively scanned at 25Hz.
bmdSwitcherVideoMode1080p2997 1080 pixels high, progressively scanned at 29.97Hz.
bmdSwitcherVideoMode1080p50 1080 pixels high, progressively scanned at 50Hz.
bmdSwitcherVideoMode1080p5994 1080 pixels high, progressively scanned at 59.94Hz.
bmdSwitcherVideoMode4KHDp2398 2160 pixels high, 3840 pixels wide, progressively scanned at 23.98Hz.
bmdSwitcherVideoMode4KHDp24 2160 pixels high, 3840 pixels wide, progressively scanned at 24Hz.
bmdSwitcherVideoMode4KHDp25 2160 pixels high, 3840 pixels wide, progressively scanned at 25Hz.
bmdSwitcherVideoMode4KHDp2997 2160 pixels high, 3840 pixels wide, progressively scanned at 29.97Hz.
Basic Switcher Control
2
SECTION
38
SDK Software Developers Kit
Switcher Down Converter Modes
BMDSwitcherDownConverterMode enumerates the possible modes for down converting between broadcast standards.
bmdSwitcherDownConverterModeCentreCut Centre cut conversion.
bmdSwitcherDownConverterModeLetterbox Letter box conversion.
bmdSwitcherDownConverterModeAnamorphic Anamorphic conversion.
Switcher Input Properties
BMDSwitcherInputPropertyId enumerates the possible properties of a switcher Input.
bmdSwitcherInputPropertyIdPortType Input port type as a BMDSwitcherPortType.
bmdSwitcherInputPropertyIdInputAvailability Input availability as a BMDSwitcherInputAvailability.
bmdSwitcherInputPropertyIdShortName Short name describing switcher input as a string limited to 4 characters.
bmdSwitcherInputPropertyIdLongName Long name describing switcher input as a string limited to 20 characters.
bmdSwitcherInputPropertyIdIsProgramTallied Flag that indicates whether the input is currently program tallied.
bmdSwitcherInputPropertyIdIsPreviewTallied Flag that indicates whether the input is currently preview tallied.
bmdSwitcherInputPropertyIdAvailableExternalPortTypes Available external port types as a bit mask of BMDSwitcherExternalPortType.
bmdSwitcherInputPropertyIdCurrentExternalPortType Selected external port type as BMDSwitcherExternalPortType.
2.2.5
2.2.6
Basic Switcher Control
2
SECTION
39
SDK Software Developers Kit
Switcher External Port Types
BMDSwitcherExternalPortType enumerates the different kinds of external port type for an input. This enumeration represents a bitset since an input port may support more than one connection type.
bmdSwitcherExternalPortTypeSDI SDI connection.
bmdSwitcherExternalPortTypeHDMI HDMI connection.
bmdSwitcherExternalPortTypeComponent Component connection.
bmdSwitcherExternalPortTypeComposite Composite connection, only available in SD video modes.
bmdSwitcherExternalPortTypeSVideo SVideo connection, only available in SD video modes.
bmdSwitcherExternalPortTypeXLR XLR audio connection.
bmdSwitcherExternalPortTypeAESEBU AES EBU audio connection.
bmdSwitcherExternalPortTypeRCA RCA audio connection.
bmdSwitcherExternalPortTypeInternal This is an internal input port.
Switcher Port Types
BMDSwitcherPortType enumerates the possible switcher input port types available for switching.
bmdSwitcherPortTypeExternal The port is an external port with a physical connector.
bmdSwitcherPortTypeBlack The port is a black video generator port.
bmdSwitcherPortTypeColorBars The port is a colorbars generator port.
bmdSwitcherPortTypeColorGenerator The port is a color generator port.
bmdSwitcherPortTypeMediaPlayerFill The port is a media player fill port.
bmdSwitcherPortTypeMediaPlayerCut The port is a media player cut port.
bmdSwitcherPortTypeSuperSource The port is a super source port.
bmdSwitcherPortTypeMixEffectBlockOutput The port is a mix effect block output port.
bmdSwitcherPortTypeAuxOutput The port is an auxiliary output port.
2.2.7
2.2.8
Basic Switcher Control
2
SECTION
40
SDK Software Developers Kit
2.2.10
Switcher Input Availability
BMDSwitcherInputAvailability enumerates the different kinds of input availability for a port. This enumeration represents a bitset since an input can have multiple availabilities.
bmdSwitcherInputAvailabilityMixEffectBlock0 The input is available to be used by mix effect block 0.
bmdSwitcherInputAvailabilityMixEffectBlock1 The input is available to be used by mix effect block 1.
bmdSwitcherInputAvailabilityAuxOutputs The input is available to be used by aux outputs.
bmdSwitcherInputAvailabilityMultiView The input can be routed to a MultiView window.
bmdSwitcherInputAvailabilitySuperSourceArt The input is available to be used for SuperSource Art.
bmdSwitcherInputAvailabilitySuperSourceBox The input is available to be used within a SuperSource Box.
bmdSwitcherInputAvailabilityInputCut The input is available to be used as a cut.
Switcher Mix Effect Block Properties
BMDSwitcherMixEffectBlockPropertyId enumerates the possible properties of a Mix Effect Block.
bmdSwitcherMixEffectBlockPropertyIdProgramInput The program input as a BMDSwitcherInputId.
bmdSwitcherMixEffectBlockPropertyIdPreviewInput The preview input as a BMDSwitcherInputId.
bmdSwitcherMixEffectBlockPropertyIdTransitionPosition Float value between 0 and 1 representing the progress through a transition where 0 is the start of a transition and 1 is the end.
bmdSwitcherMixEffectBlockPropertyIdTransitionFramesRemaining Number of frames remaining in a transition as an integer.
bmdSwitcherMixEffectBlockPropertyIdInTransition State of mix effect block being in a transition as a boolean.
bmdSwitcherMixEffectBlockPropertyIdFadeToBlackFramesRemaining Number of frames remaining in a fade to black as an integer.
bmdSwitcherMixEffectBlockPropertyIdInFadeToBlack State of mix effect block being in a fade to black as a boolean.
bmdSwitcherMixEffectBlockPropertyIdPreviewLive Boolean value which is true when preview is live.
bmdSwitcherMixEffectBlockPropertyIdPreviewTransition Boolean value which is true when preview transition is active.
bmdSwitcherMixEffectBlockPropertyIdInputAvailabilityMask The corresponding BMDSwitcherInputAvailability bit value for this
mix effect block.
2.2.9
Basic Switcher Control
2
SECTION
41
SDK Software Developers Kit
bmdSwitcherMixEffectBlockPropertyIdFadeToBlackRate The fade to black rate in frames.
bmdSwitcherMixEffectBlockPropertyIdFadeToBlackFullyBlack Boolean value which is true when fade to black is fully black.
bmdSwitcherMixEffectBlockPropertyIdFadeToBlackInTransition Boolean value which is true when fade to black is transitioning.
Switcher Connection Errors
BMDSwitcherConnectToFailure enumerates the possible errors that can occur when connecting to a switcher.
bmdSwitcherConnectToFailureNoResponse The Switcher did not respond after a connection attempt was made.
bmdSwitcherConnectToFailureIncompatibleFirmware The software on the Switcher is incompatible with the current version
of the Switcher SDK.
bmdSwitcherConnectToFailureCorruptData Corrupt data was received during a connection attempt.
bmdSwitcherConnectToFailureStateSync State synchronisation failed during a connection attempt.
bmdSwitcherConnectToFailureStateSyncTimedOut State synchronisation timed out during a connection attempt.
Switcher MultiView Layouts
BMDSwitcherMultiViewLayout enumerates the possible layout formats for MultiView.
bmdSwitcherMultiViewLayoutProgramTop Program and preview reside in upper section of the screen,
windows reside below.
bmdSwitcherMultiViewLayoutProgramBottom Program and preview reside in lower section of the screen,
windows reside above.
bmdSwitcherMultiViewLayoutProgramLeft Program and preview reside on left hand side, windows reside on the right.
bmdSwitcherMultiViewLayoutProgramRight Program and preview reside on right hand side, windows reside on the left.
Switcher Color Events
BMDSwitcherInputColorEventType enumerates the possible event types for IBMDSwitcherInputColorCallback.
bmdSwitcherInputColorEventTypeHueChanged The hue changed.
bmdSwitcherInputColorEventTypeSaturationChanged The saturation changed.
bmdSwitcherInputColorEventTypeLumaChanged The luma changed.
2.2.11
2.2.12
2.2.13
Basic Switcher Control
2
SECTION
42
SDK Software Developers Kit
Switcher Aux Events
BMDSwitcherInputAuxEventType enumerates the possible event types for IBMDSwitcherInputAuxCallback.
bmdSwitcherInputAuxEventTypeInputSourceChanged The input source changed.
Switcher MultiView Events
BMDSwitcherMultiViewEventType enumerates the possible event types for IBMDSwitcherMultiViewCallback.
bmdSwitcherMultiViewEventTypeLayoutChanged The layout changed.
bmdSwitcherMultiViewEventTypeWindowChanged Routing to a MultiView window has changed.
2.2.14
2.2.15
Basic Switcher Control
2
SECTION
43
SDK Software Developers Kit