io.github.jaredmdobson.concentus

Class OpusMSEncoder

java.lang.Object

io.github.jaredmdobson.concentus.OpusMSEncoder

public class OpusMSEncoder
extends Object

OpusMSEncoder class.

Version:

$Id: $Id

Method Summary

Modifier and Type	Method and Description
static OpusMSEncoder	Create(int Fs, int channels, int streams, int coupled_streams, short[] mapping, OpusApplication application) Create.
static OpusMSEncoder	CreateSurround(int Fs, int channels, int mapping_family, io.github.jaredmdobson.concentus.BoxedValueInt streams, io.github.jaredmdobson.concentus.BoxedValueInt coupled_streams, short[] mapping, OpusApplication application) CreateSurround.
int	encodeMultistream(short[] pcm, int pcm_offset, int frame_size, byte[] outputBuffer, int outputBuffer_offset, int max_data_bytes) encodeMultistream.
OpusApplication	getApplication() Getter for the field application.
OpusBandwidth	getBandwidth() getBandwidth.
int	getBitrate() getBitrate.
int	getComplexity() getComplexity.
OpusFramesize	getExpertFrameDuration() getExpertFrameDuration.
int	getFinalRange() getFinalRange.
int	getForceChannels() getForceChannels.
OpusMode	getForceMode() getForceMode.
int	getLookahead() getLookahead.
int	getLSBDepth() getLSBDepth.
OpusBandwidth	getMaxBandwidth() getMaxBandwidth.
OpusEncoder	getMultistreamEncoderState(int streamId) getMultistreamEncoderState.
int	getPacketLossPercent() getPacketLossPercent.
boolean	getPredictionDisabled() getPredictionDisabled.
int	getSampleRate() getSampleRate.
OpusSignal	getSignalType() getSignalType.
boolean	getUseConstrainedVBR() getUseConstrainedVBR.
boolean	getUseDTX() getUseDTX.
boolean	getUseInbandFEC() getUseInbandFEC.
boolean	getUseVBR() getUseVBR.
void	resetState() resetState.
void	setApplication(OpusApplication value) Setter for the field application.
void	setBandwidth(OpusBandwidth value) setBandwidth.
void	setBitrate(int value) setBitrate.
void	setComplexity(int value) setComplexity.
void	setExpertFrameDuration(OpusFramesize value) setExpertFrameDuration.
void	setForceChannels(int value) setForceChannels.
void	setForceMode(OpusMode value) setForceMode.
void	setLSBDepth(int value) setLSBDepth.
void	setMaxBandwidth(OpusBandwidth value) setMaxBandwidth.
void	setPacketLossPercent(int value) setPacketLossPercent.
void	setPredictionDisabled(boolean value) setPredictionDisabled.
void	setSignalType(OpusSignal value) setSignalType.
void	setUseConstrainedVBR(boolean value) setUseConstrainedVBR.
void	setUseDTX(boolean value) setUseDTX.
void	setUseInbandFEC(boolean value) setUseInbandFEC.
void	setUseVBR(boolean value) setUseVBR.

Methods inherited from class java.lang.Object

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

Method Detail

resetState

public void resetState()

resetState.

Create

public static OpusMSEncoder Create(int Fs,
                                   int channels,
                                   int streams,
                                   int coupled_streams,
                                   short[] mapping,
                                   OpusApplication application)
                            throws OpusException

Create.

Parameters:

Fs - a int

channels - a int

streams - a int

coupled_streams - a int

mapping - an array of short objects

application - a OpusApplication object

Returns:

a OpusMSEncoder object

Throws:

OpusException - if any.

CreateSurround

public static OpusMSEncoder CreateSurround(int Fs,
                                           int channels,
                                           int mapping_family,
                                           io.github.jaredmdobson.concentus.BoxedValueInt streams,
                                           io.github.jaredmdobson.concentus.BoxedValueInt coupled_streams,
                                           short[] mapping,
                                           OpusApplication application)
                                    throws OpusException

CreateSurround.

Parameters:

Fs - a int

channels - a int

mapping_family - a int

streams - a BoxedValueInt object

coupled_streams - a BoxedValueInt object

mapping - an array of short objects

application - a OpusApplication object

Returns:

a OpusMSEncoder object

Throws:

OpusException - if any.

encodeMultistream

public int encodeMultistream(short[] pcm,
                             int pcm_offset,
                             int frame_size,
                             byte[] outputBuffer,
                             int outputBuffer_offset,
                             int max_data_bytes)

