Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
discovery_api [2024/02/07 01:43] – nedsdiscovery_api [2024/02/07 19:05] (current) – [Low level C Library] neds
Line 14: Line 14:
 Requires C99 compliant compiler. Requires C99 compliant compiler.
  
-===Example code=== + 
-See hdhomerun_discover_example.c for an example of using the discover API.+**Example code:** 
 + 
 +See [[https://github.com/Silicondust/libhdhomerun/blob/master/hdhomerun_discover_example.c|hdhomerun_discover_example.c]] for an example of using the discover API.
 Header files: Header files:
  
Line 23: Line 25:
  
 ====Source files required for discover==== ====Source files required for discover====
 +<WRAP indent>
 ^ File ^ Purpose ^ ^ File ^ Purpose ^
 ^ All platforms ^ ^ ^ All platforms ^ ^
Line 40: Line 43:
 | hdhomerun_os_windows.c | Internal OS wrapper functions | | hdhomerun_os_windows.c | Internal OS wrapper functions |
 | hdhomerun_sock_windows.c | Internal IP address detection & socket handling | | hdhomerun_sock_windows.c | Internal IP address detection & socket handling |
 +</WRAP>
 +
 +===== hdhomerun_discover_create() =====
 +<WRAP indent>
 +<code>struct hdhomerun_discover_t *hdhomerun_discover_create(struct hdhomerun_debug_t *dbg);</code>
 +
 +Creates a discover object for managing / executing the discover process. The object may be maintained across the lifespan of the app or may be created and destroyed for each discover.
 +
 +If the app polls discover often the discover object should be maintained and reused to avoid excessive cycling through local port numbers.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **dbg:** debug object for debug logging or NULL if not using logging.
 +
 +**Returns:**
 +  * Discover object. Free using hdhomerun_discover_destroy().
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover_destroy() =====
 +<WRAP indent>
 +<code>void hdhomerun_discover_destroy(struct hdhomerun_discover_t *ds);</code>
 +
 +Frees all resources associated with the given discover object.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **ds:** discover object to free.
 +
 +**Returns:**
 +  * None.
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_find_devices_broadcast() =====
 +<WRAP indent>
 +<code>int hdhomerun_discover2_find_devices_broadcast(struct hdhomerun_discover_t *ds, uint32_t flags, uint32_t const device_types[], size_t device_types_count);</code>
 +
 +Execute discover process to find devices of the specified type(s) on the local network(s). Results from any prior discover are wiped.
 +
 +This is the primary API to discover devices.
 +
 +Execution time is 400ms.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **ds:** discover object.
 +  * **flags:** specify which IP types to use for discover. Multiple flags can be specified by OR’ing together:
 +    * <WRAP>
 +| HDHOMERUN_DISCOVER_FLAGS_IPV4_GENERAL | Discover using all local IPv4 addresses (excluding localhost). |
 +| HDHOMERUN_DISCOVER_FLAGS_IPV4_LOCALHOST | Discover via IPv4 localhost. Specify if the local system can support running the HDHomeRun record engine for storing recordings on the local system. |
 +| HDHOMERUN_DISCOVER_FLAGS_IPV6_GENERAL | Discover using all global and site-local IPv6 addresses. |
 +| HDHOMERUN_DISCOVER_FLAGS_IPV6_LINKLOC | Discover using all link-local IPv6 addresses. Only specify if the application supports tracking IPv6 scope IDs. |
 +| HDHOMERUN_DISCOVER_FLAGS_IPV6_LOCALHOST | Discover via IPv6 localhost. Specify if the local system can support running the HDHomeRun record engine for storing recordings on the local system. | 
 +</WRAP>
 +  * **device_types:** array of uint32_t values specifying the types of devices to detect. Values:
 +    * <WRAP>
 +| HDHOMERUN_DEVICE_TYPE_TUNE | Detect HDHomeRun tuner devices. |
 +| HDHOMERUN_DEVICE_TYPE_STORAGE | Detect HDHomeRun record engines. |
 +</WRAP>
 +  * **device_types_count:** number of entries in the device_types array provided.
 +
 +**Returns:**
 +  * 1 if one or more devices were found.
 +  * 0 if the discover process completed without error but no devices were found.
 +  * -1 if the discover process failed.
 +
 +**Notes:**\\
 +Applications that support the complete HDHomeRun DVR system should pass in a 2 element device_type array indicating both TUNER and STORAGE.
 +
 +Applications that support live TV or don’t use the HDHomeRun DVR system should pass in a 1 element device_type array indicating TUNER.
 +
 +HDHomeRun tuner models with a hard drive present respond as both TUNER and STORAGE and report both TUNER and STORAGE types in the results.
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_find_devices_targeted() =====
 +<WRAP indent>
 +<code>int hdhomerun_discover2_find_devices_targeted(struct hdhomerun_discover_t *ds, const struct sockaddr *target_addr, const uint32_t device_types[], size_t device_types_count);</code>
 +
 +Execute discover process to get information about the device where the IP address is known. Results from any prior discover are wiped.
 +
 +Execution time can be up to 400ms if there is no response.
 +<WRAP indent>
 +**Parameters:**
 +  * **ds:** discover object.
 +  * **target_addr:** IP address to send discover request to.
 +    * IPv4 and IPv6 addresses supported.
 +    * IPv6 link-local – the Scope ID is used if specified, auto-detected if 0.
 +    * IPv6 non link-local – set Scope ID to 0.
 +  * **device_types:** array of uint32_t values specifying the types of devices to detect. See [[#hdhomerun_discover2_find_devices_broadcast()]] for the description.
 +  * **device_types_count:** number of entries in the device_types array provided.
 +
 +**Returns:**
 +  * 1 if the device responded successfully.
 +  * 0 if the discover process completed without error but the device did not respond.
 +  * -1 if the discover process failed.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_find_device_id_broadcast() =====
 +<WRAP indent>
 +<code>int hdhomerun_discover2_find_device_id_broadcast(struct hdhomerun_discover_t *ds, uint32_t flags, uint32_t device_id);</code>
 +Execute discover process to locate the specified device by Device ID (serial number) on the local network(s). Results from any prior discover are wiped.
 +
 +Execution time can be up to 400ms if the device is not detected.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **ds:** discover object.
 +  * **flags:** specify which IP types to use for discover. See [[#hdhomerun_discover2_find_devices_broadcast()]] for the description.
 +  * **device_id:** uint32_t device id (serial number) of the device to locate.
 +
 +**Returns:**
 +  * 1 if the specified device was successfully located.
 +  * 0 if the discover process completed without error but the specified device could not be located.
 +  * -1 if the discover process failed.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_find_device_id_targeted() =====
 +<WRAP indent>
 +<code>int hdhomerun_discover2_find_device_id_targeted(struct hdhomerun_discover_t *ds, const struct sockaddr *target_addr, uint32_t device_id);</code>
 +
 +Execute discover process to get information about the device where both the Device ID (serial number) and IP address are known.
 +
 +Execution time can be up to 400ms if there is no response.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **ds:** discover object.
 +  * **flags:** specify which IP types to use for discover. See [[#hdhomerun_discover2_find_devices_broadcast()]] for the description.
 +  * **target_addr:** IP address to send discover request to.
 +    * IPv4 and IPv6 addresses supported.
 +    * IPv6 link-local – the Scope ID is used if specified, or auto-detected if 0.
 +    * IPv6 non link-local – set Scope ID to 0.
 +  * **device_id:** uint32_t device id (serial number) of the device to locate.
 +
 +**Returns:**
 +  * 1 if the specified device responded successfully.
 +  * 0 if the discover process completed without error but the specified device did not respond.
 +  * -1 if the discover process failed.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_iter_device_first() =====
 +<WRAP indent>
 +<code>struct hdhomerun_discover2_device_t *hdhomerun_discover2_iter_device_first(struct hdhomerun_discover_t *ds);</code>
 +Return the first device from the list of devices discovered by the most recent invocation of one of the hdhomerun_discover2_find_devices_xxx() APIs.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **ds:** discover object.
 +**Returns:**
 +  * Device object. Resource maintained by the ds discover object – do not store or free.
 +  * NULL is no devices were found
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_iter_device_next() =====
 +<WRAP indent>
 +<code>struct hdhomerun_discover2_device_t *hdhomerun_discover2_iter_device_next(struct hdhomerun_discover2_device_t *device);</code>
 +Return the next device from the list of devices discovered by the most recent invocation of one of the hdhomerun_discover2_find_devices_xxx() APIs.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device:** device object from hdhomerun_discover2_iter_device_first() or previous call to hdhomerun_discover2_iter_device_next().
 +**Returns:**
 +  * Device object. Resource maintained by the ds discover object – do not store or free.
 +  * NULL when the end of the list has been reached.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_is_legacy() =====
 +<WRAP indent>
 +<code>bool hdhomerun_discover2_device_is_legacy(struct hdhomerun_discover2_device_t *device);</code>
 +Check if the detected device is a legacy tuner lacking channel management and http streaming support.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device:** device object from hdhomerun_discover2_iter_device_first() or hdhomerun_discover2_iter_device_next().
 +**Returns:**
 +  * True if the device is a legacy tuner.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_is_type() =====
 +<WRAP indent>
 +<code>bool hdhomerun_discover2_device_is_type(struct hdhomerun_discover2_device_t *device, uint32_t device_type);</code>
 +Check if the detected device is of a given type.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device:** device object from hdhomerun_discover2_iter_device_first() or hdhomerun_discover2_iter_device_next().
 +  * **device_type:** type to query:
 +    * <WRAP>
 +| HDHOMERUN_DEVICE_TYPE_TUNER | HDHomeRun tuner device. |
 +| HDHOMERUN_DEVICE_TYPE_STORAGE | HDHomeRun record engine. |
 +</WRAP>
 +**Returns:**
 +  * True if the device is of the type specified by the device_type parameter.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_get_device_id() =====
 +<WRAP indent>
 +<code>uint32_t hdhomerun_discover2_device_get_device_id(struct hdhomerun_discover2_device_t *device);</code>
 +
 +Return the 32-bit Device ID (serial number) of the device if the device is HDHomeRun hardware.
 +
 +Devices of type TUNER are hardware products and always have a Device ID.
 +
 +Devices of type STORAGE may be a hardware product with a Device ID or may be a software product with no Device ID (such as the HDHomeRun DVR record engine installed on a PC or NAS). To uniquely identify devices of type STORAGE use the alternative hdhomerun_discover2_device_get_storage_id() API.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device:** device object from hdhomerun_discover2_iter_device_first() or hdhomerun_discover2_iter_device_next().
 +
 +**Returns:**
 +  * 32-bit Device ID (serial number) of the HDHomeRun hardware.
 +  * 0 if the device does not have a Device ID, for example a DVR record engine installed on a PC or NAS.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_get_storage_id() =====
 +<WRAP indent>
 +<code>const char *hdhomerun_discover2_device_get_device_auth(struct hdhomerun_discover2_device_t *device);</code>
 +Return the UUID string Storage ID of the device.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device:** device object from hdhomerun_discover2_iter_device_first() or hdhomerun_discover2_iter_device_next().
 +
 +**Returns:**
 +  * UUID string Storage ID. The returned result must be copied if the value needs to be accessed by the app beyond the scope of the current discover action.
 +  * NULL if the device does not have a Storage ID, for example a tuner without storage capabilities.
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_get_tuner_count() =====
 +<WRAP indent>
 +<code>uint8_t hdhomerun_discover2_device_get_tuner_count(struct hdhomerun_discover2_device_t *device);</code>
 +Return the number of tuners the device has.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device:** device object from hdhomerun_discover2_iter_device_first() or hdhomerun_discover2_iter_device_next().
 +
 +**Returns:**
 +  * The number of tuners the device has.
 +  * 0 if the device does not have tuners.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_get_device_auth() =====
 +<WRAP indent>
 +<code>const char *hdhomerun_discover2_device_get_device_auth(struct hdhomerun_discover2_device_t *device);</code>
 +The DeviceAuth string reported by the device. Used to access HDHomeRun cloud APIs.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device:** device object from hdhomerun_discover2_iter_device_first() or hdhomerun_discover2_iter_device_next().
 +
 +**Returns:**
 +  * The DeviceAuth string reported by the device. The returned result must be copied if the value needs to be accessed by the app beyond the scope of the current discover action.
 +  * NULL if the device did not report a DeviceAuth string during discovery.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_iter_device_if_first() =====
 +<WRAP indent>
 +<code>struct hdhomerun_discover2_device_if_t *hdhomerun_discover2_iter_device_if_first(struct hdhomerun_discover2_device_t *device);</code>
 +A device can have multiple IP addresses, for example IPv4, IPv6 global, and IPv6 link-local. Use hdhomerun_discover2_iter_device_if_first() to obtain the first device-if object (IP address object) in the list associated with a device. This object is used to query the IP address and associated URLs.
 +
 +A typical application only needs to get the first device-if object and does not need to iterate through the list of device-if objects.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device:** device object from hdhomerun_discover2_iter_device_first() or hdhomerun_discover2_iter_device_next().
 +
 +**Returns:**
 +  * Device-IF object. Resource maintained by the ds discover object – do not store or free. A device-if object is always present and cannot be NULL.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_iter_device_if_next() =====
 +<WRAP indent>
 +<code>struct hdhomerun_discover2_device_if_t *hdhomerun_discover2_iter_device_if_next(struct hdhomerun_discover2_device_if_t *device_if)</code>
 +Return the next device-if object (IP address object) in the list associated with a device. This object is used to query the IP address and associated URLs.
 +
 +A typical application only needs to get the first device-if object and does not need to iterate through the list of device-if objects.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device_if:** device-if object from hdhomerun_discover2_iter_device_if_first() or previous call to hdhomerun_discover2_iter_device_if_next().
 +
 +**Returns:**
 +  * Device-IF object. Resource maintained by the ds discover object – do not store or free.
 +  * NULL when the end of the list has been reached.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_if_get_ip_addr() =====
 +<WRAP indent>
 +<code>void hdhomerun_discover2_device_if_get_ip_addr(struct hdhomerun_discover2_device_if_t *device_if, struct sockaddr_storage *ip_addr);</code>
 +Return the IP address of the device.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device_if:** device-if object from hdhomerun_discover2_iter_device_if_first() or hdhomerun_discover2_iter_device_if_next().
 +  * **ip_addr:** sockaddr_storage struct where the IP address is returned.
 +
 +**Returns:**
 +  * None.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_if_get_base_url() =====
 +<WRAP indent>
 +<code>const char *hdhomerun_discover2_device_if_get_base_url(struct hdhomerun_discover2_device_if_t *device_if);</code>
 +Return the base URL of the device as a string.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device_if:** device-if object from hdhomerun_discover2_iter_device_if_first() or hdhomerun_discover2_iter_device_if_next().
 +
 +**Returns:**
 +  * Base URL as a string. The returned result must be copied if the value needs to be accessed by the app beyond the scope of the current discover action. The Base URL is always present and cannot be NULL.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_if_get_lineup_url() =====
 +<WRAP indent>
 +<code>const char *hdhomerun_discover2_device_if_get_lineup_url(struct hdhomerun_discover2_device_if_t *device_if);</code>
 +Return the lineup URL (lineup.json) of the device as a string. Only present for devices of type TUNER.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device_if:** device-if object from hdhomerun_discover2_iter_device_if_first() or hdhomerun_discover2_iter_device_if_next().
 +
 +**Returns:**
 +  * Lineup URL as a string. The returned result must be copied if the value needs to be accessed by the app beyond the scope of the current discover action.
 +  * NULL if the device is not type TUNER.
 +
 +</WRAP>
 +</WRAP>
 +
 +===== hdhomerun_discover2_device_if_get_storage_url() =====
 +<WRAP indent>
 +<code>const char *hdhomerun_discover2_device_if_get_storage_url(struct hdhomerun_discover2_device_if_t *device_if);</code>
 +Return the storage URL (recorded_files.json) of the device as a string. Only present for devices of type STORAGE.
 +
 +<WRAP indent>
 +**Parameters:**
 +  * **device_if:** device-if object from hdhomerun_discover2_iter_device_if_first() or hdhomerun_discover2_iter_device_if_next().
 +
 +**Returns:**
 +  * Storage URL as a string. The returned result must be copied if the value needs to be accessed by the app beyond the scope of the current discover action.
 +  * NULL if the device is not type STORAGE.
 +
 +</WRAP>
 +</WRAP>
  
 {{tag>development}} {{tag>development}}
  • Last modified: 2024/02/07 01:43