Copyright © 2006 - 2008 MultiMedia Soft  Return to Table of contents

 

WAVEFORM_ANALYZER_SETTINGS class 

 

The WAVEFORM_ANALYZER_SETTINGS class describes the graphical settings applied to the Waveform Analyzer. The current settings can be retrieved through the WaveformAnalyzer.GetGraphicalSettings method and modified through the WaveformAnalyzer.SetGraphicalSettings method. 

 

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section. 

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section. 

 

C# definition 

 

public class WAVEFORM_ANALYZER_SETTINGS 

{ 

       public bool                    bAppearance3d; 

       public Color                   colorWaveLine; 

       public Color                   colorWaveBackground; 

       public Color                   colorWavePositionLine; 

       public Color                   colorWavePlaybackLine; 

       public Color                   colorRulersBackground; 

       public Color                   colorRulersLines; 

       public Color                   colorRulersText; 

       public Color                   colorScrollbarsBackground; 

       public Color                   colorScrollbarsThumb; 

       public bool                    bRulerAmplitudeVisibleLeft; 

       public bool                    bRulerAmplitudeVisibleRight; 

       public bool                    bRulerTimeVisibleTop; 

       public bool                    bRulerTimeVisibleBottom; 

       public bool                    bScrollbarVisibleTop; 

       public bool                    bScrollbarVisibleBottom; 

       public enumAnalyzerResolutions nResolution; 

       public float                   fZoomFactor; 

       public enumWaveformStereoModes nStereoVisualizationMode; 

       public enumWaveformLineModes   nWavePositionLineType; 

       public enumWaveformLineModes   nWavePlaybackLineType; 

       public bool                    bWavePlaybackLineVisible; 

};  

 

 

Picture A 

 

 

Picture B 

 

Member	Description
bAppearance3d	Boolean value that specifies if the Waveform Analyzer is displayed with 3D borders.    Supported values are the following:  Mnemonic constant Value Meaning False 0 Doesn't display 3D borders True 1 Displays 3D borders
colorWaveLine	Color used for rendering the waveform's line (see Picture A above).
colorWaveBackground	Color used for rendering the waveform's background (see Picture A above).
colorWavePositionLine	Color used for rendering the line that indicates a selected position on the waveform (see Picture A above).
colorWavePlaybackLine	Color used for rendering the line that indicates the playback position on the waveform during a playback session (see Picture A above).
colorRulersBackground	Color used for rendering the rulers background (see Picture A above).
colorRulersLines	Color used for rendering the rulers lines (see Picture A above).
colorRulersText	Color used for rendering the rulers texts (see Picture A above).
colorScrollbarsBackground	Color used for rendering the scrollbars background (see Picture A above).
colorScrollbarsThumb	Color used for rendering the scrollbars thumb (see Picture A above).
bRulerAmplitudeVisibleLeft	Boolean value that specifies if the left sound's amplitude ruler is visible. (see Picture B above)  Supported values are the following:  Mnemonic constant Value Meaning False 0 Doesn't display the left sound's amplitude ruler True 1 Displays the left sound's amplitude ruler
bRulerAmplitudeVisibleRight	Boolean value that specifies if the right sound's amplitude ruler is visible. (see Picture B above)  Supported values are the following:  Mnemonic constant Value Meaning False 0 Doesn't display the right sound's amplitude ruler True 1 Displays the right sound's amplitude ruler
bRulerTimeVisibleTop	Boolean value that specifies if the if the top time ruler is visible (see Picture B above)  Supported values are the following:  Mnemonic constant Value Meaning False 0 Doesn't display the top time ruler True 1 Displays the top time ruler
bRulerTimeVisibleBottom	Boolean value that specifies if the if the bottom time ruler is visible (see Picture B above)  Supported values are the following:  Mnemonic constant Value Meaning False 0 Doesn't display the bottom time ruler True 1 Displays the bottom time ruler
bScrollbarVisibleTop	Boolean value that specifies if the if the top scrollbar is visible (see Picture B above)  Supported values are the following:  Mnemonic constant Value Meaning False 0 Doesn't display the top scrollbar True 1 Displays bottom the top scrollbar
bScrollbarVisibleBottom	Boolean value that specifies if the if the bottom scrollbar is visible (see Picture B above)  Supported values are the following:  Mnemonic constant Value Meaning False 0 Doesn't display the bottom scrollbar True 1 Displays bottom the bottom scrollbar
nResolution	Resolution used for waveform's analysis.  Supported values are the following:  Mnemonic constant Numeric value Meaning WAVEANALYZER_RES_MINIMUM 100 Minimum resolution, faster calculation time. Each line on the analyzer is the average for 256 PCM samples. WAVEANALYZER_RES_VERY_LOW 101 Very low resolution. Each line on the analyzer is the average for 128 PCM samples. WAVEANALYZER_RES_LOW 102 Low resolution. Each line on the analyzer is the average for 64 PCM samples. WAVEANALYZER_RES_MIDDLE 103 Middle resolution. Each line on the analyzer is the average for 32 PCM samples. WAVEANALYZER_RES_HIGH 104 High resolution. Each line on the analyzer is the average for 16 PCM samples. WAVEANALYZER_RES_VERY_HIGH 105 Very high resolution. Each line on the analyzer is the average for 8 PCM samples. WAVEANALYZER_RES_MAXIMUM 106 Maximum resolution, slower calculation time. Each line on the analyzer is the average for 4 PCM samples.
fZoomFactor	Floating point value indicating the factor applied to zooming operations: by default the zoom factor is 2.0
nStereoVisualizationMode	Visualization mode used for displaying stereo sounds  Supported values are the following:  Mnemonic constant Numeric value Meaning STEREO_MODE_CHANNELS_BOTH 0 Right and left channels are displayed separately on two different panes as seen on the pictures A and B above. STEREO_MODE_CHANNELS_LEFT 1 Only the left channel content is displayed on a single pane STEREO_MODE_CHANNELS_RIGHT 2 Only the right channel content is displayed on a single pane STEREO_MODE_CHANNELS_MIXED 3 Right and left channels contents are mixed together and displayed on a single pane
nWavePositionLineType	Line mode used for rendering the line that indicates a selected position on the waveform.  Supported values are the following:  Mnemonic constant Numeric value Meaning LINE_MODE_DOTTED 0 Dotted line LINE_MODE_DASHED 1 Dashed line LINE_MODE_SOLID 2 Solid line
nWavePlaybackLineType	Line mode used for rendering the line that indicates the playback position on the waveform during a playback session.  Supported values are the following:  Mnemonic constant Numeric value Meaning LINE_MODE_DOTTED 0 Dotted line LINE_MODE_DASHED 1 Dashed line LINE_MODE_SOLID 2 Solid line
bWavePlaybackLineVisible	Boolean value that determines if the line that indicates the playback position is visible during a playback session.  Supported values are the following:  Mnemonic constant Value Meaning False 0 Doesn't display the position line during playback True 1 Displays the position line during playback

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Copyright © 2006 - 2008 MultiMedia Soft 

Return to Table of contents