Crosstales.NVorbis.IContainerReader Interface Reference

Provides a interface for a Vorbis logical stream container. More...

Inheritance diagram for Crosstales.NVorbis.IContainerReader:

Public Member Functions
bool	Init ()
	Initializes the container and finds the first stream. More...
bool	FindNextStream ()
	Finds the next new stream in the container. More...
int	GetTotalPageCount ()
	Retrieves the total number of pages in the container. More...

Properties
int[]	StreamSerials [get]
	Gets the list of stream serials found in the container so far. More...
bool	CanSeek [get]
	Gets whether the container supports seeking. More...
long	WasteBits [get]
	Gets the number of bits in the container that are not associated with a logical stream. More...
int	PagesRead [get]
	Gets the number of pages that have been read in the container. More...

Events
EventHandler< NewStreamEventArgs >	NewStream
	Event raised when a new logical stream is found in the container. More...

Detailed Description

Provides a interface for a Vorbis logical stream container.

Member Function Documentation

FindNextStream()

bool Crosstales.NVorbis.IContainerReader.FindNextStream

(

)

Finds the next new stream in the container.

Returns

True if a new stream was found, otherwise False.

Exceptions

InvalidOperationException

CanSeek is False.

Implemented in Crosstales.NVorbis.Ogg.ContainerReader.

GetTotalPageCount()

int Crosstales.NVorbis.IContainerReader.GetTotalPageCount

(

)

Retrieves the total number of pages in the container.

Returns

The total number of pages.

Exceptions

InvalidOperationException

CanSeek is False.

Implemented in Crosstales.NVorbis.Ogg.ContainerReader.

Init()

bool Crosstales.NVorbis.IContainerReader.Init

(

)

Initializes the container and finds the first stream.

Returns

True if a valid logical stream is found, otherwise False.

Implemented in Crosstales.NVorbis.Ogg.ContainerReader.

Property Documentation

CanSeek

bool Crosstales.NVorbis.IContainerReader.CanSeek

get

Gets whether the container supports seeking.

PagesRead

int Crosstales.NVorbis.IContainerReader.PagesRead

get

Gets the number of pages that have been read in the container.

StreamSerials

int [] Crosstales.NVorbis.IContainerReader.StreamSerials

get

Gets the list of stream serials found in the container so far.

WasteBits

long Crosstales.NVorbis.IContainerReader.WasteBits

get

Gets the number of bits in the container that are not associated with a logical stream.

Event Documentation

NewStream

EventHandler<NewStreamEventArgs> Crosstales.NVorbis.IContainerReader.NewStream

Event raised when a new logical stream is found in the container.

---

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

• C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/Common/Libraries/NVorbis/IContainerReader.cs