PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFBMediaPHR
Wrapper Class for the IMediaPHR interface.
#include <SFBMediaPHR.h.hpp>
class SFBMediaPHR : public SFBMedia;
SFMTYPEDEFWRAPPER(SFBMediaPHR)

Inheritance diagram

 Inheritance diagram of SFBMediaPHRClass

Version

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0
X O O O

Reference

BREW API IMediaPhr

Member

Public Functions
static
SFBMediaPHRSmp
NewInstance( SFCErrorPtr exception = null )
Create a new SFBMediaPHR instance.
static
SFBMediaPHRSmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
Create a new SFBMediaPHR instance.
SFCError EnableChannelShare( Bool enable ) (inherits from SFBMedia)
Enable/Disable exclusive playback of the media.
SFCError EnableFrameCallback( Bool enable ) (inherits from SFBMedia)
Enable/Disable frame playback of the media.
SFCError FastForward( SInt32 time ) (inherits from SFBMedia)
Fast forward lTimeMS milliseconds from the current position. The media is left in the current state.
SFCError GetClassID( AEECLSID* clsid ) (inherits from SFBMedia)
Retrieve the class ID of SFBMedia Interface object.
AEECLSID GetClassID( Void ) (inherits from SFBMedia)
Retrieve the class ID of SFBMedia Interface object.
SFCError GetDecryptCaps( UInt32Ptr caps , UInt32ConstHandle formats ) (inherits from SFBMedia)
Retrieves the decryption capabilities, including the decryption formats, supported for the media.
SFCError GetFrame( SFBBitmapSmpPtr frame ) (inherits from SFBMedia)
Retrieves the current frame as SFBBitmap pointer.
SFCError GetMediaData( AEEMediaData* data ) (inherits from SFBMedia)
Get the media data.
SFCError GetMediaParm( SInt32 id , SInt32Ptr param1 , SInt32Ptr param2 ) (inherits from SFBMedia)
Get the parameters.
SFCError GetRect( SFXRectanglePtr imgRect , SFXRectanglePtr textRect ) (inherits from SFBMedia)
Retrieve the destination image rectangle and text rectangle.
SInt32 GetState( BoolPtr stateChanging ) (inherits from SFBMedia)
Return the current state of SFBMedia Interface and also indicates if the SFBMedia Interface object is currently in state transition.
SFCError GetTotalTime( Void ) (inherits from SFBMedia)
Return the total playback time of the SFBMedia Interface object.
SFCError GetVolume( UInt16Ptr volume ) (inherits from SFBMedia)
Retrieve the volume of the current playback / recording.
UInt16 GetVolume( Void ) (inherits from SFBMedia)
Retrieve the volume of the current playback / recording.
SFCError IsChannelShare( BoolPtr enable ) (inherits from SFBMedia)
Retrieves the current channel share setting.
SFCError IsFrameCallback( BoolPtr enable ) (inherits from SFBMedia)
Retrieves the current frame callback enable/disable setting.
SFCError Pause( Void ) (inherits from SFBMedia)
Pause the media.
SFCError Play( Void ) (inherits from SFBMedia)
Start the playback of a 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.
SFCError Record( Void ) (inherits from SFBMedia)
Start the recording of a media.
SFCError RegisterNotify( PFNMEDIANOTIFY notify , VoidPtr data = null ) (inherits from SFBMedia)
Register a callback notification function.
SFCError Resume( Void ) (inherits from SFBMedia)
Resume the media from the current position.
SFCError Rewind( SInt32 time ) (inherits from SFBMedia)
Rewind the specified time from the current position. The media is left in the current state.
SFCError Seek( AEEMediaSeek seek , SInt32 time ) (inherits from SFBMedia)
Seek the media position. The media is left in the current state.
SFCError SeekFrame( AEEMediaSeek seek , SInt32 frames ) (inherits from SFBMedia)
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.
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.
SFCError SetAudioDevice( AEESoundDevice device ) (inherits from SFBMedia)
Set the audio output device.
SFCError SetAudioPath( SInt32 path , UInt32 pause ) (inherits from SFBMedia)
Set the audio path for playback/recording.
SFCError SetDecryptInfo( AEEMediaDecryptInfo* info ) (inherits from SFBMedia)
Set required decryption info necessary to decrypt the media content.
SFCError SetMediaData( AEEMediaData* data ) (inherits from SFBMedia)
Set the media data and puts the media in Ready state.
SFCError SetMediaDataEx( AEEMediaDataEx* mediaContent , SInt32 count ) (inherits from SFBMedia)
Set a list of media data and puts the media in Ready state.
SFCError SetMediaParm( SInt32 id , SInt32 param1 , SInt32 param2 ) (inherits from SFBMedia)
Set specified the media parameters.
SFCError SetMuteCtl( Bool mute ) (inherits from SFBMedia)
Mute / Unmute the current audio path.
SFCError SetPan( UInt16 pan ) (inherits from SFBMedia)
Set the pan factor of the current playback.
SFCError SetRect( SFXRectanglePtr imgRect , SFXRectanglePtr textRect ) (inherits from SFBMedia)
Set the destination image rectangle and text rectangle.
SFCError SetTickTime( UInt32 tick ) (inherits from SFBMedia)
Set periodicity of MM_TICK_UPDATE event sent to the application during playback/recording.
SFCError SetVolume( UInt16 volume ) (inherits from SFBMedia)
Set the volume of the current playback / recording.
SFCError Stop( Void ) (inherits from SFBMedia)
Stop the playback/recording of media.
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.

SFBMediaPHR::NewInstance
Create a new SFBMediaPHR instance.
[ public, static ]
SFBMediaPHRSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);
[ public, static ]
SFBMediaPHRSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);