COM API - Control Functions

 

以下の各機能はアナライザーをコントロールするために使われます。


 

Analyzer Operations（アナライザー操作）

 

Run()

アナライザーをランするか、レコーディングを開始します

Parameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

Stop()

アナライザーもしくはレコーディングを停止します

Parameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

Record()

レコーディングを開始します

Parameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

RecordPause()

レコーディングをポーズします。アナライザーは動作を継続しますが、データはWAVファイルに保存されますParameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

RecordResume()

ポーズしたレコーディングを再開します

Parameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

FileStep( int numFFTSteps )

現在のファイル位置で指定した回数のFFTを実行します(Post-Processモードのみ)

Parameters: numFFTSteps: 1 or more

Return: S_OK = success, E_FAIL = unsuccessful



▲

 

 

Analyzer Configuration（アナライザー構成）

 

SetMode( long mode )

モードをセットします

Parameters: mode: 0 = Real-Time, 1 = Recorder, 2 = Post-Process

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

ChannelEnable( long channel )

有効チャンネルを指定します

Parameters: channel = 0 - 15

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

ChannelDisable( long channel )

無効にするチャンネルを指定します

Parameters: channel = 0 - 15

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

RecordEnable( long channel )

レコーディングするチャンネルを指定します(前述ChannelEnable()で有効にしておかなければなりません)

Parameters: channel = 0 - 15

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

RecordEnable( long channel )

指定したチャンネルのレコーディングを無効にします

Parameters: channel = 0 - 15

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

LoadConfig( BSTR cfg_filename )

指定した定義ファイル(.cfg)をロードします

Parameters: cfg_filename = filename of the configuration file.  Full path or just filename if file located in /cfg folder

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

SaveConfig( BSTR cfg_filename )

現在の設定値を指定した定義ファイル(.cfg)に保存します

Parameters: cfg_filename = filename of the configuration file. 

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

SetAverageSize( long channel, long size)

指定したチャンネルにアベレージサイズをセットします

Parameters: channel = 0 - 15; size = average size 1 - 10000 (free run mode), 0 = Off, 1 = Fast, 2 = Medium, 3 = Slow, 4 = Forever (SLM mode)

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

ResetAverage( long channel)

指定したチャンネルのアベレージ値をリセットします

Parameters: channel = 0 - 15

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

SetPeakHold( long channel_ext, long peak_hold_type )

指定したチャンネルのピークホールドタイプをセットします

Parameters: channel_ext = 0 - 15 for main channels, 16 - 31 for composite channels; peak_hold_type: 0 = Off, 1 = Fast, 2 = Medium, 3 = Slow, 4 = Forever

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

ResetPeakHold( long channel_ext )

指定したチャンネルのピークホールドをリセットします

Parameters: channel_ext = 0 - 15 for main channels, 16 - 31 for composite channels

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

SetOverlapPercentage( long channel, long overlap_percent )

指定したチャンネルのoverlap percentage値をセットします

Parameters: channel = 0 - 15; overlap_percent = 1 - 99

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

SetCompensationFile( long channel, BSTR comp_filename )

指定したチャンネルのtransducer compensation ファイルをセットします

Parameters: channel = 0 - 15; comp_filename = filename of the transducer file. 

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

SetMarkerFreq( long channel_ext, long marker, float freqHz )

指定したチャンネルのマーカに周波数をセットします

Parameters: channel_ext = 0 - 15 for main channels, 16 - 31 for composite channels; marker = 1 - 8, freqHz = frequency in Hz

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

ResetOverloadCount( )

すべてのチャンネルのオーバーロード検知をリセットします

Parameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

DataLoggingEnable()

data loggingを有効にします

Parameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

DataLoggingDisable()

data loggingを無効にします

Parameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

LoadCalibrationFile( long channel, BSTR cal_filename )

指定したチャンネルのキャリブレーションファイル(.cal)をロードします

Parameters: channel = 0 - 15; cal_filename = filename of the calibration file. 

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

SaveCalibrationFile( long channel, BSTR cal_filename )

指定したチャンネルのキャリブレーションファイル(.cal)を保存します

Parameters: channel = 0 - 15; cal_filename = filename of the calibration file. 

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter



Calibration Commands

　LoadCalibrationFile( long channel, BSTR filename )
　　指定されたチャネルのキャリブレーションファイルをロードしますParameters: channel: 0 = Left, 1 = Right; filename = the filename of the calibration file
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
   　Note: 短いファイル名を使用すると、<File><Set Paths>ダイアログボックスにリストされているキャリブレーションパスに保存されます
　
