Kamaelia docs : Kamaelia.UI.Pygame.VideoSurface.VideoSurface

Kamaelia.UI.Pygame.VideoSurface.VideoSurface

For examples and more explanations, see the module level docs.

class VideoSurface(Axon.Component.component)

VideoSurface([position]) -> new VideoSurface component

Displays a pygame surface using the Pygame Display service component, for displaying RGB video frames sent to its "inbox" inbox.

The surface is sized and configured by the first frame of (uncompressed) video data is receives.

Keyword arguments:

position -- (x,y) pixels position of top left corner (default=(0,0))

Inboxes

control : Shutdown messages: shutdownMicroprocess or producerFinished
callback : Receive callbacks from Pygame Display
inbox : Video frame data structures containing RGB data

Outboxes

outbox : NOT USED
signal : Shutdown signalling: shutdownMicroprocess or producerFinished
display_signal : Outbox used for sending signals of various kinds to the display service

Methods defined here

Warning!

You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

init(self[, position])

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

formatChanged(self, frame)

Returns True if frame size or pixel format is new/different for this frame.

main(self)

Main loop.

shutdown(self)

waitBox(self, boxname)

Generator. yield's 1 until data is ready on the named inbox.

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, 20 Jul 2008 at 03:02:36 UTC/GMT

(C) 2005 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved,
This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC.