Shiny Client v6.3Easy Live Activities, Game Center, Geospatial Geofencing, App Store APIs, More Thermal Printer Support, & Call Directory

Discovery

The discovery bridge finds and advertises services on the local network over mDNS/Bonjour, SSDP/UPnP and WS-Discovery, backed by Shiny.Net.Discovery.

Install and register

dotnet add package Shiny.AppDeviceBridge.Discovery

builder.UseAppDeviceBridge(
    bridge => bridge.AddDiscoveryBridge(DiscoveryProtocols.All),
    webApp => { /* … */ }
);

Client	C#	TypeScript
`IDiscoveryBridge`	`AddDiscoveryBridgeClient()`	`DiscoveryBridge`

Details

Topic	Details
Searching	`search` returns everything seen during `scanMs`, 5 s by default and 30 s at most.
Browsing	each `browse` streams results as `discovery.mdns`, `discovery.ssdp` or `discovery.wsd`, so listen to that event first; without a listener it answers `409`. At most 8 run at once, and a protocol’s browses stop once nothing listens to its event.
Publishing	`publications` keep advertising until deleted. At most 16.
Platform setup	on iOS and Mac Catalyst, list every browsed service type in `NSBonjourServices` and set `NSLocalNetworkUsageDescription`. On Android, SSDP and WS-Discovery need `CHANGE_WIFI_MULTICAST_STATE`.

From the page

A search collects answers for scanMs and returns them; a browse keeps going and streams them as events until you stop it or nothing listens any more.

import { DiscoveryBridge } from "@shinyorg/appdevicebridge";

const discovery = new DiscoveryBridge();

// one-shot: every printer that answers within 3 seconds
const printers = await discovery.searchMdns({ serviceType: "_ipp._tcp", resolveServices: true, scanMs: 3000 });

// continuous: services as they come and go
await discovery.onMdns(r => r.status === "Found" ? add(r.service) : remove(r.service));
const browse = await discovery.browseMdns({ serviceType: "_http._tcp" });

// later
await discovery.stopBrowse(browse.id);

Requests

POST/_bridge/discovery/mdns/search#

The mDNS services seen during the scan window, less any that went away.

C#IDiscoveryBridge.SearchMdnsAsyncTSDiscoveryBridge.searchMdns

Body

application/json · MdnsSearchRequest

MdnsSearchRequest · 4 fields

`serviceType`	`string`	Such as `_http._tcp`.
`domain`	`string \| null`	`local.` when null.
`resolveServices`	`boolean`	Resolve host, port, addresses and TXT records for each service found.
`scanMs`	`number \| null`	A search's window, 250–30,000 ms; 5 seconds when null. Ignored by a browse.

Response

200 MdnsService[]

MdnsService · 9 fields

`instanceName`	`string`
`serviceType`	`string`
`domain`	`string`
`fullName`	`string`
`hostName`	`string \| null`
`port`	`number`
`addresses`	`string[]`
`txtRecords`	`Record<string, string>`
`isResolved`	`boolean`

POST/_bridge/discovery/mdns/browse#

Browses for mDNS services; results arrive through onMdns.

C#IDiscoveryBridge.BrowseMdnsAsyncTSDiscoveryBridge.browseMdns

Body

application/json · MdnsSearchRequest

MdnsSearchRequest · 4 fields

`serviceType`	`string`	Such as `_http._tcp`.
`domain`	`string \| null`	`local.` when null.
`resolveServices`	`boolean`	Resolve host, port, addresses and TXT records for each service found.
`scanMs`	`number \| null`	A search's window, 250–30,000 ms; 5 seconds when null. Ignored by a browse.

Response

200 DiscoveryBrowse

DiscoveryBrowse · 3 fields

`id`	`string`
`protocol`	`DiscoveryProtocol`
`target`	`string`	What is being browsed for: a service type, search target or type list.

GET/_bridge/discovery/mdns/resolve#

Resolves one mDNS service. Fails with 404 when it does not answer.

C#IDiscoveryBridge.ResolveMdnsAsyncTSDiscoveryBridge.resolveMdns

