Sound.OSC.Packet

Data types for OSC messages, bundles and packets.

Message

type Address_Pattern = String

OSC address pattern. This is strictly an ASCII value, but it is very common to pattern match on addresses and matching on ByteString requires OverloadedStrings.

data Message

An OSC message.

Constructors

Message

Fields

• messageAddress :: Address_Pattern
• messageDatum :: [Datum]

Instances

Eq Message

Methods

(==) :: Message -> Message -> Bool

(/=) :: Message -> Message -> Bool

Read Message

Methods

readsPrec :: Int -> ReadS Message

readList :: ReadS [Message]

readPrec :: ReadPrec Message

readListPrec :: ReadPrec [Message]

Show Message

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

OSC Message

Methods

toPacket :: Message -> Packet

fromPacket :: Packet -> Maybe Message

message :: Address_Pattern -> [Datum] -> Message

Message constructor. It is an error if the Address_Pattern doesn't conform to the OSC specification.

Bundle

data Bundle

An OSC bundle.

Constructors

Bundle

Fields

• bundleTime :: Time
• bundleMessages :: [Message]

Instances

Eq Bundle

Methods

(==) :: Bundle -> Bundle -> Bool

(/=) :: Bundle -> Bundle -> Bool

Ord Bundle

OSC Bundles can be ordered (time ascending).

Methods

compare :: Bundle -> Bundle -> Ordering

(<) :: Bundle -> Bundle -> Bool

(<=) :: Bundle -> Bundle -> Bool

(>) :: Bundle -> Bundle -> Bool

(>=) :: Bundle -> Bundle -> Bool

max :: Bundle -> Bundle -> Bundle

min :: Bundle -> Bundle -> Bundle

Read Bundle

Methods

readsPrec :: Int -> ReadS Bundle

readList :: ReadS [Bundle]

readPrec :: ReadPrec Bundle

readListPrec :: ReadPrec [Bundle]

Show Bundle

Methods

showsPrec :: Int -> Bundle -> ShowS

show :: Bundle -> String

showList :: [Bundle] -> ShowS

OSC Bundle

Methods

toPacket :: Bundle -> Packet

fromPacket :: Packet -> Maybe Bundle

bundle :: Time -> [Message] -> Bundle

Bundle constructor. It is an error if the Message list is empty.

Packet

data Packet

An OSC Packet is either a Message or a Bundle.

Constructors

Packet_Message

Fields

• packetMessage :: Message

Packet_Bundle

Fields

• packetBundle :: Bundle

Instances

Eq Packet

Methods

(==) :: Packet -> Packet -> Bool

(/=) :: Packet -> Packet -> Bool

Read Packet

Methods

readsPrec :: Int -> ReadS Packet

readList :: ReadS [Packet]

readPrec :: ReadPrec Packet

readListPrec :: ReadPrec [Packet]

Show Packet

Methods

showsPrec :: Int -> Packet -> ShowS

show :: Packet -> String

showList :: [Packet] -> ShowS

OSC Packet

Methods

toPacket :: Packet -> Packet

fromPacket :: Packet -> Maybe Packet

p_bundle :: Time -> [Message] -> Packet

Packet_Bundle . bundle.

p_message :: Address_Pattern -> [Datum] -> Packet

Packet_Message . message.

packetTime :: Packet -> Time

The Time of Packet, if the Packet is a Message this is immediately.

packetMessages :: Packet -> [Message]

Retrieve the set of Messages from a Packet.

packet_to_bundle :: Packet -> Bundle

If Packet is a Message add immediately timestamp, else id.

packet_to_message :: Packet -> Maybe Message

If Packet is a Message or a Bundle with an immediate time tag and with one element, return the Message, else Nothing.

packet_is_immediate :: Packet -> Bool

Is Packet immediate, ie. a Bundle with timestamp immediately, or a plain Message.

at_packet :: (Message -> a) -> (Bundle -> a) -> Packet -> a

Variant of either for Packet.

Address Query

message_has_address :: Address_Pattern -> Message -> Bool

Does Message have the specified Address_Pattern.

bundle_has_address :: Address_Pattern -> Bundle -> Bool

Do any of the Messages at Bundle have the specified Address_Pattern.

packet_has_address :: Address_Pattern -> Packet -> Bool

Does Packet have the specified Address_Pattern, ie. message_has_address or bundle_has_address.

Pretty printing

messagePP :: FP_Precision -> Message -> String

Pretty printer for Message.

bundlePP :: FP_Precision -> Bundle -> String

Pretty printer for Bundle.

packetPP :: FP_Precision -> Packet -> String

Pretty printer for Packet.