XML_ControlParam

XML message about terminal control parameters

<ControlParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
  <operateType >
    <!--required, xs:string, operations: "startPlay"-start playing, "insert"-cut-in, "stopInserstop"-stop cut-in, "Play"-stop playing, "powerOn"-startup, "powerOff"-shutdown, reboot, "restoreConfig"-restore configuration, "planCtrl"-control schedule, "cancelInsert"-cancel cut-in , "publishStateShow"-display terminal release progress, "publishStateHide"-hide terminal release progress-->
  </operateType>
  <InsertInfo>
    <!--dependent, message to cut-in,  this field is valid only when operateType is "insert"->
    <storageInfo>
      <!--optional-->
      <terminalID>
        <!--optional, string, terminal ID-->
      </terminalID>
      <xmlUniqueSeq>
        <!--optional, string, XML file ID-->
      </xmlUniqueSeq>
      <storageId>
        <!--optional, string, ID of position where the XML file is stored-->
      </storageId>
      <serverIP>
        <!--optional, string, server ID-->
      </serverIP>
      <serverPort>
        <!--optional, integer, server port No.-->
      </serverPort>
    </storageInfo>
    <insertType >
      <!--required, xs:string, content to cut-in: material, program-->
    </insertType>
    <MaterialInfo>
      <!--dependent-->
      <materialNo>
        <!--required, xs:integer-->
      </materialNo>
      <playMode>
        <!--required, "byTime,byEndTime "-->
      </playMode>
      <countNum>
        <!--dependent, xs:integer, playing times-->
      </countNum>
      <playDuration>
        <!--dependent, xs:integer, duration of a single playing, unit: second-->
      </playDuration>
      <playEndTime>
        <!--optional, xs:string, end time (ISO 8601 format)-->
      </playEndTime>
    </MaterialInfo>
    <ProgramInfo>
      <!--dependent, program information-->
      <programNo>
        <!--required, xs:integer, program No.-->
      </programNo>
      <playMode>
        <!--required, "byTime,byEndTime "-->
      </playMode>
      <countNum>
        <!--dependent, xs:integer-->
      </countNum>
      <playDuration>
        <!--dependent, xs:integer, playing duration, unit: second->
      </playDuration>
      <playEndTime>
        <!--optional, xs:string, playing end time (ISO 8601 format)-->
      </playEndTime>
    </ProgramInfo>
    <coordinateType>
      <!--optional, xs:string-->
    </coordinateType>
    <Position>
      <!--optional, position-->
      <positionX>
        <!--required, xs:integer, X position-->
      </positionX>
      <positionY>
        <!--required, xs:integer, Y position-->
      </positionY>
      <height>
        <!--required, xs:integer, height-->
      </height>
      <width>
        <!--required, xs:integer, width-->
      </width>
    </Position>
    <InsertEffect>
      <!--optional, playing effect-->
      <CharactersEffect>
        <!--dependent-->
        <fontSize>
          <!--required, xs:integer-->
        </fontSize>
        <FontColor>
          <!--required, foreground color -->
          <RGB>
            <!--required, xs:integer-->
          </RGB>
        </FontColor>
        <BackColor>
          <!--required, background color -->
          <RGB>
            <!--required, xs:integer-->
          </RGB>
        </BackColor>
        <backTransparent>
          <!--required, xs:integer, transparency-->
        </backTransparent>
        <subtitlesEnabled >
          <!--required, xs:string-->
        </subtitlesEnabled>
        <scrollDirection>
          <!--required, xs:string, scrolling direction-->
        </scrollDirection>
        <scrollSpeed>
          <!--required, xs:integer, scrolling speed-->
        </scrollSpeed>
      </CharactersEffect>
      <pageTime>
        <!--dependent, xs:integer, unit: second-->
      </pageTime>
      <scrollSpeed>
        <!--dependent, xs:integer, scrolling speed-->
      </scrollSpeed>
    </InsertEffect>
    <taskName>
      <!--optional, xs:string, cut-in task name-->
    </taskName>
  </InsertInfo>
  <PlanCtrlParam>
    <!--dependent-->
    <planType >
      <!--required, xs:string, schedule type: "switchPlan"-startup and shutdown schedule, "volumePlan"-volume adjustment schedule, "inputPlan"-auto switch release information-->
    </planType>
    <enabled  >
      <!--required, xs:string, whether to enable-->
    </enabled>
  </PlanCtrlParam>
  <targetType>
    <!--required, xs:string, operation mode: "terminals"-by terminal, "terminalGroups"-by terminal group, "byOrg"-by organization-->
  </targetType>
  <TerminalNoList >
    <!--dependent, terminal ID list-->
    <terminalNo>
      <!--list, required, xs:integer, terminal ID-->
    </terminalNo>
  </TerminalNoList>
  <OrgNoList>
    <!--dependent, organization No. list-->
    <orgNo>
      <!--list, required, xs:integer, organization No.-->
    </orgNo>
  </OrgNoList>
</ControlParam>