Firelight Technologies FMOD Studio API

ChannelGroup::getDelay

Retrieves a start (and/or stop) time relative to the parent channel group DSP clock, with sample accuracy.

C++ Syntax

FMOD_RESULT ChannelGroup::getDelay(
  unsigned long long *dspclock_start,
  unsigned long long *dspclock_end,
  bool *stopchannels
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetDelay(
  FMOD_CHANNELGROUP *channelgroup,
  unsigned long long *dspclock_start,
  unsigned long long *dspclock_end,
  FMOD_BOOL *stopchannels
);

C# Syntax

RESULT ChannelGroup.getDelay(
  out ulong dspclock_start,
  out ulong dspclock_end,
  out bool stopchannels
);

JavaScript Syntax

ChannelGroup.getDelay(
  dspclock_start,                  // writes value to dspclock_start.val
  dspclock_end,                    // writes value to dspclock_end.val
  stopchannels                     // writes value to stopchannels.val
);

Parameters

dspclock_start

Address of a variable that receives the DSP clock of the parent channel group to audibly start playing sound at. Optional, specify 0 or NULL to ignore.

dspclock_end

Address of a variable that receives the DSP clock of the parent channel group to audibly stop playing sound at. Optional, specify 0 or NULL to ignore.

stopchannels

Address of a variable that receives TRUE = stop according to ChannelControl::isPlaying. FALSE = remain 'active' and a new start delay could start playback again at a later time. Optional, specify 0 or NULL to ignore.

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.

See Also

• ChannelControl::setDelay
• ChannelControl::getDSPClock
• ChannelControl::isPlaying

Version 1.10.03 Built on Feb 1, 2018