Web Service: DvsClipsterWebservice

Port type DvsClipsterWebservicePortType Source code

1. ConfigClose
   Source code
   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
   Source code
   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
   Source code
   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
   Source code
   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
   Source code
   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
   Source code
   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
   Source code
   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
   Source code
   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
   Source code
   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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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
    Source code
    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

Imported Schema exc-c14n.xsd

Imported Schema oasis-200401-wss-wssecurity-utility-1.0.xsd

Imported Schema xmldsig-core-schema.xsd

Imported Schema oasis-200401-wss-wssecurity-secext-1.0.xsd

Imported Schema .xsd

Imported Schema exc-c14n.xsd

Imported Schema oasis-200401-wss-wssecurity-utility-1.0.xsd

Imported Schema xmldsig-core-schema.xsd

Imported Schema oasis-200401-wss-wssecurity-secext-1.0.xsd

Imported Schema .xsd

About this Page

This page was generated by using wsdl-viewer.xsl,
version 3.1.02,
author tomi vanek,
with modifications made by DVS Digital Video Systems AG.

The generator was SAXON 9.1.0.8 from Saxonica XSLT engine.
The engine processed the WSDL in XSLT 2.0 compliant mode.

DVS Digital Video Systems AG
http://www.dvs.de
doku@dvs.de