TagWithSequenceNumber tags items with a sequence numbers, for example: 0, 1, 2, 3, ... etc. The default initial value of the sequence is a 0.
It takes in items on its "inbox" inbox and outputs (seqnum, item) tuples on its "outbox" outbox.
Tagging frames from a Dirac video file with a frame number, starting with 1:
Pipeline( RateControlledFileReader("videofile.dirac", readmode="bytes", rate=... ), DiracDecoder(), TagWithSequenceNumber(initial=1), ... )
At initialisation, specify the initial sequence number to use.
Send an item to TagWithSequenceNumber's "inbox" inbox, and it will send (seqnum, item) to its "outbox" outbox.
The sequence numbers begin 0, 1, 2, 3, ... etc ad infinitum.
If a producerFinished or shutdownMicroprocess message is received on the "control" inbox. It is immediately sent on out of the "signal" outbox and the component then immediately terminates.
TagWithSequenceNumber() -> new TagWithSequenceNumber component.
Send 'item' to the "inbox" inbox and it will be tagged with a sequence number, and sent out as (seqnum, 'item') to the "outbox" outbox.
Sequence numbering goes 0, 1, 2, 3, ... etc.
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, 19 Oct 2008 at 14:29:09 UTC/GMT