CRIミドルウェアリファレンスマニュアル : ADXCS

定数

[メニュー]

ADXCS_STAT_~
再生状態

解説

ADXCSハンドルの再生状態を表します。

この再生状態は、ADXCS_GetStat関数により取得することができます。

定数 | 説明
--- | ---
ADXCS_STAT_STOP | 停止中
ADXCS_STAT_PREP | 再生準備中
ADXCS_STAT_PLAYING | デコード＆再生中
ADXCS_STAT_PLAYEND | 再生終了
ADXCS_STAT_ERROR | エラー発生

[メニュー]

ADXCS_FADE_STAT_~
フェード状態

解説

ADXCSハンドルのフェード状態を表します。

このフェード状態は、ADXCS_GetFadeStat関数により取得することができます。

定数 | 説明
--- | ---
ADXCS_FADE_STAT_IDLE | フェード処理をしていない
ADXCS_FADE_STAT_FADING | フェード処理中

[メニュー]

ADXCS_SND_TYPE_~
サウンドの種類

解説

ADXCSハンドルのサウンドの種類を表します。

定数 | 説明
--- | ---
ADXCS_SND_TYPE_SOUNDEFFECT | 効果音
ADXCS_SND_TYPE_MUSIC | 音楽
ADXCS_SND_TYPE_VOICE | セリフ
ADXCS_SND_TYPE_NONE | 指定なし

備考

ハンドル作成時に何も指定しないと、サウンドの種類はADXCS_SND_TYPE_NONEになります。

[メニュー]

ADXCS_CB_~
コールバック関数の種類

解説

コールバック関数の種類を表します。

ADXCS_SetCbFunc関数で登録したコールバック関数が呼ばれるときに、引数として渡されます。

定数 | 説明
--- | ---
ADXCS_CB_START_FADE_OUT | フェードアウト開始
ADXCS_CB_START_FADE_IN | フェードイン開始
ADXCS_CB_START_VOL_CHANGE | ボリューム変更開始
ADXCS_CB_END_FADE_OUT | フェードアウト終了
ADXCS_CB_END_FADE_IN | フェードイン終了
ADXCS_CB_END_VOL_CHANGE | ボリューム変更終了
ADXCS_CB_END_FADE_ALL | 全フェード終了

データ型

[メニュー]

ADXCS
ADXCSハンドル

解説 ADXCSの再生を制御するためのハンドルです。 このハンドルは、ADXCS_Create関数により生成されます。

[メニュー]

AdxcsCrePrm
ハンドル生成パラメータ構造体

解説

ADXCSハンドルの生成に必要な情報を設定する構造体です。

使用するときは、初めに0で初期化してから必要なメンバに値を設定してください。

構造体のメンバは以下の通りです。

メンバー | 型 | 説　明
--- | --- | ---
max_stm | Sint32 | 最大同時再生ストリーム数
max_ch | Sint32 | 最大チャンネル数
max_sfreq | Sint32 | 最大サンプリング周波数
max_aix_track | Sint32 | AIXの最大トラック数
play_method | Sint32 | 再生方式
sound_type | Sint8 | サウンドの種類（ADXCS_SND_TYPE_~）
use_crossfade | Bool | クロスフェードをするか否か
use_aix | Bool | AIXを使用するか否か
use_ahx | Bool | AHXを使用するか否か

備考

（１）max_stm、max_ch、max_sfreq、play_methodは、ADXのワーク領域サイズ計算マクロに渡す値と同じ意味です。

（２）max_aix_trackは、AIXのワーク領域サイズ計算マクロに渡す値と同じ意味です。

関数

[メニュー]

ADXCS_Init
ADXCSライブラリの初期化

書式
void ADXCS_Init(void)
入力

なし

出力

なし

戻り値

なし

説明

ADXCSライブラリを初期化します。

備考

再初期化する場合は、初期化前にADXCS_Finish関数を呼び出してください。

[メニュー]

ADXCS_Finish
ADXCSライブラリの終了処理

書式
void ADXCS_Finish(void)
入力

なし

出力

なし

戻り値

