Skip to content

Commit b08d51c

Browse files
committed
Explained the limitations of CastDeviceMonitor and how to find the correct versions of dependencies for manual inclusion.
1 parent d63770e commit b08d51c

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ No explicit documentation for how to use this library exists, but every piece of
1010

1111
## Include
1212

13+
### Maven
14+
1315
Ths library is available at Maven Central, simply add the following in your project's `pom.xml` file:
1416

1517
```xml
@@ -23,3 +25,11 @@ Ths library is available at Maven Central, simply add the following in your proj
2325
...
2426
</dependencies>
2527
```
28+
29+
### Manual
30+
31+
If you don't use a build automation tool like Maven, you have to provide the library's dependencies manually, please make sure to use compatible versions. The applicable versions are listed in [pom.xml](pom.xml) under `<dependencies>`. Please note the `<scope>`, dependencies scoped with `compile` or `test` are only required to build the library, not to use it.
32+
33+
## Discovery
34+
35+
The library includes [CastDeviceMonitor](src/main/java/org/digitalmediaserver/cast/CastDeviceMonitor.java) for easy discovery of cast devices. The class isn't very sophisticated, and is only meant for very basic projects or to get up and running quickly. If you need more control over the network configuration, or the project already has a mDNS instance running, it's recommended that the project takes care of mDNS and uses the library to create `CastDevice` instances when devices that provide `_googlecast._tcp.local.` are found.

src/main/java/org/digitalmediaserver/cast/CastDeviceMonitor.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,13 @@
3838
* <p>
3939
* After creating a {@link CastDeviceMonitor}, it must be started using
4040
* {@link #startDiscovery(InetAddress, String)}.
41+
* <p>
42+
* <b>Note</b>: This class isn't very sophisticated, and is only meant for basic
43+
* projects or to get up and running quickly. If you need more control over the
44+
* network configuration, or the project already has a mDNS instance running,
45+
* use another mDNS instance and use the library to create {@link CastDevice}
46+
* instances when devices that provide {@value CastDevice#SERVICE_TYPE} are
47+
* found.
4148
*/
4249
public final class CastDeviceMonitor {
4350

0 commit comments

Comments
 (0)