SophiaFramework UNIVERSE 5.3 |
BREW 2.0 | BREW 2.1 | BREW 3.1 | BREW 4.0 |
---|---|---|---|
O | O | O | O |
Public Functions | |
---|---|
SFCError |
EnableChannelShare(
Bool enable
)
Enable/Disable exclusive playback of the media.
|
SFCError |
EnableFrameCallback(
Bool enable
)
Enable/Disable frame playback of the media.
|
SFCError |
FastForward(
SInt32 time
)
Fast forward lTimeMS milliseconds from the current position.
The media is left in the current state.
|
SFCError |
GetClassID(
AEECLSID* clsid
)
Retrieve the class ID of SFBMedia Interface object.
|
AEECLSID |
GetClassID( Void )
Retrieve the class ID of SFBMedia Interface object.
|
SFCError |
GetDecryptCaps(
UInt32Ptr caps
, UInt32ConstHandle formats
)
Retrieves the decryption capabilities, including the decryption formats, supported for the media.
|
SFCError |
GetFrame(
SFBBitmapSmpPtr frame
)
Retrieves the current frame as SFBBitmap pointer.
|
SFCError |
GetMediaData(
AEEMediaData* data
)
Get the media data.
|
SFCError |
GetMediaParm(
SInt32 id
, SInt32Ptr param1
, SInt32Ptr param2
)
Get the parameters.
|
SFCError |
GetRect(
SFXRectanglePtr imgRect
, SFXRectanglePtr textRect
)
Retrieve the destination image rectangle and text rectangle.
|
SInt32 |
GetState(
BoolPtr stateChanging
)
Return the current state of SFBMedia Interface
and also indicates if the SFBMedia Interface object is currently in state transition.
|
SFCError |
GetTotalTime( Void )
Return the total playback time of the SFBMedia Interface object.
|
SFCError |
GetVolume(
UInt16Ptr volume
)
Retrieve the volume of the current playback / recording.
|
UInt16 |
GetVolume( Void )
Retrieve the volume of the current playback / recording.
|
SFCError |
IsChannelShare(
BoolPtr enable
)
Retrieves the current channel share setting.
|
SFCError |
IsFrameCallback(
BoolPtr enable
)
Retrieves the current frame callback enable/disable setting.
|
static SFBMediaSmp |
NewInstance(
SFCErrorPtr exception = null
)
Create a new SFBMedia instance.
|
static SFBMediaSmp |
NewInstance(
AEECLSID id
, SFCErrorPtr exception = null
)
Create a new SFBMedia instance.
|
SFCError |
Pause( Void )
Pause the media.
|
SFCError |
Play( Void )
Start the playback of a media.
|
SFCError |
Record( Void )
Start the recording of a media.
|
SFCError |
RegisterNotify(
PFNMEDIANOTIFY notify
, VoidPtr data = null
)
Register a callback notification function.
|
SFCError |
Resume( Void )
Resume the media from the current position.
|
SFCError |
Rewind(
SInt32 time
)
Rewind the specified time from the current position.
The media is left in the current state.
|
SFCError |
Seek(
AEEMediaSeek seek
, SInt32 time
)
Seek the media position.
The media is left in the current state.
|
SFCError |
SeekFrame(
AEEMediaSeek seek
, SInt32 frames
)
Seek the media pos based on the seek reference and number of frames.
Typically, this API is used for video formats to seek based on frames.
The media is left in the current state.
|
SFCError |
SetAudioDevice(
AEESoundDevice device
)
Set the audio output device.
|
SFCError |
SetAudioPath(
SInt32 path
, UInt32 pause
)
Set the audio path for playback/recording.
|
SFCError |
SetDecryptInfo(
AEEMediaDecryptInfo* info
)
Set required decryption info necessary to decrypt the media content.
|
SFCError |
SetMediaData(
AEEMediaData* data
)
Set the media data and puts the media in Ready state.
|
SFCError |
SetMediaDataEx(
AEEMediaDataEx* mediaContent
, SInt32 count
)
Set a list of media data and puts the media in Ready state.
|
SFCError |
SetMediaParm(
SInt32 id
, SInt32 param1
, SInt32 param2
)
Set specified the media parameters.
|
SFCError |
SetMuteCtl(
Bool mute
)
Mute / Unmute the current audio path.
|
SFCError |
SetPan(
UInt16 pan
)
Set the pan factor of the current playback.
|
SFCError |
SetRect(
SFXRectanglePtr imgRect
, SFXRectanglePtr textRect
)
Set the destination image rectangle and text rectangle.
|
SFCError |
SetTickTime(
UInt32 tick
)
Set periodicity of MM_TICK_UPDATE event sent to the application during playback/recording.
|
SFCError |
SetVolume(
UInt16 volume
)
Set the volume of the current playback / recording.
|
SFCError |
Stop( Void )
Stop the playback/recording of media.
|
SFCError |
QueryInterface(
AEECLSID clsid
, VoidHandle handle
)
(inherits from SFBQuery)
Ask an object for another API contract from the object in question.
|
SFCError |
QueryInterface(
AEECLSID clsid
, SFBBaseSmpPtr handle
)
(inherits from SFBQuery)
Ask an object for another API contract from the object in question.
|
SFBBaseSmp |
QueryInterface(
AEECLSID clsid
)
(inherits from SFBQuery)
Ask an object for another API contract from the object in question.
|
Void |
Self(
AEECLSID clsidReq
, SFBQuerySmpPtr clone
, AEECLSID clsidImp
)
(inherits from SFBQuery)
Helper macro for those implementing an object with a single interface.
|
SFBQuerySmp |
Self(
AEECLSID clsidReq
, AEECLSID clsidImp
)
(inherits from SFBQuery)
Helper macro for those implementing an object with a single interface.
|
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 EnableChannelShare( Bool enable // true/false => Enable/Disable channel share );
Supported in BREW 2.1 or later.
[ public ] SFCError EnableFrameCallback( Bool enable // true/false => Enable/Disable frame callback );
Supported in BREW 2.1 or later.
BREW API IMEDIA_FastForward | SFBMedia::Seek | SFBMedia::Rewind | SFBMedia::Play
[ public ] SFCError GetClassID( AEECLSID* clsid // pointer to the space for retrieving ClassID );
[ public ] AEECLSID GetClassID(Void);
[ public ] SFCError GetDecryptCaps( UInt32Ptr caps // pointer to ORed MM_DECRYPT_CAPS_XXX (see comments) UInt32ConstHandle formats // pointer to a zero-terminated array of decryption formats supported );
This function is available in BREW 3.1.
[ public ] SFCError GetFrame( SFBBitmapSmpPtr frame // pointer to space for retrieving SFBBitmap object );
Supported in BREW 2.1 or later.
[ public ] SFCError GetMediaData( AEEMediaData* data // pointer to space for retrieving media data );
BREW API IMEDIA_GetMediaData | AEEMediaData | SFBMedia::GetMediaParm | SFBMedia::GetMediaData | SFBMedia::SetMediaParm
[ public ] SFCError GetMediaParm( SInt32 id // parameter ID SInt32Ptr param1 // pointer to space for retrieving the first parameter SInt32Ptr param2 // pointer to space for retrieving the second parameter );
[ public ] SFCError GetRect( SFXRectanglePtr imgRect // image rectangle pointer SFXRectanglePtr textRect // text rectangle pointer );
BREW API IMEDIA_GetRect | SFBMedia::Play | SFBMedia::Record | SFBMedia::SetMediaParm | SFBMedia::GetMediaParm
[ public ] SInt32 GetState( BoolPtr stateChanging // true means SFBMedia Interface is currently busy with state transition );
[ public ] SFCError GetTotalTime(Void);
[ public ] SFCError GetVolume( UInt16Ptr volume // pointer to space for retrieving volume );
[ public ] UInt16 GetVolume(Void);
BREW API IMEDIA_GetVolume | SFBMedia::SetAudioPath | SFBMedia::SetMuteCtl | SFBMedia::SetVolume | SFBMedia::SetPan | SFBMedia::SetMediaParm | SFBMedia::GetMediaParm | SFBMedia::SetAudioDevice
[ public ] SFCError IsChannelShare( BoolPtr enable // pointer to space for retrieving channel share setting );
Supported in BREW 2.1 or later.
[ public ] SFCError IsFrameCallback( BoolPtr enable // pointer to space for retrieving frame callback setting );
Supported in BREW 2.1 or later.
[ public, static ] SFBMediaSmp NewInstance( SFCErrorPtr exception = null // Error );
[ public, static ] SFBMediaSmp NewInstance( AEECLSID id // Class ID SFCErrorPtr exception = null // Error );
[ public ] SFCError Pause(Void);
BREW API IMEDIA_Pause | SFBMedia::Play | SFBMedia::Resume | SFBMedia::Record | AEEMediaCmdNotify
[ public ] SFCError Play(Void);
BREW API IMEDIA_Play | SFBMedia::FastForward | SFBMedia::Pause | SFBMedia::Record | SFBMedia::Resume | SFBMedia::Rewind | SFBMedia::Seek | SFBMedia::Stop | AEEMediaCmdNotify
[ public ] SFCError Record(Void);
BREW API IMEDIA_Record | SFBMedia::FastForward | SFBMedia::Pause | SFBMedia::Play | SFBMedia::Resume | SFBMedia::Rewind | SFBMedia::Seek | SFBMedia::Stop | AEEMediaCmdNotify | AEEMediaData
[ public ] SFCError RegisterNotify( PFNMEDIANOTIFY notify // callback function VoidPtr data = null // user data );
[ public ] SFCError Resume(Void);
BREW API IMEDIA_Resume | SFBMedia::Play | SFBMedia::Pause | SFBMedia::Record | AEEMediaCmdNotify
When LEFT key is pressed, rewind sound for 10 seconds.
// announce as class member argument. SFBMediaSmp _media; AEEMediaData _mdata; ---------------------------------------------------------------------- // announce local parameter in function. SFBShellSmp shell = SFBShell::GetInstance(); const char* filename = "test.qcp"; // get SFBMediaQCP interface, set media data. _media = SFBMediaQCP::NewInstance(); if (_media != null) { // set media data inAEEMediaData structure. _mdata.clsData = MMD_FILE_NAME; _mdata.pData = STRDUP(filename); _mdata.dwSize = 0; // set media data. _media->SetMediaData(&_mdata); // set audio device. _media->SetAudioDevice(AEE_SOUND_DEVICE_CURRENT); // play sound. _media->Play(); } ---------------------------------------------------------------------- // if LEFT key is pressed, // rewind sound for 10 seconds. if (key == AVK_LEFT) { if (_media != null) { // rewind (10 seconds) _media->Rewind(10000); } }
BREW API IMEDIA_Resume | SFBMedia::FastForward | SFBMedia::Seek | SFBMedia::Play | AEEMediaCmdNotify
[ public ] SFCError Seek( AEEMediaSeek seek // seek reference SInt32 time // time in milliseconds );
BREW API IMEDIA_Seek | AEEMediaSeek | SFBMedia::FastForward | SFBMedia::Rewind | SFBMedia::Play
[ public ] SFCError SeekFrame( AEEMediaSeek seek // seek reference SInt32 frames // number of frames );
Supported in BREW 2.1 or later.
[ public ] SFCError SetAudioDevice( AEESoundDevice device // target audio device );
BREW API IMEDIA_SetAudioDevice | AEESoundDevice | SFBMedia::SetAudioPath | SFBMedia::SetMuteCtl | SFBMedia::SetVolume | SFBMedia::GetVolume | SFBMedia::SetPan | SFBMedia::SetMediaParm | SFBMedia::GetMediaParm
[ public ] SFCError SetAudioPath( SInt32 path // audio path UInt32 pause // pause, in milliseconds, between rings );
BREW API IMEDIA_SetAudioPath | SFBMedia::SetMuteCtl | SFBMedia::SetVolume | SFBMedia::GetVolume | SFBMedia::SetPan | SFBMedia::SetMediaParm | SFBMedia::GetMediaParm | SFBMedia::SetAudioDevice
[ public ] SFCError SetDecryptInfo( AEEMediaDecryptInfo* info // decrypt information );
This function is available in BREW 3.1.
[ public ] SFCError SetMediaData( AEEMediaData* data // media data );
BREW API IMEDIA_SetMediaData | SFBMedia::GetMediaData | SFBMedia::GetMediaParm | SFBMedia::SetMediaParm
[ public ] SFCError SetMediaDataEx( AEEMediaDataEx* mediaContent // list of media content SInt32 count // number of the elements in mediaContent );
This function is available in BREW 3.1.
BREW API IMEDIA_SetMediaDataEx | SFBMedia::GetMediaData | SFBMedia::GetMediaParm | SFBMedia::SetMediaParm
[ public ] SFCError SetMediaParm( SInt32 id // parameter ID SInt32 param1 // the first parameter SInt32 param2 // the second parameter );
BREW API IMEDIA_SetMediaParm | AEEMediaData | SFBMedia::GetMediaParm
BREW API IMEDIA_SetMuteCtl | SFBMedia::SetAudioPath | SFBMedia::SetVolume | SFBMedia::GetVolume | SFBMedia::SetPan | SFBMedia::SetMediaParm | SFBMedia::GetMediaParm | SFBMedia::SetAudioDevice
BREW API IMEDIA_SetPan | SFBMedia::SetAudioPath | SFBMedia::SetMuteCtl | SFBMedia::SetVolume | SFBMedia::GetVolume | SFBMedia::SetMediaParm | SFBMedia::GetMediaParm | SFBMedia::SetAudioDevice
[ public ] SFCError SetRect( SFXRectanglePtr imgRect // image rectangle pointer SFXRectanglePtr textRect // text rectangle pointer );
BREW API IMEDIA_SetRect | AEERect | SFBMedia::Play | SFBMedia::Record | SFBMedia::SetMediaParm | SFBMedia::GetMediaParm
BREW API IMEDIA_SetTickTime | SFBMedia::Play | SFBMedia::Record | SFBMedia::SetMediaParm | SFBMedia::GetMediaParm
BREW API IMEDIA_SetVolume | SFBMedia::SetAudioDevice | SFBMedia::SetAudioPath | SFBMedia::SetMuteCtl | SFBMedia::GetVolume | SFBMedia::SetPan | SFBMedia::SetMediaParm | SFBMedia::GetMediaParm
[ public ] SFCError Stop(Void);
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |