api

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 18, 2020 License: GPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthMixin 

type AuthMixin struct {
	Username string
	Password string
}

func (*AuthMixin) Login 

func (am *AuthMixin) Login() func(*rest.RestHandler) (bool, error)

func (*AuthMixin) Logout 

func (am *AuthMixin) Logout() func(handler *rest.RestHandler) (bool, error)

type DeviceMixin 

type DeviceMixin struct {
}

func (*DeviceMixin) FormatHdd 

func (dm *DeviceMixin) FormatHdd(hddId int) func(handler *rest.RestHandler) (bool, error)

Format the camera HDD. Default hddId: 0 TODO: better error messages

func (*DeviceMixin) GetHddInfo 

func (dm *DeviceMixin) GetHddInfo() func(handler *rest.RestHandler) (*models.HddInfo, error)

Get the Camera's HDD information TODO: Better error messages

type DisplayMixin 

type DisplayMixin struct {
}

func (*DisplayMixin) GetMask 

func (dm *DisplayMixin) GetMask() func(handler *rest.RestHandler) (*models.MaskData, error)

Get the camera's mask information

func (*DisplayMixin) GetOSD 

func (dm *DisplayMixin) GetOSD() func(handler *rest.RestHandler) (*models.Osd, error)

Get the camera's Osd information

func (*DisplayMixin) SetOSD 

func (dm *DisplayMixin) SetOSD(osdOption ...OptionOsd) func(handler *rest.RestHandler) (bool,
	error)

Set the camera's Osd

type ImageMixin 

type ImageMixin struct {
}

func (*ImageMixin) SetAdvanceImageSettings 

func (im *ImageMixin) SetAdvanceImageSettings(imageAdvancedOptions ...OptionAdvancedImageSetting) func(handler *rest.RestHandler) (bool,
	error)

Set the Advanced Image setting. Parameters are optional and will fallback to defaults. Defaults: antiFlicker: "Outdoor", exposure: "Auto", gainMin: 1, gainMax: 62, shutterMin: 1, shutterMax: 125, blueGain: 128, redGain: 128, whiteBalance: "Auto", dayNight: "Auto", backLight: "DynamicRangeControl", blc: 128, drc: 128, rotation: 0, mirroring: 0, nr3d: 1,

func (*ImageMixin) SetImageSettings 

func (im *ImageMixin) SetImageSettings(imageOptions ...OptionImageSetting) func(handler *rest.RestHandler) (bool,
	error)

Set the Image Settings. Parameters are optional and will fallback to defautls. Defaults: brightness: 128, contrast: 62, hue: 1, saturation: 125, sharpness: 128,

type NetworkMixin 

type NetworkMixin struct {
}

func (*NetworkMixin) GetNetworkDDNS 

func (nm *NetworkMixin) GetNetworkDDNS() func(handler *rest.RestHandler) (*models.NetworkDDNS, error)

Get the camera's network DDNS information

func (*NetworkMixin) GetNetworkEmail 

func (nm *NetworkMixin) GetNetworkEmail() func(handler *rest.RestHandler) (*models.NetworkEmail, error)

Get the camera's network Email information

func (*NetworkMixin) GetNetworkFTP 

func (nm *NetworkMixin) GetNetworkFTP() func(handler *rest.RestHandler) (*models.NetworkFTP, error)

Get the camera's network FTP information

func (*NetworkMixin) GetNetworkGeneral 

func (nm *NetworkMixin) GetNetworkGeneral() func(handler *rest.RestHandler) (*models.NetworkGeneral, error)

Get the camera's general network information

func (*NetworkMixin) GetNetworkNTP 

func (nm *NetworkMixin) GetNetworkNTP() func(handler *rest.RestHandler) (*models.NetworkNTP, error)

Get the camera's network NTP information

func (*NetworkMixin) GetNetworkPush 

func (nm *NetworkMixin) GetNetworkPush() func(handler *rest.RestHandler) (*models.NetworkPush, error)

