就业培训     下载中心     Wiki     联络 登录   注册

---

// use selected sound file const DescLevel soundTrackID = DescLevel ( CTsound , CTsound , 0); CTrack * const soundTrack = CTrack::Alloc (soundEffector, soundTrackID); if (soundTrack == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION ); soundTrack-> SetParameter ( CID_SOUND_NAME , soundFile, DESCFLAGS_SET::NONE ); soundTrack-> SetName ( "New Sound Track" _s); soundEffector-> InsertTrackSorted (soundTrack);

// set track active sound track GeData data; soundEffector-> GetParameter ( MGSOUNDEFFECTOR_GADGET , data, DESCFLAGS_GET::NONE ); MAXON_SCOPE { CustomDataType * const customData = data. GetCustomDataType ( CUSTOMDATATYPE_SOUNDEFFECTOR ); SoundEffectorData * const soundData = static_cast< SoundEffectorData * > (customData); if (soundData == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); soundData-> SetActiveSoundTrack (soundTrack, doc); soundEffector-> SetParameter ( MGSOUNDEFFECTOR_GADGET , data, DESCFLAGS_SET::NONE ); }

Access

The SoundEffectorData is typically used with the "Sound" MoGraph effector. An instance of this class is obtained from this object. The parameter ID is defined in oesound.h .

Allocation/Deallocation

A SoundEffectorData object can be created with the usual tools, see Entity Creation and Destruction Manual (Classic) .

• SoundEffectorData::Alloc() : Creates a new SoundEffectorData 对象。
• SoundEffectorData::Free() : Deletes the given SoundEffectorData 对象。

Sound

A SoundEffectorData is referencing a CTrack of the type CTsound . The sound file used in that CTrack is the sound file used by a SoundEffectorData , which is sampled and displayed in the Attribute Manager.

• SoundEffectorData::GetActiveSoundTrack() : Returns the active CTrack .
• SoundEffectorData::SetActiveSoundTrack() : Sets the active CTrack .

另请参阅 CTrack Manual .

// get used sound track CTrack * const track = soundData-> GetActiveSoundTrack (doc); if (track) { const DescID id = track-> GetDescriptionID ();

// check if the track is a sound track if ( id [0]. id == CTsound ) { // get file name GeData parameterData; track-> GetParameter ( CID_SOUND_NAME , parameterData, DESCFLAGS_GET::NONE ); const Filename soundFile = parameterData. GetFilename (); const String soundFileStr = soundFile. GetString (); ApplicationOutput ( "Sound File: " + soundFileStr); } }

Probes

One or many probes can be used to sample the sound file. Such probes are edited with these functions:

• SoundEffectorData::CreateProbe() : Creates a new probe and returns its index.
• SoundEffectorData::CreateDefaultProbe() : Creates the default probe.
• SoundEffectorData::GetProbeCount() : Returns the number of probes.
• SoundEffectorData::GetProbe() ：返回 Probe of the given index.
• SoundEffectorData::DeleteProbe() : Deletes the probe of the given index.
• SoundEffectorData::UpdateProbeOrder() : Updates the probe order. Must be called after any change to a probe position.

A probe is represented with the Probe class. The "left" and "right" position is defined in Hz, the top and bottom values as a normalized scalar defined between 0.0 and 1.0.

• Probe::GetRight() : Returns the right value.
• Probe::SetRight() : Sets the right value.
• Probe::GetLeft() : Returns the left value.
• Probe::SetLeft() : Sets the left value.
• Probe::GetBottom() : Returns the bottom value.
• Probe::SetBottom() : Sets the bottom value.
• Probe::GetTop() : Returns the top value.
• Probe::SetTop() : Sets the top value.
• Probe::ValidateDimensions() : Swaps the left/right and top/bottom values if they are inverted.

The Probe class also has these public attributes:

• Probe::_clamp : Clamps the output from 0.0 to 1.0.
• Probe::_colorMode : The color mode (Default, Custom Color, Custom 渐变 ).
• Probe::_samplingMode : The sampling mode (Peak, Average, Step).
• Probe::_strength : Overall strength multiplier.
• Probe::_color : Color for the "Custom Color" mode.
• Probe::_gradient : 渐变 for the "Custom Gradient" mode.
• Probe::_fadePercentage : Fade percentage for decay.
• Probe::_freeze : Freeze state of the output.
• Probe::_freezeArray : Freeze value of the output.

数据

Additional settings allow to define the range of the frequency spectrum that is currently displayed in the Attribute Manager. These range functions are only valid if the sound data is displayed using the SoundDataCustomGui (e.g. in the Attribute Manager).

• SoundEffectorData::GetRange() : Returns the currently displayed range.
• SoundEffectorData::SetRange() : Sets the currently displayed range.

Further functions are:

• SoundEffectorData::GetLinLog() : Returns the blend value of the linear/logarithmic slider.
• SoundEffectorData::SetLinLog() : Sets the blend value of the linear/logarithmic slider.
• SoundEffectorData::GetFreeze() : Returns the freeze state.
• SoundEffectorData::SetFreeze() : Sets the freeze state.

The color used to colorize the sound is defined by a 渐变 :

• SoundEffectorData::GetGradient() : Returns the global 渐变 .
• SoundEffectorData::GetGradientDirection() : Returns the gradient direction.
• SoundEffectorData::SetGradientDirection() : Sets the gradient direction.

采样

The SoundEffectorData class can be used to sample a sound file. The sound file that is sampled is defined with the active CTrack (见 Sound ).

• SoundEffectorData::IsFFTSamplingCacheDirty() : Returns true if the cache is up-to-date.
• SoundEffectorData::InitSampling() : Initializes the sampling functionality.
• SoundEffectorData::Sample() : Samples the sound file at the current frame.
• SoundEffectorData::SampleArray() : Samples whole array of elements simultaneously.
• SoundEffectorData::FreeSampling() : Frees the memory used for sampling.

注意

The sound data is sampled using the existing probes and their settings.

拷贝

The settings of a given SoundEffectorData object can be copied with:

• SoundEffectorData::CopyTo() : Copies the sound data into the given SoundEffectorData .

延伸阅读

• MoGraph 概述
• CTrack Manual
• CustomDataType