Kamaelia docs : Kamaelia.UI.Pygame.VideoOverlay.VideoOverlay

Kamaelia.UI.Pygame.VideoOverlay.VideoOverlay

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"

Inboxes

control : Shutdown signalling
inbox : Receives uncompressed video frames

Outboxes

outbox : NOT USED
signal : Shutdown signalling
yuvdata : Sending yuv video data to overlay display service
displayctrl : Sending requests to the Pygame 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, **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(self)

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.

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

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

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. (the site is powered by a wiki engine)