hosc-0.17: Haskell Open Sound Control

Safe HaskellSafe
LanguageHaskell98

Sound.OSC.Packet

Contents

Description

Data types for OSC messages, bundles and packets.

Synopsis

Message

type Address_Pattern = String Source #

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

data Message Source #

An OSC message, an Address_Pattern and a sequence of Datum.

Instances
Eq Message Source # 
Instance details

Defined in Sound.OSC.Packet

Methods

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

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

Read Message Source # 
Instance details

Defined in Sound.OSC.Packet

Show Message Source # 
Instance details

Defined in Sound.OSC.Packet

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

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

Bundle

data Bundle Source #

An OSC bundle, a Time and a sequence of Messages.

Constructors

Bundle 
Instances
Eq Bundle Source # 
Instance details

Defined in Sound.OSC.Packet

Methods

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

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

Ord Bundle Source #

OSC Bundles can be ordered (time ascending).

Instance details

Defined in Sound.OSC.Packet

Read Bundle Source # 
Instance details

Defined in Sound.OSC.Packet

Show Bundle Source # 
Instance details

Defined in Sound.OSC.Packet

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

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

Packet

data Packet Source #

An OSC Packet is either a Message or a Bundle.

Instances
Eq Packet Source # 
Instance details

Defined in Sound.OSC.Packet

Methods

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

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

Read Packet Source # 
Instance details

Defined in Sound.OSC.Packet

Show Packet Source # 
Instance details

Defined in Sound.OSC.Packet

packetTime :: Packet -> Time Source #

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

packetMessages :: Packet -> [Message] Source #

Retrieve the set of Messages from a Packet.

packet_to_bundle :: Packet -> Bundle Source #

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

packet_to_message :: Packet -> Maybe Message Source #

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 Source #

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

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

Variant of either for Packet.

Address Query

bundle_has_address :: Address_Pattern -> Bundle -> Bool Source #

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

Pretty printing

messagePP :: FP_Precision -> Message -> String Source #

Pretty printer for Message.

bundlePP :: FP_Precision -> Bundle -> String Source #

Pretty printer for Bundle.

packetPP :: FP_Precision -> Packet -> String Source #

Pretty printer for Packet.