Index

API symbols

`$`:

• pcmdata: `$`(pcm: PCMData): string

adjustedVolume:

• pcmdata: adjustedVolume(pcm: PCMData; mul: float): PCMData

adjustVolume:

• pcmdata: adjustVolume(pcm: var PCMData; mul: float)

AllocFail:

• OpusErrorCodes.AllocFail

allowedSamplingRates:

• common: allowedSamplingRates

Audio:

• OpusApplicationModes.Audio

BadArg:

• OpusErrorCodes.BadArg

bandwidthFull:

• ctl: bandwidthFull

bandwidthMedium:

• ctl: bandwidthMedium

bandwidthNarrow:

• ctl: bandwidthNarrow

bandwidthSuperwide:

• ctl: bandwidthSuperwide

bandwidthWide:

• ctl: bandwidthWide

bitrateMax:

• ctl: bitrateMax

BufferTooSmall:

• OpusErrorCodes.BufferTooSmall

checkRC:

• common: checkRC(call: untyped)

checkSampleRate:

• common: checkSampleRate(sampleRate: int32)

createDecoder:

• decoder: createDecoder(sampleRate: int32; channels: range[1 .. 2]; frameSize: int): OpusDecoder

createEncoder:

• encoder: createEncoder(sampleRate: int32; channels: range[1 .. 2]; frameSize: int; application: OpusApplicationModes): OpusEncoder

decode:

• decoder: decode(decoder: OpusDecoder; encoded: OpusFrame; errorCorrection: bool = false): PCMData
• decoder: decode(st: ptr OpusDecoderRaw; data: ptr uint8; len: opusInt32; pcm: ptr opusInt16; frame_size, decodeFec: cint): cint

decodeFloat:

• decoder: decodeFloat(st: ptr OpusDecoderRaw; data: ptr uint8; len: opusInt32; pcm: ptr cfloat; frame_size, decodeFec: cint): cint

DecoderCTLGetter:

• ctl: DecoderCTLGetter

DecoderCTLSetter:

• ctl: DecoderCTLSetter

destroy:

• decoder: destroy(str: ptr OpusDecoderRaw)
• encoder: destroy(st: ptr OpusEncoderRaw)

encode:

• encoder: encode(encoder: OpusEncoder; data: PCMData): OpusFrame
• encoder: encode(st: ptr OpusEncoderRaw; data: ptr opusInt16; frameSize: cint; outData: ptr uint8; maxBytes: opusInt32): opusInt32

encodeFloat:

• encoder: encodeFloat(st: ptr OpusEncoderRaw; pcm: ptr cfloat; frameSize: cint; outData: ptr uint8; maxBytes: opusInt32)

EncoderCTLGetter:

• ctl: EncoderCTLGetter

EncoderCTLSetter:

• ctl: EncoderCTLSetter

GenericCTLGetter:

• ctl: GenericCTLGetter

GenericCTLSetter:

• ctl: GenericCTLSetter

getApplication:

• ctl: getApplication

getBandwidth:

• ctl: getBandwidth
• decoder: getBandwidth(data: ptr uint8): cint

getBitrate:

• ctl: getBitrate

getComplexity:

• ctl: getComplexity

getDecoderSize:

• decoder: getDecoderSize(channels: cint): cint

getDtx:

• ctl: getDtx

getEncoderSize:

• encoder: getEncoderSize(channels: cint): cint

getExpertFrameDuration:

• ctl: getExpertFrameDuration

getFinalRange:

• ctl: getFinalRange

getForceChannels:

• ctl: getForceChannels

getGain:

• ctl: getGain

getInbandFec:

• ctl: getInbandFec

getInDTX:

• ctl: getInDTX

getLastPacketDuration:

• ctl: getLastPacketDuration

getLookahead:

• ctl: getLookahead

getLsbDepth:

• ctl: getLsbDepth

getMaxBandwidth:

• ctl: getMaxBandwidth

getNumChannels:

• decoder: getNumChannels(data: ptr uint8): cint

getNumFrames:

• decoder: getNumFrames(packet: ptr uint8; len: opusInt32): cint

getNumSamples:

• decoder: getNumSamples(decoder: OpusDecoder; packet: seq[uint8]): int
• decoder: getNumSamples(dec: ptr OpusDecoderRaw; packet: ptr uint8; len: opusInt32): cint
• decoder: getNumSamples(packet: ptr uint8; len, fs: opusInt32): cint

getPacketLossPerc:

