ASUS Aura SDK v3.1 Developer's Guide
AuraServiceLib::IAuraSyncDevice Interface Reference

Interface to devices which supports Aura protocols. More...

Inheritance diagram for AuraServiceLib::IAuraSyncDevice:
AuraServiceLib::IAuraSyncKeyboard

Public Member Functions

HRESULT Apply ()
 Apply LED settings in IAuraSyncDevice::Lights to physical devices. More...
 

Properties

IAuraRgbLightCollection Lights [get]
 The collection of all LED's of this device. More...
 
ULONG Type [get]
 Type ID of this device. More...
 
BSTR Name [get]
 Name of this device in human-readable string.
 
ULONG Width [get]
 Number of columns of each row of LED's.
 
ULONG Height [get]
 Number of rows of each row of LED's.
 

Detailed Description

Interface to devices which supports Aura protocols.

  • Interface ID: {6A30D789-F5DA-4F26-BF09-6DFB9DEDF91E}

Member Function Documentation

◆ Apply()

HRESULT AuraServiceLib::IAuraSyncDevice::Apply ( )

Apply LED settings in IAuraSyncDevice::Lights to physical devices.

Returns
This method always returns S_OK.

Property Documentation

◆ Lights

IAuraRgbLightCollection AuraServiceLib::IAuraSyncDevice::Lights
get

The collection of all LED's of this device.

All LED's are listed as a 1D array in IAuraRgbLightCollection::Item. If the LED's form a matrix layout (such as keyboards), the 2D matrix are stored in row-major in IAuraRgbLightCollection::Item.

If you want to control the LED of a specific key on keyboard devices via Key Name(or Scan Code, more precisely), you can do that via IAuraSyncKeyboard interface.

See also
IAuraSyncKeyboard

◆ Type

ULONG AuraServiceLib::IAuraSyncDevice::Type
get

Type ID of this device.

The meaning of each type ID is identical to the ones used in IAuraSdk::Enumerate().