Crosstales.NVorbis.VorbisReader Class Reference

Inheritance diagram for Crosstales.NVorbis.VorbisReader:

Public Member Functions
	VorbisReader (string fileName)
	VorbisReader (Stream stream, bool closeStreamOnDispose)
	VorbisReader (IContainerReader containerReader)
	VorbisReader (IPacketProvider packetProvider)
void	Dispose ()
int	ReadSamples (float[] buffer, int offset, int count)
	Reads decoded samples from the current logical stream More...
void	ClearParameterChange ()
	Clears the parameter change flag so further samples can be requested. More...
bool	FindNextStream ()
	Searches for the next stream in a concatenated file More...
bool	SwitchStreams (int index)
	Switches to an alternate logical stream. More...

Properties
int	Channels [get]
	Gets the number of channels in the current selected Vorbis stream More...
int	SampleRate [get]
	Gets the sample rate of the current selected Vorbis stream More...
int	UpperBitrate [get]
	Gets the encoder's upper bitrate of the current selected Vorbis stream More...
int	NominalBitrate [get]
	Gets the encoder's nominal bitrate of the current selected Vorbis stream More...
int	LowerBitrate [get]
	Gets the encoder's lower bitrate of the current selected Vorbis stream More...
string	Vendor [get]
	Gets the encoder's vendor string for the current selected Vorbis stream More...
string[]	Comments [get]
	Gets the comments in the current selected Vorbis stream More...
bool	IsParameterChange [get]
	Gets whether the previous short sample count was due to a parameter change in the stream. More...
long	ContainerOverheadBits [get]
	Gets the number of bits read that are related to framing and transport alone More...
bool	ClipSamples [get, set]
	Gets or sets whether to automatically apply clipping to samples returned by VorbisReader.ReadSamples. More...
IVorbisStreamStatus[]	Stats [get]
	Gets stats from each decoder stream available More...
int	StreamIndex [get]
	Gets the currently-selected stream's index More...
int	StreamCount [get]
	Returns the number of logical streams found so far in the physical container More...
TimeSpan	DecodedTime [get, set]
	Gets or Sets the current timestamp of the decoder. Is the timestamp before the next sample to be decoded More...
long	DecodedPosition [get, set]
	Gets or Sets the current position of the next sample to be decoded. More...
TimeSpan	TotalTime [get]
	Gets the total length of the current logical stream More...
long	TotalSamples [get]

Member Function Documentation

ClearParameterChange()

void Crosstales.NVorbis.VorbisReader.ClearParameterChange

(

)

Clears the parameter change flag so further samples can be requested.

FindNextStream()

bool Crosstales.NVorbis.VorbisReader.FindNextStream

(

)

Searches for the next stream in a concatenated file

Returns

True if a new stream was found, otherwise false.

ReadSamples()

int Crosstales.NVorbis.VorbisReader.ReadSamples	(	float[]	buffer,
		int	offset,
		int	count
	)

Reads decoded samples from the current logical stream

Parameters

buffer	The buffer to write the samples to
offset	The offset into the buffer to write the samples to
count	The number of samples to write

Returns

The number of samples written

SwitchStreams()

bool Crosstales.NVorbis.VorbisReader.SwitchStreams

(

int

index

)

Switches to an alternate logical stream.

Parameters

index

The logical stream index to switch to

Returns

True if the properties of the logical stream differ from those of the one previously being decoded. Otherwise, False.

Property Documentation

Channels

int Crosstales.NVorbis.VorbisReader.Channels

get

Gets the number of channels in the current selected Vorbis stream

ClipSamples

bool Crosstales.NVorbis.VorbisReader.ClipSamples

getset

Gets or sets whether to automatically apply clipping to samples returned by VorbisReader.ReadSamples.

Comments

string [] Crosstales.NVorbis.VorbisReader.Comments

get

Gets the comments in the current selected Vorbis stream

ContainerOverheadBits

long Crosstales.NVorbis.VorbisReader.ContainerOverheadBits

get

Gets the number of bits read that are related to framing and transport alone

DecodedPosition

long Crosstales.NVorbis.VorbisReader.DecodedPosition

getset

Gets or Sets the current position of the next sample to be decoded.

DecodedTime

TimeSpan Crosstales.NVorbis.VorbisReader.DecodedTime

getset

Gets or Sets the current timestamp of the decoder. Is the timestamp before the next sample to be decoded

IsParameterChange

bool Crosstales.NVorbis.VorbisReader.IsParameterChange

get

Gets whether the previous short sample count was due to a parameter change in the stream.

LowerBitrate

int Crosstales.NVorbis.VorbisReader.LowerBitrate

get

Gets the encoder's lower bitrate of the current selected Vorbis stream

NominalBitrate

int Crosstales.NVorbis.VorbisReader.NominalBitrate

get

Gets the encoder's nominal bitrate of the current selected Vorbis stream

SampleRate

int Crosstales.NVorbis.VorbisReader.SampleRate

get

Gets the sample rate of the current selected Vorbis stream

Stats

IVorbisStreamStatus [] Crosstales.NVorbis.VorbisReader.Stats

get

Gets stats from each decoder stream available

StreamCount

int Crosstales.NVorbis.VorbisReader.StreamCount

get

Returns the number of logical streams found so far in the physical container

StreamIndex

int Crosstales.NVorbis.VorbisReader.StreamIndex

get

Gets the currently-selected stream's index

TotalTime

TimeSpan Crosstales.NVorbis.VorbisReader.TotalTime

get

Gets the total length of the current logical stream

UpperBitrate

int Crosstales.NVorbis.VorbisReader.UpperBitrate

get

Gets the encoder's upper bitrate of the current selected Vorbis stream

Vendor

string Crosstales.NVorbis.VorbisReader.Vendor

get

Gets the encoder's vendor string for the current selected Vorbis stream

---

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

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