Adds configure support for URLs

[rbdr/captura] / Captura / Scripting / Captura.sdef

<!DOCTYPE dictionary SYSTEM "file://localhost/System/Library/DTDs/sdef.dtd">
<dictionary title="Captura Terminology">
    <suite name="Standard Suite" code="CStd" description="Common classes and commands for all applications.">
          <command name="quit" code="aevtquit" description="Quit the application.">
              <cocoa class="NSQuitCommand"/>
          </command>
    </suite>
    <suite name="Captura Suite" code="CAPT" description="Controls Captura">
      <class name="application" code="capp" description="The application's top-level scripting object.">
        <cocoa class="CapturaApp"/>
      </class>
      <record-type code="CCRc" name="configuration">
        <property name="fps" code="pPfp" type="integer" description="Sets the FPS of the recording" access="rw" />
        <property name="outputs" code="pPou" type="text" description="Which outputs get generated locally" access="rw" />
        <property name="backend" code="pPbk" type="text" description="Updates the backend URL that will be used" access="rw" />
        <property name="backend_output" code="pPbo" type="text" description="Which output should be sent to the backend" access="rw" />
        <property name="keep_local_files" code="pPlf" type="boolean" description="Whether to keep local files after a successful backend upload." access="rw"/>
      </record-type>
      <record-type code="CCRr" name="recording_configuration">
          <property name="x" code="CCrx" type="integer" description="Sets the starting horizontal position of the recording frame from the left of the screen. Defaults to the center of the screen." />
          <property name="y" code="CCry" type="integer" description="Sets the starting vertical position of the recording frame from the bottom of the screen. Defaults to the center of the screen." />
          <property name="width" code="CCrw" type="integer" description="Sets the width of the recording frame. Defaults to 400" />
          <property name="height" code="CCrh" type="integer" description="Sets the height of the recording frame. Defaults to 400" />
          <property name="prevent_resize" code="CCRz" type="boolean" description="Prevents the recording frame from being resized. Defaults to false." />
          <property name="prevent_move" code="CCRm" type="boolean" description="Prevents the recording frame from being moved. Defaults to false." />
          <property name="fps" code="CCrf" type="integer" description="Sets the FPS of the recording" />
          <property name="outputs" code="CCRo" type="text" description="Which outputs get generated locally" />
          <property name="backend" code="CCRb" type="text" description="Updates the backend URL that will be used" />
          <property name="backend_output" code="CCRp" type="text" description="Which output should be sent to the backend" />
          <property name="keep_local_files" code="CCRk" type="boolean" description="Whether to keep local files after a successful backend upload." />
          <property name="auto_start" code="CCRa" type="boolean" description="Whether the recording session should start automatically or not. It takes 3 seconds to start." />
          <property name="max_length" code="CCrl" type="integer" description="The max length for the recording in seconds, default and max is 300." />
      </record-type>
      <command name="start_recording" code="CCCMStRc">
        <cocoa class="RecordCommand" />
        <direct-parameter description="The settings to be configured">
          <type type="recording_configuration" />
        </direct-parameter>
      </command>
      <command name="configure" code="CCCMConf">
        <cocoa class="ConfigureCommand" />
        <direct-parameter description="The settings to be updated">
          <type type="configuration" />
        </direct-parameter>
      </command>
    </suite>
</dictionary>