Skip to content

API Documentation

mewlips edited this page Feb 12, 2017 · 1 revision

nx-remote-controller-mod API Documentation

Version: 0.9

/api/v1/camera/info


GET

Description: Returns camera informations

Responses

Code Description
200 camera model, firmware version, mac address

/api/v1/camera/status


GET

Description: Returns status of camera

Responses

Code Description
200 battery charging, battery percent, battery level, drive, mode, hevc, cameras

/api/v1/liveview/get


GET

Description: get liveview image

/api/v1/liveview/get_low


GET

Description: get liveview image (Low quality)

/api/v1/osd/get


GET

Description: get osd screen image

/api/v1/input/inject?key=key-name


GET

Description: send a key event to camera. see https://github.com/mewlips/nx-remote-controller-mod/wiki/Key-mappings

/api/v1/input/inject?keydown=key-name


GET

Description: send a key down event to camera. see https://github.com/mewlips/nx-remote-controller-mod/wiki/Key-mappings

/api/v1/input/inject?keyup=key-name


GET

Description: send a key down event to camera. see https://github.com/mewlips/nx-remote-controller-mod/wiki/Key-mappings

/api/v1/input/inject?mousedown=1


GET

Description: send a mouse down event to camera.

/api/v1/input/inject?mousemove=x-y


GET

Description: send a mouse move event to camera.

/api/v1/input/inject?mouseup=1


GET

Description: send a mouse up event to camera.

/api/v1/input/inject_keep_alive


GET

Description: send a key for keep alive

/api/v1/lcd/on


GET

Description: Turn on the lcd

/api/v1/lcd/off


GET

Description: Turn off the lcd

/api/v1/lcd/video


GET

Description: Turn off the osd

/api/v1/led/on


GET

Description: Turn on the led

/api/v1/led/off


GET

Description: Turn off the led

/api/v1/shutter/normal


GET

Description: Set shutter to normal (NX500 only)

/api/v1/shutter/silent


GET

Description: Set shutter to silent mode (NX500 only)