前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFBVocoder
IVocoder インターフェースのラッパークラスです。
#include <SFBVocoder.h.hpp>
class SFBVocoder : public SFBBase;
SFMTYPEDEFWRAPPER(SFBVocoder)

継承図

SFBVocoder クラスの継承図

バージョン

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0

参照

BREW API IVocoder

メンバ

パブリック関数
SInt16 GetFrameLength( VocoderType type , DataRateType rate , UInt16Ptr length )
与えられたレートでの指定したボコーダフレームのサイズを取得します。
SFCError GetInDepth( UInt16Ptr depth )
キューに格納されているエンコードされたフレームの数を取得します。
SFCError GetOutDepth( UInt16Ptr depth )
再生のためキューに格納されているフレームの数を取得します。
static
SFBVocoderSmp
NewInstance( SFCErrorPtr exception = null )
SFBVocoder インスタンスを生成します。
static
SFBVocoderSmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
SFBVocoder インスタンスを生成します。
SFCError PlayTone( UInt16 tone1 , UInt16 tone2 , SInt16 volume , UInt16 duration )
ボコーダを通してトーンを再生します。
SFCError VocConfigure( IVocoderConfigType config , IVocoderInfoType* info )
特定のボコーダを使用するようにボコーダ オブジェクトを構成します。
SFCError VocInRead( DataRateType* rate , UInt16Ptr length , VoidPtr data )
キューから、最古のエンコードされた音声フレームを取得します。
SFCError VocInRead( DataRateType* rate , SFXBufferPtr data )
キューから、最古のエンコードされた音声フレームを取得します。
SFCError VocInReset( Void )
エンコードされたボコーダ フレームのキューを停止、クリアします。
SFCError VocInStart( Void )
音声フレームのエンコードを開始します。
SFCError VocInStop( Void )
音声フレームのエンコードを停止します。
SFCError VocOutReset( Void )
デコードに使用可能なフレームのキューをクリアします。
SFCError VocOutStart( Void )
キュー内のフレームのデコードと再生を開始します。
SFCError VocOutStop( Void )
キュー内のフレームのデコードと再生を停止します。
SFCError VocOutWrite( DataRateType rate , UInt16 length , VoidConstPtr data )
デコーダに新しいデータ フレームを供給します。
SFCError VocOutWrite( DataRateType rate , SFXBufferConstRef data )
デコーダに新しいデータ フレームを供給します。
プロテクト関数
static
SFBBaseSmp
FactoryByCreate( AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを生成します。
static
SFBBaseSmp
FactoryByQuery( SFBQuerySmpConstRef query , AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBVocoder::GetFrameLength
与えられたレートでの指定したボコーダフレームのサイズを取得します。
[ public ]
SInt16 GetFrameLength(
    VocoderType type    // フレームのボコーダタイプ
    DataRateType rate   // フレームのデータレート
    UInt16Ptr length    // フレームのサイズを読み込むストレージへのポインタ
);

参照

BREW API IVOCODER_GetFrameLength


SFBVocoder::GetInDepth
キューに格納されているエンコードされたフレームの数を取得します。
[ public ]
SFCError GetInDepth(
    UInt16Ptr depth   // キュー内のフレームの数を読み込むストレージへのポインタ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED

参照

BREW API IVOCODER_GetInDepth


SFBVocoder::GetOutDepth
再生のためキューに格納されているフレームの数を取得します。
[ public ]
SFCError GetOutDepth(
    UInt16Ptr depth   // キュー内のフレームの数を読み込むストレージへのポインタ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED

参照

BREW API IVOCODER_GetOutDepth


SFBVocoder::NewInstance
SFBVocoder インスタンスを生成します。
[ public, static ]
SFBVocoderSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);
[ public, static ]
SFBVocoderSmp NewInstance(
    AEECLSID id                    // クラスID
    SFCErrorPtr exception = null   // エラー値
);

SFBVocoder::PlayTone
ボコーダを通してトーンを再生します。
[ public ]
SFCError PlayTone(
    UInt16 tone1      // 第 1 トーンの周波数
    UInt16 tone2      // 第 2 トーンの周波数
    SInt16 volume     // トーンのボリューム
    UInt16 duration   // トーンの長さ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED
  • SFBVocoder が現在、再生中または取得中のとき : AEE_VOC_EACTIVE

参照

BREW API IVOCODER_PlayTone


SFBVocoder::VocConfigure
特定のボコーダを使用するようにボコーダ オブジェクトを構成します。
[ public ]
SFCError VocConfigure(
    IVocoderConfigType config   // ボコーダ オブジェクトの構成パラメータ
    IVocoderInfoType* info      // 選択されたボコーダについての構成情報
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 失敗したとき: SFERR_FAILED
  • 指定されたボコーダが使用可能でないとき : AEE_VOC_ENOT_AVAIL
  • 指定された最小または最大レートがボコーダでサポートされていないとき : AEE_VOC_ERATE_OUT_OF_RANGE
  • 送信低減値が不適切なとき : AEE_VOC_EBAD_TX_REDUCTION
  • ボコーダーが現在、SFBVocoder の別のインスタンスによって使用されているとき : AEE_VOC_IN_USE

参照

BREW API IVOCODER_VocConfigure | IVocoderConfigType


SFBVocoder::VocInRead
キューから、最古のエンコードされた音声フレームを取得します。
[ public ]
SFCError VocInRead(
    DataRateType* rate   // フレームのデータレートを読み込むストレージへのポインタ
    UInt16Ptr length     // フレームのサイズ( バイト数 )を読み込むストレージへのポインタ
    VoidPtr data         // エンコードされたフレームバイトを読み込むストレージへのポインタ
);
[ public ]
SFCError VocInRead(
    DataRateType* rate   // フレームのデータレートを読み込むストレージへのポインタ
    SFXBufferPtr data    // エンコードされたフレームバイトを読み込むバッファサイズは API 呼び出し時に UInt16 に変換される
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • data が null のとき: SFERR_INVALID_PARAM
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED
  • キュー内にエンコードされたフレームがないとき : AEE_VOC_EBUFFER_EMPTY

参照

BREW API IVOCODER_VocInRead | IVocoderConfigType


SFBVocoder::VocInReset
エンコードされたボコーダ フレームのキューを停止、クリアします。
[ public ]
SFCError VocInReset(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED

参照

BREW API IVOCODER_VocInReset | SFBVocoder::VocInStop


SFBVocoder::VocInStart
音声フレームのエンコードを開始します。
[ public ]
SFCError VocInStart(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED

参照

BREW API IVOCODER_VocInStart | IVocoderConfigType


SFBVocoder::VocInStop
音声フレームのエンコードを停止します。
[ public ]
SFCError VocInStop(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED

参照

BREW API IVOCODER_VocInStop | IVocoderConfigType


SFBVocoder::VocOutReset
デコードに使用可能なフレームのキューをクリアします。
[ public ]
SFCError VocOutReset(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED

参照

BREW API IVOCODER_VocOutReset | IVocoderConfigType


SFBVocoder::VocOutStart
キュー内のフレームのデコードと再生を開始します。
[ public ]
SFCError VocOutStart(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED

参照

BREW API IVOCODER_VocOutStart | SFBVocoder::VocOutWrite | IVocoderConfigType


SFBVocoder::VocOutStop
キュー内のフレームのデコードと再生を停止します。
[ public ]
SFCError VocOutStop(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED

参照

BREW API IVOCODER_VocOutStop


SFBVocoder::VocOutWrite
デコーダに新しいデータ フレームを供給します。
[ public ]
SFCError VocOutWrite(
    DataRateType rate   // フレームのデータ レート
    UInt16 length       // フレームのサイズ( バイト数 )
    VoidConstPtr data   // フレーム データ バイトへのポインタ
);
[ public ]
SFCError VocOutWrite(
    DataRateType rate        // フレームのデータ レート
    SFXBufferConstRef data   // バッファサイズは API 呼び出し時に UInt16 に変換される
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • SFBVocoder が他のアプリケーションで使用中のとき : AEE_VOC_EIN_USE
  • SFBVocoder が構成されていないとき : AEE_VOC_ENOT_CONFIGED
  • 出力キューがこれ以上フレームを受け入れることができないとき : AEE_VOC_EBUFFER_FULL
  • 再生操作が開始されていないときに、フレームが再生のためキューに格納されたとき : AEE_VOC_ENOT_STARTED

参照

BREW API IVOCODER_VocOutWrite | IVocoderConfigType