Get the camera's network Push information

func (*NetworkMixin) GetNetworkStatus 

func (nm *NetworkMixin) GetNetworkStatus() func(handler *rest.RestHandler) (*models.NetworkGeneral, error)

Get the camera's network Status information is just a wrapper for networkGeneral TODO: revise this, exactly copied from the reolink-python-api project.

func (*NetworkMixin) GetWifi 

func (nm *NetworkMixin) GetWifi() func(handler *rest.RestHandler) (*models.Wifi, error)

Get the current camera's wifi settings

func (*NetworkMixin) ScanWifi 

func (nm *NetworkMixin) ScanWifi() func(handler *rest.RestHandler) (*models.ScanWifi, error)

Scan the current camera's wifi network

func (*NetworkMixin) SetNetworkPort 

func (nm *NetworkMixin) SetNetworkPort(networkPortOptions ...NetworkPortOptions) func(handler *rest.RestHandler) (bool,
	error)

Set the camera network ports using the NetworkPortOption<prop> functions Defaults are automatically for the excluded networkPortOptions http: 80 https: 443 media: 9000 onvif: 8000 rtmp: 1935 rtsp: 554

func (*NetworkMixin) SetWifi 

func (nm *NetworkMixin) SetWifi(ssid string, password string) func(handler *rest.RestHandler) (bool, error)

Set the camera's wifi settings

type NetworkPortOptions 

type NetworkPortOptions func(*networkPorts)

func NetworkPortOptionHttp 

func NetworkPortOptionHttp(httpPort int) NetworkPortOptions

An option for SetNetworkPort to set the httpPort Default value of httpPort is 80

func NetworkPortOptionHttps 

func NetworkPortOptionHttps(https int) NetworkPortOptions

An option for SetNetworkPort to set the httpsPort Default value of httpsPort is 443

func NetworkPortOptionMedia 

func NetworkPortOptionMedia(media int) NetworkPortOptions

An option for SetNetworkPort to set the mediaPort Default value of mediaPort is 9000

func NetworkPortOptionOnvif 

func NetworkPortOptionOnvif(onvif int) NetworkPortOptions

An option for SetNetworkPort to set the onvifPort Default value of onvifPort is 8000

func NetworkPortOptionRtmp 

func NetworkPortOptionRtmp(rtmp int) NetworkPortOptions

An option for SetNetworkPort to set the rtmpPort Default value of rtmpPort is 1935

func NetworkPortOptionRtsp 

func NetworkPortOptionRtsp(rtsp int) NetworkPortOptions

An option for SetNetworkPort to set the rtspPort Default value of rtspPort is 554

type OptionAdvancedImageSetting 

type OptionAdvancedImageSetting func(*imageAdvanced)

func ImageAdvancedOptionAntiFlicker 

func ImageAdvancedOptionAntiFlicker(antiFlicker enum.AntiFlicker) OptionAdvancedImageSetting

Set the anti flicker value Default: Outdoor

func ImageAdvancedOptionBacklight 

func ImageAdvancedOptionBacklight(backlight enum.Backlight) OptionAdvancedImageSetting

Set the backlight value Default: DynamicRangeControl

func ImageAdvancedOptionBlc 

func ImageAdvancedOptionBlc(blc int) OptionAdvancedImageSetting

Set the blc value Default: 128

func ImageAdvancedOptionBlueGain 

func ImageAdvancedOptionBlueGain(blueGain int) OptionAdvancedImageSetting

Set the blue gain value Default: 128

func ImageAdvancedOptionDayNight 

func ImageAdvancedOptionDayNight(dayNight enum.DayNight) OptionAdvancedImageSetting

Set the day night value Default: Auto

func ImageAdvancedOptionDrc 

func ImageAdvancedOptionDrc(drc int) OptionAdvancedImageSetting

Set the drc value Default: 128

func ImageAdvancedOptionExposure 

func ImageAdvancedOptionExposure(exposure enum.Exposure) OptionAdvancedImageSetting

