Classes

The following classes are available globally.

  • Stores all relevant information to keep an ATEM connection alive. Use this store to interprete incoming packets and construct new outgoing packets.

    See more

    Declaration

    Swift

    public class ConnectionState
    Show on GitHub

  • An interface to

    • send commands to an ATEM Switcher
    • react upon incomming state change messages from the ATEM Switcher

    To make an anology with real world devices: this class can be compared to a BlackMagicDesign Control Panel. It is used to control a production switcher.

    See more

    Declaration

    Swift

    public class Controller
    Show on GitHub

  • A utility to parse RawMessages and call their attached handlers within a certain context. This class is similar to PureMessageHandler with the difference that the registered handlers are also passed a certain context in addition to the attached message. This context can be used to determine where the message comes from.

    See more

    Declaration

    Swift

    public class ContextualMessageHandler : MessageParser
    Show on GitHub

  • A utility to parse RawMessages and call their attached handlers.

    Handlers are functions that will be executed when handle(rawMessage: RawMessage) is called. Handlers are attached to a specific Message type for example: ProgramBusChanged.

    See more

    Declaration

    Swift

    public class PureMessageHandler : MessageParser
    Show on GitHub

  • A utility to parse binary messages and look up corresponding message handlers.

    Declaration

    Swift

    public class MessageParser
    Show on GitHub

  • An endpoint to interact with BMD ATEM controllers like “Atem Software Control” or any of the hardware control panels.

    See more

    Declaration

    Swift

    public class Switcher
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public class UploadManager
    Show on GitHub