Sound.RtMidi.Report

Utility code to gather MIDI system information.

Documentation

data ApiReport

MIDI system information specific to a particular API.

Constructors

ApiReport

Fields

• apiRepApi :: !Api
• apiRepName :: !String
• apiRepDisplayName :: !String
• apiInPorts :: ![(Int, String)]
• apiOutPorts :: ![(Int, String)]

Instances

Eq ApiReport

Defined in Sound.RtMidi.Report

Methods

(==) :: ApiReport -> ApiReport -> Bool

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

Show ApiReport

Defined in Sound.RtMidi.Report

Methods

showsPrec :: Int -> ApiReport -> ShowS

show :: ApiReport -> String

showList :: [ApiReport] -> ShowS

Generic ApiReport

Defined in Sound.RtMidi.Report

Associated Types

type Rep ApiReport :: Type -> Type

Methods

from :: ApiReport -> Rep ApiReport x

to :: Rep ApiReport x -> ApiReport

NFData ApiReport

Defined in Sound.RtMidi.Report

Methods

rnf :: ApiReport -> ()

type Rep ApiReport

Defined in Sound.RtMidi.Report

type Rep ApiReport = D1 ('MetaData "ApiReport" "Sound.RtMidi.Report" "RtMidi-0.5.0.1-inplace" 'False) (C1 ('MetaCons "ApiReport" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiRepApi") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Api) :*: S1 ('MetaSel ('Just "apiRepName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String)) :*: (S1 ('MetaSel ('Just "apiRepDisplayName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String) :*: (S1 ('MetaSel ('Just "apiInPorts") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [(Int, String)]) :*: S1 ('MetaSel ('Just "apiOutPorts") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [(Int, String)])))))

data Report

MIDI system information for any number of APIs.

Constructors

Report

Fields

• defaultInApi :: !Api
• defaultOutApi :: !Api
• apiReports :: ![ApiReport]

Instances

Eq Report

Defined in Sound.RtMidi.Report

Methods

(==) :: Report -> Report -> Bool

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

Show Report

Defined in Sound.RtMidi.Report

Methods

showsPrec :: Int -> Report -> ShowS

show :: Report -> String

showList :: [Report] -> ShowS

Generic Report

Defined in Sound.RtMidi.Report

Associated Types

type Rep Report :: Type -> Type

Methods

from :: Report -> Rep Report x

to :: Rep Report x -> Report

NFData Report

Defined in Sound.RtMidi.Report

Methods

rnf :: Report -> ()

type Rep Report

Defined in Sound.RtMidi.Report

type Rep Report = D1 ('MetaData "Report" "Sound.RtMidi.Report" "RtMidi-0.5.0.1-inplace" 'False) (C1 ('MetaCons "Report" 'PrefixI 'True) (S1 ('MetaSel ('Just "defaultInApi") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Api) :*: (S1 ('MetaSel ('Just "defaultOutApi") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Api) :*: S1 ('MetaSel ('Just "apiReports") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ApiReport]))))

buildApiReport :: MonadIO m => Api -> m ApiReport

Gather information about the given Api, including port information.

buildCustomReport

Arguments

:: MonadIO m

=> Bool

True to report on default APIs, False to report on all compiled APIs.

-> m Report

Variant of buildReport that allows you to restrict it to the default APIs.

buildReport :: MonadIO m => m Report

Gather information about all compiled APIs.