Firelight Technologies FMOD Studio API

DSP::getOutputChannelFormat

Call the DSP process function to retrieve the output signal format for a DSP based on input values.

C++ Syntax

FMOD_RESULT DSP::getOutputChannelFormat(
  FMOD_CHANNELMASK inmask,
  int inchannels,
  FMOD_SPEAKERMODE inspeakermode,
  FMOD_CHANNELMASK *outmask,
  int *outchannels,
  FMOD_SPEAKERMODE *outspeakermode
);

C Syntax

FMOD_RESULT FMOD_DSP_GetOutputChannelFormat(
  FMOD_DSP *dsp,
  FMOD_CHANNELMASK inmask,
  int inchannels,
  FMOD_SPEAKERMODE inspeakermode,
  FMOD_CHANNELMASK *outmask,
  int *outchannels,
  FMOD_SPEAKERMODE *outspeakermode
);

C# Syntax

RESULT DSP.getOutputChannelFormat(
  CHANNELMASK inmask,
  int inchannels,
  SPEAKERMODE inspeakermode,
  out CHANNELMASK outmask,
  out int outchannels,
  out SPEAKERMODE outspeakermode
);

JavaScript Syntax

DSP.getOutputChannelFormat(
  inmask,                          
  inchannels,                      
  inspeakermode,                   
  outmask,                         // writes value to outmask.val
  outchannels,                     // writes value to outchannels.val
  outspeakermode                   // writes value to outspeakermode.val
);

Parameters

inmask

Channel bitmask representing the speakers enabled for the incoming signal. For example a 5.1 signal could have inchannels 2 that represent FMOD_CHANNELMASK_SURROUND_LEFT and FMOD_CHANNELMASK_SURROUND_RIGHT.

inchannels

Number of channels for the incoming signal.

inspeakermode

Speaker mode for the incoming signal.

outmask

Address of a variable to receive the DSP unit's output mask, based on the DSP units preference and settings.

outchannels

Address of a variable to receive the DSP unit's output channel count, based on the DSP units preference and settings.

outspeakermode

Address of a variable to receive the DSP unit's output speaker mode, based on the DSP units preference and settings.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

A DSP unit may be an up mixer or down mixer for example. In this case if you specified 6 in for a downmixer, it may provide you with 2 out for example.
Generally the input values will be reproduced for the output values, but some DSP units will want to alter the output format.

See Also

• DSP::getChannelFormat

Version 1.10.03 Built on Feb 1, 2018