Parameter	In	Type
`instanceName`	query	`string`	required
`serviceType`	query	`string`	required
`timeoutMs`	query	`number \| null`	optional

Response

200 MdnsService

MdnsService · 9 fields

`instanceName`	`string`
`serviceType`	`string`
`domain`	`string`
`fullName`	`string`
`hostName`	`string \| null`
`port`	`number`
`addresses`	`string[]`
`txtRecords`	`Record<string, string>`
`isResolved`	`boolean`

Errors

404Not found

POST/_bridge/discovery/mdns/publications#

Advertises a service over mDNS. On iOS the type must be listed in NSBonjourServices.

C#IDiscoveryBridge.PublishMdnsAsyncTSDiscoveryBridge.publishMdns

Body

application/json · MdnsPublishRequest

MdnsPublishRequest · 5 fields

`instanceName`	`string`
`serviceType`	`string`
`port`	`number`	1–65535.
`domain`	`string \| null`
`txtRecords`	`Record<string, string> \| null`

Response

200 DiscoveryPublication

DiscoveryPublication · 3 fields

`id`	`string`
`protocol`	`DiscoveryProtocol`
`name`	`string`	The name in use, which mDNS may have changed to settle a conflict on the network.

POST/_bridge/discovery/ssdp/search#

The UPnP devices seen during the scan window, less any that went away.

C#IDiscoveryBridge.SearchSsdpAsyncTSDiscoveryBridge.searchSsdp

Body

application/json · SsdpSearchRequest

SsdpSearchRequest · 3 fields

`searchTarget`	`string \| null`	`ssdp:all` when null.
`scanMs`	`number \| null`	A search's window, 250–30,000 ms; 5 seconds when null. Ignored by a browse.
`maxWaitMs`	`number \| null`	How long devices may wait before answering, 1,000–5,000 ms.

Response

200 SsdpDevice[]

SsdpDevice · 9 fields

`udn`	`string`
`location`	`string \| null`
`server`	`string \| null`
`notificationTypes`	`string[]`
`sourceAddress`	`string \| null`
`isRootDevice`	`boolean`
`deviceType`	`string \| null`
`serviceTypes`	`string[]`
`headers`	`Record<string, string>`

POST/_bridge/discovery/ssdp/browse#

Browses for UPnP devices; results arrive through onSsdp.

C#IDiscoveryBridge.BrowseSsdpAsyncTSDiscoveryBridge.browseSsdp

Body

application/json · SsdpSearchRequest

SsdpSearchRequest · 3 fields

`searchTarget`	`string \| null`	`ssdp:all` when null.
`scanMs`	`number \| null`	A search's window, 250–30,000 ms; 5 seconds when null. Ignored by a browse.
`maxWaitMs`	`number \| null`	How long devices may wait before answering, 1,000–5,000 ms.

Response

200 DiscoveryBrowse

DiscoveryBrowse · 3 fields

`id`	`string`
`protocol`	`DiscoveryProtocol`
`target`	`string`	What is being browsed for: a service type, search target or type list.

GET/_bridge/discovery/ssdp/description#

A device's UPnP description. The device must have been seen by a search or browse first; otherwise 404.

C#IDiscoveryBridge.GetSsdpDescriptionAsyncTSDiscoveryBridge.getSsdpDescription

Parameter	In	Type
`udn`	query	`string`	required

Response

200 UpnpDeviceDescription

UpnpDeviceDescription · 15 fields

`udn`	`string \| null`
`deviceType`	`string \| null`
`friendlyName`	`string \| null`
`manufacturer`	`string \| null`
`manufacturerUrl`	`string \| null`
`modelName`	`string \| null`
`modelNumber`	`string \| null`
`modelDescription`	`string \| null`
`modelUrl`	`string \| null`
`serialNumber`	`string \| null`
`upc`	`string \| null`
`presentationUrl`	`string \| null`
`icons`	`UpnpIcon[]`
`services`	`UpnpService[]`
`devices`	`UpnpDeviceDescription[]`

Errors

404Not found

POST/_bridge/discovery/ssdp/publications#

Advertises a device over SSDP.

C#IDiscoveryBridge.PublishSsdpAsyncTSDiscoveryBridge.publishSsdp

Body

application/json · SsdpPublishRequest

SsdpPublishRequest · 7 fields

`udn`	`string`
`location`	`string`	The absolute URL of the device description XML.
`deviceType`	`string \| null`
`serviceTypes`	`string[] \| null`
`isRootDevice`	`boolean`
`maxAgeSeconds`	`number \| null`
`server`	`string \| null`

Response

200 DiscoveryPublication

DiscoveryPublication · 3 fields

`id`	`string`
`protocol`	`DiscoveryProtocol`
`name`	`string`	The name in use, which mDNS may have changed to settle a conflict on the network.

POST/_bridge/discovery/wsd/search#

The WS-Discovery targets seen during the scan window, less any that went away.

C#IDiscoveryBridge.SearchWsdAsyncTSDiscoveryBridge.searchWsd

Body

application/json · WsdSearchRequest

WsdSearchRequest · 5 fields

`types`	`WsdQualifiedName[] \| null`
`scopes`	`string[] \| null`
`scopeMatchBy`	`string \| null`
`profiles`	`WsDiscoveryProfile`
`scanMs`	`number \| null`	A search's window, 250–30,000 ms; 5 seconds when null. Ignored by a browse.

Response

200 WsdTarget[]

WsdTarget · 9 fields

`endpointReference`	`string`
`types`	`WsdQualifiedName[]`
`scopes`	`string[]`
`addresses`	`string[]`
`preferredAddress`	`string \| null`
`metadataVersion`	`number`
`sourceAddress`	`string \| null`
`profile`	`WsDiscoveryProfile`
`isOnvifCamera`	`boolean`

POST/_bridge/discovery/wsd/browse#

Browses for WS-Discovery targets; results arrive through onWsd.

C#IDiscoveryBridge.BrowseWsdAsyncTSDiscoveryBridge.browseWsd

Body

application/json · WsdSearchRequest

WsdSearchRequest · 5 fields

`types`	`WsdQualifiedName[] \| null`
`scopes`	`string[] \| null`
`scopeMatchBy`	`string \| null`
`profiles`	`WsDiscoveryProfile`
`scanMs`	`number \| null`	A search's window, 250–30,000 ms; 5 seconds when null. Ignored by a browse.

Response

200 DiscoveryBrowse

DiscoveryBrowse · 3 fields

`id`	`string`
`protocol`	`DiscoveryProtocol`
`target`	`string`	What is being browsed for: a service type, search target or type list.

GET/_bridge/discovery/wsd/resolve#

Resolves one WS-Discovery target. Fails with 404 when it does not answer.

C#IDiscoveryBridge.ResolveWsdAsyncTSDiscoveryBridge.resolveWsd

Parameter	In	Type
`endpointReference`	query	`string`	required
`timeoutMs`	query	`number \| null`	optional

Response

200 WsdTarget

WsdTarget · 9 fields

`endpointReference`	`string`
`types`	`WsdQualifiedName[]`
`scopes`	`string[]`
`addresses`	`string[]`
`preferredAddress`	`string \| null`
`metadataVersion`	`number`
`sourceAddress`	`string \| null`
`profile`	`WsDiscoveryProfile`
`isOnvifCamera`	`boolean`

Errors

404Not found

POST/_bridge/discovery/wsd/publications#

Advertises a target over WS-Discovery.

C#IDiscoveryBridge.PublishWsdAsyncTSDiscoveryBridge.publishWsd

Body

application/json · WsdPublishRequest

WsdPublishRequest · 6 fields

`endpointReference`	`string`
`types`	`WsdQualifiedName[] \| null`
`scopes`	`string[] \| null`
`addresses`	`string[] \| null`	Absolute URLs the target answers at.
`metadataVersion`	`number`
`profiles`	`WsDiscoveryProfile`

Response

200 DiscoveryPublication

DiscoveryPublication · 3 fields

`id`	`string`
`protocol`	`DiscoveryProtocol`
`name`	`string`	The name in use, which mDNS may have changed to settle a conflict on the network.

GET/_bridge/discovery/browses#

The running browses.

C#IDiscoveryBridge.GetBrowsesAsyncTSDiscoveryBridge.getBrowses