encodeMultistream.

Parameters:

pcm - an array of short objects

pcm_offset - a int

frame_size - a int

outputBuffer - an array of byte objects

outputBuffer_offset - a int

max_data_bytes - a int

Returns:

a int

getBitrate

public int getBitrate()

getBitrate.

Returns:

a int

setBitrate

public void setBitrate(int value)

setBitrate.

Parameters:

value - a int

getApplication

public OpusApplication getApplication()

Getter for the field application.

Returns:

a OpusApplication object

setApplication

public void setApplication(OpusApplication value)

Setter for the field application.

Parameters:

value - a OpusApplication object

getForceChannels

public int getForceChannels()

getForceChannels.

Returns:

a int

setForceChannels

public void setForceChannels(int value)

setForceChannels.

Parameters:

value - a int

getMaxBandwidth

public OpusBandwidth getMaxBandwidth()

getMaxBandwidth.

Returns:

a OpusBandwidth object

setMaxBandwidth

public void setMaxBandwidth(OpusBandwidth value)

setMaxBandwidth.

Parameters:

value - a OpusBandwidth object

getBandwidth

public OpusBandwidth getBandwidth()

getBandwidth.

Returns:

a OpusBandwidth object

setBandwidth

public void setBandwidth(OpusBandwidth value)

setBandwidth.

Parameters:

value - a OpusBandwidth object

getUseDTX

public boolean getUseDTX()

getUseDTX.

Returns:

a boolean

setUseDTX

public void setUseDTX(boolean value)

setUseDTX.

Parameters:

value - a boolean

getComplexity

public int getComplexity()

getComplexity.

Returns:

a int

setComplexity

public void setComplexity(int value)

setComplexity.

Parameters:

value - a int

getForceMode

public OpusMode getForceMode()

getForceMode.

Returns:

a OpusMode object

setForceMode

public void setForceMode(OpusMode value)

setForceMode.

Parameters:

value - a OpusMode object

getUseInbandFEC

public boolean getUseInbandFEC()

getUseInbandFEC.

Returns:

a boolean

setUseInbandFEC

public void setUseInbandFEC(boolean value)

setUseInbandFEC.

Parameters:

value - a boolean

getPacketLossPercent

public int getPacketLossPercent()

getPacketLossPercent.

Returns:

a int

setPacketLossPercent

public void setPacketLossPercent(int value)

setPacketLossPercent.

Parameters:

value - a int

getUseVBR

public boolean getUseVBR()

getUseVBR.

Returns:

a boolean

setUseVBR

public void setUseVBR(boolean value)

setUseVBR.

Parameters:

value - a boolean

getUseConstrainedVBR

public boolean getUseConstrainedVBR()

getUseConstrainedVBR.

Returns:

a boolean

setUseConstrainedVBR

public void setUseConstrainedVBR(boolean value)

setUseConstrainedVBR.

Parameters:

value - a boolean

getSignalType

public OpusSignal getSignalType()

getSignalType.

Returns:

a OpusSignal object

setSignalType

public void setSignalType(OpusSignal value)

setSignalType.

Parameters:

value - a OpusSignal object

getLookahead

public int getLookahead()

getLookahead.

Returns:

a int

getSampleRate

public int getSampleRate()

getSampleRate.

Returns:

a int

getFinalRange

public int getFinalRange()

getFinalRange.

Returns:

a int

getLSBDepth

public int getLSBDepth()

getLSBDepth.

Returns:

a int

setLSBDepth

public void setLSBDepth(int value)

setLSBDepth.

Parameters:

value - a int

getPredictionDisabled

public boolean getPredictionDisabled()

getPredictionDisabled.

Returns:

a boolean

setPredictionDisabled

public void setPredictionDisabled(boolean value)

setPredictionDisabled.

Parameters:

value - a boolean

getExpertFrameDuration

public OpusFramesize getExpertFrameDuration()

getExpertFrameDuration.

Returns:

a OpusFramesize object

setExpertFrameDuration

public void setExpertFrameDuration(OpusFramesize value)

setExpertFrameDuration.

Parameters:

value - a OpusFramesize object

getMultistreamEncoderState

public OpusEncoder getMultistreamEncoderState(int streamId)

getMultistreamEncoderState.

Parameters:

streamId - a int

Returns:

a OpusEncoder object