OpusEncoder (concentus 1.0.2 API)

java.lang.Object
- io.github.jaredmdobson.concentus.OpusEncoder

```
public class OpusEncoder
extends Object
```
OpusEncoder class.

Version:

$Id: $Id

Constructor Summary

Constructors
Constructor and Description

OpusEncoder(int Fs, int channels, OpusApplication application)
Allocates and initializes an encoder state.

Constructors
Constructor and Description
`OpusEncoder(int Fs, int channels, OpusApplication application)` Allocates and initializes an encoder state.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`encode(byte[] in_pcm, int pcm_offset, int frame_size, byte[] out_data, int out_data_offset, int max_data_bytes)` Encodes an Opus frame, putting the output into a specified data buffer
`int`	`encode(short[] in_pcm, int pcm_offset, int frame_size, byte[] out_data, int out_data_offset, int max_data_bytes)` Encodes an Opus frame, putting the output into a specified data buffer
`OpusApplication`	`getApplication()` Getter for the field `application`.
`OpusBandwidth`	`getBandwidth()` Getter for the field `bandwidth`.
`int`	`getBitrate()` getBitrate.
`int`	`getComplexity()` getComplexity.
`boolean`	`getEnableAnalysis()` getEnableAnalysis.
`OpusFramesize`	`getExpertFrameDuration()` getExpertFrameDuration.
`int`	`getFinalRange()` getFinalRange.
`int`	`getForceChannels()` getForceChannels.
`OpusMode`	`getForceMode()` getForceMode.
`boolean`	`getIsLFE()` getIsLFE.
`int`	`getLookahead()` getLookahead.
`int`	`getLSBDepth()` getLSBDepth.
`OpusBandwidth`	`getMaxBandwidth()` getMaxBandwidth.
`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)` Setter for the field `bandwidth`.
`void`	`setBitrate(int value)` setBitrate.
`void`	`setComplexity(int value)` setComplexity.
`void`	`setEnableAnalysis(boolean value)` setEnableAnalysis.
`void`	`setExpertFrameDuration(OpusFramesize value)` setExpertFrameDuration.
`void`	`setForceChannels(int value)` setForceChannels.
`void`	`setForceMode(OpusMode value)` setForceMode.
`void`	`setIsLFE(boolean value)` setIsLFE.
`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

- Constructor Detail
  - OpusEncoder
```
public OpusEncoder(int Fs,
                   int channels,
                   OpusApplication application)
            throws OpusException
```
    Allocates and initializes an encoder state. Note that regardless of the sampling rate and number channels selected, the Opus encoder can switch to a lower audio bandwidth or number of channels if the bitrate selected is too low. This also means that it is safe to always use 48 kHz stereo input and let the encoder optimize the encoding. The decoder will not be constrained later on by the mode that you select here for the encoder.
    
    Parameters:
    
    Fs - Sampling rate of input signal (Hz). This must be one of 8000, 12000, 16000, 24000, or 48000.
    
    channels - Number of channels (1 or 2) in input signal
    
    application - There are three coding modes: OPUS_APPLICATION_VOIP gives best quality at a given bitrate for voice signals. It enhances the input signal by high-pass filtering and emphasizing formants and harmonics.Optionally it includes in-band forward error correction to protect against packet loss. Use this mode for typical VoIP applications. Because of the enhancement, even at high bitrates the output may sound different from the input. OPUS_APPLICATION_AUDIO gives best quality at a given bitrate for most non-voice signals like music. Use this mode for music and mixed (music/voice) content, broadcast, and applications requiring less than 15 ms of coding delay. OPUS_APPLICATION_RESTRICTED_LOWDELAY configures low-delay mode that disables the speech-optimized mode in exchange for slightly reduced delay. This mode can only be set on an newly initialized or freshly reset encoder because it changes the codec delay.
    
    Throws:
    
    OpusException
- Method Detail
  - resetState
```
public void resetState()
```
    resetState.
  - encode
```
public int encode(short[] in_pcm,
                  int pcm_offset,
                  int frame_size,
                  byte[] out_data,
                  int out_data_offset,
                  int max_data_bytes)
           throws OpusException
