Namespace: Xebra

Members

Xebra.CONNECTION_STATES:object

static constant

Connection States

Properties:

Name	Type	Description
INIT	number	The connection hasn't been set up yet, it's still waiting for a call to connect (unless auto_connect is set to true)
CONNECTING	number	The connection is being established
CONNECTED	number	The connection is established and alive
CONNECTION_FAIL	number	The connection could NEVER be established
RECONNECTING	number	The connection was lost and attempts to reconnect are made (based on reconnect, reconnect_attempts and reconnect_timeout options)
DISCONNECTED	number	The connection was lost and all attempts to reconnect failed

Xebra.EMPTY_RESOURCE:String

static constant

Filename for an empty XebraResource

Xebra.LIVE_UNIT_STYLES:object

static constant

Unit Styles of live.* objects.

Properties:

Name	Type	Description
LIVE_UNIT_INT	string	Integer Unit Style
LIVE_UNIT_FLOAT	string	Float Unit Style
LIVE_UNIT_TIME	string	Time Unit Style
LIVE_UNIT_HZ	string	Hertz Unit Style
LIVE_UNIT_DB	string	deciBel Unit Style
LIVE_UNIT_PERCENT	string	Percent (%) Unit Style
LIVE_UNIT_PAN	string	Pan Unit Style
LIVE_UNIT_SEMITONES	string	Semitones Unit Stlye
LIVE_UNIT_MIDI	string	MIDI Notes Unit Style
LIVE_UNIT_CUSTOM	string	Custom Unit Style
LIVE_UNIT_NATIVE	string	Native Unit Style

Xebra.LIVE_VALUE_TYPES:object

static constant

Unit Styles of live.* objects.

Properties:

Name	Type	Description
LIVE_UNIT_INT	string	Integer Unit Style

Xebra.MOTION_TYPES:object

static constant

Motion Types supported by Xebra. Use these as type identifiers when calling sendMotionData on Xebra.State.

Properties:

Name	Type	Description
ACCEL	string	Acceleration, minus any acceleration due to gravity
GRAVITY	string	Acceleration due to gravity
ORIENTATION	string	Roll, pitch and yaw
RAWACCEL	string	Raw acceleration, including both user acceleration as well as gravity
ROTATIONRATE	string	Raw gyroscope readings: x, y and z rotation rates

Xebra.SUPPORTED_OBJECTSArray.<string>

static constant

List of objects available for synchronization in Xebra. Use this or a subset of this when setting the supported_objects option in Xebra.State.

Xebra.VIEW_MODES:object

static constant

Available View Modes of XebraState.

Properties:

Name	Type	Description
LINKED	number	Calculate visibility and position using the same view mode as Max
PRESENTATION	number	Calculate visibility and position always using Presentation Mode
PATCHING	number	Calculate visibility and position always using Patching Mode

Type Definitions

Xebra.ColorArray.<number>

Color attribute consisting of 4 Numbers in the format of [r, g, b, a]

Xebra.NodeId:number|:string

A string or number based id

Xebra.ParamValueType:number|:string|Array.<string>|Array.<number>|:object

Generic parameter value type

Xebra.PatchingRectArray.<number>

Patching Rectangle attribute consisting of 4 Numbers (x, y, width, height)