August'24: Kamaelia is in maintenance mode and will recieve periodic updates, about twice a year, primarily targeted around Python 3 and ecosystem compatibility. PRs are always welcome. Latest Release: 1.14.32 (2024/3/24)

Axon

All of these components are implemented using Axon - Kamaelia's core. You probably want to have a look over at the Axon documentation if you're writing new components.

Kamaelia Components

Application specific components are now at the end of the file, preceded by support code.

Audio
- Codec
  - PyMedia
    - Decoder ( Decoder )
    - Encoder ( Encoder )
- Filtering ( LPF )
- Input
- Output
- PyMedia
  - Input ( Input )
  - Output ( Output )
  - Resample ( Resample )
- RawAudioMixer ( RawAudioMixer )
Automata
- Behaviours ( bouncingFloat, cartesianPingPong, continuousIdentity, continuousOne, continuousZero, loopingCounter )
BaseIPC
Chassis
- Carousel ( Carousel )
- ConnectedServer ( ServerCore, SimpleServer )
- Graphline ( Graphline )
- Pipeline ( Pipeline )
- Prefab ( JoinChooserToCarousel )
- Seq ( Seq )
Codec
- Dirac ( DiracDecoder, DiracEncoder )
- RawYUVFramer ( RawYUVFramer )
- Speex ( SpeexDecode, SpeexEncode )
- Vorbis ( AOAudioPlaybackAdaptor, VorbisDecode )
- WAV ( WAVParser, WAVWriter )
- YUV4MPEG ( FrameToYUV4MPEG, YUV4MPEGToFrame )
Community
Device
- DVB
  - Core ( DVB_Demuxer, DVB_Multiplex )
  - DemuxerService ( DemuxerService )
  - EIT ( EITPacketParser, NowNextChanges, NowNextServiceFilter, PSIPacketReconstructor, TimeAndDatePacketParser )
  - NowNext ( NowNextProgrammeJunctionDetect, NowNextServiceFilter )
  - PSITables ( FilterOutNotCurrent )
  - Parse
  - Receiver ( Receiver )
  - SoftDemux ( DVB_SoftDemuxer )
  - Tuner ( Tuner )
Exceptions
Experimental
- Chassis ( Carousel, Graphline, InboxControlledCarousel, Pipeline )
- ERParsing ( ERModel2Visualiser, ERParser )
- Services ( RegisterService, Subscribe, ToService )
File
- Append ( Append )
- BetterReading ( IntelligentFileReader )
- MaxSpeedFileReader ( MaxSpeedFileReader )
- ReadFileAdaptor ( ReadFileAdaptor )
- Reading ( FixedRateControlledReusableFileReader, PromptedFileReader, RateControlledFileReader, RateControlledReusableFileReader, ReusableFileReader, SimpleReader )
- TriggeredFileReader ( TriggeredFileReader )
- UnixPipe
- UnixProcess ( UnixProcess )
- UnixProcess2 ( UnixProcess2 )
- WholeFileWriter ( WholeFileWriter )
- Writing ( SimpleFileWriter )
IPC
Internet
- ConnectedSocketAdapter ( ConnectedSocketAdapter )
- Multicast_receiver ( Multicast_receiver )
- Multicast_sender ( Multicast_sender )
- Multicast_transceiver ( Multicast_transceiver )
- Selector ( Selector )
- Simulate
  - BrokenNetwork ( Duplicate, Reorder, Throwaway )
- SingleServer ( SingleServer, echo )
- TCPClient ( TCPClient )
- TCPServer ( TCPServer )
- ThreadedTCPClient ( ThreadedTCPClient )
- TimeOutCSA
- UDP ( PostboxPeer, SimplePeer, TargettedPeer )
- UDP_ng ( PostboxPeer, SimplePeer, TargettedPeer, UDPReceiver, UDPSender )
KamaeliaExceptions
KamaeliaIPC
Protocol
- AIM
  - AIMHarness ( AIMHarness )
  - ChatManager ( ChatManager )
  - LoginHandler ( LoginHandler )
  - OSCARClient ( OSCARClient, OSCARProtocol, SNACExchanger )
