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.
WAVParser() -> new WAVParser component.
Send WAV format audio file data to its "inbox" inbox, and the raw
audio data will be sent out of the "outbox" outbox as binary strings.
The format of the audio data is also sent out of other outboxes as soon
as it is determined (before the data starts to flow).
Inboxes
- control : Shutdown signalling
- inbox : Raw WAV file data
Outboxes
- signal : Shutdown signalling
- sample_format : Sample format of the audio (eg.
'S16_LE')
- channels : Number of channels in the audio
- all_meta : Dict of 'sample_format', 'sample_rate',
and 'channels'
- sample_rate : The sample rate of the audio
- outbox : Binary audio data strings
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)
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature
checkShutdown(self)
Collects any new shutdown messages arriving at the "control" inbox,
and returns "NOW" if immediate shutdown is required, or "WHENEVER" if
the component can shutdown when it has finished processing pending
data.
main(self)
readbytes(self, size)
Generator.
Read the specified number of bytes from the stream of chunks of
binary string data arriving at the "inbox" inbox.
Any excess data is placed into self.remainder ready for the next call
to self.readline or self.readbytes.
Data is only read from the inbox when required. It is not
preemptively fetched.
The read data is placed into self.bytesread
If a shutdown is detected, self.bytesread is set to "" and this
generator immediately returns.
readline(self)
Generator.
Read up to the next newline char from the stream of chunks of binary
string data arriving at the "inbox" inbox.
Any excess data is placed into self.remainder ready for the next call
to self.readline or self.readbytes.
Data is only read from the inbox when required. It is not
preemptively fetched.
The read data is placed into self.bytesread
If a shutdown is detected, self.bytesread is set to "" and this
generator immediately returns.
readuptobytes(self,
size)
Generator.
Reads up to the specified number of bytes from any remainder, or (if
there is no remainder) the next string that arrives at the "inbox"
inbox
Any excess data is placed into self.remainder ready for the next call
to self.readline or self.readbytes.
Data is only read from the inbox when required. It is not
preemptively fetched.
The read data is placed into self.bytesread
If a shutdown is detected, self.bytesread is set to "" and this
generator immediately returns.
safesend(self, data, boxname)
Generator.
Sends data out of the named outbox. If the destination is full
(noSpaceInBox exception) then it waits until there is space and retries
until it succeeds.
If a shutdownMicroprocess message is received, returns early.
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
