Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Dev1an/Swift-Atem
Blackmagic Design Atem network protocol implementation in swift 5.1 using NIO 2
https://github.com/Dev1an/Swift-Atem
atem communication implementation networking nio protocol sdk swift swift-nio swift5
Last synced: about 2 months ago
JSON representation
Blackmagic Design Atem network protocol implementation in swift 5.1 using NIO 2
- Host: GitHub
- URL: https://github.com/Dev1an/Swift-Atem
- Owner: Dev1an
- License: mit
- Created: 2018-05-22T13:03:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T15:08:19.000Z (about 1 year ago)
- Last Synced: 2024-04-14T12:07:29.000Z (9 months ago)
- Topics: atem, communication, implementation, networking, nio, protocol, sdk, swift, swift-nio, swift5
- Language: Swift
- Homepage:
- Size: 8.55 MB
- Stars: 55
- Watchers: 8
- Forks: 27
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Atem network protocol implementation
Implementation of BlackMagicDesign's ATEM communication protocol in Swift. It is written on top of Apple's networking library [NIO](https://github.com/apple/swift-nio) and implements both sides of the protocol: the control panel and the switcher side. This means that you can not only use it to control atem switchers but also to connect to your control panels without the need for a switcher. Opening a whole new world of applications for the Atem control panels. An example can be found at [Atem-Simulator](https://github.com/Dev1an/Atem-Simulator)
Starting from version 1.0.0 this package uses Swift 5 and NIO2.
### Tested platforms
- macOS 10.14.6 on a MacBook Pro retina 15" late 2013
- macOS 10.15.3 on a MacBook Pro retina 15" late 2013
- Raspbian GNU/Linux 9 stretch on a Raspberry Pi model 3 B
- Raspbian GNU/Linux 10 Buster on a Raspberry Pi 4 model B Rev 1.2
## Installation
When starting a new project: create a Swift package via [SPM](https://swift.org/package-manager/)
```shell
# Shell
> swift package init # --type empty|library|executable|system-module
```
Then add this library to the [package description](https://github.com/apple/swift-package-manager/blob/master/Documentation/PackageDescriptionV4.md#dependencies)'s dependencies
```swift
.package(url: "https://github.com/Dev1an/Swift-Atem", from: "1.0.0")
```
And resolve this new dependency
```sh
# Shell
> swift package resolve
```
Finally import the `Atem` module in your code
```swift
import Atem
```
You are now ready to create atem controllers and switchers 😎 !
## Usage
After looking at the following examples, study the [API reference](https://dev1an.github.io/Swift-Atem/) for more details.
### Controller
This example shows how to create a controller that connects to a swicther at ip address 10.1.0.67 and print a message whenever the preview bus changes.
```swift
try Controller(ipAddress: "10.1.0.67") { connection in
connection.when{ (change: PreviewBusChanged) in
print(change) // prints: 'Preview bus changed to input(x)'
}
}
```
**Sending messages**
To send a message to the switcher use the `send(...)` method like this:
```swift
controller.send(message: ChangeTransitionPosition(to: 5000))
```
### Switcher
The following example shows how to emulate the basic functionality of an atem switcher. It will forward incoming messages containing transition and preview & program bus changes to all connected controllers.
This snippet is also included in a seperate SPM target "Simulator" (./Sources/Simulator) and can be run by simply executing `swift run Simulator` in the terminal.
```swift
let switcher = Switcher { controllers in
controllers.when { (change: ChangePreviewBus, _) in
controllers.send(
PreviewBusChanged(
to: change.previewBus,
mixEffect: change.mixEffect
)
)
}
controllers.when{ (change: ChangeProgramBus, _) in
controllers.send(
ProgramBusChanged(
to: change.programBus,
mixEffect: change.mixEffect
)
)
}
controllers.when { (change: ChangeTransitionPosition, _) in
controllers.send(
TransitionPositionChanged(
to: change.position,
remainingFrames: 250 - UInt8(change.position/40),
mixEffect: change.mixEffect
)
)
}
controllers.when { (change: ChangeAuxiliaryOutput, _) in
controllers.send(
AuxiliaryOutputChanged(
source: change.source,
output: change.output
)
)
}
}
```