API reference
MpegFile Class
Extends IDisposable
Properties
int SampleRate[Get]
Sample rate of source Mpeg, in Hertz.
int Channels[Get]
Channel count of source Mpeg.
bool CanSeek[Get]
Whether the Mpeg stream supports seek operation.
long Length[Get]
Data length of decoded data, in PCM.
TimeSpan Duration[Get]
Media duration of the Mpeg file.
long Position[Get]
Current decode position, in number of sample. Calling the setter will result in a seeking operation.
TimeSpan Time[Get]
Current decode position, represented by time. Calling the setter will result in a seeking operation.
StereoMode StereoMode[Get]
Stereo mode used in decoding.
Member Functions
MpegFile
( string fileName )
Construct Mpeg file representation from filename.
Parameters
fileName
The file which contains Mpeg data.
MpegFile
( System.IO.Stream stream )
Construct Mpeg file representation from stream.
Parameters
stream
The input stream which contains Mpeg data.
void Dispose ( )
Implements IDisposable.Dispose.
void SetEQ
( float [] eq )
Set the equalizer.
Parameters
eq
The equalizer, represented by an array of 32 adjustments in dB.
int ReadSamples
( byte [] buffer,
int index,
int count )
Read specified samples into provided buffer. Do exactly the same as ReadSamples(float[], int, int) except that the data is written in type of byte, while still representing single-precision float (in local endian).
Parameters
buffer
Buffer to write. Floating point data will be actually written into this byte array.
index
Writing offset on the destination buffer.
count
Length of samples to be read, in bytes.
Returns
Sample size actually reads, in bytes.
int ReadSamples
( float [] buffer,
int index,
int count )
Read specified samples into provided buffer, as PCM format. Result varies with diffirent StereoMode:
- For NLayer.StereoMode.Both, sample data on both two channels will occur in turn (left first).
- For NLayer.StereoMode.LeftOnly and NLayer.StereoMode.RightOnly, only data on specified channel will occur.
- For NLayer.StereoMode.DownmixToMono, two channels will be down-mixed into single channel.
Parameters
buffer
Buffer to write.
index
Writing offset on the destination buffer.
count
Count of samples to be read.
Returns
Sample count actually reads.
int ReadSamplesInt16
( byte [] buffer,
int index,
int count )
int ReadSamplesInt8
( byte [] buffer,
int index,
int count )
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta