UNPKG

2.91 kBTypeScriptView Raw
1/**
2 * Class describing a device on the network.
3 */
4export declare class Device {
5 /**
6 * Gets the address.
7 */
8 readonly address: string;
9 /**
10 * Gets the port.
11 */
12 readonly port: number | undefined;
13 /**
14 * Gets the MAC address. In most situations this is identical to the
15 * serial number. The exceptions are the Axis products which bundle
16 * multiple physical devices into a single casing with a shared network
17 * interface. Because of the shared network interface they also share
18 * the same MAC address.
19 */
20 readonly macAddress: string;
21 /**
22 * Gets the short description for the end user.
23 */
24 readonly friendlyName: string | undefined;
25 /**
26 * Gets the model name.
27 */
28 readonly modelName: string | undefined;
29 /**
30 * Gets the long model description for the end user.
31 */
32 readonly modelDescription: string | undefined;
33 /**
34 * Gets the model number.
35 */
36 readonly modelNumber: string | undefined;
37 /**
38 * Gets the URL to the web page of the device.
39 */
40 readonly presentationURL: string | undefined;
41 /**
42 * Initializes a new instance of the class.
43 * @param address The address.
44 * @param port The port.
45 * @param macAddress The MAC address. In most situations this is identical
46 * to the serial number. The exceptions are the Axis products which bundle
47 * multiple physical devices into a single casing with a shared network
48 * interface. Because of the shared network interface they also share the
49 * same MAC address.
50 * @param friendlyName The short description for the end user.
51 * @param modelName The model name.
52 * @param modelDescription The long model description for the end user.
53 * @param modelNumber The model number.
54 * @param presentationURL The URL to the web page of the device.
55 */
56 constructor(
57 /**
58 * Gets the address.
59 */
60 address: string,
61 /**
62 * Gets the port.
63 */
64 port: number | undefined,
65 /**
66 * Gets the MAC address. In most situations this is identical to the
67 * serial number. The exceptions are the Axis products which bundle
68 * multiple physical devices into a single casing with a shared network
69 * interface. Because of the shared network interface they also share
70 * the same MAC address.
71 */
72 macAddress: string,
73 /**
74 * Gets the short description for the end user.
75 */
76 friendlyName: string | undefined,
77 /**
78 * Gets the model name.
79 */
80 modelName: string | undefined,
81 /**
82 * Gets the long model description for the end user.
83 */
84 modelDescription: string | undefined,
85 /**
86 * Gets the model number.
87 */
88 modelNumber: string | undefined,
89 /**
90 * Gets the URL to the web page of the device.
91 */
92 presentationURL: string | undefined);
93}