The OSCKit package provides the classes needed for your apps to communicate among computers, sound synthesizers, and other multimedia devices via OSC over an IP network.
This branch MIT-3.x is an independently maintained branch of the previous MIT licensed work. Please see MIT-2.x
for the equivalent version 2 branch.
When using Swift Package Manager, please use the following to ensure you stay within the MIT licensed release.
dependencies: [
.package(url: "https://github.com/dsmurfin/OSCKit", "3.0.1"..<"3.1.0")
]Use the OSCKit package to create client or server objects. In its simplest form a client can send a packet, either a Message or Bundle to a server. A server, when listening, can receive these packets and action upon them. Depending on a client or server using either UDP or TCP as a transport, there are varying levels of fuctionality and delegate methods for you to take advantage of.
OSCKit implements all required argument types as specified in OSC 1.1.
- UDP and TCP Transport options
- UDP Servers can join multicast groups
- UDP Clients can broadcast packets
- TCP Server with client management
- TCP Stream Framing
- OSC Bundles
- OSC Timetags
Add the package dependency to your Xcode project using the following repository URL:
https://github.com/SammySmallman/OSCKit
Add the package dependency to your Package.swift and depend on "OSCKit" in the necessary targets:
dependencies: [
.package(url: "https://github.com/SammySmallman/OSCKit", .upToNextMajor(from: "3.0.1"))
]- Enable Incoming Connections (Required for OSCTcpClient, OSCTcpServer & OSCUdpServer)
- Enable Outgoing Connections (Required for OSCTcpClient, OSCTcpServer & OSCUdpClient)
TCP Client
Import OSCKit into your project
import OSCKitCreate a client
let client = OSCTcpClient(host: "10.101.130.101",
port: 24601,
streamFraming: .SLIP,
delegate: self)Conform to the clients delegate protocol OSCTcpClientDelegate:
func client(_ client: OSCTcpClient,
didConnectTo host: String,
port: UInt16) {
print("client did connect to \(host):\(port)")
}
func client(_ client: OSCTcpClient,
didDisconnectWith error: Error?) {
if let error = error {
print("client did disconnect with error: \(error.localizedDescription)")
} else {
print("client did disconnect")
}
}
func client(_ client: OSCTcpClient,
didSendPacket packet: OSCPacket) {
print("Client did send packet")
}
func client(_ client: OSCTcpClient,
didReceivePacket packet: OSCPacket) {
print("Client did receive packet")
}
func client(_ client: OSCTcpClient,
didReadData data: Data,
with error: Error) {
print("Client did read data with error: \(error.localizedDescription)"
}Create an OSCPacket e.g. An OSC message:
do {
let message = try OSCMessage(with: "/osc/kit", arguments: [1,
3.142,
"hello world!"])
} catch {
print("Unable to create OSCMessage: \(error.localizedDescription)")
}Send the packet
client.send(message)TCP Server
Import OSCKit into your project
import OSCKitCreate a client
let server = OSCTcpServer(port: 24601,
streamFraming: .SLIP,
delegate: self)Conform to the servers delegate protocol OSCTcpServerDelegate:
func server(_ server: OSCTcpServer,
didConnectToClientWithHost host: String,
port: UInt16) {
print("Server did connect to client \(host):\(port)")
}
func server(_ server: OSCTcpServer,
didDisconnectFromClientWithHost host: String,
port: UInt16) {
print("Server did disconnect from client \(host):\(port)")
}
func server(_ server: OSCTcpServer,
didReceivePacket packet: OSCPacket,
fromHost host: String,
port: UInt16) {
print("Server did receive packet")
}
func server(_ server: OSCTcpServer,
didSendPacket packet: OSCPacket,
toClientWithHost host: String,
port: UInt16) {
print("Server did send packet to \(host):\(port)")
}
func server(_ server: OSCTcpServer,
socketDidCloseWithError error: Error?) {
if let error = error {
print("server did stop listening with error: \(error.localizedDescription)")
} else {
print("server did stop listening")
}
}
func server(_ server: OSCTcpServer,
didReadData data: Data,
with error: Error) {
print("Server did read data with error: \(error.localizedDescription)"
}Start listening for new connections and packets:
do {
try server.startListening()
} catch {
print(error.localizedDescription)
}UDP Client
Import OSCKit into your project
import OSCKitCreate a client
let client = OSCUdpClient(host: "10.101.130.101",
port: 24601,
delegate: self)Conform to the clients delegate protocol OSCUdpClientDelegate:
func client(_ client: OSCUdpClient,
didSendPacket packet: OSCPacket,
fromHost host: String?,
port: UInt16?) {
print("client sent packet to \(client.host):\(client.port)")
}
func client(_ client: OSCUdpClient,
didNotSendPacket packet: OSCPacket,
fromHost host: String?,
port: UInt16?,
error: Error?) {
print("client did not send packet to \(client.host):\(client.port)")
}
func client(_ client: OSCUdpClient,
socketDidCloseWithError error: Error) {
print("Client Error: \(error.localizedDescription)")
}Create an OSCPacket e.g. An OSC message:
do {
let message = try OSCMessage(with: "/osc/kit", arguments: [1,
3.142,
"hello world!"])
} catch {
print("Unable to create OSCMessage: \(error.localizedDescription)")
}Send the packet
client.send(message)UDP Server
Import OSCKit into your project
import OSCKitCreate a client
let server = OSCUdpServer(port: 24601,
delegate: self)Conform to the servers delegate protocol OSCUdpServerDelegate:
func server(_ server: OSCUdpServer,
didReceivePacket packet: OSCPacket,
fromHost host: String,
port: UInt16) {
print("server did receive packet from \(host):\(port)")
}
func server(_ server: OSCUdpServer,
socketDidCloseWithError error: Error?) {
if let error = error {
print("server did stop listening with error: \(error.localizedDescription)")
} else {
print("server did stop listening")
}
}
func server(_ server: OSCUdpServer,
didReadData data: Data,
with error: Error) {
print("Server did read data with error: \(error.localizedDescription)"
}Start listening for packets:
do {
try server.startListening()
} catch {
print(error.localizedDescription)
}OSCKit is supported by the infrastructural code provided by CoreOSC. For more detailed information pertaining to the OSC objects that OSCKit uses, such as Address Patterns, Messages and Bundles, please direct all queries to CoreOSC.
Sammy Smallman - Initial Work - SammySmallman
Dan Murfin - This Fork - dsmurfin
See also the list of contributors who participated in this project.
- Socket library dependency CocoaSyncSocket
- Network Interface library dependency Swift-Netutils.