Logo Search packages:      
Sourcecode: libhdhomerun version File versions

hdhomerun_discover.h

/*
 * hdhomerun_discover.h
 *
 * Copyright  2006 Silicondust Engineering Ltd. <www.silicondust.com>.
 *
 * This library is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifdef __cplusplus
extern "C" {
#endif

struct hdhomerun_discover_device_t {
      uint32_t ip_addr;
      uint32_t device_type;
      uint32_t device_id;
};

/*
 * Find a device by device ID.
 *
 * The device information is stored in caller-supplied hdhomerun_discover_device_t var.
 * Multiple attempts are made to find the device.
 * Worst-case execution time is 1 second.
 *
 * Returns 1 on success.
 * Returns 0 if not found.
 * Retruns -1 on error.
 */
extern int hdhomerun_discover_find_device(uint32_t device_id, struct hdhomerun_discover_device_t *result);

/*
 * Find all devices of a given type.
 *
 * The device information is stored in caller-supplied array of hdhomerun_discover_device_t vars.
 * Multiple attempts are made to find devices.
 * Execution time is 1 second.
 *
 * Returns the number of devices found.
 * Retruns -1 on error.
 */
extern int hdhomerun_discover_find_devices(uint32_t device_type, struct hdhomerun_discover_device_t result_list[], int max_count);

/*
 * Find custom.
 *
 * The device information is stored in caller-supplied array of hdhomerun_discover_device_t vars.
 * Multiple attempts are made to find devices.
 * Execution time is 1 second.
 *
 * Returns the number of devices found.
 * Retruns -1 on error.
 */
extern int hdhomerun_discover_find_devices_custom(uint32_t target_ip, uint32_t device_type, uint32_t device_id, struct hdhomerun_discover_device_t result_list[], int max_count);

/*
 * Verify that the device ID given is valid.
 *
 * The device ID contains a self-check sequence that detects common user input errors including
 * single-digit errors and two digit transposition errors.
 *
 * Returns TRUE if valid.
 * Returns FALSE if not valid.
 */
extern bool_t hdhomerun_discover_validate_device_id(uint32_t device_id);

#ifdef __cplusplus
}
#endif

Generated by  Doxygen 1.6.0   Back to index