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

Logical stream writer

Do not derive from Writer. It is an iterator-like class for writing packets. More...

#include <Logical.H>

List of all members.

Public Member Functions
	~Writer ()
	Ends writing this Logical stream.
size_t	dataSize () const
	Get the current size of the data payload.
void	dataSize (size_t)
	Set the size of the next packet's data payload.
void	flush ()
	Flush previously enqued packets.
void	beginData ()
	Set the current packet to begin data packets.
void	granulePosition (Position)
	Set granule position of current packet.
Position	granulePosition () const
	Get granule position of the last enqued packet.
size_t	pageSize () const
	Get the current page size for transport.
void	pageSize (size_t)
	Set size for transport pages.
Writer &	operator++ ()
	Creates the next packet and enques the last.
Packet *	operator-> () const throw ()
	Get to the Packet methods.
Packet *	packet () const throw ()
	Get the packet.
Protected Member Functions
	Writer ()

---

Detailed Description

Logical stream writer

Do not derive from Writer. It is an iterator-like class for writing packets.

---

Constructor & Destructor Documentation

Ogg::Logical::Writer::Writer

(

)

[inline, protected]

Ogg::Logical::Writer::~Writer

(

)

Ends writing this Logical stream.

The user deletes the Writer instance, or the Writer instance falls out of scrope, which implicitly calls this destructor which closes the Logical stream.

---

Member Function Documentation

size_t Ogg::Logical::Writer::dataSize

(

)

const

Get the current size of the data payload.

void Ogg::Logical::Writer::dataSize

(

size_t

)

Set the size of the next packet's data payload.

Be aware that the payload may be at a different address, invalidating any previous operator->() calls.

void Ogg::Logical::Writer::flush

(

)

Flush previously enqued packets.

void Ogg::Logical::Writer::beginData

(

)

Set the current packet to begin data packets.

Writer assumes header packets until beginData() is called.

void Ogg::Logical::Writer::granulePosition

(

Position

)

Set granule position of current packet.

Default is last granulePosition, beginning with 0

Position Ogg::Logical::Writer::granulePosition

(

)

const

Get granule position of the last enqued packet.

size_t Ogg::Logical::Writer::pageSize

(

)

const

Get the current page size for transport.

void Ogg::Logical::Writer::pageSize

(

size_t

)

Set size for transport pages.

beginning with the page where the current packet begins.

Writer& Ogg::Logical::Writer::operator++

(

)

Creates the next packet and enques the last.

Packet* Ogg::Logical::Writer::operator->

(

)

const throw ()

Get to the Packet methods.

Packet* Ogg::Logical::Writer::packet

(

)

const throw () [inline]

Get the packet.

---

The documentation for this class was generated from the following file:

• Logical.H