Systemwalker Operation Manager リファレンスマニュアル - UNIX/Windows(R)共通 -

17.4.2.1 音声通知API

音声通知API(Mp_PlaySound)について説明します。

■記述形式

long Mp_PlaySound (unsigned char *AppName,
　　　　　　　　　　　int kind,
　　　　　　　　　　　unsigned char *text_or_filename,
　　　　　　　　　　　int repeat,
　　　　　　　　　　　MpSoundParam *SoundParam)

■機能説明

以下の音声を通知します。

• メッセージテキストの読上げ
• WAVファイルの再生
• BEEP音

■パラメタの説明

◆AppName

呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。

◆kind

通知する音声の種類を指定します。このパラメタには、次の値のいずれかを指定します。

SOUND_VOICE:

メッセージテキストを読み上げます。

SOUND_WAVE:

WAVファイルを再生します。

SOUND_BEEP:

BEEP音です。

◆text_or_filename

kindの指定値により、次の値のいずれかを指定します。

SOUND_VOICEを指定した場合:

読み上げるメッセージテキストのアドレスを指定します。

SOUND_WAVEを指定した場合:

再生するファイルのフルパス名のアドレスをMAX_PATH以内で指定します。

SOUND_BEEPを指定した場合:

無効です。

◆repeat

音声を通知する回数を指定します。0を指定した場合は、停止処理がされるまで繰り返します。

◆SoundParam

音声オプション情報構造体(MpSoundParam)のアドレスを指定します。SOUND_VOICEを指定した場合に、システムの設定値を変更する場合に指定します。SOUND_VOICE以外の場合は、無効になります。設定の必要がない場合は、NULLを指定します。また、各項目で0を指定した場合、システムの設定値が使われます。

■復帰値

正常に要求を受け取った場合は0以上の整数を返します。0未満の場合はエラーとなります。

MPACT_PARAMERR:

パラメタエラーです。

MPACT_NOMEMORY:

メモリ不足です。

MPACT_NOTSOUND:

サウンド再生用の環境がインストールされていません。

MPACT_NOTMOVE:

アクション管理サーバが起動されていません。

MPACT_COMFAIL:

アクション管理サーバとの通信でエラーが発生しました。

MPACT_SYSERR:

アクション管理サーバでエラーが発生しました。

MPACT_NOTDLL:

アクション要求用DLLがロードできません。

MPACT_EXCEPT:

不当な領域のアドレスが指定されました。

■音声オプション情報構造体(MpSoundParam)の形式

typedef struct MpSoundParam_tag { 
    DWORD dwVoiceType ;    // 声の種類
    DWORD dwIntonation ;   // 声のイントネーションのレベル
    DWORD dwPitch ;        // 声の高さ
    DWORD dwSpeed ;        // 読上げのスピード
    DWORD dwSpeedRate  ;   // 読上げスピードの変化の割合
    DWORD dwTone ;         // 高域強調の有無
    DWORD dwVolume ;       // 声のボリューム
} MpSoundParam ;

◆dwVoiceType

声種を指定します。

VOICE_MALE:

男性の声です。

VOICE_FEMALE:

女性の声です。

◆dwIntonation

イントネーションのレベルを1〜4で指定します。

◆dwPitch

発声の声の高さを1〜5で指定します。

◆dwSpeed

読上げスピードを1〜10で指定します。

◆dwSpeedRate

読上げスピードの変化の割合を1〜10で指定します。

◆dwTone

高域強調の有無を指定します。

なし:

1

あり:

2

◆DWORD dwVolume

ボリュームを1〜10で指定します。

■プログラム例

音声通知APIのプログラム例を以下に示します。

 

#include "f3crhxac.h"

unsigned char *AppName = "音声通知API" ;  // 依頼元アプリケーション名
int kind               = SOUND_VOICE ;    // テキストの読上げ
unsigned char *text    = "異常が発生しました。オペレータに連絡してください" ;
int repeat             = 0 ;           // 停止処理がされるまで繰り返す
MpSoundParam  *SndPrm  = NULL ;        // 省略値を使用
long           lrc ;

/* 音声通知依頼 */
lrc = Mp_PlaySound(AppName,kind,text,repeat,NULL) ;
if ( lrc < 0 ) {
    /* エラー処理 */
}

/* 正常終了 */