sdk

type Appliance interface {
	// GetUUID return the unique identifier of the remote appliance.
	// The UUID is Usually known after the discovery.
	// TODO(jfs): determine the UUID for devices that do not requires discovery
	GetUUID() string

	GetDeviceEndpoint() string

	GetEndpoint(name string) string

	GetServices() map[string]string

	FetchStreamURI(ctx context.Context) string

	FetchDeviceDescriptor(ctx context.Context) DeviceDescriptor

	// FetchDeviceNetwork fetches from the Appliance the network configuration from the Device
	FetchDeviceNetwork(ctx context.Context) DeviceNetwork

	// FetchDeviceNetwork fetches from the Appliance the security configuration from the Device
	FetchDeviceSecurity(ctx context.Context) DeviceSecurity

	// FetchDeviceNetwork fetches from the Appliance the core system configuration from the Device
	FetchDeviceSystem(ctx context.Context) DeviceSystem

	// FetchMedia fetches from the Appliance a fully-hydrated Media structure
	FetchMedia(ctx context.Context) Media

	// FetchPTZ fetches from the Appliance a fully-hydrated Ptz structure
	FetchPTZ(ctx context.Context) Ptz

	// FetchEvent fetches from the Appliance a fully-hydrated Event structure
	FetchEvent(ctx context.Context) Event

	// FetchMediaProfiles fetches from the Appliance only the Profile related information,
	// otherwise part from the Media information
	FetchProfiles(ctx context.Context) Profiles
}

type Audio struct {
	Sources  []AudioSource
	Encoders []AudioEncoderConfiguration
	Outputs  map[onvif.ReferenceToken]*AudioOutput
}

type AudioEncoderConfiguration struct {
	Configuration onvif.AudioEncoderConfiguration
	Options       onvif.AudioEncoderConfigurationOptions
}

type AudioOutput struct {
	Output         onvif.AudioOutput
	Configurations []onvif.AudioOutputConfiguration
}

type AudioSource struct {
	Source         onvif.AudioSource
	Configurations []onvif.AudioSourceConfiguration
}

type CertificateX struct {
	Certificate    onvif.Certificate
	Pkcs10Response onvif.BinaryData
	Information    onvif.CertificateInformation
}

type DeviceDescriptor struct {
	Capabilities        *onvif.Capabilities
	ServiceCapabilities *device.DeviceServiceCapabilities
	Information         *device.GetDeviceInformationResponse
	Service             []device.Service
	SystemDateAndTime   *onvif.SystemDateTime
	Scopes              []onvif.Scope
	EndpointReference   string
	WsdlUrl             string
}

type DeviceNetwork struct {
	DPAddress          []onvif.NetworkHost
	NetworkProtocols   []onvif.NetworkProtocol
	RelayOutputs       []onvif.RelayOutput
	NICs               map[onvif.ReferenceToken]*NetworkInterfaceX
	Dot1XConfiguration map[onvif.ReferenceToken]*onvif.Dot1XConfiguration
	NTP                *onvif.NTPInformation
	DNS                *onvif.DNSInformation
	DynDNS             *onvif.DynamicDNSInformation
	NetworkGateway     *onvif.NetworkGateway
	ZeroConfiguration  *onvif.NetworkZeroConfiguration
	IPAddressFilter    *onvif.IPAddressFilter
}

type DeviceSecurity struct {
	RemoteUser            *onvif.RemoteUser
	Users                 []onvif.User
	AccessPolicy          *onvif.BinaryData
	ClientCertificateMode bool
	NvtCertificate        []CertificateX
	CACertificate         []CertificateX
	CertificateStatus     []onvif.CertificateStatus
}

type DeviceSystem struct {
	SystemLog             *string
	AccessLog             *string
	SupportInformation    string
	DiscoveryMode         string
	RemoteDiscoveryMode   string
	Location              *onvif.LocationEntity
	Hostname              *onvif.HostnameInformation
	SystemUris            *device.GetSystemUrisResponse
	StorageConfigurations []device.StorageConfiguration
}

type Event struct {
	Capabilities event.Capabilities
	Properties   event.GetEventPropertiesResponse
}

type Media struct {
	Video        Video
	Audio        Audio
	Capabilities media.Capabilities
}

type NetworkInterfaceX struct {
	NetworkInterface   onvif.NetworkInterface
	Dot1XConfiguration onvif.Dot1XConfiguration
	Status             onvif.Dot11Status
}

type ProfileMedia struct {
	CompatibleMetadata []onvif.ReferenceToken

	CompatibleVideoSources   []onvif.ReferenceToken
	CompatibleVideoEncoders  []onvif.ReferenceToken
	CompatibleVideoAnalytics []onvif.ReferenceToken

	CompatibleAudioSources  []onvif.ReferenceToken
	CompatibleAudioEncoders []onvif.ReferenceToken

	CompatibleAudioOutputs  []onvif.ReferenceToken
	CompatibleAudioDecoders []onvif.ReferenceToken
}

type ProfilePTZ struct {
	Status        onvif.PTZStatus
	Configuration onvif.PTZConfiguration
	Options       onvif.PTZConfigurationOptions
	Preset        []onvif.PTZPreset
	PresetTour    []onvif.PresetTour
}

type ProfileUris struct {
	Stream   onvif.MediaUri
	Snapshot onvif.MediaUri
}

type Profiles struct {
	Profiles map[onvif.ReferenceToken]*XProfile
}

type Ptz struct {
	Capabilities  ptz.Capabilities
	Nodes         []onvif.PTZNode
	Configuration []onvif.PTZConfiguration
}

type Video struct {
	Sources                 []VideoSource
	Encoders                []VideoEncoderConfiguration
	AnalyticsConfigurations []onvif.VideoAnalyticsConfiguration
}

type VideoEncoderConfiguration struct {
	Configuration onvif.VideoEncoderConfiguration
	Options       onvif.VideoEncoderConfigurationOptions
}

type VideoSource struct {
	Source         onvif.VideoSource
	Configurations []onvif.VideoSourceConfiguration
}

type XProfile struct {
	Profile onvif.Profile
	Uris    ProfileUris
	Media   ProfileMedia
	PTZ     ProfilePTZ
}