chroom.bluetooth-aansluiting

Beschrijving

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

Manifest

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

"bluetooth"

Soorten

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.

  • socketId

    nummer

    De server-socket-ID.

AcceptInfo

Eigenschappen

  • clientSocketId

    nummer

    De client-socket-ID, dwz de socket-ID van de nieuw tot stand gebrachte verbinding. Deze socket-ID mag alleen worden gebruikt met functies uit de chrome.bluetoothSocket -naamruimte. Houd er rekening mee dat de client-socket aanvankelijk is gepauzeerd en expliciet door de toepassing moet worden hervat om gegevens te kunnen ontvangen.

  • socketId

    nummer

    De server-socket-ID.

CreateInfo

Eigenschappen

  • socketId

    nummer

    De ID van de nieuw gemaakte 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 wordt gebruikt door listenUsingRfcomm . Indien gespecificeerd, mag dit kanaal niet eerder in gebruik zijn, anders mislukt de methodeaanroep. Als dit niet is opgegeven, wordt er automatisch een ongebruikt kanaal toegewezen.

  • psm

    nummer optioneel

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

ReceiveError

Enum

"losgekoppeld"
De verbinding werd 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.

  • socketId

    nummer

    De socket-ID.

ReceiveInfo

Eigenschappen

  • gegevens

    ArrayBuffer

    De ontvangen gegevens, met een maximale grootte van bufferSize .

  • socketId

    nummer

    De socket-ID.

SocketInfo

Eigenschappen

  • adres

    tekenreeks optioneel

    Als het onderliggende stopcontact is aangesloten, bevat dit het Bluetooth-adres van het apparaat waarmee het is verbonden.

  • buffergrootte

    nummer optioneel

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

  • aangesloten

    Booleaans

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

  • naam

    tekenreeks optioneel

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

  • gepauzeerd

    Booleaans

    Vlag die aangeeft of een aangesloten 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 staan ​​in de luisterwachtrijachterstand. Zie setPaused . De standaardwaarde is "false".

  • volhardend

    Booleaans

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

  • socketId

    nummer

    De socket-ID.

  • uuid

    tekenreeks optioneel

    Als de onderliggende socket is verbonden, bevat deze informatie over de service-UUID waarmee deze is verbonden. Als de onderliggende socket luistert, bevat deze anders 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

    tekenreeks optioneel

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

  • volhardend

    Booleaans 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 toepassing is 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,
)

Verbreekt de verbinding en vernietigt het stopcontact. Elk gecreëerd stopcontact moet na gebruik worden gesloten. Het socket-ID is niet meer geldig zodra de functie wordt aangeroepen. De socket wordt echter alleen gegarandeerd gesloten wanneer de callback wordt aangeroepen.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 91+

    Beloftes 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,
)

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

Parameters

  • socketId

    nummer

    De socket-ID.

  • 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 parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 91+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

create()

Belofte
chrome.bluetoothSocket.create(
  properties?: SocketProperties,
  callback?: function,
)

Creëert een Bluetooth-aansluiting.

Parameters

  • eigenschappen

    SocketProperties optioneel

    De socketeigenschappen (optioneel).

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (createInfo: CreateInfo) => void

    • creëerInfo

      CreëerInfo

      Het resultaat van het maken van sockets.

Retouren

  • Beloof < CreateInfo >

    Chroom 91+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

disconnect()

Belofte
chrome.bluetoothSocket.disconnect(
  socketId: number,
  callback?: function,
)

Ontkoppelt het stopcontact. De socket-ID blijft geldig.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 91+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getInfo()

Belofte
chrome.bluetoothSocket.getInfo(
  socketId: number,
  callback?: function,
)

Haalt de status van de gegeven socket op.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (socketInfo: SocketInfo) => void

    • stopcontactInfo

      SocketInfo

      Object dat de socketinformatie bevat.

Retouren

  • Beloof het < SocketInfo >

    Chroom 91+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getSockets()

Belofte
chrome.bluetoothSocket.getSockets(
  callback?: function,
)

Haalt de lijst op met momenteel geopende sockets die eigendom zijn van de applicatie.

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (sockets: SocketInfo[]) => void

Retouren

  • Beloof het < SocketInfo []>

    Chroom 91+

    Beloftes 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,
)

Luister naar verbindingen met behulp van het L2CAP-protocol.

Parameters

  • socketId

    nummer

    De socket-ID.

  • uuid

    snaar

    Service UUID om naar te luisteren.

  • opties

    Luisteropties optioneel

    Optionele extra opties voor de service.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 91+

    Beloftes 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,
)

Luister naar verbindingen met behulp van het RFCOMM-protocol.

Parameters

  • socketId

    nummer

    De socket-ID.

  • uuid

    snaar

    Service UUID om naar te luisteren.

  • opties

    Luisteropties optioneel

    Optionele extra opties voor de service.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 91+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

send()

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

Verzendt gegevens over de opgegeven Bluetooth-aansluiting.

Parameters

  • socketId

    nummer

    De socket-ID.

  • gegevens

    ArrayBuffer

    De gegevens die moeten worden verzonden.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (bytesSent: number) => void

    • bytesVerzonden

      nummer

      Het aantal verzonden bytes.

Retouren

  • Beloof<nummer>

    Chroom 91+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

setPaused()

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

Schakelt in of uit dat een aangesloten socket berichten ontvangt van zijn peer, of dat een luisterende socket nieuwe verbindingen accepteert. De standaardwaarde is "false". Het pauzeren van een aangesloten socket wordt doorgaans door een applicatie gebruikt om de gegevens die door zijn peer worden verzonden, te beperken. Wanneer een aangesloten socket wordt gepauzeerd, wordt er geen onReceive gebeurtenis gegenereerd. Wanneer een socket is aangesloten en niet is gepauzeerd, worden onReceive gebeurtenissen opnieuw gegenereerd wanneer er berichten worden ontvangen. Wanneer een luisteraansluiting wordt gepauzeerd, worden nieuwe verbindingen geaccepteerd totdat de achterstand vol is. Vervolgens worden aanvullende verbindingsverzoeken geweigerd. onAccept gebeurtenissen worden alleen gegenereerd als de socket niet meer wordt gepauzeerd.

Parameters

  • socketId

    nummer

  • gepauzeerd

    Booleaans

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 91+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

update()

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

Werkt de socketeigenschappen bij.

Parameters

  • socketId

    nummer

    De socket-ID.

  • eigenschappen

    Socketeigenschappen

    De eigenschappen die moeten worden bijgewerkt.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 91+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

Evenementen

onAccept

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

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

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (info: AcceptInfo) => void

onAcceptError

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

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

Parameters

onReceive

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

Gebeurtenis die optreedt wanneer gegevens zijn ontvangen voor een bepaalde socket.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (info: ReceiveInfo) => void

onReceiveError

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

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

Parameters