OpusEncoder

Instance Constructors

new OpusEncoder(sampleFreq: SampleFrequency, channels: Int, app: Application, bufferSize: Int = 8192)

sampleFreq
The required sampling frequency
channels
The number of channels you intend to encode.
app
The application (Voip, Audio or LowDelay)
bufferSize
The reserved size of the buffer to which compressed data are written. The default should be more than sufficient

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def apply(audio: Array[Float]): Try[Array[Byte]]

Encode a block of raw audio in float format using the configured encoder
Encode a block of raw audio in float format using the configured encoder
audio
Audio data arranged as a contiguous block interleaved array of floats
returns
An array containing the compressed audio or the exception in case of a failure

Definition Classes
OpusEncoder → Encoder
def apply(audio: Array[Short]): Try[Array[Byte]]

Encode a block of raw audio in integer format using the configured encoder
Encode a block of raw audio in integer format using the configured encoder
audio
Audio data arranged as a contiguous block interleaved array of short integers
returns
An array containing the compressed audio or the exception in case of a failure

Definition Classes
OpusEncoder → Encoder
final def asInstanceOf[T0]: T0

Definition Classes
Any
var clean: Boolean
def cleanup(): Unit

Release all pointers allocated for the encoder.
Release all pointers allocated for the encoder. Make every attempt to call this when you are done with the encoder as finalise() is what it is in the JVM

Definition Classes
OpusEncoder → Codec
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def complexity(c: Int): Encoder

Set the complexity of the encoder.
Set the complexity of the encoder. This has no effect if the encoder does not support complexity settings
c
A value between 0 and 10 indicating the encoder complexity.
returns
A reference to the updated encoder

Definition Classes
OpusEncoder → Encoder
val decodePtr: Array[Byte]
val encoder: Long
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val error: Array[Int]
final def finalize(): Unit

Definition Classes
Codec → AnyRef
def getApplication: Int
def getBandwidth: Int
def getBitRate: Int
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getComplexity: Int
def getDetail: String

returns
A discription of this instance of an encoder or decoder

Definition Classes
OpusEncoder → Codec
def getExpertFrameDuration: Int
def getForceChannels: Int
def getInbandFec: Int
def getLookahead: Int
def getLsbDepth: Int
def getMaxBandwidth: Int
def getPacketLossPerc: Int
def getPredictionDisable: Int
def getSampleRate: Int

returns
The sample rate for this codec's instance

Definition Classes
OpusEncoder → Codec
def getSignal: Int
def getUseDtx: Int
def getVbr: Int
def getVbrConstraint: Int
def hashCode(): Int

Definition Classes
AnyRef → Any
def isDTX(audio: Array[Byte]): Boolean

Test if the packet is an Opus DTX (silent) packet
Test if the packet is an Opus DTX (silent) packet
audio
Opus compressed packet
returns
True if it is a DTX packet

Definition Classes
OpusEncoder → Codec
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def reset: Int

Reset the underlying codec.
Reset the underlying codec.

Definition Classes
OpusEncoder → Codec
def setApplication(appl: Integer): Unit
def setBandWidth(bandwidth: Integer): Unit
def setBitRate(bitRate: Integer): Unit
def setComplexity(complexity: Integer): Unit
def setExpertFrameDuration(duration: Integer): Unit
def setForceChannels(forceChannels: Integer): Unit
def setInbandFec(useInbandFec: Integer): Unit
def setLsbDepth(depth: Integer = 16): Unit
def setMaxBandwidth(bandwidth: Integer): Unit
def setPacketLossPerc(packetLossPerc: Integer): Unit
def setPredictionDisable(disable: Integer): Unit
def setSignal(signal: Integer): Unit
def setUseDtx(useDtx: Integer): Unit
def setVbr(useVbr: Integer): Unit
def setVbrConstraint(cvbr: Integer): Unit
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object OpusEncoder | package opus

class OpusEncoder extends Encoder

Instance Constructors

new OpusEncoder(sampleFreq: SampleFrequency, channels: Int, app: Application, bufferSize: Int = 8192)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply(audio: Array[Float]): Try[Array[Byte]]

def apply(audio: Array[Short]): Try[Array[Byte]]

final def asInstanceOf[T0]: T0

var clean: Boolean

def cleanup(): Unit

def clone(): AnyRef

def complexity(c: Int): Encoder

val decodePtr: Array[Byte]

val encoder: Long

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val error: Array[Int]

final def finalize(): Unit

def getApplication: Int

def getBandwidth: Int

def getBitRate: Int

final def getClass(): Class[_]

def getComplexity: Int

def getDetail: String

def getExpertFrameDuration: Int

def getForceChannels: Int

def getInbandFec: Int

def getLookahead: Int

def getLsbDepth: Int

def getMaxBandwidth: Int

def getPacketLossPerc: Int

def getPredictionDisable: Int

def getSampleRate: Int

def getSignal: Int

def getUseDtx: Int

def getVbr: Int

def getVbrConstraint: Int

def hashCode(): Int

def isDTX(audio: Array[Byte]): Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def reset: Int

def setApplication(appl: Integer): Unit

def setBandWidth(bandwidth: Integer): Unit

def setBitRate(bitRate: Integer): Unit

def setComplexity(complexity: Integer): Unit

def setExpertFrameDuration(duration: Integer): Unit

def setForceChannels(forceChannels: Integer): Unit

def setInbandFec(useInbandFec: Integer): Unit

def setLsbDepth(depth: Integer = 16): Unit

def setMaxBandwidth(bandwidth: Integer): Unit

def setPacketLossPerc(packetLossPerc: Integer): Unit

def setPredictionDisable(disable: Integer): Unit

def setSignal(signal: Integer): Unit

def setUseDtx(useDtx: Integer): Unit

def setVbr(useVbr: Integer): Unit

def setVbrConstraint(cvbr: Integer): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Encoder

Inherited from Codec

Inherited from AnyRef

Inherited from Any

Ungrouped