```
    Encodes an Opus frame, putting the output into a specified data buffer
    
    Parameters:
    
    in_pcm - 16-bit input signal (Interleaved if stereo), in a short array. Length should be at least frame_size * channels
    
    pcm_offset - Offset to use when reading the in_pcm buffer
    
    frame_size - The number of samples _per channel_ in the inpus signal. The frame size must be a valid Opus framesize for the given sample rate. For example, at 48Khz the permitted values are 120, 240, 480, 960, 1920, and 2880. Passing in a duration of less than 10ms (480 samples at 48Khz) will prevent the encoder from using FEC, DTX, or hybrid modes.
    
    out_data - Destination buffer for the output payload. This must contain at least max_data_bytes
    
    out_data_offset - The offset to use when writing to the output data buffer
    
    max_data_bytes - The maximum amount of space allocated for the output payload. This may be used to impose an upper limit on the instant bitrate, but should not be used as the only bitrate control (use setBitrate for that)
    
    Returns:
    
    The length of the encoded packet, in bytes
    
    Throws:
    
    OpusException
  - encode
```
public int encode(byte[] in_pcm,
                  int pcm_offset,
                  int frame_size,
                  byte[] out_data,
                  int out_data_offset,
                  int max_data_bytes)
           throws OpusException
```
    Encodes an Opus frame, putting the output into a specified data buffer
    
    Parameters:
    
    in_pcm - 16-bit input signal (Interleaved if stereo), in a little endian byte array. Length should be at least frame_size * channels * 2
    
    pcm_offset - Offset to use when reading the in_pcm buffer
    
    frame_size - The number of samples _per channel_ in the inpus signal. The frame size must be a valid Opus framesize for the given sample rate. For example, at 48Khz the permitted values are 120, 240, 480, 960, 1920, and 2880. Passing in a duration of less than 10ms (480 samples at 48Khz) will prevent the encoder from using FEC, DTX, or hybrid modes.
    
    out_data - Destination buffer for the output payload. This must contain at least max_data_bytes
    
    out_data_offset - The offset to use when writing to the output data buffer
    
    max_data_bytes - The maximum amount of space allocated for the output payload. This may be used to impose an upper limit on the instant bitrate, but should not be used as the only bitrate control (use setBitrate for that)
    
    Returns:
    
    The length of the encoded packet, in bytes
    
    Throws:
    
    OpusException
  - 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
  - getBitrate
```
public int getBitrate()
```
    getBitrate.
    
    Returns:
    
    a int
  - setBitrate
```
public void setBitrate(int value)
```
    setBitrate.
    
    Parameters:
    
    value - a int
  - 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()
```
    Getter for the field bandwidth.
    
    Returns:
    
    a OpusBandwidth object
  - setBandwidth
```
public void setBandwidth(OpusBandwidth value)
```
    Setter for the field bandwidth.
    
    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
  - 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
  - getExpertFrameDuration
```
public OpusFramesize getExpertFrameDuration()
```
    getExpertFrameDuration.
    
    Returns:
    
    a OpusFramesize object
  - setExpertFrameDuration
```
public void setExpertFrameDuration(OpusFramesize value)
```
    setExpertFrameDuration.
    
    Parameters:
    
    value - a OpusFramesize object
  - getForceMode
```
public OpusMode getForceMode()
```
    getForceMode.
    
    Returns:
    
    a OpusMode object
  - setForceMode
```
public void setForceMode(OpusMode value)
```
    setForceMode.
    
    Parameters:
    
    value - a OpusMode object
  - getIsLFE
```
public boolean getIsLFE()
```
    getIsLFE.
    
    Returns:
    
    a boolean
  - setIsLFE
```
public void setIsLFE(boolean value)
```
    setIsLFE.
    
    Parameters:
    
    value - a boolean
  - getPredictionDisabled
```
public boolean getPredictionDisabled()
```
    getPredictionDisabled.
    
    Returns:
    
    a boolean
  - setPredictionDisabled
```
public void setPredictionDisabled(boolean value)
```
    setPredictionDisabled.
    
    Parameters:
    
    value - a boolean
  - getEnableAnalysis
```
public boolean getEnableAnalysis()
```
    getEnableAnalysis.
    
    Returns:
    
    a boolean
  - setEnableAnalysis
```
public void setEnableAnalysis(boolean value)
```
    setEnableAnalysis.
    
    Parameters:
    
    value - a boolean

Class OpusEncoder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OpusEncoder

Method Detail

resetState

encode

encode

getApplication

setApplication

getBitrate

setBitrate

getForceChannels

setForceChannels

getMaxBandwidth

setMaxBandwidth

getBandwidth

setBandwidth

getUseDTX

setUseDTX

getComplexity

setComplexity

getUseInbandFEC

setUseInbandFEC

getPacketLossPercent

setPacketLossPercent

getUseVBR

setUseVBR

getUseConstrainedVBR

setUseConstrainedVBR

getSignalType

setSignalType

getLookahead

getSampleRate

getFinalRange

getLSBDepth

setLSBDepth

getExpertFrameDuration

setExpertFrameDuration

getForceMode

setForceMode

getIsLFE

setIsLFE

getPredictionDisabled

setPredictionDisabled

getEnableAnalysis

setEnableAnalysis