# kz-remote-api

**Repository Path**: tiansh/kz-remote-api

## Basic Information

- **Project Name**: kz-remote-api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-08-24
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

kz-remote-api
=============

- Sony camera remote API wrapper written in C#.
- Currently supports [Camera Remote API beta v2.3.0](https://developer.sony.com/develop/cameras/).
- Being developed as a part of [Locana](https://github.com/locana/locana).

## Build

1. Clone repository.

```bash
git clone git@github.com:kazyx/kz-remote-api.git
```

2. Open csproj file with Visual Studio.
    - /Project/KzRemoteApiUwp.csproj for Windows 10 Universal application.
    - /Project/KzRemoteApiDesktop.csproj for Desktop application.
    - /Project/KzRemoteApiUniversal.csproj for Windows 8.1 Universal application.
    - ~~/Project/KzRemoteApiPhone8.csproj for Windows Phone 8 or 8.1 application.~~

3. Add reference to [Json.NET](https://github.com/JamesNK/Newtonsoft.Json).

## Call camera remote APIs

1. Get end point URL of the services. See [kz-ssdp-discovery](https://github.com/kazyx/kz-ssdp-discovery).

```cs
discovery.SonyCameraDeviceDiscovered += (sender, e) => {
    var endpoints = e.SonyCameraDevice.Endpoints;
}
```

2. Create ApiClient instance.

```cs
var camera = new CameraApiClient(endpoints["camera"]);
```

3. Call async API.

```cs
var picUrls = await camera.ActTakePictureAsync();
```

## Error handling

Async methods throw `RemoteApiException` in the following cases.

- Any network error: `StatusCode.NetworkError`
- Operation is cancelled via `CancellationTokenSource`: `StatusCode.Cancelled`
- Error response: `StatusCode.Any` or larger. Or `StatusCode.Undefined` if it is not defined yet.

## License

This software is published under the [MIT License](http://opensource.org/licenses/mit-license).