　CalibrateToExternalSource( long channel, float source_level )
     指定されたチャネルで校正測定を実行します
     Parameters: channel: 0 = Left, 1 = Right; source_level = value to calibrate to (SPL example: 94.0). 
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

   Notes: 外部ソースにキャリブレーションするには、キャリブレーションオプションを使用している必要があります
   以下の条件が満たされるまで測定を継続します：
         1) 測定された信号レベルは、+ /-0.1ミリボルト以内で安定。 これは、一般的なマイク感度で約+/- 0.03dBです
         2) 測定された信号レベルは、元の値の12％以内。 これは約+/- 1dBです
   これらの条件の両方が60秒以内に満たされない場合、測定は停止し、E_FAILエラーが発生します。 これらの条件により、セトリングが完了し、
　マイクキャリブレータがオンになり、正しいマイクとチャンネルが使用されることが保証されます

   CalibrateToZeroDBr( long channel, float freqiemcy )
     選択した周波数でキャリブレーションを0.0dBrに設定します
     Parameters: channel: 0 = Left, 1 = Right; frequency = frequency at which the resulting calibration will become 0.0 dBr
     Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

  SaveCalibrationFile( long channel, BSTR cal_filename )
    指定したチャネルのキャリブレーションファイルを保存します
    Parameters: channel: 0 = Left, 1 = Right; cal_filename = filename of the calibration file. 
    Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
    Note: 短いファイル名を使用すると、<File><Set Paths> ダイアログボックスにリストされているCalパスに保存されます
   
    ▲

Plot and Window Commands

  OpenPlot( long channel, long plot_type )
    指定されたチャネルのプロットを開きます
    Parameters: channel: 0 = Left, 1 = Right.
                      plot_type: 1 = Time Series, 2 = Spectrum, 3 = Phase, 4 = Spectrogram, 5 = 3-D Surface
    Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

  ClosePlot( long channel, long plot_type )
    指定されたチャネルのプロットを閉じます
    Parameters: channel: 0 = Left, 1 = Right.
                      plot_type: 1 = Time Series, 2 = Spectrum, 3 = Phase, 4 = Spectrogram, 5 = 3-D Surface
   Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

  MinimizeApplication( )
    アプリケーションウィンドウ全体をアイコンに最小化する
    Return: S_OK = success, E_FAIL = unsuccessful

  MaximizeApplication( )
    画面上のアプリケーションウィンドウ全体を最大化する
    Return: S_OK = success, E_FAIL = unsuccessful

  RestoreApplication( )
    アプリケーションを以前のサイズに復元します
    Return: S_OK = success, E_FAIL = unsuccessful

  HideApplication( )
    アプリケーションウィンドウ全体とアイコンを非表示にします
    Return: S_OK = success, E_FAIL = unsuccessful

  ShowApplication( )
    アプリケーションウィンドウ全体とアイコンを表示します（HideApplication（）から復元）
    Return: S_OK = success, E_FAIL = unsuccessful

  ClearSpectrum( long channel_ext )
    指定されたチャネルのスペクトルデータをクリアします
    Parameters: channel_ext: 0 = Left, 1 = Right, 2 = Composite, 3 = Coherence.
    Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
    Note: コンポジットチャネル=デュアルチャネル操作（L＆R平均、伝達関数、またはクロススペクトル）

  ClearPeakHoldSpectrum( long channel_ext )
    指定されたチャネルのピークホールドスペクトルデータをクリアします
    Parameters: channel_ext: 0 = Left, 1 = Right, 2 = Composite, 3 = Coherence.
    Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
    Note: コンポジットチャネル=デュアルチャネル操作（L＆R平均、伝達関数、またはクロススペクトル）

　SetSpectrumPlotFrequencySpan( long channel_ext, float startHz, float stopHz )
　   指定されたチャネルのスペクトルプロットに表示される周波数スパンを設定します
　   Parameters: channel_ext: 0 = Left, 1 = Right, 2 = Composite, 3 = Coherence.
  　 startHz = start frequency, stopHz = stop frequency
  　 Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
  　Note: コンポジットチャネル=デュアルチャネル操作（L＆R平均、伝達関数、またはクロススペクトル）

　SetSpectrumPlotTop( long channel_ext, float plot_top )
   　指定されたチャネルのスペクトルプロットのアンプリチュードプロットトップ値を設定します
   　Parameters: channel_ext: 0 = Left, 1 = Right, 2 = Composite, 3 = Coherence.
                      plot_top = plot top value
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
   　Note: コンポジットチャネル=デュアルチャネル操作（L＆R平均、伝達関数、またはクロススペクトル）

　SetSpectrumPlotRange( long channel_ext, float plot_range )
   　指定されたチャネルのスペクトルプロットのアンプリチュードプロットレンジ値を設定します
  　 Parameters: channel_ext: 0 = Left, 1 = Right, 2 = Composite, 3 = Coherence.
                      plot_range = plot range value
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
   　Note: コンポジットチャネル=デュアルチャネル操作（L＆R平均、伝達関数、またはクロススペクトル）

　SetSpectrumPlotGraphType( long channel_ext, long graph_type )
   　指定したチャネルのスペクトルプロットグラフタイプを設定します
   　Parameters: channel_ext: 0 = Left, 1 = Right, 2 = Composite, 3 = Coherence.
        graph_type: 0 = Line, 1= Bars, 2 = Stepped Bars
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
   　Note: コンポジットチャネル=デュアルチャネル操作（L＆R平均、伝達関数、またはクロススペクトル）

　SetTimeSeriesPlotTimeSpan(  float start_time, float stop_time )
   　TimeSeriesプロットに表示されるスパンを設定します
   　Parameters: start_time, stop_time = time span to display 
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

　WritePlotToBitmapFile( long channel_ext, long plot_type, BSTR bmp_filename )
  　 プロット画像をビットマップファイルに保存します
　　Parameters: channel_ext: 0 = Left, 1 = Right, 2
                      plot_type: 1 = Time Series, 2 = Spectrum, 3 = Phase, 4 = Spectrogram, 5 = 3-D Surface
                      bmp_filename = full filename and path to store bitmap
  　 Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

    ▲

Overlay Control

　SetOverlay( long channel_ext, long overlay_index, int create_from_peak_hold, BSTR szLegend)
   　現在のスペクトルデータからオーバーレイを作成します
   　Parameters: channel_ext: 0 = Left, 1 = Right, 2
                      overlay_index = 1 - 14
                      create_from_peak_hold = 1 to create the overlay from the peak hold values (peak hold must be enabled)
                      szLegend = legend to apply to overlay                     
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

　ShowOverlay( long channel_ext, long overlay_index)
   　指定されたオーバーレイを表示します
   　Parameters: channel_ext: 0 = Left, 1 = Right, 2
                      overlay_index = 1 - 14
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

　HideOverlay( long channel_ext, long overlay_index)
    指定されたオーバーレイを非表示にします
    Parameters: channel_ext: 0 = Left, 1 = Right, 2
                      overlay_index = 1 - 14
    Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

  SaveOverlay( long channel_ext, long overlay_index, BSTR ovl_filename)
    オーバーレイをファイルに保存します
    Parameters: channel_ext: 0 = Left, 1 = Right, 2
                      overlay_index = 1 - 14
                      ovl_filename = name of the overlay file.
    Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
    Note: If a short filename is used, it will store in the Overlay path as listed in the <File><Set Paths> dialog box.

  LoadOverlay( long channel_ext, long overlay_index, BSTR ovl_filename)
    ファイルからオーバーレイをロードします
    Parameters: channel_ext: 0 = Left, 1 = Right, 2
                      overlay_index = 1 - 14
                      ovl_filename = name of the overlay file to load
    Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
    Note: 短いファイル名が使用されている場合、<File><Set Paths>ダイアログボックスに表示されているオーバーレイパスからロードされます


File Management（ファイル操作） 

 

FileOpen( long channel, BSTR wav_filename)

指定したチャンネルでWAVファイルを開きます 

Parameters: channel = 0 - 15; wav_filename = full path to wave file

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FileSave( long channel, BSTR wav_filename)

指定したチャンネルのWAVファイルを保存します 

Parameters: channel = 0 - 15; wav_filename = full path to wave file

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FileClose( long channel ) 

指定したチャンネルのWAVファイルを閉じます

Parameters: channel = 0 - 15

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

 

File Positioning（ファイル位置コントロール）

 

FileRewind( long channel )

指定したチャンネルのWAVファイルの頭（スタート位置）に移動します

Parameters: channel = 0 - 15

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FileForward( long channel )

指定したチャンネルのWAVファイルの最終端（ストップ位置）に移動します

Description: Go to the end of the wave file on the specified channel

Parameters: channel = 0 - 15

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FileGoToTime( long channel, float seconds)

指定したチャンネルのWAVファイルの指定時間に移動します

Parameters: channel = 0 - 15; seconds = file position in seconds

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FileGoToSample( long channel, unsigned long sample)

指定したチャンネルのサンプル位置に移動します

Description: Go to a sample position on the specified channel

Parameters: channel = 0 - 15; sample = file position in samples

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

▲

 

File Post-Process（ファイルの後処理）

 

FilePlaySegmentTime( long channel, float start_seconds, float stop_seconds)

指定したチャンネルの指定したタイムセグメントを再生します

Parameters: channel = 0 - 15; start_seconds = segment start time; stop_seconds = segment stop time

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FilePlaySegmentSample( long channel, unsigned long start_sample, unsigned long stop_sample)

指定したチャンネルの指定したサンプルを再生します

Parameters: channel = 0 - 15; start_sample = segment start sample position; stop_sample = segment stop sample position

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FileFilterSegmentTime( long channel, float start_seconds, float stop_seconds)

指定したチャンネルの指定したタイムセグメントをフィルタ処理します

Parameters: channel = 0 - 15; start_seconds = segment start time; stop_seconds = segment stop time

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FileFilterSegmentSample( long channel, unsigned long start_sample, unsigned long stop_sample)

指定したチャンネルの指定したサンプルをフィルタ処理します

Description: Filter the specified time segment for the selected channel

Parameters: channel = 0 - 15; start_sample = segment start sample position; stop_sample = segment stop sample position

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FileProcessSegmentTime( long channel, float start_seconds, float stop_seconds)

指定したチャンネルの指定したタイムセグメントにスペクトラデータを処理します

Parameters: channel = 0 - 15; start_seconds = segment start time; stop_seconds = segment stop time

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

FileProcessSegmentSample( long channel, unsigned long start_sample, unsigned long stop_sample)

指定したチャンネルの指定したサンプルにスペクトラデータを処理します

Description: Process the spectral data for the specified time segment for the selected channel

Parameters: channel = 0 - 15; start_sample = segment start sample position; stop_sample = segment stop sample position

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

 

Signal Generation（シグナルジェネレータ）

 

RunGenerator()

シグナルジェネレータをスタートします

Parameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

StopGenerator()

シグナルジェネレータをストップします

Parameters: none

Return: S_OK = success, E_FAIL = unsuccessful

 

SetGeneratorSignalType( long channel_sig, long signal_type )

指定したチャンネルに信号のフォーム/タイプをセットします

Parameters: channel = 0 - 1; signal_type - as follows:

         0 = White Noise

         1 = Pink Noise

         2 = Noise Burst

         3 = 1 kHz Tone

         4 = Multiple Tones

         5 = Tone Burst

         6 = IMD Tones

         7 = Freq Sweep

         8 = Level Sweep

         9 = Sawtooth

        10 = Triangular

        11 = Pulse

        12 = Squarewave

        13 = User Defined wave file

        14 = DTMF

        15 = Digital Zero

        16 = Frequency Step

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

 

SetGeneratorLevel( long channel_sig, float volts )

指定したチャンネルの信号レベルをセットします

Parameters: channel = 0 - 1; volts = rms voltage level 

Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter

Note: このコマンドを使用すると、出力単位がボルトに変わります


   SetGeneratorFreq( long channel_sig, float freqHz )
     シグナルタイプをマルチトーンに設定し、指定された周波数で1つのトーンのみを有効にします。 マルチトーンのレベルは 0 dBFS に設定されます

　　　（出力レベルを設定するには SetGeneratorLeve() を使用します）
　　Parameters: channel_sig = 0 - 1; freqHz = frequency in Hz
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
   　Note: このコマンドを使用すると、信号の種類が Multiple Tones に変更されます


　LoadGeneratorMultiToneFile( long channel_sig, BSTR toneFilename )
　　　ディスクから.tonesファイルをロードします-これにより、トーンのセットを変更できます
   　Parameters: channel_sig = 0 - 1; toneFilename = name of .tones file
   　Return: S_OK = success, E_FAIL = unsuccessful, E_INVALIDARG = invalid parameter
   　Note: このコマンドを使用すると、信号の種類が Multiple Tones に変更されます



Digital Input and Output Lines

SpectraDAQ-200ハードウェアモジュールには、リレーなどの外部機器を制御および読み取るためのデジタル入力および出力ラインがあります。 これらの関数を使用すると、これらの行の状態を読み書きできます。 3つの入力ラインと3つの出力ラインがあります。


　GetDigitalInputLineState( DWORD *state )
   　　デジタル入力ラインの現在の状態を取得します
   　　Parameters: state = pointer to value to receive the current state of the digital input lines
   　　Return: S_OK = success, E_FAIL = unsuccessful

　SetDigitalOutputLineState( DWORD state )
　   デジタル出力ラインの現在の状態を設定します
   　Parameters: state = value containing the new state to set the output lines
   　Return: S_OK = success, E_FAIL = unsuccessful


  

 ▲　戻る