Set the exposure value Default: Auto

func ImageAdvancedOptionGainMax 

func ImageAdvancedOptionGainMax(gainMax int) OptionAdvancedImageSetting

Set the gain max value Default: 62

func ImageAdvancedOptionGainMin 

func ImageAdvancedOptionGainMin(gainMin int) OptionAdvancedImageSetting

Set the gain min value Default: 1

func ImageAdvancedOptionMirroring 

func ImageAdvancedOptionMirroring(mirroring int) OptionAdvancedImageSetting

Set the mirroring value Default: 0

func ImageAdvancedOptionNr3d 

func ImageAdvancedOptionNr3d(nr3d int) OptionAdvancedImageSetting

Set the nr3d value Default: 0

func ImageAdvancedOptionRedGain 

func ImageAdvancedOptionRedGain(redGain int) OptionAdvancedImageSetting

Set the red gain value Default: 128

func ImageAdvancedOptionRotation 

func ImageAdvancedOptionRotation(rotation enum.Rotation) OptionAdvancedImageSetting

Set the rotation value Default: 0

func ImageAdvancedOptionShutterMax 

func ImageAdvancedOptionShutterMax(shutterMax int) OptionAdvancedImageSetting

Set the shutter max value Default: 125

func ImageAdvancedOptionShutterMin 

func ImageAdvancedOptionShutterMin(shutterMin int) OptionAdvancedImageSetting

Set the shutter min value Default: 1

func ImageAdvancedOptionWhiteBalance 

func ImageAdvancedOptionWhiteBalance(whiteBalance enum.WhiteBalance) OptionAdvancedImageSetting

Set the white balance value Default: Auto

type OptionFocusOperation 

type OptionFocusOperation func(*focus)

func FocusOptionSpeed 

func FocusOptionSpeed(speed int) OptionFocusOperation

Set the focus speed default: 32

type OptionImageSetting 

type OptionImageSetting func(*image)

func ImageOptionBrightness 

func ImageOptionBrightness(brightness int) OptionImageSetting

Set Image Brightness Default: 128

func ImageOptionContrast 

func ImageOptionContrast(contrast int) OptionImageSetting

Set Image Contrast Default: 62

func ImageOptionHue 

func ImageOptionHue(hue int) OptionImageSetting

Set Image Hue Default: 1

func ImageOptionSaturation 

func ImageOptionSaturation(saturation int) OptionImageSetting

Set Image Saturation Default: 125

func ImageOptionSharpness 

func ImageOptionSharpness(sharpness int) OptionImageSetting

Set Image Sharpness Default: 128

type OptionOsd 

type OptionOsd func(*osd)

func SetOsdOptionBgColor 

func SetOsdOptionBgColor(bgColor bool) OptionOsd

Set the OSD background color on or off

func SetOsdOptionsChannel 

func SetOsdOptionsChannel(channel int) OptionOsd

Set the OSD channel

func SetOsdOptionsChannelEnable 

func SetOsdOptionsChannelEnable(enable bool) OptionOsd

Set the OSD channel on or off

func SetOsdOptionsChannelName 

func SetOsdOptionsChannelName(name string) OptionOsd

Set the OSD channel name

func SetOsdOptionsChannelPos 

func SetOsdOptionsChannelPos(position enum.OsdPosition) OptionOsd

Set the OSD channel position

func SetOsdOptionsTimeEnable 

func SetOsdOptionsTimeEnable(enable bool) OptionOsd

Set the OSD time as on or off

func SetOsdOptionsTimePos 

func SetOsdOptionsTimePos(position enum.OsdPosition) OptionOsd

Set the OSD time position

type OptionPtzOperation 

type OptionPtzOperation func(*ptzOperationOptions)

func PtzOptionOpsIndex 

func PtzOptionOpsIndex(index *int) OptionPtzOperation

Set the Ptz Operation Index

func PtzOptionOpsSpeed 

func PtzOptionOpsSpeed(speed int) OptionPtzOperation

Set the Ptz Operation Speed

type OptionPtzPreset 

type OptionPtzPreset func(*ptzPresetOptions)

func PtzOptionPresetIndex 

func PtzOptionPresetIndex(index int) OptionPtzPreset

Set the Ptz Preset Index

func PtzOptionsPresetName 

func PtzOptionsPresetName(name string) OptionPtzPreset

Set the Ptz Preset Value

type OptionRecordingEncoding 

type OptionRecordingEncoding func(*encoding)

func RecordingEncodingOptionAudio 

func RecordingEncodingOptionAudio(audio bool) OptionRecordingEncoding

Set audio on or off Default: false

func RecordingEncodingOptionMainBitRate 

func RecordingEncodingOptionMainBitRate(bitRate enum.MainBitRate) OptionRecordingEncoding

Set the main bit rate Default: 8192

func RecordingEncodingOptionMainFrameRate 

func RecordingEncodingOptionMainFrameRate(frameRate enum.MainFrameRate) OptionRecordingEncoding

Set the main frame rate Default: 8

func RecordingEncodingOptionMainProfile 

func RecordingEncodingOptionMainProfile(profile enum.RecordingProfile) OptionRecordingEncoding

Set the main profile Default: High

func RecordingEncodingOptionMainSize 

func RecordingEncodingOptionMainSize(size enum.MainSize) OptionRecordingEncoding

Set the main size Default: 2560*1440

func RecordingEncodingOptionSubBitRate 

func RecordingEncodingOptionSubBitRate(bitRate enum.SubBitRate) OptionRecordingEncoding

Set the sub bit rate Default: 160

func RecordingEncodingOptionSubFrameRate 

func RecordingEncodingOptionSubFrameRate(frameRate enum.SubFrameRate) OptionRecordingEncoding

Set the sub frame rate Default: 7

func RecordingEncodingOptionSubProfile 

func RecordingEncodingOptionSubProfile(profile enum.RecordingProfile) OptionRecordingEncoding

Set the sub profile Default: High

func RecordingEncodingOptionSubSize 

func RecordingEncodingOptionSubSize(size enum.SubSize) OptionRecordingEncoding

Set the sub size Default: 640*480

type OptionZoomOperation 

type OptionZoomOperation func(*zoom)

func ZoomOptionSpeed 

func ZoomOptionSpeed(speed int) OptionZoomOperation

Set the zoom speed default: 60

type PtzMixin 

type PtzMixin struct{}

func (*PtzMixin) AddPreset 

func (pm *PtzMixin) AddPreset(ptzOptions ...OptionPtzPreset) func(handler *rest.RestHandler) (bool, error)

Create a new preset at the current camera position The preset index and name is optional and will fallback to defaults Defaults: index: 1 name: pos1

func (*PtzMixin) AutoMovement 

func (pm *PtzMixin) AutoMovement() func(handler *rest.RestHandler) (bool, error)

Move the camera in a clockwise rotation

func (*PtzMixin) GoToPreset 

func (pm *PtzMixin) GoToPreset(ptzOptions ...OptionPtzOperation) func(handler *rest.RestHandler) (
	bool, error)

Moves the camera to the specified preset The preset index and speed is optional and will fallback to defaults One can also force the preset to have no index by passing api.PtzOptionOpsIndex(nil) Defaults: index: 1 speed: 60

func (*PtzMixin) MoveDown 

func (pm *PtzMixin) MoveDown(ptzOptions ...OptionPtzOperation) func(handler *rest.RestHandler) (bool,
	error)

Move the camera to the down The operation speed is optional and will fallback to defaults. Other operations will be ignored. Defaults: speed: 25

func (*PtzMixin) MoveLeft 

func (pm *PtzMixin) MoveLeft(ptzOptions ...OptionPtzOperation) func(handler *rest.RestHandler) (bool,
	error)

Move the camera to the right Left The operation speed is optional and will fallback to defaults. Other operations will be ignored. Defaults: speed: 25

func (*PtzMixin) MoveLeftDown 

func (pm *PtzMixin) MoveLeftDown(ptzOptions ...OptionPtzOperation) func(handler *rest.RestHandler) (bool,
	error)

Move the camera to the left Down The operation speed is optional and will fallback to defaults. Other operations will be ignored. Defaults: speed: 25

func (*PtzMixin) MoveLeftUp 

func (pm *PtzMixin) MoveLeftUp(ptzOptions ...OptionPtzOperation) func(handler *rest.RestHandler) (bool,
	error)

Move the camera to the left Up The operation speed is optional and will fallback to defaults. Other operations will be ignored. Defaults: speed: 25

func (*PtzMixin) MoveRight 

func (pm *PtzMixin) MoveRight(ptzOptions ...OptionPtzOperation) func(handler *rest.RestHandler) (bool,
	error)

Move the camera to the right The operation speed is optional and will fallback to defaults. Other operations will be ignored. Defaults: speed: 25

func (*PtzMixin) MoveRightDown 

func (pm *PtzMixin) MoveRightDown(ptzOptions ...OptionPtzOperation) func(handler *rest.RestHandler) (bool,
	error)

Move the camera to the right Down The operation speed is optional and will fallback to defaults. Other operations will be ignored. Defaults: speed: 25

func (*PtzMixin) MoveRightUp 

func (pm *PtzMixin) MoveRightUp(ptzOptions ...OptionPtzOperation) func(handler *rest.RestHandler) (bool,
	error)

Move the camera to the right Up The operation speed is optional and will fallback to defaults. Other operations will be ignored. Defaults: speed: 25

func (*PtzMixin) MoveUp 

func (pm *PtzMixin) MoveUp(ptzOptions ...OptionPtzOperation) func(handler *rest.RestHandler) (bool,
	error)

Move the camera to the up The operation speed is optional and will fallback to defaults. Other operations will be ignored. Defaults: speed: 25

func (*PtzMixin) RemovePreset 

func (pm *PtzMixin) RemovePreset(ptzOptions ...OptionPtzPreset) func(handler *rest.RestHandler) (bool, error)

Remove the specified preset The preset index and name is optional and will fallback to defaults Defaults: index: 1 name: pos1

func (*PtzMixin) StopPtz 

func (pm *PtzMixin) StopPtz() func(handler *rest.RestHandler) (bool,
	error)

Stops the cameras current action

type RecordingMixin 

type RecordingMixin struct{}

func (*RecordingMixin) GetRecordingAdvanced 

func (rm *RecordingMixin) GetRecordingAdvanced() func(handler *rest.RestHandler) (*models.Recording, error)

Get the recoding advanced setup data See examples/response/GetRec.json for example response data

func (*RecordingMixin) GetRecordingEncoding 

func (rm *RecordingMixin) GetRecordingEncoding() func(handler *rest.RestHandler) (*models.Encoding, error)

Get the camera's current encoding settings for "Clear" and "Fluent" profiles See examples/response/GetEnc.json for example response data

func (*RecordingMixin) SetRecordingEncoding 

func (rm *RecordingMixin) SetRecordingEncoding(encodingOptions ...OptionRecordingEncoding) func(handler *rest.RestHandler) (bool, error)

Set the current camera encoding settings for "Clear" and "Fluent" profiles Accepts optional parameters of OptionRecordingEncoding type Defaults: Audio: false MainBitRate: 8192 MainFrameRate: 8 MainProfile: "High" MainSize: "2560*1440" SubBitRate: 160 SubFrameRate: 7 SubProfile: "High" SubSize: "640*480"

type RtspMixin 

type RtspMixin struct {
	Host     string
	Username string
	Password string
}

func (*RtspMixin) OpenRtspStream added in v0.0.2 

func (rm *RtspMixin) OpenRtspStream(profile enum.RtspProfile, rtspOpts ...rtsp.OptionRtspClient) *rtsp.RtspClient

type RtspStream 

type RtspStream struct {
	Frame []av.CodecData
	Err   error
}

type SystemMixin 

type SystemMixin struct{}

func (*SystemMixin) GetDeviceInformation 

func (sm *SystemMixin) GetDeviceInformation() func(handler *rest.RestHandler) (*models.DeviceInformation, error)

Get the camera device information See examples/responses/GetDevInfo.json for example response data

func (*SystemMixin) GetDstInformation 

func (sm *SystemMixin) GetDstInformation() func(handler *rest.RestHandler) (*models.DstInformation,
	*models.TimeInformation, error)

Get the camera DST information See examples/response/GetDSTInfo.json for example response data

func (*SystemMixin) GetGeneralSystem 

func (sm *SystemMixin) GetGeneralSystem() func(handler *rest.RestHandler) (*models.DeviceGeneralInformation, error)

Get the general system information

func (*SystemMixin) GetPerformance 

func (sm *SystemMixin) GetPerformance() func(handler *rest.RestHandler) (*models.DevicePerformanceInformation, error)

Get the camera performance information See examples/responses/GetPerformance.json for example response data

func (*SystemMixin) RebootCamera 

func (sm *SystemMixin) RebootCamera() func(handler *rest.RestHandler) (bool, error)

Reboot the camera

type UserMixin 

type UserMixin struct{}

func (*UserMixin) AddUser 

func (um *UserMixin) AddUser(
	username string,
	password string,
	level enum.UserLevel) func(handler *rest.RestHandler) (bool, error)

Add a User to the camera

func (*UserMixin) DeleteUser 

func (um *UserMixin) DeleteUser(username string) func(handler *rest.RestHandler) (bool, error)

Delete the User account

func (*UserMixin) GetOnlineUsers 

func (um *UserMixin) GetOnlineUsers() func(handler *rest.RestHandler) ([]*models.User, error)

Retrieves a slice of Online Users

func (*UserMixin) GetUsers 

func (um *UserMixin) GetUsers() func(handler *rest.RestHandler) ([]*models.User, error)

Retrieves a slice of Users

func (*UserMixin) UpdateUserPassword 

func (um *UserMixin) UpdateUserPassword(username string, password string) func(handler *rest.RestHandler) (bool,
	error)

Update the User's password

type ZoomFocusMixin 

type ZoomFocusMixin struct{}

func (*ZoomFocusMixin) StartFocusingIn 

func (zfm *ZoomFocusMixin) StartFocusingIn(focusOptions ...OptionFocusOperation) func(handler *rest.RestHandler) (
	bool, error)

Focus in with the camera with optional parameters. Defaults: speed: 32

func (*ZoomFocusMixin) StartFocusingOut 

func (zfm *ZoomFocusMixin) StartFocusingOut(focusOptions ...OptionFocusOperation) func(handler *rest.RestHandler) (
	bool, error)

Focus out with the camera with optional parameters. Defaults: speed: 32

func (*ZoomFocusMixin) StartZoomingIn 

func (zfm *ZoomFocusMixin) StartZoomingIn(zoomOptions ...OptionZoomOperation) func(handler *rest.RestHandler) (bool,
	error)

Zoom in with the camera with optional parameters. Defaults: speed: 60

func (*ZoomFocusMixin) StartZoomingOut 

func (zfm *ZoomFocusMixin) StartZoomingOut(zoomOptions ...OptionZoomOperation) func(handler *rest.RestHandler) (bool,
	error)

Zoom out with the camera with optional parameters. Default: speed: 60

func (*ZoomFocusMixin) StopFocusing 

func (zfm *ZoomFocusMixin) StopFocusing() func(handler *rest.RestHandler) (bool, error)

func (*ZoomFocusMixin) StopZooming 

func (zfm *ZoomFocusMixin) StopZooming() func(handler *rest.RestHandler) (bool, error)

Stop zooming

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.