atem/atem library
ATEM SDK for Dart.
This package provides a complete implementation of the Blackmagic Design ATEM protocol for controlling ATEM switchers over UDP.
Classes
- AtemCommand
- Internal base class for AtemCommand.
- AtemCommandBuilder
- Builder for ATEM command payloads.
- AtemCommandCode
- Common ATEM command codes.
- AtemConnected
- AtemConnection
- Main ATEM connection class.
- AtemConnectionConfig
- ATEM connection configuration.
- AtemDisconnected
- AtemError
- AtemEvent
- ATEM connection events.
- AtemField
- Base class for all ATEM state fields.
- AtemFieldCode
- ATEM field codes.
- AtemPacket
- ATEM UDP packet.
- AtemPacketFlags
- ATEM UDP protocol flags.
- AtemPacketReceived
- AtemState
- ATEM switcher state.
- AtemStateChanged
- AtemTransportConnected
- AtemTransportData
- AtemTransportDisconnected
- AtemTransportError
- AtemTransportEvent
- Events from the UDP transport.
- AtemUdpTransport
- UDP transport for ATEM protocol.
- AudioLevel
- Audio level data.
- AudioMasterState
- Audio master state.
- AudioMeterLevelsField
- Audio meter levels (AMLv).
- AudioMixerMasterField
- Audio mixer master properties (AMMO).
- AudioMixerMonitorField
- Audio mixer monitor properties (AMmO).
- AudioStripState
- Audio strip state.
- AutoInputVideoModeField
- Auto input video mode (AiVM).
- AutoTransitionCommand
- Auto transition command.
- AuxSourceCommand
- Aux source command.
- AuxSourceField
- Aux output source (AuxS).
- CameraControlDataField
- Camera control data packet (CCdP).
- CameraControlDataPacketField
- Camera control data packet (CCdP).
- CameraControlSettingsField
- Camera control settings (CCst).
- ColorGeneratorCommand
- Color generator command.
- ColorGeneratorField
- Color generator (ColV).
- CutCommand
- Cut command - instant transition (Cut Preview).
- DskPropertiesBaseField
- DSK properties base (DskB).
- DskPropertiesField
- DSK properties (DskP).
- DskStateField
- DSK state (DskS).
- DveCapabilitiesField
- DVE capabilities (_DVE).
- FadeToBlackCommand
- Fade to black command.
- FadeToBlackEnabledField
- Fade to black enabled (FEna).
- FadeToBlackExecuteCommand
- Fade to black execute command.
- FadeToBlackField
- Fade to black properties (FtbP).
- FadeToBlackStateField
- Fade to black state (FtbS).
- FairlightAudioConfigField
- Fairlight audio config (_FAC).
- FairlightMasterLevelsField
- Fairlight master levels (FDLv).
- FairlightMasterPropertiesField
- Fairlight master properties (FAMP).
- FairlightMasterState
- Fairlight master state.
- FairlightMeterLevelsField
- Fairlight meter levels (FMLv).
- FairlightPropertiesField
- Fairlight properties (FMPP).
- FairlightStripPropertiesField
- Fairlight strip properties (FASP).
- FairlightStripState
- Fairlight strip state.
- FirmwareVersionField
- Firmware version field (_ver).
- InitCompleteField
- Init complete (InCm).
- InputPropertiesField
- Input properties (InPr).
- KeyerState
- Keyer state.
- KeyOnAirCommand
- Key on air command.
- KeyOnAirField
- Key on air (KeOn).
- KeyPropertiesBaseCommand
- Key properties base command.
- KeyPropertiesBaseField
- Key properties base (KeBP).
- MacroConfigField
- Macro config (_MAC).
- MacroPlayStatusField
- Macro play status (MRPr).
- MacroProperties
- Macro properties.
- MacroPropertiesField
- Macro properties (MPrp).
- MacroRecordStatusField
- Macro record status (MRcS).
- MediaPlayerAudioSourceField
- Media player audio source (MPAS).
- MediaPlayerClipSourceField
- Media player clip source (MPCS).
- MediaPlayerClipStatusField
- Media player clip status (RCPS).
- MediaPlayerFileInfoField
- Media player file info (MPfe).
- MediaPlayerSelectedField
- Media player selected clip (MPCE).
- MediaPlayerSlotsField
- Media player slots (_mpl).
- MediaPlayerState
- Media player state.
- MixerEffectConfigField
- Mixer effect config (_MeC).
- MultiviewerConfigField
- Multiviewer config (_MvC).
- MultiviewerInputField
- Multiviewer input (MvIn).
- MultiviewerPropertiesField
- Multiviewer properties (MvPr).
- MultiviewerSafeAreaField
- Multiviewer safe area (SaMw).
- MultiviewerState
- Multiviewer state.
- MultiviewerVuField
- Multiviewer VU meter (VuMC).
- MultiviewerWindow
- Multiviewer window.
- PowerStatusField
- Power status (Powr).
- PreviewInputCommand
- Preview input command (CPvI).
- PreviewInputField
- Preview bus input (PrvI).
- ProductIdField
- Product ID field (_pin).
- ProgramInputCommand
- Program input command (CPgI).
- ProgramInputField
- Program bus input (PrgI).
- RecordingDiskField
- Recording disk (RTMD).
- RecordingDurationField
- Recording duration (RTMR).
- RecordingSettingsField
- Recording settings (RMSu).
- RecordingState
- Recording state.
- RecordingStatusField
- Recording status (RTMS).
- StreamingAudioBitrateField
- Streaming audio bitrate (STAB).
- StreamingServiceField
- Streaming service (SRSU).
- StreamingState
- Streaming state.
- StreamingStatsField
- Streaming stats (SRSS).
- StreamingStatusField
- Streaming status (StRS).
- SuperSourceBox
- SuperSource box.
- SuperSourceBoxPropertiesField
- SuperSource box properties (SSBP).
- SuperSourcePropertiesField
- SuperSource properties (SSrc).
- SuperSourceState
- SuperSource state.
- Topology
- Topology info.
- TopologyField
- Topology field (_top).
- TransitionDipField
- Dip transition properties (TDpP).
- TransitionDveField
- DVE transition properties (TDvP).
- TransitionMixField
- Mix transition properties (TMxP).
- TransitionPositionField
- Transition position (TrPs).
- TransitionPreviewField
- Transition preview (TrPr).
- TransitionSettingsField
- Transition settings (TrSS).
- TransitionState
- Transition state.
- TransitionStingerField
- Stinger transition properties (TStP).
- TransitionWipeField
- Wipe transition properties (TWpP).
- UnknownField
- Unknown field fallback.
- UsbAudioFunctionField
- USB audio function (UAFn).
- VideoModeCapabilityField
- Video mode capability (_VMC).
- VideoModeField
- Video mode field (VidM).
Enums
- FairlightStripType
- Fairlight strip type enum.
- KeyType
- Key type enum.
- ProductModel
- Product model enum.
- StreamingStateEnum
- Streaming state enum.
- TransitionStyle
- Transition style enum.
- TransitionType
- Transition type enum.
- UsbAudioMode
- USB audio mode enum.
- VideoMode
- Video mode enum.
Functions
-
packCommands(
Iterable< AtemCommand> commands) → Uint8List - Packs multiple commands into a single packet payload.
-
parseAtemField(
String code, Uint8List data) → AtemField - Parses a field from raw data.
-
unpackCommands(
Uint8List data) → List< AtemCommand> - Unpacks a packet payload into individual commands.