chroom.bluetooth-aansluiting

Beschrijving

Gebruik de chrome.bluetoothSocket API om gegevens te verzenden naar en ontvangen van Bluetooth-apparaten via RFCOMM- en L2CAP-verbindingen.

Manifest

De volgende sleutels moeten in het manifest worden gedeclareerd om deze API te gebruiken.

"bluetooth"

Typen

AcceptError

Enum

"systeemfout"
Er is een systeemfout opgetreden en de verbinding kan mogelijk niet worden hersteld.

"niet_luisteren"
Het stopcontact luistert niet.

AcceptErrorInfo

Eigenschappen

  • Een foutcode die aangeeft wat er mis is gegaan.

  • foutbericht

    snaar

    De foutmelding.

  • socket-ID

    nummer

    De serversocket-ID.

AcceptInfo

Eigenschappen

  • clientSocketId

    nummer

    De client socket-ID, d.w.z. de socket-ID van de nieuw tot stand gebrachte verbinding. Deze socket-ID mag alleen worden gebruikt met functies uit de chrome.bluetoothSocket -naamruimte. Let op: de client socket is in eerste instantie gepauzeerd en moet expliciet door de applicatie worden hervat om gegevens te kunnen ontvangen.

  • socket-ID

    nummer

    De serversocket-ID.

CreateInfo

Eigenschappen

  • socket-ID

    nummer

    De ID van de nieuw aangemaakte socket. Houd er rekening mee dat socket-ID's die met deze API zijn gemaakt, niet compatibel zijn met socket-ID's die met andere API's zijn gemaakt, zoals de [ sockets.tcp ](../sockets_tcp/) API.

ListenOptions

Eigenschappen

  • achterstand

    nummer optioneel

    Lengte van de luisterwachtrij van de socket. De standaardwaarde is afhankelijk van het hostsubsysteem van het besturingssysteem.

  • kanaal

    nummer optioneel

    Het RFCOMM-kanaal dat door listenUsingRfcomm wordt gebruikt. Indien opgegeven, mag dit kanaal niet eerder in gebruik zijn, anders mislukt de methodeaanroep. Indien niet opgegeven, wordt automatisch een ongebruikt kanaal toegewezen.

  • psm

    nummer optioneel

    De L2CAP PSM die door listenUsingL2cap wordt gebruikt. Indien opgegeven, mag deze PSM niet eerder in gebruik zijn, anders mislukt de methodeaanroep. Indien niet opgegeven, wordt automatisch een ongebruikte PSM toegewezen.

ReceiveError

Enum

"losgekoppeld"
De verbinding is verbroken.

"systeemfout"
Er is een systeemfout opgetreden en de verbinding kan mogelijk niet worden hersteld.

"niet_verbonden"
Het stopcontact is niet aangesloten.

ReceiveErrorInfo

Eigenschappen

  • Een foutcode die aangeeft wat er mis is gegaan.

  • foutbericht

    snaar

    De foutmelding.

  • socket-ID

    nummer

    De socket-identificatie.

ReceiveInfo

Eigenschappen

  • gegevens

    ArrayBuffer

    De ontvangen gegevens, met een maximale grootte van bufferSize .

  • socket-ID

    nummer

    De socket-identificatie.

SocketInfo

Eigenschappen

  • adres

    string optioneel

    Als de onderliggende socket verbonden is, bevat deze het Bluetooth-adres van het apparaat waarmee deze verbonden is.

  • buffergrootte

    nummer optioneel

    De grootte van de buffer die wordt gebruikt om gegevens te ontvangen. Als er geen expliciete buffergrootte is opgegeven, wordt de waarde niet opgegeven.

  • aangesloten

    Booleaanse

    Vlag die aangeeft of de socket is verbonden met een externe peer.

  • naam

    string optioneel

    Door de toepassing gedefinieerde tekenreeks die aan de socket is gekoppeld.

  • gepauzeerd

    Booleaanse

    Vlag die aangeeft of een verbonden socket zijn peer blokkeert om meer gegevens te verzenden, of dat verbindingsaanvragen op een luisterende socket worden verzonden via de onAccept -gebeurtenis of in de wachtrij worden geplaatst in de luisterwachtrij. Zie setPaused . De standaardwaarde is "false".

  • volhardend

    Booleaanse

    Vlag die aangeeft of de socket open blijft wanneer de gebeurtenispagina van de applicatie wordt verwijderd (zie SocketProperties.persistent ). De standaardwaarde is "false".

  • socket-ID

    nummer

    De socket-identificatie.

  • uuid

    string optioneel

    Als de onderliggende socket verbonden is, bevat deze informatie over de service-UUID waarmee deze verbonden is. Als de onderliggende socket luistert, bevat deze informatie over de service-UUID waarnaar deze luistert.

SocketProperties

Eigenschappen

  • buffergrootte

    nummer optioneel

    De grootte van de buffer die wordt gebruikt om gegevens te ontvangen. De standaardwaarde is 4096.

  • naam

    string optioneel

    Een door de applicatie gedefinieerde tekenreeks die aan de socket is gekoppeld.

  • volhardend

    boolean optioneel

    Vlag die aangeeft of de socket open blijft wanneer de gebeurtenispagina van de applicatie wordt verwijderd (zie App-levenscyclus beheren ). De standaardwaarde is false. Wanneer de applicatie wordt geladen, kunnen alle sockets die eerder zijn geopend met persistent=true worden opgehaald met getSockets .

Methoden

close()

Belofte
chrome.bluetoothSocket.close(
  socketId: number,
  callback?: function,
): Promise<void>

Verbreekt de verbinding en vernietigt de socket. Elke aangemaakte socket moet na gebruik worden gesloten. De socket-id is niet meer geldig zodra de functie wordt aangeroepen. De socket wordt echter gegarandeerd alleen gesloten wanneer de callback wordt aangeroepen.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

connect()

Belofte
chrome.bluetoothSocket.connect(
  socketId: number,
  address: string,
  uuid: string,
  callback?: function,
): Promise<void>

Verbindt de socket met een extern Bluetooth-apparaat. Wanneer de connect succesvol is voltooid, worden onReceive -gebeurtenissen gegenereerd wanneer gegevens van de peer worden ontvangen. Als er een netwerkfout optreedt terwijl de runtime pakketten ontvangt, wordt een onReceiveError -gebeurtenis gegenereerd. Vanaf dat moment worden er geen onReceive gebeurtenissen meer gegenereerd voor deze socket totdat de methode setPaused(false) wordt aangeroepen.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • adres

    snaar

    Het adres van het Bluetooth-apparaat.

  • uuid

    snaar

    De UUID van de service waarmee verbinding moet worden gemaakt.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

create()

Belofte
chrome.bluetoothSocket.create(
  properties?: SocketProperties,
  callback?: function,
): Promise<CreateInfo>

Creëert een Bluetooth-socket.

Parameters

  • eigenschappen

    SocketProperties optioneel

    De socket-eigenschappen (optioneel).

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Het resultaat van de socketcreatie.

Retourneren

  • Belofte< CreateInfo >

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

disconnect()

Belofte
chrome.bluetoothSocket.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

Verbreekt de verbinding met de socket. De socket-ID blijft geldig.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getInfo()

Belofte
chrome.bluetoothSocket.getInfo(
  socketId: number,
  callback?: function,
): Promise<SocketInfo>

Haalt de status van de opgegeven socket op.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Object dat de socketinformatie bevat.

Retourneren

  • Belofte <SocketInfo>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getSockets()

Belofte
chrome.bluetoothSocket.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

Haalt de lijst op met de sockets die momenteel geopend zijn en eigendom zijn van de toepassing.

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (sockets: SocketInfo[]) => void

Retourneren

  • Belofte< SocketInfo []>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

listenUsingL2cap()

Belofte
chrome.bluetoothSocket.listenUsingL2cap(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
): Promise<void>

Luister naar verbindingen via het L2CAP-protocol.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • uuid

    snaar

    Service-UUID waarnaar moet worden geluisterd.

  • opties

    ListenOptions optioneel

    Optionele aanvullende opties voor de service.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

listenUsingRfcomm()

Belofte
chrome.bluetoothSocket.listenUsingRfcomm(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
): Promise<void>

Luister naar verbindingen via het RFCOMM-protocol.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • uuid

    snaar

    Service-UUID waarnaar moet worden geluisterd.

  • opties

    ListenOptions optioneel

    Optionele aanvullende opties voor de service.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

send()

Belofte
chrome.bluetoothSocket.send(
  socketId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<number>

Verstuurt gegevens via de opgegeven Bluetooth-socket.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • gegevens

    ArrayBuffer

    De te verzenden gegevens.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (bytesSent: number) => void

    • bytesVerzonden

      nummer

      Het aantal verzonden bytes.

Retourneren

  • Belofte<nummer>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setPaused()

Belofte
chrome.bluetoothSocket.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

Hiermee wordt in- of uitgeschakeld dat een verbonden socket berichten van zijn peer ontvangt, of dat een luisterende socket nieuwe verbindingen accepteert. De standaardwaarde is "false". Het pauzeren van een verbonden socket wordt doorgaans door een applicatie gebruikt om de gegevens die door zijn peer worden verzonden, te beperken. Wanneer een verbonden socket wordt gepauzeerd, wordt er geen onReceive gebeurtenis gegenereerd. Wanneer een socket wordt verbonden en de pauze wordt hervat, worden er opnieuw onReceive gebeurtenissen gegenereerd wanneer er berichten worden ontvangen. Wanneer een luisterende socket wordt gepauzeerd, worden nieuwe verbindingen geaccepteerd totdat de backlog vol is, waarna aanvullende verbindingsaanvragen worden geweigerd. onAccept gebeurtenissen worden alleen gegenereerd wanneer de socket wordt hervat.

Parameters

  • socket-ID

    nummer

  • gepauzeerd

    Booleaanse

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

update()

Belofte
chrome.bluetoothSocket.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
): Promise<void>

Werkt de socket-eigenschappen bij.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • eigenschappen

    Socketeigenschappen

    De eigenschappen die bijgewerkt moeten worden.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Evenementen

onAccept

chrome.bluetoothSocket.onAccept.addListener(
  callback: function,
)

Gebeurtenis die wordt gegenereerd wanneer er een verbinding tot stand is gebracht voor een bepaalde socket.

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (info: AcceptInfo) => void

onAcceptError

chrome.bluetoothSocket.onAcceptError.addListener(
  callback: function,
)

Gebeurtenis gegenereerd wanneer er een netwerkfout optrad terwijl de runtime wachtte op nieuwe verbindingen op de opgegeven socket. Zodra deze gebeurtenis is gegenereerd, wordt de socket paused en worden er geen onAccept -gebeurtenissen meer gegenereerd voor deze socket.

Parameters

onReceive

chrome.bluetoothSocket.onReceive.addListener(
  callback: function,
)

Gebeurtenis die wordt gegenereerd wanneer gegevens voor een bepaalde socket zijn ontvangen.

Parameters

onReceiveError

chrome.bluetoothSocket.onReceiveError.addListener(
  callback: function,
)

Gebeurtenis gegenereerd wanneer er een netwerkfout optrad terwijl de runtime wachtte op gegevens op de socket. Zodra deze gebeurtenis is gegenereerd, wordt de socket op paused gezet en worden er geen onReceive gebeurtenissen meer gegenereerd voor deze socket.

Parameters