Crosstales.NVorbis.Ogg.Packet Class Reference
Inheritance diagram for Crosstales.NVorbis.Ogg.Packet:
Crosstales.NVorbis.DataPacket

Public Member Functions

override void Done ()
 Indicates that the packet has been read and its data is no longer needed. More...
 
- Public Member Functions inherited from Crosstales.NVorbis.DataPacket
ulong TryPeekBits (int count, out int bitsRead)
 Attempts to read the specified number of bits from the packet, but may return fewer. Does not advance the position counter. More...
 
void SkipBits (int count)
 Advances the position counter by the specified number of bits. More...
 
ulong ReadBits (int count)
 Reads the specified number of bits from the packet and advances the position counter. More...
 
byte PeekByte ()
 Reads the next byte from the packet. Does not advance the position counter. More...
 
byte ReadByte ()
 Reads the next byte from the packet and advances the position counter. More...
 
byte[] ReadBytes (int count)
 Reads the specified number of bytes from the packet and advances the position counter. More...
 
int Read (byte[] buffer, int index, int count)
 Reads the specified number of bytes from the packet into the buffer specified and advances the position counter. More...
 
bool ReadBit ()
 Reads the next bit from the packet and advances the position counter. More...
 
short ReadInt16 ()
 Retrieves the next 16 bits from the packet as a short and advances the position counter. More...
 
int ReadInt32 ()
 Retrieves the next 32 bits from the packet as a int and advances the position counter. More...
 
long ReadInt64 ()
 Retrieves the next 64 bits from the packet as a long and advances the position counter. More...
 
ushort ReadUInt16 ()
 Retrieves the next 16 bits from the packet as a ushort and advances the position counter. More...
 
uint ReadUInt32 ()
 Retrieves the next 32 bits from the packet as a uint and advances the position counter. More...
 
ulong ReadUInt64 ()
 Retrieves the next 64 bits from the packet as a ulong and advances the position counter. More...
 
void SkipBytes (int count)
 Advances the position counter by the specified number of bytes. More...
 

Protected Member Functions

override int ReadNextByte ()
 Reads the next byte of the packet. More...
 
- Protected Member Functions inherited from Crosstales.NVorbis.DataPacket
bool GetFlag (PacketFlags flag)
 Gets the value of the specified flag. More...
 
void SetFlag (PacketFlags flag, bool value)
 Sets the value of the specified flag. More...
 
 DataPacket (int length)
 Creates a new instance with the specified length. More...
 
void ResetBitReader ()
 Resets the bit reader. More...
 

Additional Inherited Members

- Protected Types inherited from Crosstales.NVorbis.DataPacket
enum  PacketFlags : byte {
  PacketFlags.IsResync = 0x01, PacketFlags.IsEndOfStream = 0x02, PacketFlags.IsShort = 0x04, PacketFlags.HasGranuleCount = 0x08,
  PacketFlags.User1 = 0x10, PacketFlags.User2 = 0x20, PacketFlags.User3 = 0x40, PacketFlags.User4 = 0x80
}
 Defines flags to apply to the current packet More...
 
- Properties inherited from Crosstales.NVorbis.DataPacket
bool IsResync [get, set]
 Gets whether the packet was found after a stream resync. More...
 
long GranulePosition [get, set]
 Gets the position of the last granule in the packet. More...
 
long PageGranulePosition [get, set]
 Gets the position of the last granule in the page the packet is in. More...
 
int Length [get, protected set]
 Gets the length of the packet. More...
 
bool IsEndOfStream [get, set]
 Gets whether the packet is the last one in the logical stream. More...
 
long BitsRead [get]
 Gets the number of bits read from the packet. More...
 
int? GranuleCount [get, set]
 Gets the number of granules in the packet. If null, the packet has not been decoded yet. More...
 

Member Function Documentation

◆ Done()

override void Crosstales.NVorbis.Ogg.Packet.Done ( )
virtual

Indicates that the packet has been read and its data is no longer needed.

Reimplemented from Crosstales.NVorbis.DataPacket.

◆ ReadNextByte()

override int Crosstales.NVorbis.Ogg.Packet.ReadNextByte ( )
protectedvirtual

Reads the next byte of the packet.

Returns
The next byte if available, otherwise -1.

Implements Crosstales.NVorbis.DataPacket.


The documentation for this class was generated from the following file:
  • C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/Common/Libraries/NVorbis/Ogg/OggPacket.cs