PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFBBTAudioGateway
Wrapper Class for the IBTAudioGateway interface.
#include <SFBBTAudioGateway.h.hpp>
class SFBBTAudioGateway : public SFBQuery;
SFMTYPEDEFWRAPPER(SFBBTAudioGateway)

Inheritance diagram

 Inheritance diagram of SFBBTAudioGatewayClass

Version

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

Reference

BREW API IBTAudioGateway

Member

Public Functions
SFCError Config( BTAGConfigFlags flags , BTAGButtonFunction buttonFunction , BTSecurityLevel security , ACharConstPtr dial , BDAddress const * addressList , SInt32 num )
Configure the Audio Gateway subsystem.
SFCError Config( BTAGConfigFlags flags , BTAGButtonFunction buttonFunction , BTSecurityLevel security , SFXAnsiStringConstRef dial , BDAddress const * addressList , SInt32 num )
Configure the Audio Gateway subsystem.
SFCError ConfigEx( ACharConstPtr config )
This function is an alternative to Config().
SFCError ConfigEx( SFXAnsiStringConstRef config )
This function is an alternative to Config().
SFCError Connect( BDAddress const * address )
Initiate connection to a given audio device.
SFCError ConnectAudio( BDAddress const * address )
Initiate audio connection to a given remote device.
SFCError Disable( Void )
Deactivate the Audio Gateway subsystem.
SFCError Disconnect( BDAddress const * address )
Initiate discconnection from a given audio device.
SFCError DisconnectAudio( BDAddress const * address )
Initiate audio discconnection from a given audio device.
SFCError Enable( Void )
Activate the Audio Gateway subsystem.
SFCError GetConnectionList( BTAGConnection * connectionList , SInt32 num , SInt32Ptr numreq )
Retrieve current list of AG connections.
SFCError GetEvent( BTAGEventType * event )
Retrieve AG events.
SFCError GetOpResult( BTAGOperationType * type , BTResult * result )
Retrieve information on the just completed operation.
SFCError GetStatus( BTAGStatus * status )
Retrieve current status of AG object.
static
SFBBTAudioGatewaySmp
NewInstance( SFCErrorPtr exception = null )
Create a new SFBBTAudioGateway instance.
static
SFBBTAudioGatewaySmp
NewInstance( AEECLSID id , SFCErrorPtr exception = null )
Create a new SFBBTAudioGateway instance.
SFCError OnEventNotify( SFBSignalSmpConstRef signal )
Register a signal to be triggered when there is an event that occurred on the AG object.
SFCError OnOpResult( SFBSignalSmpConstRef signal )
SFCError ReportVRState( Bool active )
Inform the AG object of current state of the VR engine.
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.

SFBBTAudioGateway::Config
Configure the Audio Gateway subsystem.
[ public ]
SFCError Config(
    BTAGConfigFlags flags               // bitmask for config flags
    BTAGButtonFunction buttonFunction   // how to interpret Button Press
    BTSecurityLevel security            // level of security to enforce
    ACharConstPtr dial                  // pre-set dial string; only required if dButtonAction == AEEBTAG_HSBUTTON_DIAL
    BDAddress const * addressList       // list of devices to which to connect
    SInt32 num                          // number of valid entries on psAddrList; only the first AEEBTAG_MAX_DEVICES entries will be saved
);
[ public ]
SFCError Config(
    BTAGConfigFlags flags               // bitmask for config flags
    BTAGButtonFunction buttonFunction   // how to interpret Button Press
    BTSecurityLevel security            // level of security to enforce
    SFXAnsiStringConstRef dial          // pre-set dial string; only required if dButtonAction == AEEBTAG_HSBUTTON_DIAL
    BDAddress const * addressList       // list of devices to which to connect
    SInt32 num                          // number of valid entries on psAddrList; only the first AEEBTAG_MAX_DEVICES entries will be saved
);

Reference

BREW API IBTAudioGateway_Config


SFBBTAudioGateway::ConfigEx
This function is an alternative to Config().
[ public ]
SFCError ConfigEx(
    ACharConstPtr config   // config params in string format
);
[ public ]
SFCError ConfigEx(
    SFXAnsiStringConstRef config   // config params in string format
);

Reference

BREW API IBTAudioGateway_ConfigEx | SFBBTAudioGateway::Config


SFBBTAudioGateway::Connect
Initiate connection to a given audio device.
[ public ]
SFCError Connect(
    BDAddress const * address   // address of audio device to which to connect
);

Reference

BREW API IBTAudioGateway_Connect


SFBBTAudioGateway::ConnectAudio
Initiate audio connection to a given remote device.
[ public ]
SFCError ConnectAudio(
    BDAddress const * address   // address of device to which to set up audio connection
);

Reference

BREW API IBTAudioGateway_ConnectAudio


SFBBTAudioGateway::Disable
Deactivate the Audio Gateway subsystem.
[ public ]
SFCError Disable(Void);

Reference

BREW API IBTAudioGateway_Disable


SFBBTAudioGateway::Disconnect
Initiate discconnection from a given audio device.
[ public ]
SFCError Disconnect(
    BDAddress const * address   // address of audio device from which to disconnect
);

Reference

BREW API IBTAudioGateway_Disconnect


SFBBTAudioGateway::DisconnectAudio
Initiate audio discconnection from a given audio device.
[ public ]
SFCError DisconnectAudio(
    BDAddress const * address   // address of audio device from which to disconnect the audio link
);

Reference

BREW API IBTAudioGateway_DisconnectAudio


SFBBTAudioGateway::Enable
Activate the Audio Gateway subsystem.
[ public ]
SFCError Enable(Void);

Reference

BREW API IBTAudioGateway_Enable


SFBBTAudioGateway::GetConnectionList
Retrieve current list of AG connections.
[ public ]
SFCError GetConnectionList(
    BTAGConnection * connectionList   // destination for info on all existing AG connections
    SInt32 num                        // max number of entries the list can hold
    SInt32Ptr numreq                  // number of existing connections, no more than the max concurrent connections supported by underlying AG
);

Reference

BREW API IBTAudioGateway_GetConnectionList


SFBBTAudioGateway::GetEvent
Retrieve AG events.
[ public ]
SFCError GetEvent(
    BTAGEventType * event   // destination for the event code
);

Reference

BREW API IBTAudioGateway_GetEvent


SFBBTAudioGateway::GetOpResult
Retrieve information on the just completed operation.
[ public ]
SFCError GetOpResult(
    BTAGOperationType * type   // ID of operation
    BTResult * result          // result of operation; should be a falure of some sort
);

Reference

BREW API IBTAudioGateway_GetOpResult


SFBBTAudioGateway::GetStatus
Retrieve current status of AG object.
[ public ]
SFCError GetStatus(
    BTAGStatus * status   // destination for AG status
);

Reference

BREW API IBTAudioGateway_GetStatus


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

SFBBTAudioGateway::OnEventNotify
Register a signal to be triggered when there is an event that occurred on the AG object.
[ public ]
SFCError OnEventNotify(
    SFBSignalSmpConstRef signal   // signal to be triggered when an event occurs
);

Reference

BREW API IBTAudioGateway_OnEventNotify


SFBBTAudioGateway::OnOpResult
[ public ]
SFCError OnOpResult(
    SFBSignalSmpConstRef signal   // signal to be triggered when operation is done
);

Reference

BREW API IBTAudioGateway_OnOpResult


SFBBTAudioGateway::ReportVRState
Inform the AG object of current state of the VR engine.
[ public ]
SFCError ReportVRState(
    Bool active   // true if VR engine got activated; false de-activated
);

Reference

BREW API IBTAudioGateway_ReportVRState