April 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.


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

class VideoOverlay(Axon.Component.component)

VideoOverlay() -> new VideoOverlay component

Displays a pygame video overlay using the Pygame Display service component. The overlay is sized and configured by the first frame of (uncompressed) video data is receives.

NB: Currently, the only supported pixel format is "YUV420_planar"



Methods defined here


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, **argd)

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 loop.

newOverlay(self, frame)

Request an overlay to suit the supplied frame of data

waitBox(self, boxname)

Generator. yields 1 until data ready on the named inbox.


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