SophiaFramework UNIVERSE 5.3 |
#include <SFBRemoteControlTarget.h.hpp>
class SFBRemoteControlTarget : public SFBQuery;
SFMTYPEDEFWRAPPER(SFBRemoteControlTarget)
BREW 2.0 | BREW 2.1 | BREW 3.1 | BREW 4.0 |
---|---|---|---|
X | X | X | O |
Public Functions | |
---|---|
SFCError |
GetCommand(
AEERemoteControl_CommandType * command
) Retrieve the next command sent by the remote controller.
|
SFCError |
GetSupportedTransports(
AEERemoteControl_Transport * transportIDList
, SInt32 length
, SInt32Ptr lenreq
) Return a list of available implementation-dependant transports which can be used by the application.
|
SFCError |
GetVendorCommand(
AEERemoteControl_VendorCommandType * command
) Retreivesa vendor command sent by the remote controller.
|
static SFBRemoteControlTargetSmp |
NewInstance(
SFCErrorPtr exception = null
) Create a new SFBRemoteControlTarget instance.
|
static SFBRemoteControlTargetSmp |
NewInstance(
AEECLSID id
, SFCErrorPtr exception = null
) Create a new SFBRemoteControlTarget instance.
|
SFCError |
OnCommandNotify(
SFBSignalSmpConstRef signal
) Register a signal handler with the interface.
|
SFCError |
OnVendorCommandNotify(
SFBSignalSmpConstRef signal
) Register a signal to be set upon receipt of a vendor-specific command with an ID previously registered with RegVendorID().
|
SFCError |
RegCommandMask(
uint64struct const * mask
) Register the set of commands the application handles.
|
SFCError |
RegCommandMask(
UInt64 mask
) Register the set of commands the application handles.
|
SFCError |
RegExtension(
SFBQuerySmpConstRef extension
) Register an extension to the remote control interface to add extended control and data capabilities.
|
SFCError |
RegVendorID(
ACharConstPtr vendorID
, AEERemoteControl_Transport transportID
) Register a vendor specific ID with the interface via a particular transport.
|
SFCError |
RegVendorID(
SFXAnsiStringConstRef vendorID
, AEERemoteControl_Transport transportID
) Register a vendor specific ID with the interface via a particular transport.
|
SFCError |
ReplyVendorCommand(
AEERemoteControl_VendorCommandType const * command
) Send a reply to a vendor command to the remote controller.
|
SFCError |
SetFocus( Void ) Set the focus for directing remote control events.
|
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 GetCommand( AEERemoteControl_CommandType * command // contains the next command sent by the remote controller );
[ public ] SFCError GetSupportedTransports( AEERemoteControl_Transport * transportIDList // sequence of Transport types containing implementation defined transports SInt32 length // the size allocated by the application for the transportIDList SInt32Ptr lenreq // the size needed to contain the full transportIDList );
[ public ] SFCError GetVendorCommand( AEERemoteControl_VendorCommandType * command // the implementation and transport defined string containing the command sent by the remote controller );
[ public, static ] SFBRemoteControlTargetSmp NewInstance( SFCErrorPtr exception = null // Error );
[ public, static ] SFBRemoteControlTargetSmp NewInstance( AEECLSID id // Class ID SFCErrorPtr exception = null // Error );
[ public ] SFCError OnCommandNotify( SFBSignalSmpConstRef signal // signal to be set upon receipt of a basic command );
[ public ] SFCError OnVendorCommandNotify( SFBSignalSmpConstRef signal // signal to be set );
BREW API IRemoteControl_Target_OnVendorCommandNotify | SFBRemoteControlTarget::RegVendorID
[ public ] SFCError RegCommandMask( uint64struct const * mask // the bit-mask of AEERemoteControl_OP commands supported by the instantiator );
[ public ] SFCError RegCommandMask( UInt64 mask // the bit-mask of AEERemoteControl_OP commands supported by the instantiator );
[ public ] SFCError RegExtension( SFBQuerySmpConstRef extension // instantiation of an extension object handled by the implemenatiton );
[ public ] SFCError RegVendorID( ACharConstPtr vendorID // idendification for this vendor, as defined in the implementation and transport. AEERemoteControl_Transport transportID // the UID of the transport for which this VendorID applies. );
[ public ] SFCError RegVendorID( SFXAnsiStringConstRef vendorID // idendification for this vendor, as defined in the implementation and transport AEERemoteControl_Transport transportID // the UID of the transport for which this VendorID applies );
BREW API IRemoteControl_Target_RegVendorID | SFBRemoteControlTarget::OnVendorCommandNotify
[ public ] SFCError ReplyVendorCommand( AEERemoteControl_VendorCommandType const * command // string representation of the reply );
[ public ] SFCError SetFocus(Void);
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |