構成 | マクロ定義 | 関数
CriAtomEx iOS API

構成

struct  CriAtomConfig_IOS
 Atomライブラリ初期化用コンフィグ構造体CRI Atomライブラリの動作仕様を指定するための構造体です。
criAtom_Initialize_IOS 関数の引数に指定します。
[詳細]
struct  CriAtomExConfig_IOS
 Atomライブラリ初期化用コンフィグ構造体CRI Atomライブラリの動作仕様を指定するための構造体です。
criAtomEx_Initialize_IOS 関数の引数に指定します。
[詳細]

マクロ定義

#define criAtom_SetDefaultConfig_IOS(p_config)
 ライブラリ初期化用コンフィグ構造体にデフォルト値をセット
#define criAtomEx_SetDefaultConfig_IOS(p_config)
 ライブラリ初期化用コンフィグ構造体にデフォルト値をセット

関数

CriSint32 CRIAPI criAtom_CalculateWorkSize_IOS (const CriAtomConfig_IOS *config)
 ライブラリ初期化用ワーク領域サイズの計算
void CRIAPI criAtom_Initialize_IOS (const CriAtomConfig_IOS *config, void *work, CriSint32 work_size)
 ライブラリの初期化
void CRIAPI criAtom_Finalize_IOS (void)
 ライブラリの終了
void CRIAPI criAtom_SetServerThreadPriority_IOS (int prio)
 サーバスレッドプライオリティの設定
void CRIAPI criAtom_StartSound_IOS (void)
 サウンド処理の再開
void CRIAPI criAtom_StopSound_IOS (void)
 サウンド処理の停止
void CRIAPI criAtom_RecoverSound_IOS (void)
 サウンドの復旧
CriBool CRIAPI criAtom_IsInitializationSucceeded_IOS (void)
 サウンドの初期化に成功したか否か
CriSint32 CRIAPI criAtomEx_CalculateWorkSize_IOS (const CriAtomExConfig_IOS *config)
 ライブラリ初期化用ワーク領域サイズの計算
void CRIAPI criAtomEx_Initialize_IOS (const CriAtomExConfig_IOS *config, void *work, CriSint32 work_size)
 ライブラリの初期化
void CRIAPI criAtomEx_Finalize_IOS (void)
 ライブラリの終了
void CRIAPI criAtomEx_SetServerThreadPriority_IOS (int prio)
 サーバスレッドプライオリティの設定
void CRIAPI criAtomEx_StartSound_IOS (void)
 サウンド処理の再開
void CRIAPI criAtomEx_StopSound_IOS (void)
 サウンド処理の停止
void CRIAPI criAtomEx_RecoverSound_IOS (void)
 サウンドの復旧
CriBool CRIAPI criAtomEx_IsInitializationSucceeded_IOS (void)
 サウンドの初期化に成功したか否か

説明


マクロ定義

#define criAtom_SetDefaultConfig_IOS (   p_config)
値:
{                                                           \
    criAtom_SetDefaultConfig(&(p_config)->atom);            \
    criAtomExAsr_SetDefaultConfig(&(p_config)->asr);        \
    criAtomHcaMx_SetDefaultConfig(&(p_config)->hca_mx);     \
    (p_config)->buffering_time = 50;                        \
    (p_config)->output_sampling_rate = CRIATOM_DEFAULT_OUTPUT_SAMPLING_RATE; \
}

ライブラリ初期化用コンフィグ構造体にデフォルト値をセット

引数:
[out]p_config初期化用コンフィグ構造体へのポインタ
説明:
criAtom_Initialize_IOS 関数に設定するコンフィグ構造体 ( CriAtomConfig_IOS )に、デフォルトの値をセットします。
注意:
本マクロは下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本マクロの代わりに criAtomEx_SetDefaultConfig_IOS マクロをご利用ください。
参照:
CriAtomConfig_IOS
#define criAtomEx_SetDefaultConfig_IOS (   p_config)
値:
{                                                           \
    criAtomEx_SetDefaultConfig(&(p_config)->atom_ex);       \
    criAtomExAsr_SetDefaultConfig(&(p_config)->asr);        \
    criAtomExHcaMx_SetDefaultConfig(&(p_config)->hca_mx);   \
    (p_config)->buffering_time = 50;                        \
    (p_config)->output_sampling_rate = CRIATOM_DEFAULT_OUTPUT_SAMPLING_RATE; \
}