Response

200 DiscoveryBrowse[]

DiscoveryBrowse · 3 fields

`id`	`string`
`protocol`	`DiscoveryProtocol`
`target`	`string`	What is being browsed for: a service type, search target or type list.

DELETE/_bridge/discovery/browses/{id}#

Stops a browse.

C#IDiscoveryBridge.StopBrowseAsyncTSDiscoveryBridge.stopBrowse

Parameter	In	Type
`id`	path	`string`	required

Response: 204 No content

GET/_bridge/discovery/publications#

The active publications.

C#IDiscoveryBridge.GetPublicationsAsyncTSDiscoveryBridge.getPublications

Response

200 DiscoveryPublication[]

DiscoveryPublication · 3 fields

`id`	`string`
`protocol`	`DiscoveryProtocol`
`name`	`string`	The name in use, which mDNS may have changed to settle a conflict on the network.

DELETE/_bridge/discovery/publications/{id}#

Stops advertising, sending a goodbye so it vanishes from other devices straight away.

C#IDiscoveryBridge.UnpublishAsyncTSDiscoveryBridge.unpublish

Parameter	In	Type
`id`	path	`string`	required

Response: 204 No content

Events

EVENTdiscovery.mdns#

An mDNS service was found or lost by a browse.

C#IDiscoveryBridge.OnMdnsAsyncTSDiscoveryBridge.onMdns

Payload: MdnsBrowseResult

`browseId`	`string`
`status`	`DiscoveryStatus`
`service`	`MdnsService`

EVENTdiscovery.ssdp#

A UPnP device was found or lost by a browse.

C#IDiscoveryBridge.OnSsdpAsyncTSDiscoveryBridge.onSsdp

Payload: SsdpBrowseResult

`browseId`	`string`
`status`	`DiscoveryStatus`
`device`	`SsdpDevice`

EVENTdiscovery.wsd#

A WS-Discovery target was found or lost by a browse.

C#IDiscoveryBridge.OnWsdAsyncTSDiscoveryBridge.onWsd

Payload: WsdBrowseResult

`browseId`	`string`
`status`	`DiscoveryStatus`
`target`	`WsdTarget`

EVENTdiscovery.error#

A browse failed; onStopped follows.

C#IDiscoveryBridge.OnErrorAsyncTSDiscoveryBridge.onError

Payload: DiscoveryError

`browseId`	`string`
`protocol`	`DiscoveryProtocol`
`message`	`string`

EVENTdiscovery.stopped#

A browse ended.

C#IDiscoveryBridge.OnStoppedAsyncTSDiscoveryBridge.onStopped

Payload: DiscoveryBrowse

`id`	`string`
`protocol`	`DiscoveryProtocol`
`target`	`string`	What is being browsed for: a service type, search target or type list.

Types

JSON property names are camelCase and enums travel as their names. A ? marks a property the payload may omit;| null one that may be null.

MdnsSearchRequestobject#

`serviceType`	`string`	Such as `_http._tcp`.
`domain?`	`string \| null`	`local.` when null.
`resolveServices?`	`boolean`	Resolve host, port, addresses and TXT records for each service found.
`scanMs?`	`number \| null`	A search's window, 250–30,000 ms; 5 seconds when null. Ignored by a browse.

MdnsServiceobject#

`instanceName`	`string`
`serviceType`	`string`
`domain`	`string`
`fullName`	`string`
`hostName`	`string \| null`
`port`	`number`
`addresses`	`string[]`
`txtRecords`	`Record<string, string>`
`isResolved`	`boolean`

DiscoveryBrowseobject#

`id`	`string`
`protocol`	`DiscoveryProtocol`
`target`	`string`	What is being browsed for: a service type, search target or type list.

DiscoveryProtocolenum#

"Mdns""Ssdp""Wsd"

MdnsPublishRequestobject#

`instanceName`	`string`
`serviceType`	`string`
`port`	`number`	1–65535.
`domain?`	`string \| null`
`txtRecords?`	`Record<string, string> \| null`

DiscoveryPublicationobject#

