io.github.jaredmdobson.concentus

Class OpusPacketInfo

java.lang.Object

io.github.jaredmdobson.concentus.OpusPacketInfo

public class OpusPacketInfo
extends Object

OpusPacketInfo class.

Version:

$Id: $Id

Field Summary

Fields

Modifier and Type	Field and Description
List<Byte[]>	Frames The list of subframes in this packet
int	PayloadOffset The index of the start of the payload within the packet
byte	TOCByte The Table of Contents byte for this packet.

Method Summary

Modifier and Type	Method and Description
static OpusBandwidth	getBandwidth(byte[] packet, int packet_offset) getBandwidth.
static OpusMode	getEncoderMode(byte[] packet, int packet_offset) getEncoderMode.
static int	getNumEncodedChannels(byte[] packet, int packet_offset) getNumEncodedChannels.
static int	getNumFrames(byte[] packet, int packet_offset, int len) getNumFrames.
static int	getNumSamples(byte[] packet, int packet_offset, int len, int Fs) getNumSamples.
static int	getNumSamples(OpusDecoder dec, byte[] packet, int packet_offset, int len) getNumSamples.
static int	getNumSamplesPerFrame(byte[] packet, int packet_offset, int Fs) getNumSamplesPerFrame.
static OpusPacketInfo	parseOpusPacket(byte[] packet, int packet_offset, int len) Parse an opus packet into a packetinfo object containing one or more frames.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOCByte

public byte TOCByte

The Table of Contents byte for this packet. Contains info about modes, frame length, etc.

Frames

public List<Byte[]> Frames

The list of subframes in this packet

PayloadOffset

public int PayloadOffset

The index of the start of the payload within the packet

Method Detail

parseOpusPacket

public static OpusPacketInfo parseOpusPacket(byte[] packet,
                                             int packet_offset,
                                             int len)
                                      throws OpusException

Parse an opus packet into a packetinfo object containing one or more frames. Opus_decode will perform this operation internally so most applications do not need to use this function.

Parameters:

packet - The packet data to be parsed

packet_offset - The index of the beginning of the packet in the data array (usually 0)

len - The packet's length

Returns:

A parsed packet info struct

Throws:

OpusException

getNumSamplesPerFrame

public static int getNumSamplesPerFrame(byte[] packet,
                                        int packet_offset,
                                        int Fs)

getNumSamplesPerFrame.

Parameters:

packet - an array of byte objects

packet_offset - a int

Fs - a int

Returns:

a int

getBandwidth

public static OpusBandwidth getBandwidth(byte[] packet,
                                         int packet_offset)

getBandwidth.

Parameters:

packet - an array of byte objects

packet_offset - a int

Returns:

a OpusBandwidth object

getNumEncodedChannels

public static int getNumEncodedChannels(byte[] packet,
                                        int packet_offset)

getNumEncodedChannels.

Parameters:

packet - an array of byte objects

packet_offset - a int

Returns:

a int

getNumFrames

public static int getNumFrames(byte[] packet,
                               int packet_offset,
                               int len)

getNumFrames.

Parameters:

packet - an array of byte objects

packet_offset - a int

len - a int

Returns:

a int

getNumSamples

public static int getNumSamples(byte[] packet,
                                int packet_offset,
                                int len,
                                int Fs)

getNumSamples.

Parameters:

packet - an array of byte objects

packet_offset - a int

len - a int

Fs - a int

Returns:

a int

getNumSamples

public static int getNumSamples(OpusDecoder dec,
                                byte[] packet,
                                int packet_offset,
                                int len)

getNumSamples.

Parameters:

dec - a OpusDecoder object

packet - an array of byte objects

packet_offset - a int

len - a int

Returns:

a int

getEncoderMode

public static OpusMode getEncoderMode(byte[] packet,
                                      int packet_offset)

getEncoderMode.

Parameters:

packet - an array of byte objects

packet_offset - a int

Returns:

a OpusMode object