Classes

Global

Global

Type Definitions

AirConsoleDevice

The AirConsole Screen device data of relevance to game developers.
Type:
  • object
Properties:
Name Type Attributes Description
environment AirConsoleScreenEnvironment <optional>
 The environment object this device is in. Only present on the screen.
Source:

AirConsoleObject

The AirConsole Screen device data of relevance to game developers.
Type:
  • object
Properties:
Name Type Description
devices Array.<AirConsoleDevice> List of devices in this session. Screen is always devices[AirConsole.SCREEN].
Source:

AirConsoleSafeArea

Properties:
Name Type Description
top number top border offset of the safe area
left number left border offset of the safe area
bottom number bottom border offset of the safe area
right number right border offset of the safe area
Source:

AirConsoleScreenEnvironment

The devices environment. Only available on the screen device. Please visit the Multiplayer guide to see how to use this from onDeviceStateChange or through airconsole.devices[AirConsole.SCREEN].environment.id
Type:
  • object
Properties:
Name Type Description
id string Identifier of the environment this screen is in. Where possible this is a specific physical location, like a specific car.
partner string Identifier of the partner in the environment.
Source:

CompositionVibrationData

Type:
  • Object
Properties:
Name Type Attributes Default Description
primitive string Identifier used to play a specific vibration primitive.
scale Number Vibration scale value between 0.0 and 1.0.
delay Number <optional>
 0 Delay in milliseconds before this primitive is played.
Source:

ImmersiveClimateOption

Type:
  • Object
Properties:
Name Type Description
fanSpeed number Speed of the fans. Format: integer between 0 and 100.
Source:

ImmersiveLightOption

Type:
  • Object
Properties:
Name Type Description
r number The red value of the light. Format: integer between 0 and 255.
g number The green value of the light. Format: integer between 0 and 255.
b number The blue value of the light. Format: integer between 0 and 255.
Source:

ImmersiveOption

Type:
  • Object
Properties:
Name Type Attributes Description
light ImmersiveLightOption <optional>
 Light state inside the car.
climate ImmersiveClimateOption <optional>
 Climate state inside the car.
experiment any <optional>
 Experimental payload for experimental APIs
Source:

VibrationOptions

Options of how vibrations should be executed. Depending on the interface used multiple vibration events can be chained together.
Type:
  • Object
Properties:
Name Type Description
type string Type of abstraction interface to use for executing vibrations. This should currently always be set to 'composition'.
value Array.<CompositionVibrationData> Array of vibration parameters depending on the interface type.
Source: