Web Service: DvsClipsterWebservice

Target Namespace:
urn:dvs:webservices:clipster
Description:
This document provides a reference to all commands supported by the web service DvsClipsterWebservice. The commands allow you to access the top-level functionality of DVS's CLIPSTER via SOAP (Build date: 2009/06/18).

To use the web service you need a proper license. Furthermore, the web service must be enabled as well as configured correctly in the CLIPSTER software and its user interface must be running on the client to which you want to connect.

For a successful communication with the CLIPSTER web service most commands require a handle that must be explicitly requested from the software first. It has to be passed as a header element in subsequent calls to the web service. Once you are finished using the web service, the handle should be released. To manually force the release of a handle close the user interface of the CLIPSTER software on the SOAP client. Then the handle will be void.

The web service expects the commands in XML format. The XML as well as the data to be sent are case-sensitive.

When sending predefined control strings (restricted strings), you may, instead of sending the string, send the enumeration constant (enum const) as detailed in the WSDL source code (see "Source code" links).

Port DvsClipsterWebserviceHttpPort Port type Source code

Location:
http://127.0.0.1:8080
Protocol:
SOAP
Default style:
document
Transport protocol:
SOAP over HTTP
Operations:
  1. ConfigClose Detail Source code
  2. ConfigGet Detail Source code
  3. ConfigLoad Detail Source code
  4. DesktopMessageDiscard Detail Source code
  5. DesktopMessageGetStatus Detail Source code
  6. DesktopMessageInvoke Detail Source code
  7. JobControl Detail Source code
  8. JobGetIDs Detail Source code
  9. JobGetStatus Detail Source code
  10. JobStart Detail Source code
  11. ProjectClose Detail Source code
  12. ProjectGet Detail Source code
  13. ProjectLoad Detail Source code
  14. ProjectNameGet Detail Source code
  15. ProjectPropertyGet Detail Source code
  16. ProjectPropertySet Detail Source code
  17. SystemGetHandles Detail Source code
  18. SystemGetLastMessages Detail Source code
  19. SystemGetStatus Detail Source code
  20. SystemReleaseHandle Detail Source code
  21. SystemRenewHandle Detail Source code
  22. SystemRequestHandle Detail Source code
  23. TCPCommandWrapper Detail Source code
  24. TimelineMarkerPositionGet Detail Source code

Operations

    Port type DvsClipsterWebservicePortType Source code

    1. ConfigClose
      Description:
      Saves the global settings that are currently set to a file.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      ConfigClose (SOAP:body, use = literal, part = Handle)Source code
      parameters type ConfigClose
      [ConfigLocationURL] --- The location and file name for the global settings to be saved (e.g. file:///V:/settings/some_config_file.cgs). When left empty, they will be saved in the file soapdefault.cgs in the system base video directory.

      [ForceSave] --- Obsolete. Leave empty.

      • ConfigLocationURL - optional; type anyURI
      • ForceSave - optional; type boolean
      Output:
      ConfigCloseResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type ConfigCloseResponse
      • ConfigLocationURL type string
    2. ConfigGet
      Description:
      Returns the specified global settings file as a data string.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      ConfigGet (SOAP:body, use = literal, part = Handle)Source code
      parameters type ConfigGet
      [ConfigLocationURL] --- The location and file name of the global settings file that should be returned (e.g. file:///V:/settings/some_config_file.cgs).
      • ConfigLocationURL type anyURI
      Output:
      ConfigGetResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type ConfigGetResponse
      • ConfigData type string
    3. ConfigLoad
      Description:
      Loads a global settings file either by specifying an existing global settings file on the SOAP client or by providing a complete *.cgs file (valid for the SOAP client) as an XML string.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      ConfigLoad (SOAP:body, use = literal, part = Handle)Source code
      parameters type ConfigLoad
      [ConfigLocationURL] --- The location and file name of either the global settings file to load or for the XML string to be saved if [ConfigContent] is provided (e.g. file:///V:/settings/some_config_file.cgs).

      [ConfigContent] --- The content of a complete global settings file as an XML string.

      [ForceLoad] --- Obsolete. Leave empty.

      • ConfigLocationURL type anyURI
      • ConfigContent - optional; type string
      • ForceLoad - optional; type boolean
      Output:
      ConfigLoadResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type ConfigLoadResponse
      • ConfigLocationURL type string
    4. DesktopMessageDiscard
      Description:
      Closes the message box that is shown on the CLIPSTER system.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      DesktopMessageDiscard (SOAP:body, use = literal, part = Handle)Source code
      parameters type DesktopMessageDiscard
      No parameters.
      Output:
      DesktopMessageDiscardResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type DesktopMessageDiscardResponse
    5. DesktopMessageGetStatus
      Description:
      Returns status information about the message box displayed on the CLIPSTER system and its buttons.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      DesktopMessageGetStatus (SOAP:body, use = literal, part = Handle)Source code
      parameters type DesktopMessageGetStatus
      No parameters.
      Output:
      DesktopMessageGetStatusResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type DesktopMessageGetStatusResponse
      [ButtonNameClicked] --- A comma-separated string of the button names that were clicked. Each time this command is called this value will be erased afterwards.

      [State] --- Shows the current state (visibility) of the message box.

      • ButtonNameClicked type string
      • State type DesktopMessageStateEnum - type string with restriction - enum { 'DMSTATE-UNKNOWN', 'DMSTATE-ON', 'DMSTATE-OFF' }
    6. DesktopMessageInvoke
      Description:
      This command allows for an interaction with the desktop of the remote controlled CLIPSTER system. The message that is sent will pop up a message box (window) on the screen of the CLIPSTER system. Only the last message that has been sent will be shown. The user at the system can interact with it by pressing buttons.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      DesktopMessageInvoke (SOAP:body, use = literal, part = Handle)Source code
      parameters type DesktopMessageInvoke
      [Caption] --- The title of the message box.

      [Text] --- The text of the message.

      [Icon] --- The icon that should be shown for the message. You can choose between no icon, an icon for an information, for a question, for a warning, or for a critical message.

      [TypeFlagList] --- Determines the type of message box that will be shown. DMMESSAGE-LOCK will show predefined messages that lock the user interface and indicate that the web service is in use. DMMESSAGE-FULLSCREEN shows the message in fullscreen. DMMESSAGE-FLASHING shows a flashing message box. DMMESSAGE-CLOSEABLE allows the message box to be closed by the user.

      [ButtonNameList] --- A comma-separated list of the button names that should be shown thereby determining the number of buttons in the message box.

      • Caption - optional; type string
      • Text - optional; type string
      • Icon - optional; type DesktopMessageIconEnum - type string with restriction - enum { 'DMICON-UNKNOWN', 'DMICON-NONE', 'DMICON-INFO', 'DMICON-QUESTION', 'DMICON-WARNING', 'DMICON-CRITICAL' }
      • TypeFlagList - optional, unbounded; type DesktopMessageTypeEnum - type string with restriction - enum { 'DMMESSAGE-UNKNOWN', 'DMMESSAGE-LOCK', 'DMMESSAGE-FULLSCREEN', 'DMMESSAGE-FLASHING', 'DMMESSAGE-CLOSEABLE' }
      • ButtonNameList - optional, unbounded; type string
      Output:
      DesktopMessageInvokeResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type DesktopMessageInvokeResponse
    7. JobControl
      Description:
      Controls the specified job.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      JobControl (SOAP:body, use = literal, part = Handle)Source code
      parameters type JobControl
      [JobID] --- The ID of a job. When left empty, it means the job that is currently running.

      [JobControlType] --- Determines what to perform with the job.

      • JobID - optional; type string
      • JobControlType type JobControlTypeEnum - type string with restriction - enum { 'JOBCONTROL-UNKNOWN', 'JOBCONTROL-STOP' }
      Output:
      JobControlResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type JobControlResponse
      • JobID type string
      • JobControlType type JobControlTypeEnum - type string with restriction - enum { 'JOBCONTROL-UNKNOWN', 'JOBCONTROL-STOP' }
    8. JobGetIDs
      Description:
      Returns all job IDs.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      JobGetIDs (SOAP:body, use = literal, part = Handle)Source code
      parameters type JobGetIDs
      No parameters.
      Output:
      JobGetIDsResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type JobGetIDsResponse
      • JobIDList - optional, unbounded; type string
    9. JobGetStatus
      Description:
      Returns status information about the specified job.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      JobGetStatus (SOAP:body, use = literal, part = Handle)Source code
      parameters type JobGetStatus
      [JobID] --- The ID of a job. When left empty, it means the job that is currently running.
      • JobID - optional; type string
      Output:
      JobGetStatusResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type JobGetStatusResponse
      • JobID type string
      • Type type JobTypeEnum - type string with restriction - enum { 'JOBTYPE-UNKNOWN', 'JOBTYPE-PLAYOUT', 'JOBTYPE-FINALIZE', 'JOBTYPE-INGEST', 'JOBTYPE-DISPLAY' }
      • Status type JobStatusTypeEnum - type string with restriction - enum { 'JOBSTATUS-UNKNOWN', 'JOBSTATUS-RUNNING', 'JOBSTATUS-FINISHED', 'JOBSTATUS-CANCELED', 'JOBSTATUS-ABORTED' }
      • Progress type double
      • TimeRemaining type time
      • TimeStart type dateTime
      • TimeFinished type dateTime
      • LastErrorText type string
      • LastErrorCode type int
    10. JobStart
      Description:
      Starts a job, for example, a finalize, ingest or play-out job.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      JobStart (SOAP:body, use = literal, part = Handle)Source code
      parameters type JobStart
      [JobType] --- The type of job that should be performed. JOBTYPE-PLAYOUT performs a play-out in the Playout mode of the I/O Tool, JOBTYPE-FINALIZE performs a finalizing of the currently loaded project, JOBTYPE-INGEST starts a record operation in the Autoedit mode of the I/O Tool, and JOBTYPE-DISPLAY initiates a play-out of the currently loaded project in the Edit Tool.
      • JobType type JobTypeEnum - type string with restriction - enum { 'JOBTYPE-UNKNOWN', 'JOBTYPE-PLAYOUT', 'JOBTYPE-FINALIZE', 'JOBTYPE-INGEST', 'JOBTYPE-DISPLAY' }
      Output:
      JobStartResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type JobStartResponse
      • JobID type string
    11. ProjectClose
      Description:
      Closes the currently loaded CLIPSTER project.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      ProjectClose (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectClose
      [ForceSave] --- When set to true, the project will be saved automatically before it is closed. When set to false, the project will be closed without saving.
      • ForceSave type boolean
      Output:
      ProjectCloseResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectCloseResponse
      • ProjectLocationURL type string
    12. ProjectGet
      Description:
      Returns the specified project as a data string.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      ProjectGet (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectGet
      [ProjectLocationURL] --- The location and file name of the project that should be returned (e.g. file:///V:/video/some_file.cp).
      • ProjectLocationURL type anyURI
      Output:
      ProjectGetResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectGetResponse
      • ProjectData type string
    13. ProjectLoad
      Description:
      Loads a CLIPSTER project file either by specifying an existing project on the SOAP client or by providing a complete *.cp project (valid for the SOAP client) as an XML string.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      ProjectLoad (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectLoad
      [ProjectLocationURL] --- The location and file name of either the project to load or for the XML string to be saved if [ProjectContent] is provided (e.g. file:///V:/video/some_file.cp).

      [ProjectContent] --- The content of a complete CLIPSTER project file as an XML string.

      [ForceLoad] --- Obsolete. Leave empty.

      • ProjectLocationURL type anyURI
      • ProjectContent - optional; type string
      • ForceLoad - optional; type boolean
      Output:
      ProjectLoadResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectLoadResponse
      • ProjectLocationURL type string
    14. ProjectNameGet
      Description:
      Returns the file name and path of the current project file (or an empty string if no project is loaded).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      ProjectNameGet (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectNameGet
      No parameters.
      Output:
      ProjectNameGetResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectNameGetResponse
      • FilePath type string
    15. ProjectPropertyGet
      Description:
      This command is experimental. It returns a property of the currently loaded project.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      ProjectPropertyGet (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectPropertyGet
      [Context] --- Determines the context (e.g. software module) from which to retrieve the property. CONTEXT-EDITMODE gets the property currently set in the Edit Tool, CONTEXT-IOMODE the one set in the I/O Tool and CONTEXT-FINALIZE the one set for a finalizing.

      [Property] --- The type of property that should be retrieved. PROPERTY-RASTER gets the video raster of the specified context.

      • Context type ContextEnum - type string with restriction - enum { 'CONTEXT-UNKNOWN', 'CONTEXT-EDITMODE', 'CONTEXT-IOMODE', 'CONTEXT-FINALIZE' }
      • Property type PropertyTypeEnum - type string with restriction - enum { 'PROPERTY-UNKNOWN', 'PROPERTY-RASTER' }
      Output:
      ProjectPropertyGetResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectPropertyGetResponse
      • PropertyType type PropertyTypeEnum - type string with restriction - enum { 'PROPERTY-UNKNOWN', 'PROPERTY-RASTER' }
      • PropertyValue type string
    16. ProjectPropertySet
      Description:
      This command is experimental. It sets a property for the currently loaded project.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      ProjectPropertySet (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectPropertySet
      [Context] --- Determines the context (e.g. software module) where to set the property. CONTEXT-EDITMODE sets the property for the Edit Tool, CONTEXT-IOMODE for the I/O Tool and CONTEXT-FINALIZE for a finalizing.

      [Property] --- The type of property that should be set.

      [Parameter] --- The value for the property. PROPERTY-RASTER sets the video raster for the specified context.

      • Context type ContextEnum - type string with restriction - enum { 'CONTEXT-UNKNOWN', 'CONTEXT-EDITMODE', 'CONTEXT-IOMODE', 'CONTEXT-FINALIZE' }
      • Property type PropertyTypeEnum - type string with restriction - enum { 'PROPERTY-UNKNOWN', 'PROPERTY-RASTER' }
      • Parameter type string
      Output:
      ProjectPropertySetResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type ProjectPropertySetResponse
    17. SystemGetHandles
      Description:
      Returns the current handle as well as its properties.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      SystemGetHandles (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemGetHandles
      No parameters.
      Output:
      SystemGetHandlesResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemGetHandlesResponse
      • HandleItemList - optional, unbounded; type HandleItem
        • Username type string
        • IpAddress type string
        • TimeIssuing type dateTime
        • TimeExpiration type dateTime
    18. SystemGetLastMessages
      Description:
      When controlling a CLIPSTER application via web service, message boxes by the software on the SOAP client are suppressed normally. This command returns the messages (such as information, warnings or criticals) that occurred during the lifetime of a project.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      SystemGetLastMessages (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemGetLastMessages
      No parameters.
      Output:
      SystemGetLastMessagesResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemGetLastMessagesResponse
      • SystemMessageList - optional, unbounded; type SystemMessage
        • SystemMessageType type SystemMessageTypeEnum - type string with restriction - enum { 'SYSTEMMESSAGE-UNKNOWN', 'SYSTEMMESSAGE-NONE', 'SYSTEMMESSAGE-INFO', 'SYSTEMMESSAGE-QUESTION', 'SYSTEMMESSAGE-WARNING', 'SYSTEMMESSAGE-CRITICAL' }
        • Caption type string
        • Text type string
        • Time type dateTime
        • JobID type string
        • ActionTaken type string
    19. SystemGetStatus
      Description:
      Returns the current status of the CLIPSTER application.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      SystemGetStatus (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemGetStatus
      No parameters.
      Output:
      SystemGetStatusResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemGetStatusResponse
      • SystemStatus type SystemStatusTypeEnum - type string with restriction - enum { 'SYSTEMSTATUS-UNKNOWN', 'SYSTEMSTATUS-IDLE', 'SYSTEMSTATUS-FINALIZE', 'SYSTEMSTATUS-PLAYOUT', 'SYSTEMSTATUS-INGEST', 'SYSTEMSTATUS-PROJECTLOAD', 'SYSTEMSTATUS-DISPLAY' }
    20. SystemReleaseHandle
      Description:
      Releases the handle for the CLIPSTER application. Then the handle will be void.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      SystemReleaseHandle (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemReleaseHandle
      No parameters.
      Output:
      SystemReleaseHandleResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemReleaseHandleResponse
      • Handle type string
    21. SystemRenewHandle
      Description:
      Sets a new lifetime for the handle.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      SystemRenewHandle (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemRenewHandle
      [Username] --- The Name of the user that renews the handle.

      [Lifetime] --- The time in seconds that the handle should be valid. Zero (0) (default) means no expiration.

      • Username - optional; type string
      • Lifetime - optional; type int
      Output:
      SystemRenewHandleResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemRenewHandleResponse
      • Handle type string
      • Username type string
      • TimeExpiration type dateTime
    22. SystemRequestHandle
      Description:
      Most commands require a handle that has to be passed as a header element in subsequent calls to the web service. This command requests a handle from the CLIPSTER application providing exclusive access to control commands of the web service.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      SystemRequestHandle (SOAP:body, use = literal, part = Security)Source code
      parameters type SystemRequestHandle
      [Username] --- The Name of the user that requests the handle.

      [Lifetime] --- The time in seconds that the requested handle should be valid. Zero (0) (default) means no expiration.

      [ValidationCheckInterval] --- The interval in seconds in which the web service will check for a usage of the handle. The handle must be used at least once in the specified time to keep it valid. Zero (0) (default) means no validity check.

      • Username - optional; type string
      • Lifetime - optional; type int
      • ValidationCheckInterval - optional; type int
      Output:
      SystemRequestHandleResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type SystemRequestHandleResponse
      • Handle type string
      • Username type string
      • TimeIssuing type dateTime
      • TimeExpiration type dateTime
    23. TCPCommandWrapper
      Description:
      This command allows to send encapsulated XML commands to the remote controlled CLIPSTER system.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      TCPCommandWrapper (SOAP:body, use = literal, part = Handle)Source code
      parameters type TCPCommandWrapper
      [Command] --- container for TCP command interface.
      • Context type string
      • Command type string
      • ParameterList - optional, unbounded; type CommandParameter
        • Name type string
        • Value type string
      Output:
      TCPCommandWrapperResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type TCPCommandWrapperResponse
      [ParameterList] --- A list of name value pairs of the resonse of the TCP Command Interface.
      • ParameterList - optional, unbounded; type CommandParameter
        • Name type string
        • Value type string
    24. TimelineMarkerPositionGet
      Description:
      Service definition of function __cws__TimelineMarkerPositionGet
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      TimelineMarkerPositionGet (SOAP:body, use = literal, part = Handle)Source code
      parameters type TimelineMarkerPositionGet
      [Context] ---
      Output:
      TimelineMarkerPositionGetResponse (SOAP:body, use = literal, part = Handle)Source code
      parameters type TimelineMarkerPositionGetResponse
      • MarkerPosition - optional, unbounded; type long

WSDL source code

<?xml version="1.0"?>
<definitions name="DvsClipsterWebservice" targetNamespace="urn:dvs:webservices:clipster"
xmlns:tns="urn:dvs:webservices:clipster"
xmlns:SOAP="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:WSDL="http://schemas.xmlsoap.org/wsdl/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:c14n="http://www.w3.org/2001/10/xml-exc-c14n#"
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:h="urn:h"
xmlns:MIME="http://schemas.xmlsoap.org/wsdl/mime/"
xmlns:DIME="http://schemas.xmlsoap.org/ws/2002/04/dime/wsdl/"
xmlns:cws="urn:dvs:webservices:clipster"
>
<types>
<schema targetNamespace="urn:dvs:webservices:clipster" elementFormDefault="qualified" attributeFormDefault="unqualified" >
<complexType name="DesktopMessageGetStatusResponse" >
<annotation>
<documentation> [ButtonNameClicked] --- A comma-separated string of the button names that were clicked. Each time this command is called this value will be erased afterwards.<p>[State] --- Shows the current state (visibility) of the message box.</p></documentation>
</annotation>
</complexType>
<complexType name="TCPCommandWrapperResponse" >
<annotation>
<documentation> [ParameterList] --- A list of name value pairs of the resonse of the TCP Command Interface.</documentation>
</annotation>
</complexType>
<complexType name="SystemRequestHandle" >
<annotation>
<documentation> [Username] --- The Name of the user that requests the handle.<p>[Lifetime] --- The time in seconds that the requested handle should be valid. Zero (0) (default) means no expiration.</p><p>[ValidationCheckInterval] --- The interval in seconds in which the web service will check for a usage of the handle. The handle must be used at least once in the specified time to keep it valid. Zero (0) (default) means no validity check.</p></documentation>
</annotation>
</complexType>
<complexType name="SystemRenewHandle" >
<annotation>
<documentation> [Username] --- The Name of the user that renews the handle.<p>[Lifetime] --- The time in seconds that the handle should be valid. Zero (0) (default) means no expiration.</p></documentation>
</annotation>
</complexType>
<complexType name="SystemReleaseHandle" >
<annotation>
<documentation> No parameters.</documentation>
</annotation>
</complexType>
<complexType name="SystemGetHandles" >
<annotation>
<documentation> No parameters.</documentation>
</annotation>
</complexType>
<complexType name="SystemGetStatus" >
<annotation>
<documentation> No parameters.</documentation>
</annotation>
</complexType>
<complexType name="SystemGetLastMessages" >
<annotation>
<documentation> No parameters.</documentation>
</annotation>
</complexType>
<complexType name="ProjectLoad" >
<annotation>
<documentation> [ProjectLocationURL] --- The location and file name of either the project to load or for the XML string to be saved if [ProjectContent] is provided (e.g. <i>file:///V:/video/some_file.cp</i>).<p>[ProjectContent] --- The content of a complete CLIPSTER project file as an XML string.</p><p>[ForceLoad] --- Obsolete. Leave empty.</p></documentation>
</annotation>
</complexType>
<complexType name="ProjectClose" >
<annotation>
<documentation> [ForceSave] --- When set to <code>true</code>, the project will be saved automatically before it is closed. When set to <code>false</code>, the project will be closed without saving.</documentation>
</annotation>
</complexType>
<complexType name="ProjectGet" >
<annotation>
<documentation> [ProjectLocationURL] --- The location and file name of the project that should be returned (e.g. <i>file:///V:/video/some_file.cp</i>).</documentation>
</annotation>
</complexType>
<complexType name="ConfigLoad" >
<annotation>
<documentation> [ConfigLocationURL] --- The location and file name of either the global settings file to load or for the XML string to be saved if [ConfigContent] is provided (e.g. <i>file:///V:/settings/some_config_file.cgs</i>).<p>[ConfigContent] --- The content of a complete global settings file as an XML string.</p><p>[ForceLoad] --- Obsolete. Leave empty.</p></documentation>
</annotation>
</complexType>
<complexType name="ConfigClose" >
<annotation>
<documentation> [ConfigLocationURL] --- The location and file name for the global settings to be saved (e.g. <i>file:///V:/settings/some_config_file.cgs</i>). When left empty, they will be saved in the file <i>soapdefault.cgs</i> in the system base video directory.<p>[ForceSave] --- Obsolete. Leave empty.</p></documentation>
</annotation>
</complexType>
<complexType name="ConfigGet" >
<annotation>
<documentation> [ConfigLocationURL] --- The location and file name of the global settings file that should be returned (e.g. <i>file:///V:/settings/some_config_file.cgs</i>).</documentation>
</annotation>
</complexType>
<complexType name="ProjectPropertySetInput" >
<annotation>
<documentation> [Context] --- Determines the context (e.g. software module) where to set the property. <code>CONTEXT-EDITMODE</code> sets the property for the Edit Tool, <code>CONTEXT-IOMODE</code> for the I/O Tool and <code>CONTEXT-FINALIZE</code> for a finalizing.<p>[Property] --- The type of property that should be set.</p><p>[Parameter] --- The value for the property. <code>PROPERTY-RASTER</code> sets the video raster for the specified context.</p></documentation>
</annotation>
</complexType>
<complexType name="ProjectPropertyGetInput" >
<annotation>
<documentation> [Context] --- Determines the context (e.g. software module) from which to retrieve the property. <code>CONTEXT-EDITMODE</code> gets the property currently set in the Edit Tool, <code>CONTEXT-IOMODE</code> the one set in the I/O Tool and <code>CONTEXT-FINALIZE</code> the one set for a finalizing.<p>[Property] --- The type of property that should be retrieved. <code>PROPERTY-RASTER</code> gets the video raster of the specified context.</p></documentation>
</annotation>
</complexType>
<complexType name="TimelineMarkerPositionGetInput" >
<annotation>
<documentation> [Context] --- </documentation>
</annotation>
</complexType>
<complexType name="JobStart" >
<annotation>
<documentation> [JobType] --- The type of job that should be performed. <code>JOBTYPE-PLAYOUT</code> performs a play-out in the Playout mode of the I/O Tool, <code>JOBTYPE-FINALIZE</code> performs a finalizing of the currently loaded project, <code>JOBTYPE-INGEST</code> starts a record operation in the Autoedit mode of the I/O Tool, and <code>JOBTYPE-DISPLAY</code> initiates a play-out of the currently loaded project in the Edit Tool.</documentation>
</annotation>
</complexType>
<complexType name="JobControl" >
<annotation>
<documentation> [JobID] --- The ID of a job. When left empty, it means the job that is currently running.<p>[JobControlType] --- Determines what to perform with the job.</p></documentation>
</annotation>
</complexType>
<complexType name="JobGetStatus" >
<annotation>
<documentation> [JobID] --- The ID of a job. When left empty, it means the job that is currently running.</documentation>
</annotation>
</complexType>
<complexType name="JobGetIDs" >
<annotation>
<documentation> No parameters.</documentation>
</annotation>
</complexType>
<complexType name="DesktopMessageInvoke" >
<annotation>
<documentation> [Caption] --- The title of the message box.<p>[Text] --- The text of the message.</p><p>[Icon] --- The icon that should be shown for the message. You can choose between no icon, an icon for an information, for a question, for a warning, or for a critical message.</p><p>[TypeFlagList] --- Determines the type of message box that will be shown. <code>DMMESSAGE-LOCK</code> will show predefined messages that lock the user interface and indicate that the web service is in use. <code>DMMESSAGE-FULLSCREEN</code> shows the message in fullscreen. <code>DMMESSAGE-FLASHING</code> shows a flashing message box. <code>DMMESSAGE-CLOSEABLE</code> allows the message box to be closed by the user.</p><p>[ButtonNameList] --- A comma-separated list of the button names that should be shown thereby determining the number of buttons in the message box.</p></documentation>
</annotation>
</complexType>
<complexType name="DesktopMessageDiscard" >
<annotation>
<documentation> No parameters.</documentation>
</annotation>
</complexType>
<complexType name="DesktopMessageGetStatus" >
<annotation>
<documentation> No parameters.</documentation>
</annotation>
</complexType>
<complexType name="ProjectNameGet" >
<annotation>
<documentation> No parameters.</documentation>
</annotation>
</complexType>
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
<!-- operation response element -->
</schema>
</types>
<portType name="DvsClipsterWebservicePortType" >
<operation name="SystemRequestHandle" >
<documentation> Most commands require a handle that has to be passed as a header element in subsequent calls to the web service. This command requests a handle from the CLIPSTER application providing exclusive access to control commands of the web service.</documentation>
</operation>
<operation name="SystemReleaseHandle" >
<documentation> Releases the handle for the CLIPSTER application. Then the handle will be void.</documentation>
</operation>
<operation name="SystemGetLastMessages" >
<documentation> When controlling a CLIPSTER application via web service, message boxes by the software on the SOAP client are suppressed normally. This command returns the messages (such as information, warnings or criticals) that occurred during the lifetime of a project.</documentation>
</operation>
<operation name="ProjectLoad" >
<documentation> Loads a CLIPSTER project file either by specifying an existing project on the SOAP client or by providing a complete <i>*.cp</i> project (valid for the SOAP client) as an XML string.</documentation>
</operation>
<operation name="ConfigLoad" >
<documentation> Loads a global settings file either by specifying an existing global settings file on the SOAP client or by providing a complete <i>*.cgs</i> file (valid for the SOAP client) as an XML string.</documentation>
</operation>
<operation name="ConfigClose" >
<documentation> Saves the global settings that are currently set to a file.</documentation>
</operation>
<operation name="ConfigGet" >
<documentation> Returns the specified global settings file as a data string.</documentation>
</operation>
<operation name="ProjectPropertySet" >
<documentation> This command is experimental. It sets a property for the currently loaded project.</documentation>
</operation>
<operation name="ProjectPropertyGet" >
<documentation> This command is experimental. It returns a property of the currently loaded project.</documentation>
</operation>
<operation name="JobStart" >
<documentation> Starts a job, for example, a finalize, ingest or play-out job.</documentation>
</operation>
<operation name="DesktopMessageInvoke" >
<documentation> This command allows for an interaction with the desktop of the remote controlled CLIPSTER system. The message that is sent will pop up a message box (window) on the screen of the CLIPSTER system. Only the last message that has been sent will be shown. The user at the system can interact with it by pressing buttons.</documentation>
</operation>
<operation name="DesktopMessageGetStatus" >
<documentation> Returns status information about the message box displayed on the CLIPSTER system and its buttons.</documentation>
</operation>
<operation name="TCPCommandWrapper" >
<documentation> This command allows to send encapsulated XML commands to the remote controlled CLIPSTER system. </documentation>
</operation>
<operation name="ProjectNameGet" >
<documentation> Returns the file name and path of the current project file (or an empty string if no project is loaded).</documentation>
</operation>
</portType>
<binding name="DvsClipsterWebserviceBinding" type="tns:DvsClipsterWebservicePortType" > </binding>
<service name="DvsClipsterWebservice" >
<documentation> This document provides a reference to all commands supported by the web service DvsClipsterWebservice. The commands allow you to access the top-level functionality of DVS's CLIPSTER via SOAP (Build date: 2009/06/18).<p>To use the web service you need a proper license. Furthermore, the web service must be enabled as well as configured correctly in the CLIPSTER software and its user interface must be running on the client to which you want to connect.</p><p>For a successful communication with the CLIPSTER web service most commands require a handle that must be explicitly requested from the software first. It has to be passed as a header element in subsequent calls to the web service. Once you are finished using the web service, the handle should be released. To manually force the release of a handle close the user interface of the CLIPSTER software on the SOAP client. Then the handle will be void.</p><p>The web service expects the commands in XML format. The XML as well as the data to be sent are case-sensitive.</p><p>When sending predefined control strings (restricted strings), you may, instead of sending the string, send the enumeration constant (enum const) as detailed in the WSDL source code (see "Source code" links).</p></documentation>
</service>
</definitions>

Imported Schema exc-c14n.xsd