ライブラリ初期化用コンフィグ構造体にデフォルト値をセット

引数:
[out]p_config初期化用コンフィグ構造体へのポインタ
説明:
criAtomEx_Initialize_IOS 関数に設定するコンフィグ構造体 ( CriAtomExConfig_IOS )に、デフォルトの値をセットします。
参照:
CriAtomExConfig_IOS

関数

CriSint32 CRIAPI criAtom_CalculateWorkSize_IOS ( const CriAtomConfig_IOS config)

ライブラリ初期化用ワーク領域サイズの計算

引数:
[in]config初期化用コンフィグ構造体
戻り値:
CriSint32 ワーク領域サイズ
説明:
ライブラリを使用するために必要な、ワーク領域のサイズを取得します。
備考:
ライブラリが必要とするワーク領域のサイズは、ライブラリ初期化用コンフィグ 構造体( CriAtomConfig_IOS )の内容によって変化します。

引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意:
本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_CalculateWorkSize_IOS 関数をご利用ください。
参照:
CriAtomConfig_IOS, criAtom_Initialize_IOS
void CRIAPI criAtom_Initialize_IOS ( const CriAtomConfig_IOS config,
void *  work,
CriSint32  work_size 
)

ライブラリの初期化

引数:
[in]config初期化用コンフィグ構造体
[in]workワーク領域
[in]work_sizeワーク領域サイズ
説明:
ライブラリを初期化します。
ライブラリの機能を利用するには、必ずこの関数を実行する必要があります。
(ライブラリの機能は、本関数を実行後、 criAtom_Finalize_IOS 関数を実行するまでの間、 利用可能です。)

ライブラリを初期化する際には、ライブラリが内部で利用するためのメモリ領域(ワーク領域) を確保する必要があります。
ライブラリが必要とするワーク領域のサイズは、初期化用コンフィグ構造体の内容に応じて 変化します。
ワーク領域サイズの計算には、 criAtom_CalculateWorkSize_IOS 関数を使用してください。
備考:
criAtom_SetUserAllocator マクロを使用してアロケータを登録済みの場合、 本関数にワーク領域を指定する必要はありません。
( work に NULL 、 work_size に 0 を指定することで、登録済みのアロケータ から必要なワーク領域サイズ分のメモリが動的に確保されます。)
引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意:
本関数は内部的に以下の関数を実行します。
本関数を実行する場合、上記関数を実行しないでください。

本関数を実行後、必ず対になる criAtom_Finalize_IOS 関数を実行してください。
また、 criAtom_Finalize_IOS 関数を実行するまでは、本関数を再度実行しないでください。

本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_Initialize_IOS 関数をご利用ください。
参照:
CriAtomConfig_IOS, criAtom_Finalize_IOS, criAtom_SetUserAllocator, criAtom_CalculateWorkSize_IOS
void CRIAPI criAtom_Finalize_IOS ( void  )

ライブラリの終了

説明:
ライブラリを終了します。
注意:
本関数は内部的に以下の関数を実行します。
本関数を実行する場合、上記関数を実行しないでください。

criAtom_Initialize_IOS 関数実行前に本関数を実行することはできません。

本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_Finalize_IOS 関数をご利用ください。
参照:
criAtom_Initialize_IOS
void CRIAPI criAtom_SetServerThreadPriority_IOS ( int  prio)

サーバスレッドプライオリティの設定

引数:
[in]prioスレッドのプライオリティ
説明:
CRIサーバスレッドのプライオリティを設定します。
引数 prio は pthread のプライオリティ設定値として使用します。
プライオリティ設定値はメインスレッドからの相対値になります。
アプリケーションのメインスレッド(0)よりも高いプライオリティを指定してください。
プライオリティのデフォルト値は16です。
注意:
criAtom_Initialize_IOS 関数実行前に本関数を実行することはできません。

サーバ処理スレッドは、CRI File Systemライブラリでも利用されています。
すでにCRI File SystemライブラリのAPIでサーバ処理スレッドの設定を変更している場合 本関数により設定が上書きされますのでご注意ください。
void CRIAPI criAtom_StartSound_IOS ( void  )

サウンド処理の再開

説明:
AudioSessionのInterruption Callbak関数から呼び出すための関数です。
サウンド処理を再開します。
本関数を呼び出す前に、AudioSessionのパメラータ設定とアクティベイトを行ってください。

本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_StartSound_IOS 関数をご利用ください。
注意:
criAtom_Initialize_IOS 関数実行前に本関数を実行することはできません。
参照:
criAtom_StopSound_IOS
void CRIAPI criAtom_StopSound_IOS ( void  )

サウンド処理の停止

説明:
AudioSessionのInterruption Callbak関数から呼び出すための関数です。
サウンド処理を停止します。

本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_StopSound_IOS 関数をご利用ください。
注意:
criAtom_Initialize_IOS 関数実行前に本関数を実行することはできません。
参照:
criAtom_StartSound_IOS
void CRIAPI criAtom_RecoverSound_IOS ( void  )

サウンドの復旧

説明:
AudioSessionAddPropertyListener Callback関数から呼び出すための関数です。
ライブラリ内部のボイスを復旧します。
iOSのデーモンであるmediaserverdが死亡した際には、ライブラリ内のボイスが無効なボイスになり、 再生成が必要になります。
このように、ボイスの復旧が必要な際に呼び出してください。

本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_RecoverSound_IOS 関数をご利用ください。
CriBool CRIAPI criAtom_IsInitializationSucceeded_IOS ( void  )

サウンドの初期化に成功したか否か

説明:
サウンドライブラリの初期化に成功したか否かを返す関数です。
iOSでは、アプリがバックグラウンドにある状態でサウンドライブラリの初期化を行った場合に 内部的にAudioSessionの初期化等に失敗している場合があります。
本関数で初期化が失敗していることを確認した場合は、アプリがフォアグラウンドにある状態で 再度ライブラリの初期化を行うか、 criAtom_RecoverSound_IOS を用いて サウンドの復旧を行う必要があります。

本関数は下位レイヤ向けのAPIです。
AtomExレイヤの機能を利用する際には、本関数の代わりに criAtomEx_IsInitializationSucceeded_IOS 関数をご利用ください。
CriSint32 CRIAPI criAtomEx_CalculateWorkSize_IOS ( const CriAtomExConfig_IOS config)

ライブラリ初期化用ワーク領域サイズの計算

引数:
[in]config初期化用コンフィグ構造体
戻り値:
CriSint32 ワーク領域サイズ
説明:
ライブラリを使用するために必要な、ワーク領域のサイズを取得します。
備考:
ライブラリが必要とするワーク領域のサイズは、ライブラリ初期化用コンフィグ 構造体( CriAtomExConfig_IOS )の内容によって変化します。

引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意:
CriAtomExConfig_IOS 構造体のacf_infoメンバに値を設定している場合、本関数は失敗し-1を返します。
初期化処理内でACFデータの登録を行う場合は、本関数値を使用したメモリ確保ではなくADX2システムによる メモリアロケータを使用したメモリ確保処理が必要になります。
参照:
CriAtomExConfig_IOS, criAtomEx_Initialize_IOS
void CRIAPI criAtomEx_Initialize_IOS ( const CriAtomExConfig_IOS config,
void *  work,
CriSint32  work_size 
)

ライブラリの初期化

引数:
[in]config初期化用コンフィグ構造体
[in]workワーク領域
[in]work_sizeワーク領域サイズ
説明:
ライブラリを初期化します。
ライブラリの機能を利用するには、必ずこの関数を実行する必要があります。
(ライブラリの機能は、本関数を実行後、 criAtomEx_Finalize_IOS 関数を実行するまでの間、 利用可能です。)

ライブラリを初期化する際には、ライブラリが内部で利用するためのメモリ領域(ワーク領域) を確保する必要があります。
ライブラリが必要とするワーク領域のサイズは、初期化用コンフィグ構造体の内容に応じて 変化します。
ワーク領域サイズの計算には、 criAtomEx_CalculateWorkSize_IOS 関数を使用してください。
備考:
criAtomEx_SetUserAllocator マクロを使用してアロケータを登録済みの場合、 本関数にワーク領域を指定する必要はありません。
( work に NULL 、 work_size に 0 を指定することで、登録済みのアロケータ から必要なワーク領域サイズ分のメモリが動的に確保されます。)
引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意:
本関数は内部的に以下の関数を実行します。
本関数を実行する場合、上記関数を実行しないでください。