なし

説明

ADXCSライブラリの終了処理を行います。

[メニュー]

ADXCS_Create
ADXCSハンドルの生成

書式
ADXCS ADXCS_Create(const AdxcsCrePrm *cprm, Sint8 *work, Sint32 work_size)
入力

cprm ：ハンドル生成パラメータ構造体へのポインタ

work ：ワーク領域へのポインタ

work_size ：ワーク領域サイズ（単位：バイト）

出力

なし

戻り値

ADXCSハンドル（ハンドル生成に失敗したときはNULLを返す）

説明

指定されたパラメータに応じたADXCSハンドルを生成します。ワーク領域サイズはADXCS_CalcWorkCprm関数で計算してください。

また、ハンドル生成パラメータ構造体は、初めに0で初期化してから必要なメンバに値を設定してください。

例

    /* ハンドル生成パラメータ構造体の設定 */
    memset(&cprm, 0, sizeof(cprm));
    cprm.max_stm     = 1;                   /* 最大同時再生ストリーム数：1 */
    cprm.max_nch     = 2;                   /* ステレオ                    */
    cprm.max_sfreq   = 48000;               /* 48kHz                       */
    cprm.play_method = ADXT_PLY_STM;        /* 再生方式：ストリーム再生    */
    work_size = ADXCS_CalcWorkCprm(&cprm);  /* ワーク領域サイズを計算      */
    work = (Sint8 *)malloc(work_size);      /* ワーク領域を確保            */
    /* ADXCSハンドルの生成 */
    adxcs = ADXCS_Create(&cprm, work, work_size);

[メニュー]

ADXCS_Destroy
ADXCSハンドルの消去

