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

Kamaelia.Codec.YUV4MPEG.FrameToYUV4MPEG

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


class FrameToYUV4MPEG(Axon.Component.component)

FrameToYUV4MPEG() -> new FrameToYUV4MPEG component.

Parses uncompressed video frame data structures sent to its "inbox" inbox and writes YUV4MPEG format binary data as strings to its "outbox" outbox.

Inboxes

Outboxes

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.

canShutdown(self)

Returns true if the component should terminate when it has finished processing any pending data.

checkShutdown(self)

Collects any new shutdown messages arriving at the "control" inbox, and ensures self.shutdownMsg contains the highest priority one encountered so far.

main(self)

Main loop

mustShutdown(self)

Returns true if the component should terminate immediately.

sendoutbox(self, data)

Generator.

Sends data out of the "outbox" outbox. If the destination is full (noSpaceInBox exception) then it waits until there is space. It keeps retrying until it succeeds.

If the component is ordered to immediately terminate then "STOP" is raised as an exception.

write_frame(self, frame)

Generator.

Writes out YUV4MPEG format frame marker and data.

write_header(self, frame)

Generator.

Sends the YUV4MPEG format header to the "outbox" outbox, based on attributes of the supplied frame data structure.

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