SFBDLS

Wrapper Class for the IBDLS interface.

#include <SFBDLS.h.hpp>

class SFBDLS : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBDLS)

Inheritance diagram

Version

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

Reference

BREW API IBDLS

Member

Public Functions
`SFCError`	IsGlobal( `BoolPtr` global ) Indicate whether linking of DLS to specific media is supported. If not supported, then DLS applies globally to all active media. .
`SFCError`	IsLoaded( `BoolPtr` loaded ) Check if the DLS content is currently loaded or not.
`SFCError`	Load( `AEEMediaData *` media , `SFXCallbackPtr` callback , `SInt32Ptr` ret ) Load the DLS media content.
static `SFBDLSSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBDLS instance.
static `SFBDLSSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBDLS instance.
`SFCError`	Unload( `SFXCallbackPtr` callback , `SInt32Ptr` ret ) Unload the DLS media content.
`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.

SFBDLS::IsGlobal

Indicate whether linking of DLS to specific media is supported. If not supported, then DLS applies globally to all active media. .

[ public ]
SFCError IsGlobal(
    BoolPtr global   // Pointer to the return value.
);

Argument

global

Pointer to the return value.

FALSE: Linking of DLS with specific media is not supported. DLS applies globally to all relevant active media.

TRUE: Linking of DLS with specific media is supported.

Return value

EBADPARM: Bad parm.
EUNSUPPORTED: Operation not supported by the class.
EFAILED: Operation Failed.
ENOMEMORY: Out of application heap.

Reference

BREW API IDLS_IsGlobal

SFBDLS::IsLoaded

Check if the DLS content is currently loaded or not.

[ public ]
SFCError IsLoaded(
    BoolPtr loaded   // Pointer to the return value. 
);

Argument

loaded

Pointer to the return value.

TRUE - DLS content is loaded.

FALSE - DLS content is not loaded.

Return value

EBADPARM : Bad parm.
EUNSUPPORTED : Operation not supported by the class.
EFAILED : Operation Failed.
ENOMEMORY : Out of application heap.

Reference

BREW API IDLS_IsLoaded

SFBDLS::Load

Load the DLS media content.

[ public ]
SFCError Load(
    AEEMediaData * media      // Pointer to the AEEMediaData. 
    SFXCallbackPtr callback   // Pointer to the callback function. 
    SInt32Ptr ret             // Pointer to the return value. This value needs to be preserved and used during the callback.
);

Return value

SUCCESS : The DLS load command is accepted.
EBADPARM : Bad parm.
EUNSUPPORTED : Operation not supported by the class.
EFAILED : Operation Failed.
ENOMEMORY : Out of application heap.

Reference

BREW API IDLS_Load

SFBDLS::NewInstance

Create a new SFBDLS instance.

[ public, static ]
SFBDLSSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBDLSSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBDLS::Unload

Unload the DLS media content.

[ public ]
SFCError Unload(
    SFXCallbackPtr callback   // Pointer to the callback function. 
    SInt32Ptr ret             // Pointer to the return value. This value needs to be preserved and used during the callback. 
);

Return value

EBADPARM : Bad parm.
EUNSUPPORTED : Operation not supported by the class.
EFAILED : Operation Failed.
ENOMEMORY : Out of application heap.

Reference

BREW API IDLS_Unload