Ogg::Logical::Reader Class Reference
[Derivable and Nonderivable Classes]

Logical stream reader. More...

#include <Logical.H>

List of all members.

Public Member Functions

 ~Reader ()
 Stops reading this Logical stream.
Readeroperator++ ()
 Deletes the last packet dequed, and deques the next.
Readeroperator+= (PacketNo packets)
 Seek to packet packets from current packet.
Readeroperator= (Position position)
 Seek to packet at or greater than granule position.
bool ending () const
 ending packet?
Error transportError () const
Position granulePosition () const
Packetoperator-> () const throw ()
 Get to the Packet methods.


Detailed Description

Logical stream reader.

Do not derive from Reader. It is an iterator-like class for reading packets.


Constructor & Destructor Documentation

Ogg::Logical::Reader::~Reader (  ) 

Stops reading this Logical stream.

The user may request a new reader after this.


Member Function Documentation

Reader& Ogg::Logical::Reader::operator++ (  ) 

Deletes the last packet dequed, and deques the next.

Reader& Ogg::Logical::Reader::operator+= ( PacketNo  packets  ) 

Seek to packet packets from current packet.

Deques the packet after a successful seek.

Reader& Ogg::Logical::Reader::operator= ( Position  position  ) 

Seek to packet at or greater than granule position.

Deques the packet after a successful seek.

bool Ogg::Logical::Reader::ending (  )  const

ending packet?

Error Ogg::Logical::Reader::transportError (  )  const

Position Ogg::Logical::Reader::granulePosition (  )  const

Packet* Ogg::Logical::Reader::operator-> (  )  const throw ()

Get to the Packet methods.


The documentation for this class was generated from the following file:
Generated on Tue May 1 16:35:34 2007 for libogg++ by  doxygen 1.5.1