DigitalSecurityCameraMotionImage:1 Service Template Version 1.01

Transcription

1 DigitalSecurityCameraMotionImage:1 DigitalSecurityCameraMotionImage:1 Service Template Version 1.01 For UPnP Version 1.0 Status: Standardized DCP Date: March 24, 2005 This Standardized DCP has been adopted as a Standardized DCP by the Steering Committee of the UPnP Forum, pursuant to Section 2.1(c)(ii) of the UPnP Forum Membership Agreement. UPnP Forum Members have rights and licenses defined by Section 3 of the UPnP Forum Membership Agreement to use and reproduce the Standardized DCP in UPnP Compliant Devices. All such use is subject to all of the provisions of the UPnP Forum Membership Agreement. THE UPNP FOUM TAKES NO POSITION AS TO WHETHE ANY INTELLECTUAL POPETY IGHTS EXIST IN THE STANDADIZED DCPS. THE STANDADIZED DCPS AE POVIDED "AS IS" AND "WITH ALL FAULTS". THE UPNP FOUM MAKES NO WAANTIES, EXPESS, IMPLIED, STATUTOY, O OTHEWISE WITH ESPECT TO THE STANDADIZED DCPS, INCLUDING BUT NOT LIMITED TO ALL IMPLIED WAANTIES OF MECHANTABILITY, NON-INFINGEMENT AND FITNESS FO A PATICULA PUPOSE, OF EASONABLE CAE O WOKMANLIKE EFFOT, O ESULTS O OF LACK OF NEGLIGENCE. Authors Joacim Tullberg Ted Hartzell Göran Haraldsson Company Axis Communications AB Axis Communications AB Axis Communications AB

2 Digital Security Camera Motion Image Service 2 Contents 1. OVEVIEW AND SCOPE SEVICE MODELING DEFINITIONS SEVICETYPE STATE VAIABLES AvailableEncodings DefaultEncoding AvailableCompressionLevels DefaultCompressionLevel Availableesolutions Defaultesolutions VideoUL VideoPresentationUL MaxBandwidth TargetFrameate EVENTING AND MODEATION ACTIONS GetAvailableEncodings SetDefaultEncoding GetDefaultEncoding GetAvailableCompressionLevels SetDefaultCompressionLevel GetDefaultCompressionLevel GetAvailableesolutions SetDefaultesolution GetDefaultesolution GetVideoUL GetDefaultVideoUL GetVideoPresentationUL GetDefaultVideoPresentationUL SetMaxBandwidth GetMaxBandwidth SetTargetFrameate GetTargetFrameate Non-Standard Actions Implemented by a UPnP Vendor Common Error Codes THEOY OF OPEATION XML SEVICE DESCIPTION TEST...23 List of Tables Table 1: State Variables...5 Table 2: Event Moderation...7 Table 3: Actions...8 Table 4: Arguments for GetAvailableEncodings...8

3 Digital Security Camera Motion Image Service 3 Table 5: Arguments for SetDefaultEncoding...9 Table 6: Arguments for GetDefaultEncoding...9 Table 7: Arguments for GetAvailableCompressionLevels...9 Table 8: Arguments for SetDefaultCompressionLevel...10 Table 9: Arguments for GetDefaultCompressionLevel...10 Table 10: Arguments for GetAvailableesolutions...10 Table 11: Arguments for SetDefaultesolution...11 Table 12: Arguments for GetDefaultesolution...11 Table 13: Arguments for GetVideoUL...12 Table 13: Arguments for GetDefaultVideoUL...12 Table 14: Arguments for GetVideoPresentationUL...13 Table 15: Arguments for GetDefaultVideoPresentationUL...14 Table 16: Arguments for SetMaxBandwidth...14 Table 17: Arguments for GetMaxBandwidth...14 Table 18: Arguments for SetTargetFrameate...15 Table 19: Arguments for GetTargetFrameate...15 Table 20: Common Error Codes...16

4 Digital Security Camera Motion Image Service 4 1. Overview and Scope This service definition is compliant with the UPnP Device Architecture version 1.0. The service enables delivery and control of live snapshot images from a digital security camera.

5 Digital Security Camera Motion Image Service 5 2. Service Modeling Definitions 2.1. ServiceType A service that is compliant with this template is identified with the following service type: urn:schemasupnp-org:service: DigitalSecurityCameraMotionImage: State Variables Table 1: State Variables Variable Name eq. or Opt. 1 Data Type Allowed Value Default Value Eng. Units AvailableEncodings string DefaultEncoding string AvailableCompressionLevels string DeafultCompressionLevel string Availableesolutions string Defaultesolutions string VideoUL string VideoPresentationUL string MaxBandwidth ui4 0.. (Maximum) TargetFrameate ui4 0.. (Maximum) Non-standard state variables implemented by an UPnP vendor go here. 1 = equired, O = Optional, X = Non-standard. X TBD TBD TBD TBD AvailableEncodings The value of this string should be a list of all by the vendor specific service supported MIME-type still image types. The types in the list should be separated by a,. Example: image/jpeg, image/gif, image/bmp This is a read only property DefaultEncoding The value of this string must be a MIME-type still image type. Any MIME still image type listed in AvailableEncodings may be used as an allowed value AvailableCompressionLevels Compression level describes how much an image should be compressed. Since a wide variety of compression methods and algorithms are available compression levels become subjective values that are

6 Digital Security Camera Motion Image Service 6 hard to quantify. The value of this string should be a list of all supported compression levels separated by a,. The list order should be the lowest compression level first. Example1: 0, 1, 2, 3, 4, 5 Example2: Lowest, Highest This is a read only property DefaultCompressionLevel The value of this string must be one of the supported compression levels specified in AvailableCompressionLevels. AvailableEncodings may be used as an allowed value Availableesolutions esolution is the actual number of horizontal and vertical pixels an image contains. It does not tell anything of the image quality apart from the size in pixels. There must be at least one resolution available. Presented in ascending order based on first the value of X multiplied by Y and as second order the value of X. Always formatted as "XxY". Where X is the horizontal number of pixels and Y the vertical number of pixels. Example: 320x240, 640x480 This is a read only property. esolution is always based on otation = 0. (See: Security Camera Settings Service for more information) Defaultesolutions The value of this string must be one of the supported resolutions specified in Availableesolutions VideoUL The VideoUL is the UL for the video stream itself. This is a read only property VideoPresentationUL This is the UL for an html presentation page of the current video stream. The typical implementation would be an html page that includes the VideoUL. This field must exist but may contain the empty string MaxBandwidth This is the maximum bandwidth allowed for this service to use for each video connection. Unit used is Kbit/s. If set to 0 this service would be disabled. MaxBandwidth has priority over TargetFrameate frame rate.

7 Digital Security Camera Motion Image Service TargetFrameate Frame rate in frames/minute. Target frame rate should never be exceeded by the device. If an attempt to set outside scope of device the nearest supported legal value will be set Eventing and Moderation Table 2: Event Moderation Variable Name AvailableEncod ings DefaultEncodin g AvailableComp ressionlevels DeafultCompre ssion Level Evented Moderated Event Max Event ate 1 Logical Combination No No N/A N/A Yes No N/A N/A No No N/A N/A Yes No N/A N/A Availableesol No No N/A N/A utions Defaultesoluti Yes No N/A N/A on VideoUL No No N/A N/A VideoPresentati No No N/A N/A onul MaxBandwidth Yes Yes 1 N/A TargetFrame ate Non-standard state variables implemented by an UPnP vendor go here. Yes Yes 1 N/A TBD TBD TBD TBD TBD 1 Determined by N, where ate = (Event)/(N secs). 2 (N) * (allowedvalueange Step). Min Delta per Event 2

8 Digital Security Camera Motion Image Service Actions Immediately following this table is detailed information about these actions, including short descriptions of the actions, the effects of the actions on state variables, and error codes defined by the actions. Table 3: Actions Name eq. or Opt. 1 GetAvailableEncodings SetDefaultEncoding GetDefaultEncoding GetAvailableCompressionLevels SetDefaultCompressionLevel GetDefaultCompressionLevel GetAvailableesolutions SetDefaultesolution GetDefaultesolution GetVideoUL GetDefaultVideoUL GetVideoPresentationUL GetDefaultVideoPresentationUL SetMaxBandwidth GetMaxBandwidth SetTargetFrameate GetTargetFrameate Non-standard actions implemented by an UPnP vendor go here. X 1 = equired, O = Optional, X = Non-standard GetAvailableEncodings Get the list of supported MIME-type still image types Arguments Table 4: Arguments for GetAvailableEncodings etavailableencodings OUT AvailableEncodings

9 Digital Security Camera Motion Image Service SetDefaultEncoding Set the DefaultEncoding Arguments Table 5: Arguments for SetDefaultEncoding eqencoding IN DefaultEncoding Effect on State Changes the value of DefaultEncoding to eqencoding Errors errorcode errordescription Description 700 eqencoding not supported eqencoding is not one of the supported encodings specified in AvailableEncodings GetDefaultEncoding Get the DefaultEncoding Arguments Table 6: Arguments for GetDefaultEncoding etencoding OUT DefaultEncoding GetAvailableCompressionLevels Get the list of supported compression levels Arguments Table 7: Arguments for GetAvailableCompressionLevels etavailablecompressionlevels OUT AvailableCompressionLe vels

10 Digital Security Camera Motion Image Service SetDefaultCompressionLevel Set the DefaultCompressionLevel Arguments Table 8: Arguments for SetDefaultCompressionLevel eqcompressionlevel IN DefaultCompressionLeve l Effect on State Changes the value of DefaultCompressionLevel to eqcompressionlevel Errors errorcode errordescription Description 701 eqcompressionle vel not supported eqcompressionlevel is not one of the supported compression levels specified in AvailableCompressionLevels GetDefaultCompressionLevel Get the DefaultCompressionLevel Arguments Table 9: Arguments for GetDefaultCompressionLevel etcompressionlevel OUT DefaultCompressionLeve l GetAvailableesolutions Get the list of supported resolutions Arguments Table 10: Arguments for GetAvailableesolutions etavailableesolutions OUT Availableesolutions

11 Digital Security Camera Motion Image Service SetDefaultesolution Set the Defaultesolution Arguments Table 11: Arguments for SetDefaultesolution eqesolution IN Defaultesolution Effect on State Changes the value of Defaultesolution to eqesolution Errors errorcode errordescription Description 702 eqesolution not supported eqesolution is not one of the supported resolutions specified in Availableesolutions GetDefaultesolution Get the Defaultesolution Arguments Table 12: Arguments for GetDefaultesolution etesolution OUT Defaultesolution GetVideoUL Get a UL to the video stream itself. The etvideoul is being built depending on how the different parameters has been set. eqencoding should be one of the supported encodings. eqcompression should be one of the supported compressions. eqesolution should be one of the supported resolutions. eqmaxbandwidth should be the maximum bandwidth allowed. eqtargetframeate should be the maximum frame rate in frames/minute.

12 Digital Security Camera Motion Image Service Arguments Table 13: Arguments for GetVideoUL eqencoding IN DefaultEncoding eqcompression IN DefaultCompression eqesolution IN Defaultesolution eqmaxbandwidth IN MaxBandwidth eqtargetframeate IN TargetFrameate etvideoul OUT VideoUL Errors errorcode errordescription Description 700 eqencoding not supported 701 eqcompressionle vel not supported 702 eqesolution not supported eqencoding is not one of the supported encodings specified in AvailableEncodings. eqcompressionlevel is not one of the supported compression levels specified in AvailableCompressionLevels. eqesolution is not one of the supported resolutions specified in Availableesolutions GetDefaultVideoUL Get a UL to the video stream itself. The etvideoul is being built depending on how the different default parameters DefaultEncoding, DefaultCompressionLevel and Defaultesolution has been set Arguments Table 13: Arguments for GetDefaultVideoUL etvideoul OUT VideoUL

13 Digital Security Camera Motion Image Service GetVideoPresentationUL Get a UL to an html presentation page of the current video stream. The eqvideopresentationul is being built depending on how the different parameters has been set. eqencoding should be one of the supported encodings. eqcompression should be one of the supported compressions. eqesolution should be one of the supported resolutions. eqmaxbandwidth should be the maximum bandwidth allowed. eqtargetframeate should be the maximum frame rate in frames/minute Arguments Table 14: Arguments for GetVideoPresentationUL eqencoding IN DefaultEncoding eqcompression IN DefaultCompression eqesolution IN Defaultesolution eqmaxbandwidth IN MaxBandwidth eqtargetframeate IN TargetFrameate etvideopresentationul OUT VideoPresentationUL Errors errorcode errordescription Description 700 eqencoding not supported 701 eqcompressionle vel not supported 702 eqesolution not supported eqencoding is not one of the supported encodings specified in AvailableEncodings. eqcompressionlevel is not one of the supported compression levels specified in AvailableCompressionLevels. eqesolution is not one of the supported resolutions specified in Availableesolutions.

14 Digital Security Camera Motion Image Service GetDefaultVideoPresentationUL Get a UL to an html presentation page of the current video stream. The etvideopresentationul is being built depending on how the different default parameters DefaultEncoding, DefaultCompressionLevel and Defaultesolution has been set Arguments Table 15: Arguments for GetDefaultVideoPresentationUL etvideopresentationul OUT VideoPresentationUL SetMaxBandwidth Change Maximum bandwidth allowed for each connection to this Motion Image service. The response to an attempt to set an unsupported but legal value shall result in the nearest supported legal value Arguments Table 16: Arguments for SetMaxBandwidth eqmaxbandwidth IN MaxBandwidth Effect on State Changes the value of MaxBandwidth to eqmaxbandwidth GetMaxBandwidth Get the Maximum bandwidth allowed for each connection to this Motion Image service Arguments Table 17: Arguments for GetMaxBandwidth etmaxbandwidth OUT MaxBandwidth

15 Digital Security Camera Motion Image Service SetTargetFrameate Change Target Frame rate. The response to an attempt to set an unsupported but legal value shall result in the nearest supported legal value Arguments Table 18: Arguments for SetTargetFrameate eqtargetframeate IN TargetFrameate Effect on State Changes the value of TargetFrameate to eqtargetframeate GetTargetFrameate Get the Target Frame ate allowed for each connection to this Motion Image service Arguments Table 19: Arguments for GetTargetFrameate eqtargetframeate OUT TargetFrameate Non-Standard Actions Implemented by a UPnP Vendor To facilitate certification, non-standard actions implemented by UPnP vendors should be included in this service template. The UPnP Device Architecture lists naming requirements for non-standard actions (see the section on Description).

16 Digital Security Camera Motion Image Service Common Error Codes The following table lists error codes common to actions for this service type. If an action results in multiple errors, the most specific error should be returned. Table 20: Common Error Codes errorcode errordescription Description 401 Invalid Action See UPnP Device Architecture section on Control. 402 Invalid Args See UPnP Device Architecture section on Control. 404 Invalid Var See UPnP Device Architecture section on Control. 501 Action Failed See UPnP Device Architecture section on Control TBD Common action errors. Defined by UPnP Forum Technical Committee. 700 eqencoding not supported 701 eqcompressionle vel not supported 702 eqesolution not supported TBD (Specified by UPnP vendor.) eqencoding is not one of the supported encodings specified in AvailableEncodings. eqcompressionlevel is not one of the supported compression levels specified in AvailableCompressionLevels. eqesolution is not one of the supported resolutions specified in Availableesolutions Theory of Operation An instance of Digital Security Camera Motion Image Service may be embedded into a Digital Security Camera Device or other devices requiring this service. This service will enable access to live motion images (video) by providing the retrieval address of the desired video stream. The retrieval address will be in the form of a complete UL. Method of video data transfer is in no way restricted by this specification, implementers are free to use any available transport protocols that can be described in the form of a UL. The operation of this service is stateless. The action of fetching a VideoUL or VideoPresentationUL does not affect the properties of previous, simultaneous or later fetched video streams and VideoPresentation ULs. This allows for multiple User Control Points to receive images with different properties without potential interference. The properties Availableesolutions, AvailableCompressionLevels and AvailableEncodings are vendor specific descriptions of the complete set of available options of the matching property. The VideoUL property is the UL where the video stream itself can be fetched. The VideoPresentationUL is a container document needed for display of the video by a user control point. This does for instance allow for display of video that require special viewers such as ActiveX components or Java applets.

17 Digital Security Camera Motion Image Service XML Service Description <?xml version="1.0"?> <scpd xmlns="urn:schemas-upnp-org:service-1-0"> <specversion> <major>1</major> <minor>0</minor> </specversion> <actionlist> <name>getavailableencodings</name> <name>etavailableencodings</name> <relatedstatevariable>availableencodings <name>getdefaultencoding</name> <name>etencoding</name> <relatedstatevariable>defaultencoding </ argument> <name>setdefaultencoding</name> <name>eqencoding</name> <relatedstatevariable>defaultencoding <name>getavailablecompressionlevels</name> <name>etavailablecompressionlevels</name> <relatedstatevariable>availablecompressionlevels <name>getdefaultcompressionlevel</name>

18 Digital Security Camera Motion Image Service 18 <name>etcompressionlevel</name> <relatedstatevariable>defaultcompressionlevel <name>setdefaultcompressionlevel</name> <name>eqcompressionlevel</name> <relatedstatevariable>defaultcompressionlevel <name>getavailableesolutions</name> <name>etavailableesolutions</name> <relatedstatevariable>availableesolutions <name>getdefaultesolution</name> <name>etesolution</name> <relatedstatevariable>defaultesolution <name>setdefaultesolution</name> <name>eqesolution</name> <relatedstatevariable>defaultesolution <name>getvideoul</name> <name>eqencoding</name>

19 Digital Security Camera Motion Image Service 19 <relatedstatevariable>defaultencoding <name>eqcompression</name> <relatedstatevariable>defaultcompressionlevel <name>eqesolution</name> <relatedstatevariable>defaultesolution <name>eqmaxbandwidth</name> <relatedstatevariable>maxbandwidth <name>eqtargetframeate</name> <relatedstatevariable>targetframeate <name>etvideoul</name> <relatedstatevariable>videoul <name>getdefaultvideoul</name> <name>etvideoul</name> <relatedstatevariable>videoul <name>getvideopresentationul</name> <name>eqencoding</name> <relatedstatevariable>defaultencoding <name>eqcompression</name> <relatedstatevariable>defaultcompressionlevel

20 Digital Security Camera Motion Image Service 20 <name>eqesolution</name> <relatedstatevariable>defaultesolution </ relatedstatevariable> <name>eqmaxbandwidth</name> <relatedstatevariable>maxbandwidth <name>eqtargetframeate</name> <relatedstatevariable>targetframeate <name>etvideopresentationul</name> <relatedstatevariable>videopresentationul <name>getdefaultvideopresentationul</name> <name>etvideopresentationul</name> <relatedstatevariable>videopresentationul <name>setmaxbandwidth</name> <name>eqmaxbandwidth</name> <relatedstatevariable>maxbandwidth <name>getmaxbandwidth</name> <name>etmaxbandwidth</name> <relatedstatevariable>maxbandwidth

21 Digital Security Camera Motion Image Service 21 <name>settargetframeate</name> <name>eqtargetframeate</name> <relatedstatevariable>targetframeate <name>gettargetframeate</name> < name>ettargetframeate</name> <relatedstatevariable>targetframeate </actionlist> <servicestatetable> <statevariable sendevents="no"> <name>availableencodings</name> <datatype>string</datatype> </statevariable> <statevariable sendevents="yes"> <name>defaultencoding</name> <datatype>string</datatype> </statevariable> <statevariable sendevents="no"> <name>availablecompressionlevels</name> <datatype>string</datatype> </statevariable> <statevariable sendevents="yes"> <name>defaultcompressionlevel</name> <datatype>string</datatype> </statevariable> <statevariable sendevents="no"> <name>availableesolutions</name> <datatype>string</datatype> </statevariable> <statevariable sendevents="yes"> <name>defaultesolution</name> <datatype>string</datatype> </statevariable> <statevariable sendevents="no"> <name>videoul</name> <datatype>string</datatype> </statevariable> <statevariable sendevents="no">

22 Digital Security Camera Motion Image Service 22 <name>videopresentationul</name> <datatype>string</datatype> </statevariable> <statevariable sendevents="yes"> <name>maxbandwidth</name> <datatype>ui4</datatype> <defaultvalue>maximum</defaultvalue> <allowedvalueange> <minimum>0</minimum> <maximum>maximum</maximum> </allowedvalueange> </statevariable> <statevariable sendevents="yes"> <name>targetframeate</name> <datatype>ui4</datatype> <defaultvalue>maximum</defaultvalue> <allowedvalueange> <minimum>0</minimum> < maximum>maximum</maximum> </allowedvalueange> </statevariable> </servicestatetable> </scpd>

23 Digital Security Camera Motion Image Service Test Testing of the UPnP functions Addressing, Discovery, Description, Control (Syntax) and Eventing are performed by the UPnP Test Tool v1.1 based on the following documents: UPnP Device Architecture v1.0 The Service Definitions in chapter 2 of this document The XML Service Description in chapter 3 of this document The UPnP Test Tool service template test file: DigitalSecurityCameraMotionImage1.xml The UPnP Test Tool service template test file: DigitalSecurityCameraMotionImage1.SyntaxTests.xml The test suite does not include tests for Control Semantics, since it is felt that such tests would not provide a higher level of interoperability.