書式
void ADXCS_Destroy(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

なし

説明

ADXCS_Create関数で生成したADXCSハンドルを消去します。

[メニュー]

ADXCS_CalcWorkCprm
ワーク領域サイズを計算する

書式
Sint32 ADXCS_CalcWorkCprm(const AdxcsCrePrm *cprm)
入力

cprm ：ハンドル生成パラメータ構造体へのポインタ

出力

なし

戻り値

ワーク領域サイズ（単位：バイト）

説明

ハンドル生成パラメータ構造体から、ADXCSが必要とするワーク領域サイズを計算します。

この関数で計算したワーク領域サイズを、ADXCS_Create関数に指定します。

例

    /* ハンドル生成パラメータ構造体の設定 */
    memset(&cprm, 0, sizeof(cprm));
    cprm.max_stm     = 1;                   /* 最大同時再生ストリーム数：1 */
    cprm.max_nch     = 2;                   /* ステレオ                    */
    cprm.max_sfreq   = 48000;               /* 48kHz                       */
    cprm.play_method = ADXT_PLY_STM;        /* 再生方式：ストリーム再生    */
    work_size = ADXCS_CalcWorkCprm(&cprm);  /* ワーク領域サイズを計算      */
    work = (Sint8 *)malloc(work_size);      /* ワーク領域を確保            */
    /* ADXCSハンドルの生成 */
    adxcs = ADXCS_Create(&cprm, work, work_size);

[メニュー]

ADXCS_AttachAhx
AHX再生機能の組み込み

書式
void ADXCS_AttachAhx(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

なし

説明

ADXCSハンドルにAHX再生機能を組み込みます。この関数を実行すると、指定したADXCSハンドルでAHX音声データを再生できるようになります。

備考

ハンドル生成時に、ハンドル生成パラメータ構造体のuse_ahxメンバをTRUEに設定しておく必要があります。

例

    /* ハンドル生成パラメータ構造体の設定 */
    memset(&cprm, 0, sizeof(cprm));
    cprm.max_stm     = 1;                    /*    最大同時再生ストリーム数：1 */
    cprm.max_nch     = 1;                    /*    モノラル                    */
    cprm.max_sfreq   = 24000;                /*    24kHz                       */
    cprm.play_method = ADXT_PLY_STM;         /*    再生方式：ストリーム再生    */
    cprm.use_ahx     = TRUE;                 /*    AHXを使用する               */
    work_size = ADXCS_CalcWorkCprm(&cprm);   /*    ワーク領域サイズを計算      */
    work = (Sint8 *)malloc(work_size);       /*    ワーク領域を確保            */
    /* ADXCSハンドルの生成 */
    adxcs = ADXCS_Create(&cprm, work, work_size);
    /* AHX再生機能の組み込み */
    ADXCS_AttachAhx(adxcs);

[メニュー]

ADXCS_DetachAhx
AHX再生機能の分離

書式
void ADXCS_DetachAhx(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

なし

説明

ADXCSハンドルからAHX再生機能を分離します。この関数を実行すると、指定したADXCSハンドルでAHX音声データを再生できなくなります。

備考

ハンドル生成時に、ハンドル生成パラメータ構造体のuse_ahxメンバをTRUEに設定しておく必要があります。

[メニュー]

ADXCS_StartFname
再生開始（ファイルからの再生）

書式
void ADXCS_StartFname(ADXCS adxcs, Char8 *fname)
入力

adxcs ：ADXCSハンドル

fname ：再生するファイル名

出力

なし

戻り値

なし

説明

指定したファイルの再生を開始します。

備考

（１）フェードインしながら再生が始まります。フェードインは、設定されたパラメータに従って行われます。

（２）ハンドル生成時に、ハンドル生成パラメータ構造体のuse_crossfadeメンバにTRUEを設定した場合、再生中の音声とのクロスフェードが行われます。

（３）ボイスハイライトが有効になっている場合にこの関数でセリフを再生すると、他のハンドルで再生中の音楽のボリュームが自動的に下がります。

[メニュー]

ADXCS_StartAfs
FID指定による再生の開始

書式
void ADXCS_StartAfs(ADXCS adxcs, Sint32 patid, Sint32 fid)
入力

adxcs ：ADXCSハンドル

patid ：パーティション識別子

fid ：ファイル識別子

出力

なし

戻り値

なし

説明

パーティション識別子とファイル識別子で指定し、AFSファイル内のインサイドファイルを再生開始します。

備考

フェードイン／クロスフェード／ボイスハイライトに関する機能はADXCS_StartFname関数と同様です。

[メニュー]

ADXCS_StartMem
メモリ再生の開始

書式
void ADXCS_StartMem(ADXCS adxcs, void *dat, Sint32 datlen)
入力

adxcs ：ADXCSハンドル

dat ：メモリ内のデータへのポインタ

datlen ：データの長さ

出力

なし

戻り値

なし

説明

メモリ内のデータを再生開始します。

備考

フェードイン／クロスフェード／ボイスハイライトに関する機能はADXCS_StartFname関数と同様です。

[メニュー]

ADXCS_StartMemIdx
メモリインデックス再生の開始

書式
void ADXCS_StartMemIdx(ADXCS adxcs, void *acx, Sint32 no)
入力

adxcs ：ADXCSハンドル

acx ：メモリ内のACXデータへのポインタ

no ：再生する音声のインデックス番号

出力

なし

戻り値

なし

説明

メモリ内のACXデータを再生開始します。ACXデータ中の音声データをインデックス指定します。

備考

（１）フェードイン／クロスフェード／ボイスハイライトに関する機能はADXCS_StartFname関数と同様です。

（２）ハンドル生成パラメータ構造体のuse_aixメンバをTRUEにして生成したハンドルでは使用できません。

[メニュー]

ADXCS_Stop
再生停止

書式
void ADXCS_Stop(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

なし

説明

再生を停止します。

備考

設定されたパラメータに従ってフェードアウトします。

[メニュー]

ADXCS_Pause
ポーズ／ポーズ解除

書式
void ADXCS_Pause(ADXCS adxcs, Sint32 sw)
入力

adxcs ：ADXCSハンドル

sw ：切り替えスイッチ（ON：ポーズする、OFF：ポーズ解除する）

出力

なし

戻り値

なし

説明

ポーズおよびポーズ解除を行います。

備考

ポーズ時のフェードアウトや、ポーズ解除時のフェードインは行いません。

[メニュー]

ADXCS_GetStatPause
ポーズ状態の取得

書式
Sint32 ADXCS_GetStatPause(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

ON = ポーズ中、OFF = ポーズ中でない

説明

ポーズ状態を取得します。

[メニュー]

ADXCS_GetStat
再生状態の取得

書式
Sint32 ADXCS_GetStat(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

ADXCSハンドルの状態（ADXCS_STAT_~）

説明

ハンドルの再生状態を取得します。

ハンドルの再生状態は以下の通りです。

定数 | 説明
--- | ---
ADXCS_STAT_STOP | 停止中
ADXCS_STAT_PREP | 再生準備中
ADXCS_STAT_PLAYING | デコード＆再生中
ADXCS_STAT_PLAYEND | 再生終了
ADXCS_STAT_ERROR | エラー発生

[メニュー]

ADXCS_GetCprm
ハンドル生成パラメータ構造体の取得

書式
const AdxcsCrePrm *ADXCS_GetCprm(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

ハンドル生成パラメータ構造体へのポインタ

説明

指定したADXCSハンドルのハンドル生成パラメータ構造体を取得します。

[メニュー]

ADXCS_SetLpFlg
ループフラグの設定

書式
void ADXCS_SetLpFlg(ADXCS adxcs, Sint32 flg)
入力

adxcs ：ADXCSハンドル

flg ：ループフラグ（ON：ループする、OFF：ループしない）

出力

なし

戻り値

なし

説明

ループフラグを設定します。

備考

ADXT_SetLpFlg関数、AIXP_SetLpSw関数と同じ意味です。

[メニュー]

ADXCS_SetType
サウンドの種類の設定

書式
void ADXCS_SetType(ADXCS adxcs, Sint32 type)
入力

adxcs ：ADXCSハンドル

type ：サウンドの種類（ADXCS_SND_TYPE_~）

出力

なし

戻り値

なし

説明

サウンドの種類を設定します。

サウンドの種類は以下の通りです。

定数 | 説明
--- | ---
ADXCS_SND_TYPE_SOUNDEFFECT | 効果音
ADXCS_SND_TYPE_MUSIC | 音楽
ADXCS_SND_TYPE_VOICE | セリフ
ADXCS_SND_TYPE_NONE | 指定なし

[メニュー]

ADXCS_GetType
サウンドの種類の取得

書式
Sint32 ADXCS_GetType(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

サウンドの種類（ADXCS_SND_TYPE_~）

説明

サウンドの種類を取得します。

[メニュー]

ADXCS_SetOutVol
出力ボリュームの設定

書式
void ADXCS_SetOutVol(ADXCS adxcs, Sint32 vol)
入力

adxcs ：ADXCSハンドル

vol ：基本出力ボリューム（0：0[dB] 〜 -960：-96.0[dB]）

出力

なし

戻り値

なし

説明

基本出力ボリュームを設定します。基本出力ボリュームとは、フェードやボイスハイライト機能によって増減する分を含まない、基準となるボリュームです。

備考

実際に適用される出力ボリュームは、フェード状況やボイスハイライト機能の状態によって変化します。

[メニュー]

ADXCS_GetOutVol
出力ボリュームの取得

書式
Sint32 ADXCS_GetOutVol(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

基本出力ボリューム（0：0[dB] 〜 -960：-96.0[dB]）

説明

基本出力ボリュームを取得します。

備考

フェードやボイスハイライトによって増減している分は含みません。

実際に適用されている出力ボリュームを取得したいときは、ADXTハンドルを取得し、ADXT_GetOutVol関数により取得してください。

[メニュー]

ADXCS_SetTrackVol
トラックごとの出力ボリュームの設定

書式
void ADXCS_SetTrackVol(ADXCS adxcs, Sint32 trno, Sint32 vol)
入力

adxcs ：ADXCSハンドル

trno ：トラック番号

vol ：基本出力ボリューム（0：0[dB] 〜 -960：-96.0[dB]）

出力

なし

戻り値

なし

説明

AIXのトラックごとの基本出力ボリュームを設定します。

備考

ここで設定されるのは基本出力ボリュームです。実際に適用される出力ボリュームは、フェード状況やボイスハイライトの状態によって変化します。

[メニュー]

ADXCS_GetTrackVol
トラックごとの出力ボリュームの取得

書式
Sint32 ADXCS_GetTrackVol(ADXCS adxcs, Sint32 trno)
入力

adxcs ：ADXCSハンドル

trno ：トラック番号

出力

なし

戻り値

トラックごとの基本出力ボリューム（0：0[dB] 〜 -960：-96.0[dB]）

説明

トラックごとの基本出力ボリュームを取得します。

備考

フェードやボイスハイライトによって増減している分は含みません。

実際に適用されている出力ボリュームを取得したいときは、内部のAIXPハンドルを取得して、そこから取得してください。

[メニュー]

ADXCS_SetFadeOutTime
フェードアウト時間の設定

書式
void ADXCS_SetFadeOutTime(ADXCS adxcs, Sint32 time)
入力

adxcs ：ADXCSハンドル

time ：フェードアウト時間（単位：Vsync）

出力

なし

戻り値

なし

説明

フェードアウト時間を設定します。

備考

引数timeに60を指定すると、フェードアウト時間は約１秒になります。

デフォルト値は30です。

[メニュー]

ADXCS_GetFadeOutTime
フェードアウト時間の取得

書式
Sint32 ADXCS_GetFadeOutTime(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

フェードアウト時間（単位：Vsync）

説明

フェードアウト時間を取得します。

[メニュー]

ADXCS_SetFadeInTime
フェードイン時間の設定

書式
void ADXCS_SetFadeInTime(ADXCS adxcs, Sint32 time)
入力

adxcs ：ADXCSハンドル

time ：フェードイン時間（単位：Vsync）

出力

なし

戻り値

なし

説明

フェードイン時間を設定します。

備考

引数timeに60を指定すると、フェードイン時間は約１秒になります。

デフォルト値は0です。（フェードインせずに再生開始）

[メニュー]

ADXCS_GetFadeInTime
フェードイン時間の取得

書式
Sint32 ADXCS_GetFadeInTime(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

フェードイン時間（単位：Vsync）

説明

フェードイン時間を取得します。

[メニュー]

ADXCS_SetVolChangeTime
ボリューム変更時間の設定

書式
void ADXCS_SetVolChangeTime(ADXCS adxcs, Sint32 time)
入力

adxcs ：ADXCSハンドル

time ：ボリューム変更時間（単位：Vsync）

出力

なし

戻り値

なし

説明

ボリューム変更時間を設定します。

備考

引数timeに60を指定すると、ボリューム変更時間は約１秒になります。

デフォルト値は0です。（瞬時にボリューム変更）

[メニュー]

ADXCS_GetVolChangeTime
ボリューム変更時間の取得

書式
Sint32 ADXCS_GetVolChangeTime(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

ボリューム変更時間（単位：Vsync）

説明

ボリューム変更時間を取得します。

[メニュー]

ADXCS_SetFadeInStartOffset
フェードイン開始時刻オフセットの設定

書式
void ADXCS_SetFadeInStartOffset(ADXCS adxcs, Sint32 offset)
入力

adxcs ：ADXCSハンドル

offset ：フェードアウトからの相対フェードイン開始時刻オフセット（単位：Vsync）

出力

なし

戻り値

なし

説明

クロスフェード時の、フェードアウト開始からフェードイン開始までの時刻オフセットを設定します。負の値を設定すると、フェードアウトより先にフェードインが開始します。

備考

デフォルト値は0です。（同時に開始）

[メニュー]

ADXCS_GetFadeInStartOffset
フェードイン開始時刻オフセットの取得

書式
Sint32 ADXCS_GetFadeInStartOffset(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

フェードアウトからの相対フェードイン開始時刻オフセット（単位：Vsync）

説明

クロスフェード時の、フェードアウト開始からフェードイン開始までの時刻オフセットを取得します。

[メニュー]

ADXCS_SetFadeEndDelay
フェード後のディレイ時間の設定

書式
void ADXCS_SetFadeEndDelay(ADXCS adxcs, Sint32 delay)
入力

adxcs ：ADXCSハンドル

delay ：フェード後のディレイ時間（単位：Vsync）

出力

なし

戻り値

なし

説明

フェード後のディレイ時間を設定します。

備考

（１）デフォルト値は60です。

（２）再生停止処理、フェード状態の更新、およびコールバックの呼び出しは、ディレイ時間経過後に行われます。

（３）サウンドドライバ、またはハードウェアの仕様上、ボリュームを設定してから実際に反映されるまでに遅延がある場合に設定します。

[メニュー]

ADXCS_GetFadeEndDelay
フェード後のディレイ時間の取得

書式
Sint32 ADXCS_GetFadeEndDelay(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

フェード後のディレイ時間の取得（単位：Vsync）

説明

フェード後のディレイ時間を取得します。

[メニュー]

ADXCS_GetActiveAdxt
アクティブなADXTハンドルの取得

書式
ADXT ADXCS_GetActiveAdxt(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

アクティブなADXTハンドル

説明

アクティブなADXTハンドルを取得します。

備考

（１）ハンドル生成パラメータ構造体のuse_aixメンバがTRUEの場合、AIXPハンドルで再生しているため、常にNULLが返ります。AIXPハンドルが必要な時は、ADXCS_GetActiveAixp関数を使用してください。

（２）ハンドル生成パラメータ構造体のuse_crossfadeメンバがFALSEの場合、常に同じハンドルが取得されます。

[メニュー]

ADXCS_GetNextAdxt
次のADXTハンドルの取得

書式
ADXT ADXCS_GetNextAdxt(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

次のADXTハンドル

説明

次のADXTハンドルを取得します。

備考

（１）ハンドル生成パラメータ構造体のuse_aixメンバがTRUEの場合、AIXPハンドルで再生しているため、常にNULLが返ります。AIXPハンドルが必要な時は、ADXCS_GetNextAixp関数を使用してください。

（２）ハンドル生成パラメータ構造体のuse_crossfadeメンバがFALSEの場合、常に同じハンドルが取得されます。

[メニュー]

ADXCS_GetAdxt
インデックス指定でのADXTハンドルの取得

書式
ADXT ADXCS_GetAdxt(ADXCS adxcs, Sint32 index)
入力

adxcs ：ADXCSハンドル

index ：ADXTハンドルのインデックス番号（0 or 1）

出力

なし

戻り値

指定したインデックス番号のADXTハンドル

説明

インデックス番号を指定してADXTハンドルを取得します。

備考

（１）ハンドル生成パラメータ構造体のuse_aixメンバがTRUEの場合、AIXPハンドルで再生しているため、常にNULLが返ります。AIXPハンドルが必要な時は、ADXCS_GetAixp関数を使用してください。

（２）ハンドル生成パラメータ構造体のuse_crossfadeメンバがTRUEの場合、ADXCSハンドルは内部にADXTハンドルを2つ保持しています。引数のインデックス番号は、その2つのADXTハンドルのいずれかを判別するためのものです。

（３）ハンドル生成パラメータ構造体のuse_crossfadeメンバがFALSEの場合、0番のみ指定できます。

use_aix | use_crossfade | ハンドルが取得可能なインデックス番号
--- | --- | ---
TRUE | TRUE | （常にNULL）
TRUE | FALSE | （常にNULL）
FALSE | TRUE | 0 or 1
FALSE | FALSE | 0のみ

[メニュー]

ADXCS_GetNumAdxt
ADXTハンドル数の取得

書式
Sint32 ADXCS_GetNumAdxt(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

ADXTハンドルの数

説明

ADXCSハンドル内のADXTハンドルの数を取得します。

備考

ハンドル生成パラメータ構造体のuse_aixメンバがTRUEの場合、AIXPハンドルで再生しているため、常に0が返ります。

use_aix | use_crossfade | 取得できるハンドル数
--- | --- | ---
TRUE | TRUE | 0
TRUE | FALSE | 0
FALSE | TRUE | 2
TRUE | FALSE | 1

[メニュー]

ADXCS_GetActiveAixp
アクティブなAIXPハンドルの取得

書式
AIXP ADXCS_GetActiveAixp(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

アクティブなAIXPハンドル

説明

アクティブなAXIPハンドルを取得します。

備考

ハンドル生成パラメータ構造体のuse_aixメンバがFALSEの場合、ADXTハンドルで再生しているため、常にNULLが返ります。ADXTハンドルが必要な時は、ADXCS_GetActiveAdxt関数を使用してください。

[メニュー]

ADXCS_GetNextAixp
次のAIXPハンドルの取得

書式
AIXP ADXCS_GetNextAixp(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

次のAIXPハンドル

説明

次のAIXPハンドルを取得します。

備考

ハンドル生成パラメータ構造体のuse_aixメンバがFALSEの場合、ADXTハンドルで再生しているため、常にNULLが返ります。ADXTハンドルが必要な時は、ADXCS_GetNextAdxt関数を使用してください。

[メニュー]

ADXCS_GetAixp
インデックス指定でのAIXPハンドルの取得

書式
AIXP ADXCS_GetAixp(ADXCS adxcs, Sint32 index)
入力

adxcs ：ADXCSハンドル

index ：AIXPハンドルのインデックス番号（0 or 1）

出力

なし

戻り値

指定したインデックスのAIXPハンドル

説明

インデックス指定でAIXPハンドルを取得します。

備考

（１）ハンドル生成パラメータ構造体のuse_aixメンバがFALSEの場合、ADXTハンドルで再生しているため、常にNULLが返ります。ADXTハンドルが必要な時は、ADXCS_GetAdxt関数を使用してください。

（２）ハンドル生成パラメータ構造体のuse_crossfadeメンバがTRUEの場合、ADXCSハンドルは内部にAIXPハンドルを2つ保持しています。引数のインデックス番号は、その2つのAIXPハンドルのいずれかを判別するためのものです。

（３）ハンドル生成パラメータ構造体のuse_crossfadeメンバがFALSEの場合、0番のみ指定できます。

use_aix | use_crossfade | ハンドルが取得可能なインデックス番号
--- | --- | ---
TRUE | TRUE | 0 or 1
TRUE | FALSE | 0のみ
FALSE | TRUE | （常にNULL）
FALSE | FALSE | （常にNULL）

[メニュー]

ADXCS_GetNumAixp
AIXPハンドル数の取得

書式
Sint32 ADXCS_GetNumAixp(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

AIXPハンドルの数

説明

ADXCSハンドル内のAIXPハンドルの数を取得します。

備考

ハンドル生成パラメータ構造体のuse_aixメンバがFALSEの場合、ADXTハンドルで再生しているため、常に0が返ります。

use_aix | use_crossfade | 取得できるハンドル数
--- | --- | ---
TRUE | TRUE | 2
TRUE | FALSE | 1
FALSE | TRUE | 0
FALSE | FALSE | 0

[メニュー]

ADXCS_CancelFading
フェード処理のキャンセル

書式
void ADXCS_CancelFading(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

なし

説明

フェード処理をキャンセルし、フェードしながら元の音量に戻します。

備考

クロスフェード時に、先にフェードアウトが終わって停止してしまった場合、キャンセルしても再生は再開されません。

[メニュー]

ADXCS_GetFadeStat
フェード状態の取得

書式
Sint32 ADXCS_GetFadeStat(ADXCS adxcs)
入力

adxcs ：ADXCSハンドル

出力

なし

戻り値

フェード状態（ADXCS_FADE_STAT_~）

説明

フェード状態を取得します。

フェード状態は以下の通りです。

定数 | 説明
--- | ---
ADXCS_FADE_STAT_IDLE | フェード処理をしていない
ADXCS_FADE_STAT_FADING | フェード処理中

[メニュー]

ADXCS_SetCbFunc
フェードコールバック関数の登録

書式
void ADXCS_SetCbFunc(ADXCS adxcs, void (*fn)(ADXCS adxcs, Sint32 cb_type))
入力

adxcs ：ADXCSハンドル

fn ：フェードコールバック関数へのポインタ

出力

なし

戻り値

なし

説明

フェードコールバック関数を登録します。

フェードコールバック関数の引数cb_typeにはコールバック関数の種類が入ります。コールバック関数の種類は以下の通りです。

定数 | 説明
--- | ---
ADXCS_CB_START_FADE_OUT | フェードアウト開始
ADXCS_CB_START_FADE_IN | フェードイン開始
ADXCS_CB_START_VOL_CHANGE | ボリューム変更開始
ADXCS_CB_END_FADE_OUT | フェードアウト終了
ADXCS_CB_END_FADE_IN | フェードイン終了
ADXCS_CB_END_VOL_CHANGE | ボリューム変更終了
ADXCS_CB_END_FADE_ALL | 全フェード終了

[メニュー]

ADXCS_EnableVhl
ボイスハイライト機能を有効にする

書式
void ADXCS_EnableVhl(void)
入力

なし

出力

なし

戻り値

なし

説明

ボイスハイライト機能を有効にします。

[メニュー]

ADXCS_DisableVhl
ボイスハイライト機能を無効にする

書式
void ADXCS_DisableVhl (void)
入力

なし

出力

なし

戻り値

なし

説明

ボイスハイライト機能を無効にします。

[メニュー]

ADXCS_SetVhlDecTime
ボリューム減少時間の設定

書式
void ADXCS_SetVhlDecTime(Sint32 dec_time)
入力

dec_time ：ボリューム減少に要する時間（単位：Vsync）

出力

なし

戻り値

なし

説明

ボイスハイライトで音楽のボリュームを下げる時の、ボリューム減少に要する時間を設定します。

備考

引数dec_timeに60を指定すると、ボリューム減少に要する時間は約１秒になります。

デフォルト値は30です。

[メニュー]

ADXCS_GetVhlDecTime
ボリューム減少時間の取得

書式
Sint32 ADXCS_GetVhlDecTime(void)
入力

なし

出力

なし

戻り値

ボリューム減少に要する時間（単位：Vsync）

説明

ボイスハイライトで音楽のボリュームを下げる時の、ボリューム減少に要する時間を取得します。

[メニュー]

ADXCS_SetVhlIncTime
ボリューム増加時間の設定

書式
void ADXCS_SetVhlIncTime(Sint32 inc_time)
入力

inc_time ：ボリューム増加に要する時間（単位：Vsync）

出力

なし

戻り値

なし

説明

ボイスハイライトで音楽のボリュームを元に戻すとき時の、ボリューム増加に要する時間を設定します。

備考

引数inc_timeに60を指定すると、ボリューム増加に要する時間は約１秒になります。

デフォルト値は60です。

[メニュー]

ADXCS_GetVhlIncTime
ボリューム増加時間の取得

書式
Sint32 ADXCS_GetVhlIncTime(void)
入力

なし

出力

なし

戻り値

ボリューム増加に要する時間（単位：Vsync）

説明

ボイスハイライトで音楽のボリュームを元に戻すとき時の、ボリューム増加に要する時間を取得します。

[メニュー]

ADXCS_SetVhlDecVol
ボリューム減少量の設定

書式
void ADXCS_SetVhlDecVol(Sint32 dec_vol)
入力

dec_vol ：ボリューム減少量（0：0[dB] 〜 960：96.0[dB]）

出力

なし

戻り値

なし

説明

ボイスハイライトで音楽のボリュームを下げる時の減少量を設定します。

備考

デフォルト値は120です。（12[dB]）

[メニュー]

ADXCS_GetVhlDecVol
ボリューム減少量の取得

書式
Sint32 ADXCS_GetVhlDecVol()
入力

なし

出力

なし

戻り値

ボリューム減少量（0：0[dB] 〜 960：96.0[dB]）

説明

ボイスハイライトで音楽のボリュームを下げる時の減少量を取得します。

Copyright (c) 2001-2006 CRI Middleware Co.,LTD.