Index

Modules: opussum, opussum/common, opussum/ctl, opussum/decoder, opussum/encoder, opussum/pcmdata.

API symbols

`$`:

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

adjustedVolume:

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

adjustVolume:

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

AllocFail:

• common: OpusErrorCodes.AllocFail

allowedSamplingRates:

• common: const allowedSamplingRates

Audio:

• common: OpusApplicationModes.Audio

BadArg:

• common: OpusErrorCodes.BadArg

bandwidthFull:

• ctl: const bandwidthFull

bandwidthMedium:

• ctl: const bandwidthMedium

bandwidthNarrow:

• ctl: const bandwidthNarrow

bandwidthSuperwide:

• ctl: const bandwidthSuperwide

bandwidthWide:

• ctl: const bandwidthWide

bitrateMax:

• ctl: const bitrateMax

BufferTooSmall:

• common: OpusErrorCodes.BufferTooSmall

checkRC:

• common: template checkRC(call: untyped)

checkSampleRate:

• common: template checkSampleRate(sampleRate: int32)

createDecoder:

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

createEncoder:

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

decode:

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

decodeFloat:

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

DecoderCTLGetter:

• ctl: type DecoderCTLGetter

DecoderCTLSetter:

• ctl: type DecoderCTLSetter

destroy:

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

encode:

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

encodeFloat:

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

EncoderCTLGetter:

• ctl: type EncoderCTLGetter

EncoderCTLSetter:

• ctl: type EncoderCTLSetter

GenericCTLGetter:

• ctl: type GenericCTLGetter

GenericCTLSetter:

• ctl: type GenericCTLSetter

getApplication:

• ctl: const getApplication

getBandwidth:

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

getBitrate:

• ctl: const getBitrate

getComplexity:

• ctl: const getComplexity

getDecoderSize:

• decoder: proc getDecoderSize(channels: cint): cint

getDtx:

• ctl: const getDtx

getEncoderSize:

• encoder: proc getEncoderSize(channels: cint): cint

getExpertFrameDuration:

• ctl: const getExpertFrameDuration

getFinalRange:

• ctl: const getFinalRange

getForceChannels:

• ctl: const getForceChannels

getGain:

• ctl: const getGain

getInbandFec:

• ctl: const getInbandFec

getInDTX:

• ctl: const getInDTX

getLastPacketDuration:

• ctl: const getLastPacketDuration

getLookahead:

• ctl: const getLookahead

getLsbDepth:

• ctl: const getLsbDepth

getMaxBandwidth:

• ctl: const getMaxBandwidth

getNumChannels:

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

getNumFrames:

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

getNumSamples:

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

getPacketLossPerc:

• ctl: const getPacketLossPerc

getPhaseInversionDisabled:

• ctl: const getPhaseInversionDisabled

getPitch:

• ctl: const getPitch

getPredictionDisabled:

• ctl: const getPredictionDisabled

getSampleRate:

• ctl: const getSampleRate

getSamplesPerFrame:

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

getSignal:

• ctl: const getSignal

getVbr:

• ctl: const getVbr

getVbrConstraint:

• ctl: const getVbrConstraint

init:

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

InternalError:

• common: OpusErrorCodes.InternalError

InvalidPacket:

• common: OpusErrorCodes.InvalidPacket

InvalidState:

• common: OpusErrorCodes.InvalidState

maxFrameSize:

• common: const maxFrameSize

maxPacketSize:

• common: const maxPacketSize

OpaqueOpusObject:

• common: object OpaqueOpusObject

OpusApplicationModes:

• common: enum OpusApplicationModes

opusAuto:

• ctl: const opusAuto

opusCreateDecoder:

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

opusCreateEncoder:

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

OpusDecoder:

• decoder: type OpusDecoder

OpusDecoderRaw:

• decoder: object OpusDecoderRaw

OpusEncoder:

• encoder: type OpusEncoder

OpusEncoderRaw:

• encoder: object OpusEncoderRaw

OpusError:

• common: object OpusError

OpusErrorCodes:

• common: enum OpusErrorCodes

OpusFrame:

• common: type OpusFrame

opusInt:

• common: type opusInt

opusInt16:

• common: type opusInt16

opusInt32:

• common: type opusInt32

opusInt64:

• common: type opusInt64

opusInt8:

• common: type opusInt8

opusLib:

• common: const opusLib

opusUInt:

• common: type opusUInt

opusUint64:

• common: type opusUint64

opusUInt8:

• common: type opusUInt8

opusVersionString:

• common: proc opusVersionString(): cstring

packetSize:

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

PCMData:

• pcmdata: type PCMData

pcmSoftClip:

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

performCTL:

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

reset:

• ctl: proc reset(coder: Coder)

resetState:

• ctl: const resetState

RestrictedLowDelay:

• common: OpusApplicationModes.RestrictedLowDelay

setApplication:

• ctl: const setApplication

setBandwidth:

• ctl: const setBandwidth

setBitrate:

• ctl: const setBitrate

setComplexity:

• ctl: const setComplexity

setDtx:

• ctl: const setDtx

setExpertFrameDuration:

• ctl: const setExpertFrameDuration

setForceChannels:

• ctl: const setForceChannels

setGain:

• ctl: const setGain

setInbandFec:

• ctl: const setInbandFec

setLsbDepth:

• ctl: const setLsbDepth

setMaxBandwidth:

• ctl: const setMaxBandwidth

setPacketLossPerc:

• ctl: const setPacketLossPerc

setPhaseInversionDisabled:

• ctl: const setPhaseInversionDisabled

setPredictionDisabled:

• ctl: const setPredictionDisabled

setSignal:

• ctl: const setSignal

setVbr:

• ctl: const setVbr

setVbrConstraint:

• ctl: const setVbrConstraint

toPCMData:

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

Unimplemented:

• common: OpusErrorCodes.Unimplemented

Voip:

• common: OpusApplicationModes.Voip