Skip to main content

Bluetooth.BluetoothGatt

Class

Provides access to the Bluetooth connection.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
  • Camera Kit WebNot supported — Available on SPECS only
  • Camera Kit MobileNot supported — Available on SPECS only

Platform details

  • Snapchat — Not supported — Available on SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — Available on SPECS only.

  • Camera Kit Mobile — Not supported — Available on SPECS only.

Index

Extends

Properties

mtu

readonly mtu: number

ExperimentalSPECS

The current Maximum Transmission Unit (MTU).


onDisconnectedEvent

readonly onDisconnectedEvent: event0<void>

ExperimentalSPECS

Event fired when the device is disconnected.


onMtuChangedEvent

readonly onMtuChangedEvent: event1<MtuChangedEvent, void>

ExperimentalSPECS

Event to observe changes in Maximum Transmission Unit (MTU).

Methods

close()

close(): void

ExperimentalSPECS

Terminate the Bluetooth client connection, disconnection included if applicable.

Returns

void


getService()

getService(serviceUUID): BluetoothGattService

ExperimentalSPECS

Retrieve a specific Bluetooth.BluetoothGattService using its UUID from the GATT server.

Parameters

ParameterType
serviceUUIDstring

Returns

BluetoothGattService


getServices()

getServices(): BluetoothGattService[]

ExperimentalSPECS

Retrieve all available services from the GATT server.

Returns

BluetoothGattService[]


getTypeName()

static getTypeName(): TypeName<BluetoothGatt>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<BluetoothGatt>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame