keb/MpcNET
1
0
Fork 0
mirror of https://github.com/ZetaKebab/MpcNET.git synced 2024-09-16 05:30:09 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source 
Connection section
This commit is contained in:
Gabriel Lucaci 2017-04-12 12:41:58 +02:00 committed by GitHub
parent c085b748e4
commit a44ae8da97
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -8,6 +8,27 @@ MpcNET
## Usage
### Connection
To create a client for MPD, you must first create a `IPEndPoint` for the Server with the right IP and Port.
````C#
var mpdEndpoint = new IPEndPoint(IPAddress.Loopback, 6600);
````
Then create a Client and Connect to MPD.
````C#
var client = new Mpc(mpdEndpoint);
var connected = await client.ConnectAsync();
````
The `ConnectAsync()` method is returning a bool to indicate if the connection was successfully. However, this can be queried directly on the Client also:
````C#
var isConnected = client.IsConnected;
````
and for MPD version, additional property is available:
````C#
var mpdVersion = client.Version
````
To disconnect the Client use the follow method:
````C#
await client.DisconnectAsync();
````
### Send Command
## API Content