Kamaelia docs : Kamaelia.Audio.PyMedia.Input

Audio Capture using PyMedia

This component captures raw audio using the pymedia library, and outputs it out of its "outbox" outbox.

Example Usage

Recording telephone quality audio to a file:

Pipeline( Input(sample_rate=8000, channels=1, format="S16_LE"),
          SimpleFileWriter("recording.raw"),
        ).run()

How does it work?

Input uses the PyMedia library to capture audio from the currently selected audio capture device.

It outputs to its "outbox" outbox raw binary audio data in strings.

This component supports sending to a size limited inbox. If the size limited inbox is full, this component will pause until it is able to send out the data.

This component will terminate if a shutdownMicroprocess or producerFinished message is sent to the "control" inbox. The message will be forwarded on out of the "signal" outbox just before termination.


Kamaelia.Audio.PyMedia.Input.Input

class Input(Axon.ThreadedComponent.threadedcomponent)

Input([sample_rate][,channels][,format]) -> new Input component.

Captures audio using the PyMedia library and sends the raw audio data out of its "outbox" outbox.

Keyword arguments:

  • sample_rate -- Sample rate in Hz (default = 44100)
  • channels -- Number of channels (default = 2)
  • format -- Sample format (default = "S16_LE")

Outboxes

  • outbox : raw audio samples
  • signal : Shutdown signalling
  • format : dictionary detailing sample_rate, sample_format and channels

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[, sample_rate][, channels][, format])

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

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)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)