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

継承図

SFBRingerMgr クラスの継承図

バージョン

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0

参照

BREW API IRingerMgr

メンバ

パブリック関数
SFCError Create( WCharConstPtr name , AEESoundPlayerFile format , SFBAStreamSmpConstRef s )
新しい着信音を作成します。
SFCError Create( SFXWideStringConstRef name , AEESoundPlayerFile format , SFBAStreamSmpConstRef s )
新しい着信音を作成します。
SFCError Create( SFXWideStringConstRef name , AEESoundPlayerFile format , SFXStorageConstRef storage )
新しい着信音を作成します。
SFCError EnumCategoryInit( Void )
カテゴリ列挙の列挙内容を初期化します。
Bool EnumNextCategory( AEERingerCat* category )
次の着信音カテゴリを列挙します。
Bool EnumNextRinger( AEERingerInfo* info )
次の着信音を列挙します。
SFCError EnumRingerInit( Void )
着信音のリストの列挙を初期化します。
SFCError GetFormats( AEESoundPlayerFile* formats , SInt32 count )
サポートされている着信音形式のリストを取得します。
SInt32 GetNumberFormats( Void )
デバイスでサポートされている着信音形式の数を取得します。
AEERingerID GetRingerID( ACharConstPtr file )
ファイル名を指定した着信音の着信音 ID を取得します。
AEERingerID GetRingerID( SFXAnsiStringConstRef file )
ファイル名を指定した着信音の着信音 ID を取得します。
SFCError GetRingerInfo( AEERingerID ringerID , AEERingerInfo* info )
指定した着信音の情報を取得します。
static
SFBRingerMgrSmp
NewInstance( SFCErrorPtr exception = null )
SFBRingerMgr インスタンスを生成します。
static
SFBRingerMgrSmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
SFBRingerMgr インスタンスを生成します。
SFCError Play( AEERingerID ringerID , UInt32 pause )
インストールされている着信音を再生します。
SFCError PlayEx( AEERingerID ringerID , ACharConstPtr file , SFBAStreamSmpConstRef s , UInt32 pause )
指定した着信音を再生します。
SFCError PlayEx( AEERingerID ringerID , SFXAnsiStringConstRef file , SFBAStreamSmpConstRef s , UInt32 pause )
指定した着信音を再生します。
SFCError PlayEx( AEERingerID ringerID , SFXAnsiStringConstRef file , SFXStorageConstRef storage , UInt32 pause )
指定した着信音を再生します。
SFCError PlayFile( ACharConstPtr file , UInt32 pause )
入力ファイル名を指定した着信音を再生します。
SFCError PlayFile( SFXAnsiStringConstRef file , UInt32 pause )
入力ファイル名を指定した着信音を再生します。
SFCError PlayStream( SFBAStreamSmpConstRef s , UInt32 pause )
入力 SFBAStream インターフェースオブジェクトを使用して、指定された着信音を再生します。
SFCError PlayStream( SFXStorageConstRef storage , UInt32 pause )
入力 SFBAStream インターフェースオブジェクトを使用して、指定された着信音を再生します。
Void RegisterNotify( PFNRINGEREVENT notify , VoidPtr data = null )
再生イベントまたは作成イベントが完了したときに、通知コールバックを登録または登録解除します。
SFCError Remove( AEERingerID ringerID )
指定した着信音を削除します。
SFCError SetRinger( AEERingerCatID category , AEERingerID ringerID )
再生する着信音を、選択されたカテゴリからコール側で設定します。
SFCError Stop( Void )
着信音の再生を停止します。
プロテクト関数
static
SFBBaseSmp
FactoryByCreate( AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを生成します。
static
SFBBaseSmp
FactoryByQuery( SFBQuerySmpConstRef query , AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBRingerMgr::Create
新しい着信音を作成します。
[ public ]
SFCError Create(
    WCharConstPtr name          // 着信音の名前
    AEESoundPlayerFile format   // 着信音の形式
    SFBAStreamSmpConstRef s     // 着信音データへのストリーム
);
[ public ]
SFCError Create(
    SFXWideStringConstRef name   // 着信音の名前
    AEESoundPlayerFile format    // 着信音の形式
    SFBAStreamSmpConstRef s      // 着信音データへのストリーム
);
[ public ]
SFCError Create(
    SFXWideStringConstRef name   // 着信音の名前
    AEESoundPlayerFile format    // 着信音の形式
    SFXStorageConstRef storage   // 着信音データへのストレージ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • storage が閉じているとき: SFERR_INVALID_STATE
  • 引数が null のとき: SFERR_INVALID_PARAM
  • 着信音が無効なとき: SFERR_FAILED

参照

BREW API IRINGERMGR_Create | AEESoundPlayerFile


SFBRingerMgr::EnumCategoryInit
カテゴリ列挙の列挙内容を初期化します。
[ public ]
SFCError EnumCategoryInit(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: AEEError.h で定義されているエラー値

参照

BREW API IRINGERMGR_EnumCategoryInit | SFBRingerMgr::EnumNextCategory


SFBRingerMgr::EnumNextCategory
次の着信音カテゴリを列挙します。
[ public ]
Bool EnumNextCategory(
    AEERingerCat* category   // 取得する着信音カテゴリ情報へのポインタ
);

戻り値

  • 列挙に成功したとき: true
  • 列挙に失敗したとき: false

参照

BREW API IRINGERMGR_EnumNextCategory | AEERingerCat


SFBRingerMgr::EnumNextRinger
次の着信音を列挙します。
[ public ]
Bool EnumNextRinger(
    AEERingerInfo* info   // 取得する着信音情報へのポインタ
);

戻り値

  • 列挙に成功したとき: true
  • 列挙に失敗したとき: false

参照

BREW API IRINGERMGR_EnumNextRinger | AEERingerInfo | SFBRingerMgr::EnumRingerInit


SFBRingerMgr::EnumRingerInit
着信音のリストの列挙を初期化します。
[ public ]
SFCError EnumRingerInit(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: SFERR_FAILED
  • その他のエラーのとき: AEEError.h で定義されているエラー値

参照

BREW API IRINGERMGR_EnumRingerInit | SFBRingerMgr::EnumNextRinger


SFBRingerMgr::GetFormats
サポートされている着信音形式のリストを取得します。
[ public ]
SFCError GetFormats(
    AEESoundPlayerFile* formats   // サイズが count * sizeof( AEESoundPlayerFile ) の形式のリストへのポインタ
    SInt32 count                  // 取得する形式エントリの数
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: SFERR_FAILED

参照

BREW API IRINGERMGR_GetFormats | AEESoundPlayerFile | SFBRingerMgr::GetNumberFormats


SFBRingerMgr::GetNumberFormats
デバイスでサポートされている着信音形式の数を取得します。
[ public ]
SInt32 GetNumberFormats(Void);

参照

BREW API IRINGERMGR_GetNumberFormats | SFBRingerMgr::GetFormats


SFBRingerMgr::GetRingerID
ファイル名を指定した着信音の着信音 ID を取得します。
[ public ]
AEERingerID GetRingerID(
    ACharConstPtr file   // 着信音のルートファイル名
);
[ public ]
AEERingerID GetRingerID(
    SFXAnsiStringConstRef file   // 着信音のルートファイル名
);

参照

BREW API IRINGERMGR_GetRingerID | AEERingerID | AEERingerInfo


SFBRingerMgr::GetRingerInfo
指定した着信音の情報を取得します。
[ public ]
SFCError GetRingerInfo(
    AEERingerID ringerID   // 着信音 ID
    AEERingerInfo* info    // 取得する着信音情報構造体へのポインタ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: SFERR_FAILED

参照

BREW API IRINGERMGR_GetRingerInfo | AEERingerID | AEERingerInfo


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

SFBRingerMgr::Play
インストールされている着信音を再生します。
[ public ]
SFCError Play(
    AEERingerID ringerID   // 再生する着信音 ID
    UInt32 pause           // 再生と再生の間の停止間隔
                           // 1 回だけ再生の場合は 0 ( ゼロ )
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 着信音が無効なとき: SFERR_FAILED
  • その他のエラーのとき: AEEError.h で定義されているエラー値

参照

BREW API IRINGERMGR_Play | AEERingerID | SFBRingerMgr::Stop


SFBRingerMgr::PlayEx
指定した着信音を再生します。
[ public ]
SFCError PlayEx(
    AEERingerID ringerID      // 再生する着信音 ID
    ACharConstPtr file        // 入力ファイル名
    SFBAStreamSmpConstRef s   // ストリーム
    UInt32 pause              // 再生と再生の間の停止間隔
                              // 1 回だけ再生の場合は 0( ゼロ )
);
[ public ]
SFCError PlayEx(
    AEERingerID ringerID         // 再生する着信音 ID
    SFXAnsiStringConstRef file   // 入力ファイル名
    SFBAStreamSmpConstRef s      // ストリーム
    UInt32 pause                 // 再生と再生の間の停止間隔
                                 // 1 回だけ再生の場合は 0( ゼロ ) 
);
[ public ]
SFCError PlayEx(
    AEERingerID ringerID         // 再生する着信音 ID
    SFXAnsiStringConstRef file   // 入力ファイル名
    SFXStorageConstRef storage   // 入力ストレージ
    UInt32 pause                 // 再生と再生の間の停止間隔
                                 // 1 回だけ再生の場合は 0( ゼロ )
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • storage が閉じているとき: SFERR_INVALID_STATE
  • 引数が null のとき: SFERR_INVALID_PARAM
  • 着信音が無効なとき: SFERR_FAILED
  • その他のエラーのとき: AEEError.h で定義されているエラー値

参照

BREW API IRINGERMGR_PlayEx | AEERingerID | SFBRingerMgr::Stop


SFBRingerMgr::PlayFile
入力ファイル名を指定した着信音を再生します。
[ public ]
SFCError PlayFile(
    ACharConstPtr file   // 入力ファイル名
    UInt32 pause         // 再生と再生の間の停止間隔( 1 回だけ再生の場合は 0 )
);
[ public ]
SFCError PlayFile(
    SFXAnsiStringConstRef file   // 入力ファイル名
    UInt32 pause                 // 再生と再生の間の停止間隔( 1 回だけ再生の場合は 0 )
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 着信音が無効なとき: SFERR_FAILED
  • その他のエラーのとき: AEEError.h で定義されているエラー値

参照

BREW API IRINGERMGR_PlayFile | SFBRingerMgr::Stop


SFBRingerMgr::PlayStream
入力 SFBAStream インターフェースオブジェクトを使用して、指定された着信音を再生します。
[ public ]
SFCError PlayStream(
    SFBAStreamSmpConstRef s   // 入力ファイル名
    UInt32 pause              // 再生と再生の間の停止間隔( ミリ秒 )
                              // 1 回だけ再生の場合は 0 ( ゼロ )
);
[ public ]
SFCError PlayStream(
    SFXStorageConstRef storage   // 入力ファイル名
    UInt32 pause                 // 再生と再生の間の停止間隔( ミリ秒 )
                              // 1 回だけ再生の場合は 0 ( ゼロ )
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • storage が閉じているとき: SFERR_INVALID_STATE
  • 引数が null のとき: SFERR_INVALID_PARAM
  • 着信音が無効なとき: SFERR_FAILED
  • その他のエラーのとき: AEEError.h で定義されているエラー値

参照

BREW API IRINGERMGR_PlayStream


SFBRingerMgr::RegisterNotify
再生イベントまたは作成イベントが完了したときに、通知コールバックを登録または登録解除します。
[ public ]
Void RegisterNotify(
    PFNRINGEREVENT notify   // ユーザー コールバックへのポインタ( 登録解除の場合は null )
    VoidPtr data = null     // コールバックのユーザー データへのポインタ
                            // データの識別が不要な場合は null を指定できる
);

参照

BREW API IRINGERMGR_RegisterNotify | PFNRINGEREVENT


SFBRingerMgr::Remove
指定した着信音を削除します。
[ public ]
SFCError Remove(
    AEERingerID ringerID   // 着信音 ID
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 着信音が無効なとき: SFERR_FAILED
  • その他のエラーのとき: AEEError.h で定義されているエラー値

参照

BREW API IRINGERMGR_Remove | AEERingerID


SFBRingerMgr::SetRinger
再生する着信音を、選択されたカテゴリからコール側で設定します。
[ public ]
SFCError SetRinger(
    AEERingerCatID category   // 着信音のカテゴリ
    AEERingerID ringerID      // 着信音の ID
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: SFERR_FAILED

参照

BREW API IRINGERMGR_SetRinger | AEERingerID | AEERingerCatID | SFBRingerMgr::EnumNextCategory


SFBRingerMgr::Stop
着信音の再生を停止します。
[ public ]
SFCError Stop(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: SFERR_FAILED

参照

BREW API IRINGERMGR_Stop | SFBRingerMgr::Play