# グローバルサウンドコントロールAPI

API分別名 | API名 | 機能
--- | --- | ---
グローバルサウンドコントロールAPI | `sdSndSetMasterVol` | グローバルなサウンドデータの再生音量の設定．
`sdSndSetSpace` | ターゲットの再生環境の設定．
`sdSndSetFxPrg` | FXプログラムの設定．
`sdSndGetFxPrg` | 現在のFXプログラム番号の取得．
`sdSndClearFxPrg` | DSPの停止．
`sdSndSetFxOut` | FXアウトプットの設定．
`sdSndGetFxOut` | 現在のFXアウトプット番号の取得．
`sdSndSetFxOutPrm` | FXアウトプットのパラメータ設定．
`sdSndStopAll` | すべてのサウンドデータの再生停止．
`sdQsndSetPos` | Qサウンドのポジションの設定．

## sdSndSetMasterVol

プロトタイプ | `SDE_ERR sdSndSetMasterVol( Sint8 master_vol);`
機能 | 最終的な出力音量を設定する．
引数 |

`master_vol` | ... | 設定する音量．範囲は０〜15です．

返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．
`SDE_ERR_PRM_OVER_RANGE` | ... | パラメータが仕様の範囲を超えている．
`SDE_ERR_HOST_CMD_BUF_NO_ENOUGH` | ... | これ以上ホストコマンドを受けることが出来ない．

備考 | 全てのサウンドデータの再生音量に影響が起こります．
参照 |

## sdSndSetSpace

プロトタイプ | `SDE_ERR sdSndSetSpace( SDE_SPACE space);`
機能 | ターゲットの音声再生環境を設定する．
引数 |

`space` | ... | 設定する再生環境．

返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．
`SDE_ERR_PRM_OVER_RANGE` | ... | パラメータが仕様の範囲を超えている．
`SDE_ERR_HOST_CMD_BUF_NO_ENOUGH` | ... | これ以上ホストコマンドを受けることが出来ない．

備考 | 現在はモノラル（`SDE_SPACE_MONO`）およびステレオ（`SDE_SPACE_STEREO`）のみ存在する．
参照 |

## sdSndSetFxPrg

プロトタイプ | `SDE_ERR sdSndSetFxPrg( Sint8 new_fx_prg_num, Sint8 new_fx_out_num);`
機能 | 使用するFX(エフェクト）の指定をする．
引数 |

`new_fx_prg_num` | ... | 使用するFXプログラムの番号．
`new_fx_out_num` | ... | 使用するFXアウトプットの番号．

返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．
`SDE_ERR_HOST_CMD_BUF_NO_ENOUGH` | ... | これ以上ホストコマンドを受けることが出来ない．
`SDE_ERR_PRM_OVER_RANGE` | ... | パラメータが仕様の範囲を超えている．

備考 |
参照 |

## sdSndGetFxPrg

プロトタイプ | `SDE_ERR sdSndGetFxPrg( Sint8 *cur_fx_prg_num);`
機能 | 現在使用しているFX（エフェクト）番号を取得する．
引数 |

`cur_fx_prg_num` | ... | 現在のFXの番号を格納する変数のポインタ．

返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．

備考 |
参照 |

## sdSndClearFxPrg

プロトタイプ | `SDE_ERR sdSndClearFxPrg( Void);`
機能 | DSPの動作を停止する．
引数 | なし．
返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．
`SDE_ERR_HOST_CMD_BUF_NO_ENOUGH` | ... | これ以上ホストコマンドを受けることが出来ない．

備考 |
参照 |

## sdSndSetFxOut

プロトタイプ | `SDE_ERR sdSndSetFxOut( Sint8 new_fx_out_num);`
機能 | 使用するFXアウトプット番号の指定をする．
引数 |

`new_fx_out_num``` | ... | 使用するFXアウトプットの番号．

返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．
`SDE_ERR_HOST_CMD_BUF_NO_ENOUGH` | ... | これ以上ホストコマンドを受けることが出来ない．
`SDE_ERR_PRM_OVER_RANGE` | ... | パラメータが仕様の範囲を超えている．

備考 |
参照 |

## sdSndGetFxOut

プロトタイプ | `SDE_ERR sdSndGetFxOut( Sint8 *cur_fx_out_num);`
機能 | 現在使用しているFXアウトプット番号を取得する．
引数 |

`cur_fx_out_num` | ... | 現在のFXアウトプット番号を格納する変数のポインタ．

返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．

備考 |
参照 |

## sdSndSetFxOutPrm

プロトタイプ | `SDE_ERR sdSndSetFxOutPrm( Sint8 out_num, Sint8 out_pan, Sint8 out_lev);`
機能 | 現在のFXアウトプットの出力パラメータを変更する．
引数 |

`out_num` | ... | 対象のDSP出力端子番号．
`out_pan` | ... | 設定するパンポットの値．8ビット2の補数で指定する．値の範囲は`-7FH`（最左）〜`00H`（基準値）〜`7FH`（最右）．
`out_lev` | ... | 設定する音量の値．8ビット2の補数で指定する．値の範囲は`-7FH`（最小値）〜`00H`（基準値）〜`7FH`（最大値）．

返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．
`SDE_ERR_HOST_CMD_BUF_NO_ENOUGH` | ... | これ以上ホストコマンドを受けることが出来ない．
`SDE_ERR_PRM_OVER_RANGE` | ... | パラメータが仕様の範囲を超えている．

備考 |
参照 |

## sdSndStopAll

プロトタイプ | `SDE_ERR sdSndStopAll( Void);`
機能 | 現在再生しているものすべてを停止する．
引数 | なし．
返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．
`SDE_ERR_HOST_CMD_BUF_NO_ENOUGH` | ... | これ以上ホストコマンドを受けることが出来ない．
`SDE_ERR_PRM_OVER_RANGE` | ... | パラメータが仕様の範囲を超えている．

備考 | このAPIを使用して停止した場合は`Snd???Continue`で再生再開できません．
参照 |

## sdQsndSetPos

プロトタイプ | `SDE_ERR sdQsndSetPos( Sint8 *pos);`
機能 | Qサウンドのポジションの設定をする．
引数 |

`pos` | ... | 設定するポジション．

返値 |

`SDE_ERR_NO_INIT` | ... | サウンドライブラリを初期化していない．
`SDE_ERR_HOST_CMD_BUF_NO_ENOUGH` | ... | これ以上ホストコマンドを受けることが出来ない．
`SDE_ERR_PRM_OVER_RANGE` | ... | パラメータが仕様の範囲を超えている．

備考 | posは符号付き８ビット整数の８バイト配列で，要素のそれぞれが各Q Soundのモジュールに対応しています．
参照 |