XML_PageList

XML message about page information

<PageList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0" >
  <Page>
    <!--list-->
    <id>
      <!--required, xs:integer, page No.-->
    </id>
    <PageBasicInfo>
      <!--required, page basic information-->
      <pageName>
        <!--required, xs:string, page name-->
      </pageName>
      <BackgroundColor>
        <!--required, background color-->
        <RGB>
          <!--required, xs:integer, RGB-->
        </RGB>
      </BackgroundColor>
      <playDurationMode>
        <!--required, xs:string, play mode: custom, auto, or auto-switch, this field is valid only when playDuration exists-->
      </playDurationMode>
      <playDuration>
        <!--dependent, xs:integer, play duration, unit: second-->
      </playDuration>
      <playCount>
        <!--optional, xs:integer-->
      </playCount>
      <switchDuration>
        <!--required, xs:integer, switch interval, unit: second-->
      </switchDuration>
      <switchEffect>
        <!--required, xs:string, switch effect, opt="none,random,boxShrink,boxSpread,cycleShrink,cycSpread,eraseUp,eraseDown,eraseLeft,eraseRight,verticalShelter,horizontalShelter,verticalChessboard,horizontalChessboard,dissolve,leftRightToCenter,ceterToLeftRight,upDownToCenter,centerToUpDown,drawOutLeftDown,drawOutLeftUp,drawOutRightDown,drawOutRightUp,verticalLine,horizontalLine"-->
      </switchEffect>
      <backgroundPic>
        <!--optional, xs:integer, background picture-->
      </backgroundPic>
    </PageBasicInfo>
    <WindowsList>
      <!--optional, window information-->
      <Windows>
        <!--list-->
        <id>
          <!--required, xs:integer, content No.-->
        </id>
        <Position>
          <!--required, content position-->
          <positionX>
            <!--required, xs:integer-->
          </positionX>
          <positionY>
            <!--required, xs:integer-->
          </positionY>
          <height>
            <!--required, xs:integer-->
          </height>
          <width>
            <!--required, xs:integer-->
          </width>
        </Position>
        <layerNo>
          <!--required, xs:integer, layer No.-->
        </layerNo>
        <WinMaterialInfo>
          <!--dependent, material information-->
          <materialType>
            <!--required, xs:string, material type: "static"-local material, "dynamic"-dynamic material, other-->
          </materialType>
          <staticMaterialType>
            <!--dependent, xs:string, local material type: "picture,flash,audio,video,document,ppt,doc,excel,pdf,web,app"; this field is valid only when materialType is "static"-->
          </staticMaterialType>
          <dynamicType>
            <!--dependent, xs:string, local material type: "web,socket,rss,call,dynamicPic,realStream,capturePic,character"; this field is valid only when materialType is "dynamic"-->
          </dynamicType>
          <otherType>
            <!--dependent, xs:string,"clock,weather,countdown,localInput,hyperlinkBtn"-->
          </otherType>
        </WinMaterialInfo>
        <TouchProperty>
          <!--optional, touch attribute-->
          <windType>
            <!--optional, xs:string, window type: "popup"-pop-up, page-->
          </windType>
          <hyperlinkType>
            <!--optional, xs:string, hyperlink type: "window,page"; this field is valid only when windType is "popup"-->
          </hyperlinkType>
          <windowId>
            <!--dependent, xs:integer, window No.; this field is valid only when hyperlinkType is "window"-->
          </windowId>
          <pageId>
            <!--dependent, xs:integer, page No.; this field is valid only when hyperlinkType is "page"-->
          </pageId>
        </TouchProperty>
        <PlayItemList>
          <!--dependent, playing list-->
          <PlayItem>
            <!--required-->
            <id>
              <!--required, xs:integer, playing No.-->
            </id>
            <materialNo>
              <!--dependent, xs:integer, material No., which can be obtained by calling /ISAPI/Publish/MaterialMgr/material by PUT method-->
            </materialNo>
            <inputChannel>
              <!--optional, xs:integer, channel No. of bound IPC (network camera)-->
            </inputChannel>
            <playEffect>
              <!--required, xs:string, playing effect, "none,marquee"-->
            </playEffect>
            <MarqueeInfo>
              <!--dep-->
              <scrollType>
                <!--required, xs:string, marquee scrolling type: none, loops, "once"-scroll once, "backAndForth"-scroll back and forth-->
              </scrollType>
              <scrollDeriction>
                <!--required, xs:string, scrolling direction, "none,up,down,left,right"-->
              </scrollDeriction>
              <scrollSpeed>
                <!--required, xs:integer, scrolling speed-->
              </scrollSpeed>
            </MarqueeInfo>
            <PlayDuration>
              <!--playing duration of material-->
              <durationType>
                <!--required, xs:string, "materialTime,selfDefine"-->
              </durationType>
              <duration>
                <!--required, xs:integer, unit: second-->
              </duration>
            </PlayDuration>
            <CharactersEffect>
              <!--dependent, character display effect, which is valid only when material type is text-->
              <fontSize>
                <!--required, xs:integer, font size -->
              </fontSize>
              <FontColor>
                <!--required, font color-->
                <RGB>
                  <!--required, xs:integer, RGB-->
                </RGB>
              </FontColor>
              <BackColor>
                <!--required, background color-->
                <RGB>
                  <!--required, xs:integer, RGB-->
                </RGB>
              </BackColor>
              <backTransparent>
                <!--required, xs:integer, background transparency-->
              </backTransparent>
              <subtitlesEnabled>
                <!--required, xs:boolean, whether to enable preview-->
              </subtitlesEnabled>
              <scrollDirection>
                <!--required, xs:string, scrolling direction, "left,right,up,down"-->
              </scrollDirection>
              <scrollSpeed>
                <!--required, xs:integer, scrolling speed-->
              </scrollSpeed>
            </CharactersEffect>
            <switchEffect>
              <!--optional, window switch effect, " xs:string,none,leftInRightOut,rightInLeftOut,bottomInTopOut,topInBottomOut,fadeInFadeOut,middleExit,topPop,rightBottomIn,leftTopIn,horizontalOpen,verticalOpen,random"-->
            </switchEffect>
            <pageTime>
              <!--dependent, xs:integer, flip interval, which is invalid only when the staticMaterialType is "word", "ppt", "pdf", or "excel", unit: second -->
            </pageTime>
            <scrollSpeed>
              <!--dependent, xs:integer, scrolling speed, which is invalid when staticMaterialType is "web"-->
            </scrollSpeed>
            <CharactersAttribute>
              <!--dependent, character attribute, which is valid only when dynamicType is "character"-->
              <fontSize>
                <!--optional, xs:integer, font size-->
              </fontSize>
              <FontColor>
                <!--optional, font color-->
                <RGB>
                  <!--optional, xs:integer, RGB-->
                </RGB>
              </FontColor>
              <BackColor>
                <!--optional, background color-->
                <RGB>
                  <!--optional, xs:integer, RGB-->
                </RGB>
              </BackColor>
              <backTransparent>
                <!--optional, xs:integer, background transparency-->
              </backTransparent>
              <alignType>
                <!--optional, xs:string, alignment, "left,right,middle,top,bottom,verticalCenter,horizontallyCenter"-->
              </alignType>
              <characterContent>
                <!--optional, xs:string, content, which is valid only when dynamicType is "character"; the maximum size is 512 bytes-->
              </characterContent>
            </CharactersAttribute>
          </PlayItem>
        </PlayItemList>
        <enabledAudio>
          <!--dependent, xs:boolean, whether to enable playing audio -->
        </enabledAudio>
        <enableHide>
          <!--optional, xs:booelan-->
        </enableHide>
        <enableLock>
          <!--optional, xs:boolean, whether to display to enable locking-->
        </enableLock>
        <AppWindow>
          <!--dependent-->
          <WindowInfoList>
            <!--required-->
            <WindowInfo>
              <!--required-->
              <id>
                <!--required, xs:integer-->
              </id>
              <materialNo>
                <!--required, xs:integer-->
              </materialNo>
            </WindowInfo>
          </WindowInfoList>
        </AppWindow>
        <DataSource>
          <!--dependent, data source, which is valid only when the window type is call or pop-up-->
          <materialNo>
            <!--required, xs:integer-->
          </materialNo>
        </DataSource>
        <Call>
          <!--dependent, call data-->
          <tableRow>
            <!--required, xs:integer, row-->
          </tableRow>
          <tableColumn>
            <!--required, xs:integer, column-->
          </tableColumn>
          <tableDirection>
            <!--required, xs:string, table direction, opt="vertical,horizontal"-->
          </tableDirection>
          <tableType>
            <!--required, xs:string,opt="template1,template2,template3,template4,template5,template6"-->
          </tableType>
          <backPicId>
            <!--optional, xs:integer, it can be obtained by calling /ISAPI/Publish/MaterialMgr/material by PUT method-->
          </backPicId>
          <alignType>
            <!--required, xs:string, alignment type, "left,right,middle"-->
          </alignType>
          <refreshDirection>
            <!--required, xs:string, refresh mode, "upTodown,downToup,leftToright,rightToleft"-->
          </refreshDirection>
          <HeadDataList>
            <!--optional-->
            <HeadData>
              <!--optional,header of call data-->
              <id>
                <!--required, xs:integer-->
              </id>
              <data>
                <!--required, xs:string-->
              </data>
            </HeadData>
          </HeadDataList>
          <ItemStyleList>
            <ItemStyle>
              <!--style of rows and columns in a table-->
              <id>
                <!--required, xs:integer-->
              </id>
              <width>
                <!--required, xs:integer, column width (%)-->
              </width>
              <fontSize min="" max="" >
                <!--required, xs:integer-->
              </fontSize>
              <FontColor>
                <!--required-->
                <RGB>
                  <!--required, xs:integer, RGB-->
                </RGB>
              </FontColor>
              <BackColor>
                <!--required-->
                <RGB>
                  <!--required, xs:integer, RGB-->
                </RGB>
              </BackColor>
            </ItemStyle>
          </ItemStyleList>
        </Call>
        <DynamicPic>
          <!--dependent, pop-up window configuration-->
          <backPicId>
            <!--optional, xs:integer-->
          </backPicId>
        </DynamicPic>
        <CapturePic>
          <!--dep-->
          <backPicId>
            <!--optional, xs:integer-->
          </backPicId>
          <ipcMaterialNo>
            <!--required, xs:integer-->
          </ipcMaterialNo>
          <cancelType>
            <!--required, xs:string,"auto,manual"-->
          </cancelType>
          <duration>
            <!--dependent, xs:integer, unit: second-->
          </duration>
        </CapturePic>
        <ClockParam>
          <!--dependent, clock parameters-->
          <backPicId>
            <!--optional, xs:integer, background picture ID of control-->
          </backPicId>
          <ClockIcon>
            <!--required, icon parameters of clock-->
            <enabled>
              <!--required, xs:boolean, whether to enable clock icon-->
            </enabled>
            <type>
              <!--dependent, xs:string, opt="clock1,clock2,..."-->
            </type>
            <Position>
              <!--dependent, position-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </ClockIcon>
          <YmdParam>
            <!--required,  YY/MM/DD parameters-->
            <enabled>
              <!--required, xs:boolean, whether to display YY/MM/DD -->
            </enabled>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </YmdParam>
          <HmsParam>
            <!--required, time parameters of clock, -->
            <enabled>
              <!--required, xs:boolean, whether to display time-->
            </enabled>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </HmsParam>
          <WeekParam>
            <!--required, week parameters of clock -->
            <enabled>
              <!--required, xs:boolean, whether to display week -->
            </enabled>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </WeekParam>
        </ClockParam>
        <WeatherParam>
          <!--dependent, weather parameters-->
          <backPicId>
            <!--optional, xs:integer, background picture ID-->
          </backPicId>
          <WeatherIcon>
            <!--optional, weather icon information-->
            <enabled>
              <!--required, xs:boolean, -->
            </enabled>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </WeatherIcon>
          <Date>
            <!--optional, date parameters of weather window -->
            <enabled>
              <!--required, xs:boolean, whether to display date -->
            </enabled>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </Date>
          <Temperature>
            <!--optional, temperature parameters of weather window -->
            <enabled>
              <!--required, xs:boolean, whether to display temperature -->
            </enabled>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </Temperature>
          <WeatherContent>
            <!--optional, weather condition parameters of weather window -->
            <enabled>
              <!--required, xs:boolean, whether to display weather condition -->
            </enabled>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </WeatherContent>
          <City>
            <!--optional, city parameters of weather window -->
            <enabled>
              <!--required, xs:boolean, whether to display city parameters -->
            </enabled>
            <cityId>
              <!--required, xs:string-->
            </cityId>
            <cityName>
              <!--required, xs:string-->
            </cityName>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </City>
          <Humidity>
            <!--optional, humidity parameters of weather window -->
            <enabled>
              <!--required, xs:boolean, whether to display humidity -->
            </enabled>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </Humidity>
          <AirQuality>
            <!--optional, air quality parameters of weather window -->
            <enabled>
              <!--required, xs:boolean, whether to display air quality -->
            </enabled>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </AirQuality>
          <UpdateTime>
            <!--optional, updating time parameters -->
            <enabled>
              <!--required, xs:boolean, whether to display updating time -->
            </enabled>
            <refreshTime>
              <!--required, xs:time, updating time (ISO 8601 format)-->
            </refreshTime>
            <updateInterval>
              <!--required, xs:integer, updating interval, unit: minute -->
            </updateInterval>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </UpdateTime>
          <Wind>
            <!--optional, wind power parameters -->
            <enabled>
              <!--required, xs:Boolean, whether to display wind power-->
            </enabled>
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <BackColor>
              <!--required-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </BackColor>
            <Position>
              <!--dep-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </Wind>
        </WeatherParam>
        <Countdown>
          <!--dependent, countdown -->
          <endTime>
            <!--required, xs:time, countdown time (ISO 8601 format)-->
          </endTime>
          <template>
            <!--required, xs:string,"template1,template2…"-->
          </template>
          <timeUnit>
            <!--required, xs:string, time unit, "year,month,day,hour,minute,second" -->
          </timeUnit>
          <backPicId>
            <!--optional, xs:integer-->
          </backPicId>
          <TimeFontCfg>
            <!--optional-->
            <fontSize>
              <!--required, xs:integer-->
            </fontSize>
            <FontColor>
              <!--required, font color-->
              <RGB>
                <!--required, xs:integer, RGB-->
              </RGB>
            </FontColor>
            <Position>
              <!--required-->
              <positionX>
                <!--required, xs:integer-->
              </positionX>
              <positionY>
                <!--required, xs:integer-->
              </positionY>
              <height>
                <!--required, xs:integer-->
              </height>
              <width>
                <!--required, xs:integer-->
              </width>
            </Position>
          </TimeFontCfg>
        </Countdown>
        <localInputNo>
          <!--dependent, xs:string-->
        </localInputNo>
        <HyperlinkBtn>
          <!--dep-->
          <backPicId>
            <!--optional, xs:integer-->
          </backPicId>
        </HyperlinkBtn>
        <CharactersAttribute>
          <!--dependent, this field is valid only when dynamicType is "character"-->
          <fontSize>
            <!--optional, xs:integer, font size-->
          </fontSize>
          <FontColor>
            <!--optional, font color-->
            <RGB>
              <!--optional, xs:integer, RGB-->
            </RGB>
          </FontColor>
          <fontType>
            <!--optional, xs:string, font, "normal,bold" -->
          </fontType>
          <BackColor>
            <!---->
            <RGB>
              <!--optional, xs:integer, RGB-->
            </RGB>
          </BackColor>
          <backTransparent>
            <!--optional, xs:integer, background transparency-->
          </backTransparent>
          <alignType>
            <!--optional, xs:string, alignment, "left,right,middle" -->
          </alignType>
          <verticaAlignType>
            <!--optional, xs:string, vertical alignment, "top,bottom,verticalCenter " -->
          </verticaAlignType>
          <characterContent>
            <!--optional, xs:string, content, the maximum size is 512 bytes -->
          </characterContent>
        </CharactersAttribute>
      </Windows>
    </WindowsList>
  </Page>
</PageList>