Crosstales.NLayer.IMpegFrame Interface Reference

Defines a standard way of representing a MPEG frame to the decoder More...

Inheritance diagram for Crosstales.NLayer.IMpegFrame:
Crosstales.NLayer.Decoder.MpegFrame

Public Member Functions

void Reset ()
 Resets the bit reader so frames can be reused More...
 
int ReadBits (int bitCount)
 Provides sequential access to the bitstream in the frame (after the header and optional CRC) More...
 

Properties

int SampleRate [get]
 Sample rate of this frame More...
 
int SampleRateIndex [get]
 The samplerate index (directly from the header) More...
 
int FrameLength [get]
 Frame length in bytes More...
 
int BitRate [get]
 Bit Rate More...
 
MpegVersion Version [get]
 MPEG Version More...
 
MpegLayer Layer [get]
 MPEG Layer More...
 
MpegChannelMode ChannelMode [get]
 Channel Mode More...
 
int ChannelModeExtension [get]
 The number of samples in this frame More...
 
int SampleCount [get]
 The channel extension bits More...
 
int BitRateIndex [get]
 The bitrate index (directly from the header) More...
 
bool IsCopyrighted [get]
 Whether the Copyright bit is set More...
 
bool HasCrc [get]
 Whether a CRC is present More...
 
bool IsCorrupted [get]
 Whether the CRC check failed (use error concealment strategy) More...
 

Detailed Description

Defines a standard way of representing a MPEG frame to the decoder

Member Function Documentation

◆ ReadBits()

int Crosstales.NLayer.IMpegFrame.ReadBits ( int  bitCount)

Provides sequential access to the bitstream in the frame (after the header and optional CRC)

Parameters
bitCountThe number of bits to read
Returns
-1 if the end of the frame has been encountered, otherwise the bits requested

Implemented in Crosstales.NLayer.Decoder.MpegFrame.

◆ Reset()

void Crosstales.NLayer.IMpegFrame.Reset ( )

Resets the bit reader so frames can be reused

Implemented in Crosstales.NLayer.Decoder.MpegFrame.

Property Documentation

◆ BitRate

int Crosstales.NLayer.IMpegFrame.BitRate
get

Bit Rate

◆ BitRateIndex

int Crosstales.NLayer.IMpegFrame.BitRateIndex
get

The bitrate index (directly from the header)

◆ ChannelMode

MpegChannelMode Crosstales.NLayer.IMpegFrame.ChannelMode
get

Channel Mode

◆ ChannelModeExtension

int Crosstales.NLayer.IMpegFrame.ChannelModeExtension
get

The number of samples in this frame

◆ FrameLength

int Crosstales.NLayer.IMpegFrame.FrameLength
get

Frame length in bytes

◆ HasCrc

bool Crosstales.NLayer.IMpegFrame.HasCrc
get

Whether a CRC is present

◆ IsCopyrighted

bool Crosstales.NLayer.IMpegFrame.IsCopyrighted
get

Whether the Copyright bit is set

◆ IsCorrupted

bool Crosstales.NLayer.IMpegFrame.IsCorrupted
get

Whether the CRC check failed (use error concealment strategy)

◆ Layer

MpegLayer Crosstales.NLayer.IMpegFrame.Layer
get

MPEG Layer

◆ SampleCount

int Crosstales.NLayer.IMpegFrame.SampleCount
get

The channel extension bits

◆ SampleRate

int Crosstales.NLayer.IMpegFrame.SampleRate
get

Sample rate of this frame

◆ SampleRateIndex

int Crosstales.NLayer.IMpegFrame.SampleRateIndex
get

The samplerate index (directly from the header)

◆ Version

MpegVersion Crosstales.NLayer.IMpegFrame.Version
get

MPEG Version


The documentation for this interface was generated from the following file:
  • C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/Common/Libraries/NLayer/IMpegFrame.cs