`id`	`string`
`protocol`	`DiscoveryProtocol`
`name`	`string`	The name in use, which mDNS may have changed to settle a conflict on the network.

SsdpSearchRequestobject#

`searchTarget?`	`string \| null`	`ssdp:all` when null.
`scanMs?`	`number \| null`	A search's window, 250–30,000 ms; 5 seconds when null. Ignored by a browse.
`maxWaitMs?`	`number \| null`	How long devices may wait before answering, 1,000–5,000 ms.

SsdpDeviceobject#

`udn`	`string`
`location`	`string \| null`
`server`	`string \| null`
`notificationTypes`	`string[]`
`sourceAddress`	`string \| null`
`isRootDevice`	`boolean`
`deviceType`	`string \| null`
`serviceTypes`	`string[]`
`headers`	`Record<string, string>`

UpnpDeviceDescriptionobject#

A device's UPnP description, with its embedded devices.

`udn`	`string \| null`
`deviceType`	`string \| null`
`friendlyName`	`string \| null`
`manufacturer`	`string \| null`
`manufacturerUrl`	`string \| null`
`modelName`	`string \| null`
`modelNumber`	`string \| null`
`modelDescription`	`string \| null`
`modelUrl`	`string \| null`
`serialNumber`	`string \| null`
`upc`	`string \| null`
`presentationUrl`	`string \| null`
`icons`	`UpnpIcon[]`
`services`	`UpnpService[]`
`devices`	`UpnpDeviceDescription[]`

UpnpIconobject#

`mimeType`	`string \| null`
`width`	`number`
`height`	`number`
`depth`	`number`
`url`	`string \| null`

UpnpServiceobject#

`serviceType`	`string \| null`
`serviceId`	`string \| null`
`scpdUrl`	`string \| null`
`controlUrl`	`string \| null`
`eventSubscriptionUrl`	`string \| null`

SsdpPublishRequestobject#

`udn`	`string`
`location`	`string`	The absolute URL of the device description XML.
`deviceType?`	`string \| null`
`serviceTypes?`	`string[] \| null`
`isRootDevice?`	`boolean`
`maxAgeSeconds?`	`number \| null`
`server?`	`string \| null`

WsdSearchRequestobject#

`types?`	`WsdQualifiedName[] \| null`
`scopes?`	`string[] \| null`
`scopeMatchBy?`	`string \| null`
`profiles?`	`WsDiscoveryProfile`
`scanMs?`	`number \| null`	A search's window, 250–30,000 ms; 5 seconds when null. Ignored by a browse.

WsdQualifiedNameobject#

An XML qualified name, since WS-Discovery types are namespaced XML names.

`name`	`string`
`namespace`	`string`

WsDiscoveryProfileenum#

"None""Ws2005""Ws2009""All"

WsdTargetobject#

`endpointReference`	`string`
`types`	`WsdQualifiedName[]`
`scopes`	`string[]`
`addresses`	`string[]`
`preferredAddress`	`string \| null`
`metadataVersion`	`number`
`sourceAddress`	`string \| null`
`profile`	`WsDiscoveryProfile`
`isOnvifCamera`	`boolean`

WsdPublishRequestobject#

`endpointReference`	`string`
`types?`	`WsdQualifiedName[] \| null`
`scopes?`	`string[] \| null`
`addresses?`	`string[] \| null`	Absolute URLs the target answers at.
`metadataVersion?`	`number`
`profiles?`	`WsDiscoveryProfile`

MdnsBrowseResultobject#

`browseId`	`string`
`status`	`DiscoveryStatus`
`service`	`MdnsService`

DiscoveryStatusenum#

Whether a browse result is new or went away.

"Found""Lost"

SsdpBrowseResultobject#

`browseId`	`string`
`status`	`DiscoveryStatus`
`device`	`SsdpDevice`

WsdBrowseResultobject#

`browseId`	`string`
`status`	`DiscoveryStatus`
`target`	`WsdTarget`

DiscoveryErrorobject#

`browseId`	`string`
`protocol`	`DiscoveryProtocol`
`message`	`string`

Security

These routes sit under AppDeviceBridgePolicies.Bridges like every other bridge: callers on this device by default. See Security.