本関数を実行後、必ず対になる criAtomEx_Finalize_IOS 関数を実行してください。
また、 criAtomEx_Finalize_IOS 関数を実行するまでは、本関数を再度実行しないでください。
参照:
CriAtomExConfig_IOS, criAtomEx_Finalize_IOS, criAtomEx_SetUserAllocator, criAtomEx_CalculateWorkSize_IOS
void CRIAPI criAtomEx_Finalize_IOS ( void  )

ライブラリの終了

説明:
ライブラリを終了します。
注意:
本関数は内部的に以下の関数を実行します。
本関数を実行する場合、上記関数を実行しないでください。

criAtomEx_Initialize_IOS 関数実行前に本関数を実行することはできません。
参照:
criAtomEx_Initialize_IOS
void CRIAPI criAtomEx_SetServerThreadPriority_IOS ( int  prio)

サーバスレッドプライオリティの設定

引数:
[in]prioスレッドのプライオリティ
説明:
CRIサーバスレッドのプライオリティを設定します。
引数 prio は pthread のプライオリティ設定値として使用します。
プライオリティ設定値はメインスレッドからの相対値になります。
アプリケーションのメインスレッド(0)よりも高いプライオリティを指定してください。
プライオリティのデフォルト値は16です。
注意:
criAtomEx_Initialize_IOS 関数実行前に本関数を実行することはできません。

サーバ処理スレッドは、CRI File Systemライブラリでも利用されています。
すでにCRI File SystemライブラリのAPIでサーバ処理スレッドの設定を変更している場合 本関数により設定が上書きされますのでご注意ください。
void CRIAPI criAtomEx_StartSound_IOS ( void  )

サウンド処理の再開

説明:
AudioSessionのInterruption Callbak関数から呼び出すための関数です。
サウンド処理を再開します。
本関数を呼び出す前に、AudioSessionのパメラータ設定とアクティベイトを行ってください。
例:
 // AudioSession Interruption Callbak
 static void interruptionListenerCallback(void *inUserData, UInt32 interruptionState)
 {
    if (interruptionState == kAudioSessionBeginInterruption) {
        // オーディオ処理の停止
        criAtomEx_StopSound_IOS();
    }
    if (interruptionState == kAudioSessionEndInterruption) {
        // AudioSessionのプロパティ設定とアクティベイト
        setupAudioSession();
        // オーディオ処理の開始
        criAtomEx_StartSound_IOS();
    }
 }
 // AudioSessionのプロパティ設定とアクティベイト
 static void setupAudioSession(void)
 {
        :
 }
注意:
criAtomEx_Initialize_IOS 関数実行前に本関数を実行することはできません。
参照:
criAtomEx_StopSound_IOS
void CRIAPI criAtomEx_StopSound_IOS ( void  )

サウンド処理の停止

説明:
AudioSessionのInterruption Callbak関数から呼び出すための関数です。
サウンド処理を停止します。
注意:
criAtomEx_Initialize_IOS 関数実行前に本関数を実行することはできません。
参照:
criAtomEx_StartSound_IOS
void CRIAPI criAtomEx_RecoverSound_IOS ( void  )

サウンドの復旧

説明:
AudioSessionAddPropertyListener Callback関数から呼び出すための関数です。
ライブラリ内部のボイスを復旧します。
iOSのデーモンであるmediaserverdが死亡した際には、ライブラリ内のボイスが無効なボイスになり、 再生成が必要になります。
このように、ボイスの復旧が必要な際に呼び出してください。
CriBool CRIAPI criAtomEx_IsInitializationSucceeded_IOS ( void  )

サウンドの初期化に成功したか否か

説明:
サウンドライブラリの初期化に成功したか否かを返す関数です。
iOSでは、アプリがバックグラウンドにある状態でサウンドライブラリの初期化を行った場合に 内部的にAudioSessionの初期化等に失敗している場合があります。
本関数で初期化が失敗していることを確認した場合は、アプリがフォアグラウンドにある状態で 再度ライブラリの初期化を行うか、 criAtomEx_RecoverSound_IOS を用いて サウンドの復旧を行う必要があります。

CRI Middleware logo Copyright (c) 2012-2018 CRI Middleware Co., Ltd. CRI ADX2 LE マニュアル (for Cocos2d-x) SDKVer.2.10版