SophiaFramework UNIVERSE 5.3 |
BREW 2.0 | BREW 2.1 | BREW 3.1 | BREW 4.0 |
---|---|---|---|
O | O | O | O |
Public Functions | |
---|---|
SFCError |
Create(
WCharConstPtr name
, AEESoundPlayerFile format
, SFBAStreamSmpConstRef s
) Create a new ringer.
|
SFCError |
Create(
SFXWideStringConstRef name
, AEESoundPlayerFile format
, SFBAStreamSmpConstRef s
) Create a new ringer.
|
SFCError |
Create(
SFXWideStringConstRef name
, AEESoundPlayerFile format
, SFXStorageConstRef storage
) Create a new ringer.
|
SFCError |
EnumCategoryInit( Void ) Initialize the enumeration context category enumeration.
|
Bool |
EnumNextCategory(
AEERingerCat* category
) Enumerate the next ringer category.
|
Bool |
EnumNextRinger(
AEERingerInfo* info
) Enumerate the next ringer.
|
SFCError |
EnumRingerInit( Void ) Initialize enumeration of the list of ringers.
|
SFCError |
GetFormats(
AEESoundPlayerFile* formats
, SInt32 count
) Fill a list of the ringer formats supported.
|
SInt32 |
GetNumberFormats( Void ) Get the number of ringer formats supported on the device.
|
AEERingerID |
GetRingerID(
ACharConstPtr file
) Get the ringer ID for a ringer given the file name.
|
AEERingerID |
GetRingerID(
SFXAnsiStringConstRef file
) Get the ringer ID for a ringer given the file name.
|
SFCError |
GetRingerInfo(
AEERingerID ringerID
, AEERingerInfo* info
) Get information about the specified ringer.
|
static SFBRingerMgrSmp |
NewInstance(
SFCErrorPtr exception = null
) Create a new SFBRingerMgr instance.
|
static SFBRingerMgrSmp |
NewInstance(
AEECLSID id
, SFCErrorPtr exception = null
) Create a new SFBRingerMgr instance.
|
SFCError |
Play(
AEERingerID ringerID
, UInt32 pause
) Play an installed ringer.
|
SFCError |
PlayEx(
AEERingerID ringerID
, ACharConstPtr file
, SFBAStreamSmpConstRef s
, UInt32 pause
) Play the specified ringer.
|
SFCError |
PlayEx(
AEERingerID ringerID
, SFXAnsiStringConstRef file
, SFBAStreamSmpConstRef s
, UInt32 pause
) Play the specified ringer.
|
SFCError |
PlayEx(
AEERingerID ringerID
, SFXAnsiStringConstRef file
, SFXStorageConstRef storage
, UInt32 pause
) Play the specified ringer.
|
SFCError |
PlayFile(
ACharConstPtr file
, UInt32 pause
) Play a ringer given an input file name.
|
SFCError |
PlayFile(
SFXAnsiStringConstRef file
, UInt32 pause
) Play a ringer given an input file name.
|
SFCError |
PlayStream(
SFBAStreamSmpConstRef s
, UInt32 pause
) plays the specified ringer using an input SFBAStream object.
|
SFCError |
PlayStream(
SFXStorageConstRef storage
, UInt32 pause
) plays the specified ringer using an input SFBAStream object.
|
Void |
RegisterNotify(
PFNRINGEREVENT notify
, VoidPtr data = null
) Register or de-register a notification callback that is called when playback or creation events are complete.
|
SFCError |
Remove(
AEERingerID ringerID
) Remove the specified ringer.
|
SFCError |
SetRinger(
AEERingerCatID category
, AEERingerID ringerID
) Specify the ringer to be played from the selected category.
|
SFCError |
Stop( Void ) Terminate playback of a ringer.
|
Protected Functions | |
---|---|
static SFBBaseSmp |
FactoryByCreate(
AEECLSID id
, SFCErrorPtr exception = null
)
(inherits from SFBBase)
Create the instance for the specified ClassID's interface.
|
static SFBBaseSmp |
FactoryByQuery(
SFBQuerySmpConstRef query
, AEECLSID id
, SFCErrorPtr exception = null
)
(inherits from SFBBase)
Create the instance for the specified ClassID's interface using the SFBQuery instance.
|
[ public ] SFCError Create( WCharConstPtr name // name of the ringer AEESoundPlayerFile format // ringer format SFBAStreamSmpConstRef s // stream to ringer data );
[ public ] SFCError Create( SFXWideStringConstRef name // name of the ringer AEESoundPlayerFile format // ringer format SFBAStreamSmpConstRef s // stream to ringer data );
[ public ] SFCError Create( SFXWideStringConstRef name // name of the ringer AEESoundPlayerFile format // ringer format SFXStorageConstRef storage // storage for ringer data );
[ public ] SFCError EnumCategoryInit(Void);
[ public ] Bool EnumNextCategory( AEERingerCat* category // pointer to ringer category information to fill );
[ public ] Bool EnumNextRinger( AEERingerInfo* info // pointer to ringer information to fill );
[ public ] SFCError EnumRingerInit(Void);
[ public ] SFCError GetFormats( AEESoundPlayerFile* formats // pointer to a list of formats of size Count * sizeof(AEESoundPlayerFile) SInt32 count // number of format entries to fill );
[ public ] SInt32 GetNumberFormats(Void);
[ public ] AEERingerID GetRingerID( ACharConstPtr file // file name of ringer );
[ public ] AEERingerID GetRingerID( SFXAnsiStringConstRef file // file name of ringer );
BREW API IRINGERMGR_GetRingerID | AEERingerID | AEERingerInfo
[ public ] SFCError GetRingerInfo( AEERingerID ringerID // ringer ID AEERingerInfo* info // pointer to ringer info structure to fill );
BREW API IRINGERMGR_GetRingerInfo | AEERingerID | AEERingerInfo
[ public, static ] SFBRingerMgrSmp NewInstance( SFCErrorPtr exception = null // Error );
[ public, static ] SFBRingerMgrSmp NewInstance( AEECLSID id // Class ID SFCErrorPtr exception = null // Error );
[ public ] SFCError Play( AEERingerID ringerID // ringer ID to play UInt32 pause // time to pause between re-plays (0 if single play) );
[ public ] SFCError PlayEx( AEERingerID ringerID // ringer ID to play ACharConstPtr file // input file name SFBAStreamSmpConstRef s // input stream UInt32 pause // time to pause between re-plays (0 if single play) );
[ public ] SFCError PlayEx( AEERingerID ringerID // ringer ID to play SFXAnsiStringConstRef file // input file name SFBAStreamSmpConstRef s // input stream UInt32 pause // time to pause between re-plays (0 if single play) );
[ public ] SFCError PlayEx( AEERingerID ringerID // ringer ID to play SFXAnsiStringConstRef file // input file name SFXStorageConstRef storage // input storage UInt32 pause // time to pause between re-plays (0 if single play) );
BREW API IRINGERMGR_PlayEx | AEERingerID | SFBRingerMgr::Stop
[ public ] SFCError PlayFile( ACharConstPtr file // input file name UInt32 pause // time to pause between re-plays (0 if single play) );
[ public ] SFCError PlayFile( SFXAnsiStringConstRef file // input file name UInt32 pause // time to pause between re-plays (0 if single play) );
[ public ] SFCError PlayStream( SFBAStreamSmpConstRef s // input file name UInt32 pause // time to pause between re-plays (0 if single play) );
[ public ] SFCError PlayStream( SFXStorageConstRef storage // input file name UInt32 pause // time to pause between re-plays (0 if single play) );
[ public ] Void RegisterNotify( PFNRINGEREVENT notify // pointer to user callback (null to de-register) VoidPtr data = null // pointer to user data for callback. // if not necessary, it is set to null );
[ public ] SFCError Remove( AEERingerID ringerID // ringer id );
[ public ] SFCError SetRinger( AEERingerCatID category // category for the ringer AEERingerID ringerID // id of the ringer );
BREW API IRINGERMGR_SetRinger | AEERingerID | AEERingerCatID | SFBRingerMgr::EnumNextCategory
[ public ] SFCError Stop(Void);
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |