\hypertarget{namespace_skm_xml_api}{}\doxysection{Skm\+Xml\+Api Namespace Reference}
\label{namespace_skm_xml_api}\index{SkmXmlApi@{SkmXmlApi}}


Web A\+PI to Video\+N\+E\+XT product.  


\doxysubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_a_p_i_command}{A\+P\+I\+Command}}
\begin{DoxyCompactList}\small\item\em The abstract class for all Skm Api commands. All command objects should derive from this class \end{DoxyCompactList}\item 
interface {\bfseries Api\+Response}
\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_authorization_command}{Authorization\+Command}}
\begin{DoxyCompactList}\small\item\em Communicates with the Skm Api to get Urls for thumbnails and Rtsp streams \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_camera}{Camera}}
\begin{DoxyCompactList}\small\item\em Skm \mbox{\hyperlink{class_skm_xml_api_1_1_camera}{Camera}} represents an Skm camera object \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_credential_command}{Credential\+Command}}
\begin{DoxyCompactList}\small\item\em Retrieves available resources via the Skm\textquotesingle{}s Credential Manager Api. Resources include cameras, audio devices, slave nodes, etc. Each resource includes user permissions and permission roles that are associated. \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_download_progress_event_args}{Download\+Progress\+Event\+Args}}
\begin{DoxyCompactList}\small\item\em Media clip download progress event arguments. \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_download_task}{Download\+Task}}
\begin{DoxyCompactList}\small\item\em Media clip download task descriptor. \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_event}{Event}}
\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_event_log}{Event\+Log}}
\item 
class {\bfseries Get\+Object\+List\+Response}
\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_identity_attributes}{Identity\+Attributes}}
\begin{DoxyCompactList}\small\item\em Available global settings. \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_identity_attributes_command}{Identity\+Attributes\+Command}}
\begin{DoxyCompactList}\small\item\em A command for retrieving global settings. \end{DoxyCompactList}\item 
class {\bfseries Media\+Clip\+Command}
\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_object_attributes}{Object\+Attributes}}
\begin{DoxyCompactList}\small\item\em Available attributes of an object. \end{DoxyCompactList}\item 
class {\bfseries Object\+List\+Item}
\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_pan_tilt_zoom_controller}{Pan\+Tilt\+Zoom\+Controller}}
\begin{DoxyCompactList}\small\item\em Controls the Pan/\+Tilt/\+Zoom functions of a P\+TZ enabled camera \end{DoxyCompactList}\item 
class {\bfseries Resources}
\begin{DoxyCompactList}\small\item\em A strongly-\/typed resource class, for looking up localized strings, etc. \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_skm_api_exception}{Skm\+Api\+Exception}}
\begin{DoxyCompactList}\small\item\em General Skm exception \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_skm_authentication_exception}{Skm\+Authentication\+Exception}}
\begin{DoxyCompactList}\small\item\em Exception occurs when authentication fails with the Skm server \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_skm_base}{Skm\+Base}}
\begin{DoxyCompactList}\small\item\em The base object for all Skm commands that use the Skm session \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_skm_object}{Skm\+Object}}
\begin{DoxyCompactList}\small\item\em An Skm resource object base class, such as a \mbox{\hyperlink{class_skm_xml_api_1_1_camera}{Camera}} or Audio or Ptz. All Skm resouce objects should inherit from this abstract class \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_skm_object_list}{Skm\+Object\+List}}
\begin{DoxyCompactList}\small\item\em Generic collection to hold any \mbox{\hyperlink{class_skm_xml_api_1_1_skm_object}{Skm\+Object}} and subclasses of \mbox{\hyperlink{class_skm_xml_api_1_1_skm_object}{Skm\+Object}} \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_skm_permission_list}{Skm\+Permission\+List}}
\begin{DoxyCompactList}\small\item\em Collection of permissions associated to an \mbox{\hyperlink{class_skm_xml_api_1_1_skm_object}{Skm\+Object}} \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_skm_session}{Skm\+Session}}
\begin{DoxyCompactList}\small\item\em The \mbox{\hyperlink{class_skm_xml_api_1_1_skm_session}{Skm\+Session}} provides authentication keeps reference to the session on the Skm server. \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_skm_user}{Skm\+User}}
\begin{DoxyCompactList}\small\item\em \mbox{\hyperlink{class_skm_xml_api_1_1_skm_user}{Skm\+User}} object provides information for a Skm user \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_version_information_command}{Version\+Information\+Command}}
\begin{DoxyCompactList}\small\item\em Gets version information associated to the Skm server \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_skm_xml_api_1_1_who_am_i_command}{Who\+Am\+I\+Command}}
\begin{DoxyCompactList}\small\item\em A command to get current user ID. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{namespace_skm_xml_api_a0cde423403524629f8017d5e126cd6f7}\label{namespace_skm_xml_api_a0cde423403524629f8017d5e126cd6f7}} 
enum {\bfseries Event\+Log\+Aggregate} \{ \newline
{\bfseries Events}, 
{\bfseries Hours}, 
{\bfseries Days}, 
{\bfseries Months}, 
\newline
{\bfseries Years}
 \}
\item 
enum \mbox{\hyperlink{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552}{Download\+Status}} \{ \mbox{\hyperlink{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552a12d868c18cb29bf58f02b504be9033fd}{Download\+Status.\+In\+Progress}}, 
\mbox{\hyperlink{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552af92965e2c8a7afb3c1b9a5c09a263636}{Download\+Status.\+Done}}, 
\mbox{\hyperlink{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552a902b0d55fddef6f8d651fe1035b7d4bd}{Download\+Status.\+Error}}
 \}
\begin{DoxyCompactList}\small\item\em Media clip download status. \end{DoxyCompactList}\item 
enum \mbox{\hyperlink{namespace_skm_xml_api_ab840375a1e25b8447f90322de2a1be57}{Pan\+Tilt\+Step\+Direction}} \{ \newline
{\bfseries Up}, 
{\bfseries Up\+Left}, 
{\bfseries Up\+Right}, 
{\bfseries Left}, 
\newline
{\bfseries Right}, 
{\bfseries Down\+Left}, 
{\bfseries Down\+Right}, 
{\bfseries Down}
 \}
\begin{DoxyCompactList}\small\item\em Direction for P\+TZ to move at it\textquotesingle{}s smallest increment. \end{DoxyCompactList}\item 
enum \mbox{\hyperlink{namespace_skm_xml_api_a127d01ab8dc231adb71ed1ce0a696f0f}{Zoom\+Direction}} \{ {\bfseries Zoom\+In}, 
{\bfseries Zoom\+Out}
 \}
\begin{DoxyCompactList}\small\item\em Direction for camera to zoom \end{DoxyCompactList}\item 
enum \mbox{\hyperlink{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9}{Skm\+Permission\+Type}} \{ \newline
\mbox{\hyperlink{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9a955ad3298db330b5ee880c2c9e6f23a0}{Skm\+Permission\+Type.\+Live}} = 1, 
\mbox{\hyperlink{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9ae727b00944f81e1d0a95c12886ac4641}{Skm\+Permission\+Type.\+Archive}}, 
\mbox{\hyperlink{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9aa1595abbb4c3a326636dd178757cd6c1}{Skm\+Permission\+Type.\+Control}}, 
\mbox{\hyperlink{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9a562da6248d4ebd7cbc9dd2fa5fab3aa9}{Skm\+Permission\+Type.\+Ptz}}, 
\newline
\mbox{\hyperlink{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9aad2376beebecdcf7846ba973fa1a005b}{Skm\+Permission\+Type.\+Setup}}
 \}
\begin{DoxyCompactList}\small\item\em User permissions of an Skm\+Object \end{DoxyCompactList}\item 
enum \mbox{\hyperlink{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5}{Skm\+Object\+Type}} \{ \newline
\mbox{\hyperlink{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5a6adf97f83acf6453d4a6a4b1070f3754}{Skm\+Object\+Type.\+None}} = 0, 
\mbox{\hyperlink{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5a967d35e40f3f95b1f538bd248640bf3b}{Skm\+Object\+Type.\+Camera}}, 
\mbox{\hyperlink{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5ab22f0418e8ac915eb66f829d262d14a2}{Skm\+Object\+Type.\+Audio}}, 
\mbox{\hyperlink{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5a6c3a6944a808a7c0bbb6788dbec54a9f}{Skm\+Object\+Type.\+Node}}, 
\newline
\mbox{\hyperlink{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5aa4ecfc70574394990cf17bd83df499f7}{Skm\+Object\+Type.\+Event}}
 \}
\begin{DoxyCompactList}\small\item\em Defines a type of resource object \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Web A\+PI to Video\+N\+E\+XT product. 



\doxysubsection{Enumeration Type Documentation}
\mbox{\Hypertarget{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552}\label{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552}} 
\index{SkmXmlApi@{SkmXmlApi}!DownloadStatus@{DownloadStatus}}
\index{DownloadStatus@{DownloadStatus}!SkmXmlApi@{SkmXmlApi}}
\doxysubsubsection{\texorpdfstring{DownloadStatus}{DownloadStatus}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552}{Skm\+Xml\+Api.\+Download\+Status}}\hspace{0.3cm}{\ttfamily [strong]}}



Media clip download status. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{InProgress@{InProgress}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!InProgress@{InProgress}}}\mbox{\Hypertarget{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552a12d868c18cb29bf58f02b504be9033fd}\label{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552a12d868c18cb29bf58f02b504be9033fd}} 
In\+Progress&In progress \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Done@{Done}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Done@{Done}}}\mbox{\Hypertarget{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552af92965e2c8a7afb3c1b9a5c09a263636}\label{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552af92965e2c8a7afb3c1b9a5c09a263636}} 
Done&Done \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Error@{Error}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Error@{Error}}}\mbox{\Hypertarget{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552a902b0d55fddef6f8d651fe1035b7d4bd}\label{namespace_skm_xml_api_ac3e3dfe2376dfba6d0059ea45f436552a902b0d55fddef6f8d651fe1035b7d4bd}} 
Error&Error \\
\hline

\end{DoxyEnumFields}
\mbox{\Hypertarget{namespace_skm_xml_api_ab840375a1e25b8447f90322de2a1be57}\label{namespace_skm_xml_api_ab840375a1e25b8447f90322de2a1be57}} 
\index{SkmXmlApi@{SkmXmlApi}!PanTiltStepDirection@{PanTiltStepDirection}}
\index{PanTiltStepDirection@{PanTiltStepDirection}!SkmXmlApi@{SkmXmlApi}}
\doxysubsubsection{\texorpdfstring{PanTiltStepDirection}{PanTiltStepDirection}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{namespace_skm_xml_api_ab840375a1e25b8447f90322de2a1be57}{Skm\+Xml\+Api.\+Pan\+Tilt\+Step\+Direction}}\hspace{0.3cm}{\ttfamily [strong]}}



Direction for P\+TZ to move at it\textquotesingle{}s smallest increment. 

\mbox{\Hypertarget{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5}\label{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5}} 
\index{SkmXmlApi@{SkmXmlApi}!SkmObjectType@{SkmObjectType}}
\index{SkmObjectType@{SkmObjectType}!SkmXmlApi@{SkmXmlApi}}
\doxysubsubsection{\texorpdfstring{SkmObjectType}{SkmObjectType}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5}{Skm\+Xml\+Api.\+Skm\+Object\+Type}}\hspace{0.3cm}{\ttfamily [strong]}}



Defines a type of resource object 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{None@{None}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!None@{None}}}\mbox{\Hypertarget{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5a6adf97f83acf6453d4a6a4b1070f3754}\label{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5a6adf97f83acf6453d4a6a4b1070f3754}} 
None&No \mbox{\hyperlink{class_skm_xml_api_1_1_skm_object}{Skm\+Object}} type \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Camera@{Camera}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Camera@{Camera}}}\mbox{\Hypertarget{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5a967d35e40f3f95b1f538bd248640bf3b}\label{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5a967d35e40f3f95b1f538bd248640bf3b}} 
Camera&A camera or visual device \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Audio@{Audio}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Audio@{Audio}}}\mbox{\Hypertarget{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5ab22f0418e8ac915eb66f829d262d14a2}\label{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5ab22f0418e8ac915eb66f829d262d14a2}} 
Audio&An audio type device \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Node@{Node}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Node@{Node}}}\mbox{\Hypertarget{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5a6c3a6944a808a7c0bbb6788dbec54a9f}\label{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5a6c3a6944a808a7c0bbb6788dbec54a9f}} 
Node&A Skm server node \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Event@{Event}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Event@{Event}}}\mbox{\Hypertarget{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5aa4ecfc70574394990cf17bd83df499f7}\label{namespace_skm_xml_api_aadf98e4a543a11dae1394fb2348d80c5aa4ecfc70574394990cf17bd83df499f7}} 
Event&\mbox{\hyperlink{class_skm_xml_api_1_1_event}{Event}} \\
\hline

\end{DoxyEnumFields}
\mbox{\Hypertarget{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9}\label{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9}} 
\index{SkmXmlApi@{SkmXmlApi}!SkmPermissionType@{SkmPermissionType}}
\index{SkmPermissionType@{SkmPermissionType}!SkmXmlApi@{SkmXmlApi}}
\doxysubsubsection{\texorpdfstring{SkmPermissionType}{SkmPermissionType}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9}{Skm\+Xml\+Api.\+Skm\+Permission\+Type}}\hspace{0.3cm}{\ttfamily [strong]}}



User permissions of an \mbox{\hyperlink{class_skm_xml_api_1_1_skm_object}{Skm\+Object}} 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{Live@{Live}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Live@{Live}}}\mbox{\Hypertarget{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9a955ad3298db330b5ee880c2c9e6f23a0}\label{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9a955ad3298db330b5ee880c2c9e6f23a0}} 
Live&The user can have access to data that is live. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Archive@{Archive}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Archive@{Archive}}}\mbox{\Hypertarget{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9ae727b00944f81e1d0a95c12886ac4641}\label{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9ae727b00944f81e1d0a95c12886ac4641}} 
Archive&The user can have access to data that has been recorded. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Control@{Control}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Control@{Control}}}\mbox{\Hypertarget{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9aa1595abbb4c3a326636dd178757cd6c1}\label{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9aa1595abbb4c3a326636dd178757cd6c1}} 
Control&Control the device \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Ptz@{Ptz}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Ptz@{Ptz}}}\mbox{\Hypertarget{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9a562da6248d4ebd7cbc9dd2fa5fab3aa9}\label{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9a562da6248d4ebd7cbc9dd2fa5fab3aa9}} 
Ptz&The user has Ptz access to a device supporting Ptz abilities. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Setup@{Setup}!SkmXmlApi@{SkmXmlApi}}\index{SkmXmlApi@{SkmXmlApi}!Setup@{Setup}}}\mbox{\Hypertarget{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9aad2376beebecdcf7846ba973fa1a005b}\label{namespace_skm_xml_api_a3c758f4c5405bdb288620c1fc63bada9aad2376beebecdcf7846ba973fa1a005b}} 
Setup&The user has the ability to change configuration of this device. \\
\hline

\end{DoxyEnumFields}
\mbox{\Hypertarget{namespace_skm_xml_api_a127d01ab8dc231adb71ed1ce0a696f0f}\label{namespace_skm_xml_api_a127d01ab8dc231adb71ed1ce0a696f0f}} 
\index{SkmXmlApi@{SkmXmlApi}!ZoomDirection@{ZoomDirection}}
\index{ZoomDirection@{ZoomDirection}!SkmXmlApi@{SkmXmlApi}}
\doxysubsubsection{\texorpdfstring{ZoomDirection}{ZoomDirection}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{namespace_skm_xml_api_a127d01ab8dc231adb71ed1ce0a696f0f}{Skm\+Xml\+Api.\+Zoom\+Direction}}\hspace{0.3cm}{\ttfamily [strong]}}



Direction for camera to zoom 