• ctl: getPacketLossPerc

getPhaseInversionDisabled:

• ctl: getPhaseInversionDisabled

getPitch:

• ctl: getPitch

getPredictionDisabled:

• ctl: getPredictionDisabled

getSampleRate:

• ctl: getSampleRate

getSamplesPerFrame:

• decoder: getSamplesPerFrame(data: ptr uint8; fs: opusInt32): cint

getSignal:

• ctl: getSignal

getVbr:

• ctl: getVbr

getVbrConstraint:

• ctl: getVbrConstraint

init:

• encoder: init(st: ptr OpusEncoderRaw; fs: opusInt32; channels, application: cint): cint

InternalError:

• OpusErrorCodes.InternalError

InvalidPacket:

• OpusErrorCodes.InvalidPacket

InvalidState:

• OpusErrorCodes.InvalidState

maxFrameSize:

• common: maxFrameSize

maxPacketSize:

• common: maxPacketSize

OpaqueOpusObject:

• common: OpaqueOpusObject

OpusApplicationModes:

• common: OpusApplicationModes

opusAuto:

• ctl: opusAuto

opusCreateDecoder:

• decoder: opusCreateDecoder(fs: opusInt32; channels: cint; error: ptr cint): ptr OpusDecoderRaw

opusCreateEncoder:

• encoder: opusCreateEncoder(fs: opusInt32; channels, application: cint; error: ptr cint): ptr OpusEncoderRaw

OpusDecoder:

• decoder: OpusDecoder

OpusDecoderRaw:

• decoder: OpusDecoderRaw

OpusEncoder:

• encoder: OpusEncoder

OpusEncoderRaw:

• encoder: OpusEncoderRaw

OpusError:

• common: OpusError

OpusErrorCodes:

• common: OpusErrorCodes

OpusFrame:

• common: OpusFrame

opusInt:

• common: opusInt

opusInt16:

• common: opusInt16

opusInt32:

• common: opusInt32

opusInt64:

• common: opusInt64

opusInt8:

• common: opusInt8

opusLib:

• common: opusLib

opusUInt:

• common: opusUInt

opusUint64:

• common: opusUint64

opusUInt8:

• common: opusUInt8

opusVersionString:

• common: opusVersionString(): cstring

packetSize:

• common: packetSize[T](obj: OpaqueOpusObject[T]): int

PCMData:

• pcmdata: PCMData

pcmSoftClip:

• decoder: pcmSoftClip(pcm: ptr cfloat; frameSize, channels: cint; softclipMem: ptr float)

performCTL:

• ctl: performCTL(coder: Coder; getter: CTLGetter): cint
• ctl: performCTL(coder: Coder; setter: CTLSetter; val: int32)
• decoder: performCTL(st: ptr OpusDecoderRaw; request: cint): cint
• decoder: performCTL(st: ptr OpusDecoderRaw; request: cint; param: ptr cint): cint
• encoder: performCTL(st: ptr OpusEncoderRaw; request: cint): cint
• encoder: performCTL(st: ptr OpusEncoderRaw; request: cint; param: ptr cint): cint

reset:

• ctl: reset(coder: Coder)

resetState:

• ctl: resetState

RestrictedLowDelay:

• OpusApplicationModes.RestrictedLowDelay

setApplication:

• ctl: setApplication

setBandwidth:

• ctl: setBandwidth

setBitrate:

• ctl: setBitrate

setComplexity:

• ctl: setComplexity

setDtx:

• ctl: setDtx

setExpertFrameDuration:

• ctl: setExpertFrameDuration

setForceChannels:

• ctl: setForceChannels

setGain:

• ctl: setGain

setInbandFec:

• ctl: setInbandFec

setLsbDepth:

• ctl: setLsbDepth

setMaxBandwidth:

• ctl: setMaxBandwidth

setPacketLossPerc:

• ctl: setPacketLossPerc

setPhaseInversionDisabled:

• ctl: setPhaseInversionDisabled

setPredictionDisabled:

• ctl: setPredictionDisabled

setSignal:

• ctl: setSignal

setVbr:

• ctl: setVbr

setVbrConstraint:

• ctl: setVbrConstraint

toPCMData:

• pcmdata: toPCMData(data: sink string; frameSize, channels: int): PCMData
• pcmdata: toPCMData[T](data: sink string; opus: OpaqueOpusObject[T]): PCMData

Unimplemented:

• OpusErrorCodes.Unimplemented

Voip:

• OpusApplicationModes.Voip