PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFBBTAG
Wrapper Class for the IBTAG interface.
#include <SFBBTAG.h.hpp>
class SFBBTAG : public SFBBase;
SFMTYPEDEFWRAPPER(SFBBTAG)

Inheritance diagram

 Inheritance diagram of SFBBTAGClass

Version

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

Reference

BREW API IBTAG

Member

Public Functions
SFCError GetEvent( AEEBTAGEvent* event )
Get the event code that occurred on the device.
SFCError GetLastError( Void )
Get the last error code.
SFCError Open( AEEBTAGInfo* btagInfo , SFXCallbackPtr callback )
Open the Audio Gateway using Bluetooth
SFCError SendCommand( AEEBTAGCmd cmdCode , UInt32 cmdVal )
Send a command.
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.

SFBBTAG::GetEvent
Get the event code that occurred on the device.
[ public ]
SFCError GetEvent(
    AEEBTAGEvent* event   // return value for the event code.
                          // the valid return values are the following:
                          // AEEBT_EV_AG_NOEVENTS           : No more events from the Bluetooth stack.
                          // AEEBT_EV_AG_ENABLED            : Bluetooth Audio Gateway enabled.
                          // AEEBT_EV_AG_DISABLED           : Bluetooth Audio Gateway disabled.
                          // AEEBT_EV_AG_HEADSET_PICKUP     : User picked up the headset.
                          // AEEBT_EV_AG_DISCONNECT_REQUEST : User disconnected the headset.
                          // AEEBT_EV_AG_AUDIO_CONNECTED    : Audio channel was connected.
                          // AEEBT_EV_AG_AUDIO_DISCONNECTED : Audio channel was disconnected
                          // AEEBT_EV_AG_AUDIO_CONN_TIMEOUT : Audio connection timed out
                          // AEEBT_EV_AG_ERROR              : Error occurred during command processing
);

Reference

BREW API IBTAG_GetEvent


SFBBTAG::GetLastError
Get the last error code.
[ public ]
SFCError GetLastError(Void);

Reference

BREW API IBTAG_GetLastError


SFBBTAG::Open
Open the Audio Gateway using Bluetooth
[ public ]
SFCError Open(
    AEEBTAGInfo* btagInfo     // the connection Information for the headset
    SFXCallbackPtr callback   // the callback scheduled on the occurrence of any event on this port. 
                              // if the user cancels this callback, 
                              // the port will not be usable any more by the user
);

Reference

BREW API IBTAG_Open


SFBBTAG::SendCommand
Send a command.
[ public ]
SFCError SendCommand(
    AEEBTAGCmd cmdCode   // cOmmand Code
                         // the available value is as below:
                         // AEEBT_CMD_RING_HEADSET  : Ring the headset.
                         // AEEBT_CMD_AUDIO_CONNECT : Connect the audio channel.
                         // AEEBT_CMD_SET_SPKR_GAIN : Increase/decrease the speaker gain.
                         // AEEBT_CMD_SET_HS_GAIN   : Increase/decrease the headset gain.
                         // AEEBT_CMD_DISCONNECT    : Disconnect the Audio Gateway
    UInt32 cmdVal        // 32-bit value as command parameter.
                         // this parameter is used with the following commands only:
                         // AEEBT_CMD_SET_SPKR_GAIN
                         // AEEBT_CMD_SET_HS_GAIN
        
);

Reference

BREW API IBTAG_SendCommand