- AudioCookieProtocol ( AudioCookieProtocol )
- EchoProtocol ( EchoProtocol )
- EchoProtocolComponent
- FortuneCookieProtocol ( FortuneCookieProtocol )
- Framing ( DataChunker, DataDeChunker, DeFramer, Framer )
- HTTP
  - ErrorPages
  - HTTPClient ( SimpleHTTPClient, SingleShotHTTPClient )
  - HTTPHelpers ( HTTPMakePostRequest )
  - HTTPParser ( HTTPParser )
  - HTTPRequestHandler ( HTTPRequestHandler )
  - HTTPResourceGlue
  - HTTPServer ( HTTPServer )
  - Handlers
    - Minimal ( Minimal )
    - SessionExample ( SessionExample )
    - UploadTorrents ( UploadTorrents )
  - IcecastClient ( IcecastClient, IcecastDemux, IcecastStreamRemoveMetadata, IcecastStreamWriter )
  - MimeTypes
- IRC
  - IRCClient
- MimeRequestComponent ( MimeRequestComponent )
- Packetise ( MaxSizePacketiser )
- RTP
  - NullPayloadPreFramer
  - NullPayloadRTP ( NullPayloadPreFramer )
  - RTCPHeader
  - RTP ( RTPDeframer, RTPFramer )
  - RTPHeader
  - RtpPacker ( RtpPacker )
- RecoverOrder
- SDP ( SDPParser )
- SimpleReliableMulticast ( Annotator, RecoverOrder, SRM_Receiver, SRM_Sender )
- SimpleVideoCookieServer ( HelloServer )
- Torrent
  - TorrentClient ( BasicTorrentExplainer, TorrentClient )
  - TorrentIPC
  - TorrentMaker ( TorrentMaker )
  - TorrentPatron ( TorrentPatron )
  - TorrentService ( TorrentService )
ReadFileAdaptor
SampleTemplateComponent ( CallbackStyleComponent, StandardStyleComponent )
SimpleServerComponent
SingleServer
UI
- GraphicDisplay
- MH
  - DragHandler
  - PyGameApp ( PyGameApp )
  - test
    - test_DragHandler
- OpenGL
  - ArrowButton ( ArrowButton )
  - Button ( Button )
  - Container ( Container )
  - Interactor ( Interactor )
  - Intersect
  - Label ( Label )
  - LiftTranslationInteractor ( LiftTranslationInteractor )
  - MatchedTranslationInteractor ( MatchedTranslationInteractor )
  - Movement ( PathMover, SimpleBuzzer, SimpleMover, SimpleRotator, WheelMover )
  - OpenGLComponent ( OpenGLComponent )
  - OpenGLDisplay ( OpenGLDisplay )
  - ProgressBar ( ProgressBar )
  - PygameWrapper ( PygameWrapper )
  - SimpleButton ( SimpleButton )
  - SimpleCube ( SimpleCube )
  - SimpleRotationInteractor ( SimpleRotationInteractor )
  - SimpleTranslationInteractor ( SimpleTranslationInteractor )
  - SkyGrassBackground ( SkyGrassBackground )
  - TexPlane ( TexPlane )
  - Transform
  - Vector
- Pygame
  - Button ( Button )
  - Display ( PygameDisplay )
  - EventHandler
  - Image ( Image )
  - KeyEvent ( KeyEvent )
  - MagnaDoodle ( MagnaDoodle )
  - Multiclick ( Multiclick )
  - Text ( TextDisplayer, Textbox )
  - Ticker ( Ticker )
  - VideoOverlay ( VideoOverlay )
  - VideoSurface ( VideoSurface )
- PygameDisplay
- Tk
  - TkWindow ( TkWindow, tkInvisibleWindow )
Util
- Backplane ( Backplane, PublishTo, SubscribeTo )
- Chargen ( Chargen )
- Chooser ( Chooser, ForwardIteratingChooser )
- ChunkNamer ( ChunkNamer )
- Chunkifier ( Chunkifier )
- Clock ( CheapAndCheerfulClock )
- Collate ( Collate )
- Comparator ( Comparator )
- Console ( ConsoleEchoer, ConsoleReader )
- ConsoleEcho
- DataSource ( DataSource, TriggeredSource )
- Detuple ( SimpleDetupler )
- Fanout ( Fanout )
- Filter ( Filter )
- FilterComponent
- FirstOnly ( FirstOnly )
- Graphline
- Introspector ( Introspector )
- LineSplit ( LineSplit )
- LossyConnector ( LossyConnector )
- MarshallComponent ( BasicMarshallComponent )
- Marshalling ( DeMarshaller, Marshaller )
- Max ( Max )
- NullSink ( nullSinkComponent )
- NullSinkComponent ( nullSinkComponent )
- OneShot ( OneShot, TriggeredOneShot )
- PassThrough ( PassThrough )
- Pipeline
- PipelineComponent
- PromptedTurnstile ( PromptedTurnstile )
- PureTransformer ( PureTransformer )
- RangeFilter ( RangeFilter )
- RateChunker ( RateChunker )
- RateFilter ( ByteRate_RequestControl, MessageRateLimit, OnDemandLimit, VariableByteRate_RequestControl )
- SequentialTransformer ( SequentialTransformer )
- Splitter ( Plug, PlugSplitter, Splitter )
- Stringify ( Stringify )
- Sync ( Sync )
- TagWithSequenceNumber ( TagWithSequenceNumber )
- TestResult ( TestResult )
- TestResultComponent
- ToStringComponent
- Tokenisation
  - Simple ( lines_to_tokenlists, tokenlists_to_lines )
- TwoWaySplitter ( TwoWaySplitter )
- UnseenOnly ( UnseenOnly )
Video
- CropAndScale ( CropAndScale )
- DetectShotChanges ( DetectShotChanges )
- PixFormatConversion ( ToRGB_interleaved, ToYUV420_planar )
Visualisation
- Axon
  - AxonLaws
  - AxonVisualiserServer ( AxonVisualiser, AxonVisualiserServer )
  - ExtraWindowFurniture
  - PComponent
  - PPostbox
- ER
  - ERLaws
  - ERVisualiserServer ( ERVisualiser, ERVisualiserServer )
  - ExtraWindowFurniture
  - PAttribute
  - PEntity
  - PISA
  - PRelation
- PhysicsGraph
  - GridRenderer
  - ParticleDragger
  - RenderingParticle
  - TopologyViewer ( TopologyViewer )
  - TopologyViewerComponent
  - TopologyViewerServer ( TextControlledTopologyViewer, TopologyViewerServer )
  - chunks_to_lines ( chunks_to_lines )
  - lines_to_tokenlists ( lines_to_tokenlists )
- PhysicsGraph3D
  - Particles3D
  - TopologyViewer3D ( TopologyViewer3D )
  - TopologyViewer3DWithParams ( TopologyViewer3DWithParams )
XML
- SimpleXMLParser ( SimpleXMLParser )
vorbisDecodeComponent

Support Code

These files do not contain Components, but are used with and useful for components.

Kamaelia

Support
- DVB
  - CRC
  - DateTime
  - Descriptors
- Data
  - Escape
  - Experimental ( GraphSlideXMLComponent, onDemandGraphFileParser_Prefab )
  - ISO639_2
  - MimeDict
  - MimeObject
  - Rationals
  - Repository
  - bitfieldrec
  - requestLine
  - tests
    - test_Escape
    - test_MimeDict
    - test_Rationals
- Deprecate
- OscarUtil
- OscarUtil2
- Particles
  - MultipleLaws
  - Particle
  - ParticleSystem
  - SimpleLaws
  - SpatialIndexer
- Protocol
  - IRC
- PyMedia
  - AudioFormats
- Tk
  - Scrolling

Application Specific Components

Kamaelia

Apps
- Compose
  - BuildViewer
  - CodeGen
  - GUI
  - PipeBuild
  - PipelineWriter
- Games4Kids
  - BasicSprite
  - MyGamesEventsComponent
  - SpriteScheduler
- Grey
  - ConcreteMailHandler ( ConcreteMailHandler )
  - GreyListingPolicy ( GreyListingPolicy )
  - MailHandler ( MailHandler )
  - PeriodicWakeup ( PeriodicWakeup )
  - Support
  - WakeableIntrospector ( WakeableIntrospector )
- IRCLogger
  - Support
- Show
  - GraphSlides ( GraphSlideXMLComponent )
- SpeakNWrite
  - Gestures
    - Analyser
    - Grammar
    - GrammarRules
    - Patterns
    - Pen
    - PreProcessing
    - StrokeRecogniser
- Whiteboard
  - Audio
  - Canvas
  - CheckpointSequencer
  - CommandConsole
  - Entuple
  - Options
  - Painter
  - Palette
  - Router
  - Routers
  - SingleShot
  - TagFiltering
  - Tokenisation
  - TwoWaySplitter
  - UI

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT