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.

Beschikbaarheid

alleen ChromeOS

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 is mogelijk niet meer te herstellen.

"niet_luisterend"
De socket luistert niet.

AcceptErrorInfo

Eigenschappen

  • Een foutcode die aangeeft wat er mis is gegaan.

  • foutmelding

    snaar

    Het foutbericht.

  • socketId

    nummer

    De server socket-identificatie.

AcceptInfo

Eigenschappen

  • clientSocketId

    nummer

    De client socket-ID, oftewel de socket-ID van de zojuist tot stand gebrachte verbinding. Deze socket-ID mag alleen worden gebruikt met functies uit de namespace chrome.bluetoothSocket . Houd er rekening mee dat de client socket in eerste instantie gepauzeerd is en expliciet door de applicatie moet worden gedepauzeerd om gegevens te kunnen ontvangen.

  • socketId

    nummer

    De server socket-identificatie.

CreateInfo

Eigenschappen

  • socketId

    nummer

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

ListenOptions

Eigenschappen

  • achterstand

    nummer optioneel

    De lengte van de wachtrij 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 geweest, anders mislukt de methodeaanroep. Indien niet gespecificeerd, wordt 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 geweest, anders mislukt de methodeaanroep. 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 is mogelijk niet meer te herstellen.

"niet_verbonden"
Het stopcontact is niet aangesloten.

ReceiveErrorInfo

Eigenschappen

  • Een foutcode die aangeeft wat er mis is gegaan.

  • foutmelding

    snaar

    Het foutbericht.

  • socketId

    nummer

    De socket-identificatie.

ReceiveInfo

Eigenschappen

  • gegevens

    ArrayBuffer

    De ontvangen gegevens hebben een maximale grootte van bufferSize .

  • socketId

    nummer

    De socket-identificatie.

SocketInfo

Eigenschappen

  • adres

    string optioneel

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

  • bufferSize

    nummer optioneel

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

  • aangesloten

    booleaans

    Een vlag die aangeeft of de socket verbonden is met een externe tegenpartij.

  • naam

    string optioneel

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

  • pauzeerde

    booleaans

    Vlag die aangeeft of een verbonden socket voorkomt dat de tegenpartij meer gegevens verzendt, of dat verbindingsverzoeken op een luisterende socket worden afgehandeld via de onAccept -gebeurtenis of in de wachtrij van de luisteraar worden geplaatst. Zie setPaused . De standaardwaarde is "false".

  • volhardend

    booleaans

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

  • socketId

    nummer

    De socket-identificatie.

  • uuid

    string optioneel

    Als de onderliggende socket verbonden is, bevat deze informatie over de UUID van de service waarmee deze verbonden is; als de onderliggende socket luistert, bevat deze informatie over de UUID van de service waarop deze luistert.

SocketProperties

Eigenschappen

  • bufferSize

    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 afgesloten (zie Levenscyclus van de applicatie beheren ). De standaardwaarde is false. Wanneer de applicatie wordt geladen, kunnen alle sockets die eerder met persistent=true zijn geopend, 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 langer geldig zodra de functie wordt aangeroepen. Het is echter gegarandeerd dat de socket pas wordt gesloten wanneer de callback wordt aangeroepen.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

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 geactiveerd wanneer gegevens van de tegenpartij worden ontvangen. Als er een netwerkfout optreedt tijdens het ontvangen van pakketten, wordt een onReceiveError -gebeurtenis geactiveerd. In dat geval worden er geen onReceive gebeurtenissen meer geactiveerd voor deze socket totdat de methode setPaused(false) wordt aangeroepen.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • adres

    snaar

    Het adres van het Bluetooth-apparaat.

  • uuid

    snaar

    De UUID van de service waarmee verbinding moet worden gemaakt.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

create()

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

Hiermee wordt een Bluetooth-aansluiting gecreëerd.

Parameters

  • eigenschappen

    SocketProperties optioneel

    De socket-eigenschappen (optioneel).

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Het resultaat van het aanmaken van de socket.

Retourneert

  • Promise< CreateInfo >

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

disconnect()

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

De verbinding met de socket wordt verbroken. De socket-ID blijft geldig.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getInfo()

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

Haalt de status van de betreffende socket op.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Object dat de socketinformatie bevat.

Retourneert

  • Promise< SocketInfo >

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getSockets()

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

Geeft een lijst weer van de momenteel geopende sockets die eigendom zijn van de applicatie.

Parameters

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (sockets: SocketInfo[]) => void

    • stopcontacten

      SocketInfo []

      Een array van objecten met socketinformatie.

Retourneert

  • Promise< SocketInfo []>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

listenUsingL2cap()

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

Luister naar verbindingen via het L2CAP-protocol.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • uuid

    snaar

    Service-UUID om op te luisteren.

  • opties

    Luisteropties optioneel

    Optionele extra opties voor de service.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

listenUsingRfcomm()

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

Luister naar verbindingen via het RFCOMM-protocol.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • uuid

    snaar

    Service-UUID om op te luisteren.

  • opties

    Luisteropties optioneel

    Optionele extra opties voor de service.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

send()

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

Verzendt gegevens via de opgegeven Bluetooth-aansluiting.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • gegevens

    ArrayBuffer

    De te verzenden gegevens.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (bytesSent: number) => void

    • bytesSent

      nummer

      Het aantal verzonden bytes.

Retourneert

  • Belofte<nummer>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

setPaused()

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

Enables or disables a connected socket from receiving messages from its peer, or a listening socket from accepting new connections. The default value is "false". Pausing a connected socket is typically used by an application to throttle data sent by its peer. When a connected socket is paused, no onReceive event is raised. When a socket is connected and un-paused, onReceive events are raised again when messages are received. When a listening socket is paused, new connections are accepted until its backlog is full then additional connection requests are refused. onAccept events are raised only when the socket is un-paused.

Parameters

  • socketId

    nummer

  • pauzeerde

    booleaans

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

update()

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

Werkt de socket-eigenschappen bij.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • eigenschappen

    SocketProperties

    De eigenschappen die moeten worden bijgewerkt.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

Evenementen

onAccept

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

Deze gebeurtenis wordt geactiveerd wanneer een verbinding tot stand is gebracht voor een bepaalde socket.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (info: AcceptInfo) => void

onAcceptError

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

Deze gebeurtenis wordt geactiveerd wanneer er een netwerkfout optreedt terwijl de runtime wacht op nieuwe verbindingen op de betreffende socket. Zodra deze gebeurtenis is geactiveerd, wordt de socket paused en worden er geen onAccept gebeurtenissen meer voor deze socket geactiveerd.

Parameters

onReceive

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

Deze gebeurtenis wordt geactiveerd wanneer er gegevens zijn ontvangen voor een bepaalde socket.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (info: ReceiveInfo) => void

onReceiveError

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

Deze gebeurtenis wordt geactiveerd wanneer er een netwerkfout optreedt terwijl de runtime wacht op gegevens op de socket. Zodra deze gebeurtenis is geactiveerd, wordt de socket paused en worden er geen onReceive gebeurtenissen meer voor deze socket geactiveerd.

Parameters