3.33 Mp_PlaySound（）関数

Systemwalker Centric Manager APIガイド - Microsoft(R) Windows NT(R)/Microsoft(R) Windows(R) 2000/Microsoft(R) Windows Server(TM) 2003 -

目次索引

第3章 APIリファレンス

3.33 Mp_PlaySound（）関数

■機能説明

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

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

■呼び出し形式

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

■パラメタ

AppName:

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

kind:

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

SOUND_VOICE:: メッセージテキストを読み上げます。
SOUND_WAVE:: WAVEファイルを再生します。
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を指定した場合、システムの設定値が使われます。

■構造体の説明

◆音声オプション情報構造体（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

dwVolume:

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

■参照

アクション管理のAPI、Mp_StopSound（）関数を参照してください。

■復帰値

0:

正常。

負の値:

エラー。

MPACT_PARAMERR:: パラメタエラーです。
MPACT_NOMEMORY:: メモリ不足です。
MPACT_NOTSOUND:: サウンド再生用の環境がインストールされていません。
MPACT_NOTMOVE:: アクション管理サーバが起動されていません。
MPACT_COMFAIL:: アクション管理サーバとの通信でエラーが発生しました。
MPACT_SYSERR:: アクション管理サーバでエラーが発生しました。
MPACT_NOTDLL:: アクション要求用DLLがロードできません。
MPACT_EXCEPT:: 不当な領域のアドレスが指定されました。

■API格納場所

アクション管理のAPIを参照してください。

■動作環境による差異

Windows(R) 2000 / Windows NT(R) / Windows Server(TM) 2003上だけで動作可能です。

■使用例

音声通知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 ) {
    /* エラー処理 */
}

/* 正常終了 */

目次索引