XML_Cap_Material

XML message about material management parameter capability

<Material version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
    <id><!--required, xs:integer, material ID--></id>
    <seq min="" max=""><!--optional, xs:integer, material serial No., which changes every time the material is modified; this field is only valid on the link between the server and the terminal--></seq>
    <materialName max=""><!--required, xs:string, material name--></materialName>
    <materialRemarks max=""><!--required, xs:string, material description--></materialRemarks>
    <materialType opt="static,dynamic"><!--required, xs:string, material type: "static"-local material, "dynamic"-dynamic material--></materialType>
    <approveState opt="approved,notPass,notApprove"><!--optional, xs:string, approval status: "approved"-pass, "notPass"-not pass, "notApprove"-not approved--></approveState>
    <approveRemarks max=""><!--optional, xs:string, approval remarks--></approveRemarks>
    <shareProperty opt="static,dynamic"><!--optional, xs:string, shared property: public, private--></shareProperty>
    <uploadUser max=""><!--ro,required, xs:string, uploader, read-only--></uploadUser>
    <uploadTime><!--read-only,  required, xs:time, upload time (ISO 8601 format)--></uploadTime>
    <materialEncrypt min="" max=""><!--optional, xs:integer, material secret key, which can be used for verifying the correctness of materials received by the terminal; this field is only valid on the link between the server and the terminal, e.g., JjEmNTA3NDg5NCY0JjI3OTM5MjAmYWEmMzYyOTM5OCZhMCY0MjAzMDQwJmI1JjQzMzc3ODgmNDg=--></materialEncrypt>
    <orgNo><!--optional, xs:integer, organization No.--></orgNo>
    <orgName><!--optional, xs:string, read-only--></orgName>
    <replaceTerminal opt="true,false"><!--optional, xs:boolean, whether to update the material to the terminal, this field is valid only when replacing materials--></replaceTerminal>
    <StorageInfo><!--optional, this field is valid only when the materials saved on the storage server-->
      <storageType min="" max=""><!--optional, xs:string, storage mode, "fms,kms,cloud,minio"--></storageType>
      <host min="" max=""><!--optional, xs:string, storage mode, https://[ip]:[port][coded string]--></host>
      <accountName min="" max=""><!--optional, xs:string, account name, which should be encrypted--></accountName>
      <accountPasswd min="" max=""><!--optional, xs:string, account password, which should be encrypted--></accountPasswd>
      <bucket min="" max=""><!--optional, xs:string, bucket , this field is valid only when storageType is "minio"--></bucket>
    </StorageInfo>
    <StaticMaterial opt="picture,flash,audio,video,document,ppt,doc,excel,pdf,web"><!--dep-->
        <staticMaterialType opt="picture,flash,audio,video,document,ppt,doc,excel,pdf,web">
        <!--dependent, xs:string,  local material type-->
      </staticMaterialType>
        <picFormat opt="gif,bmp,jpg,png"><!--dependent, xs:string, image format--></picFormat>
        <flashFormat opt="swf"><!--dependent, xs:string, flash format--></flashFormat>
        <audioFormat opt="mp3,wav,wma"><!--dependent, xs:string, audio format--></audioFormat>
        <videoFormat opt="rm,rmvb,asf,avi,mpg,3gp,mov,mkv,wmv,flv,mp4"><!--dependent, xs:string, video format--></videoFormat>
        <documentFormat opt="txt"><!--dependent, xs:string, document format--></documentFormat>
        <pptFormat opt="ppt,pptx"><!--dependent, xs:string, slide format--></pptFormat>
        <docFormat opt="doc,docx"><!--dependent, xs:string, word document format--></docFormat>
        <excelFormat opt="xls,xlsx"><!--dependent, xs:string, table format--></excelFormat>
        <pdfFormat opt="pdf"><!--dependent, xs:string, PDF--></pdfFormat>
        <webFormat opt="html,htm"><!--dependent, xs:string, web file format--></webFormat>
        <fileSize max=""><!--required, xs:integer, unit:byte, file size--></fileSize>
        <duration max=""><!--optional, xs:integer, unit:seconds, material playing duration, this field is valid only when the material is a video or slide--></duration>
        <uuid min="" max=""><!--dependent, xs:string, UUID provided by the server to identify the material, this field is valid only when StorageInfo exists; only 8520 platform saves materials on the storage server--></uuid>
        <staticMaterialUrl min="" max=""><!--dependent, xs:string, material URL, this field is valid only when StorageInfo exists; only 8520 platform saves materials on the storage server--></staticMaterialUrl>
    </StaticMaterial>
    <DynamicMaterial><!--dependent-->
        <dynamicMaterialType opt="web,socket,rss,realStream,generalData,picUrl,dataSource"><!--dependent, xs:string, dynamic material type--></dynamicMaterialType>
        <webUrl><!--dependent, xs:string, web URL--></webUrl>
        <rssUrl><!--dependent, xs:string, RSS URL--></rssUrl>
        <picUrl><!--dependent, xs:string, picture URL--></picUrl>
        <RealStream><!--dependent,  real stream-->
            <destionType opt="streamMedia,normalIPC"><!--required, xs:string, streaming terminal type: Stream Media Server, normal network camera--></destionType>
            <streamMediaUrl><!--dependent, xs:string, streaming server URL--></streamMediaUrl>
            <NormalIPC><!--dep-->
                <IpAddress><!--dep-->
                    <ipVersion opt="v4,v6,dual"><!--required, xs:string--></ipVersion>
                    <ipAddress><!--dependent, xs:string--></ipAddress>
                    <ipv6Address><!--dependent, xs:string--></ipv6Address>
                </IpAddress>
                <portNo><!--required, xs:integer--></portNo>
                <channelNo><!--required, xs:integer, channel No.--></channelNo>
                <userName min="" max=""><!--required, xs:string, user name for logging to devices, which is write-only and must be encrypted when transmission--></userName>
                <passWord min="" max=""><!--required, xs:string, password for logging to devices, which is write-only and must be encrypted when transmission--></passWord>
                <transmitProtocol opt="tcp,udp,mcast"><!--optional, xs:string, transmission protocol--></transmitProtocol>
                <streamType opt="main,sub,third"><!--optional, xs:string, stream type--></streamType>
            </NormalIPC>
            <dataType opt="capture,liveVideo"><!--optional, xs:string, data type: capture, "liveVideo"-live video--></dataType>
        </RealStream>
        <GeneralData><!--dependent, third-party data-->
            <SrcAddress><!--IP address of data source -->
                <ipVersion opt="v4,v6,dual"><!--required, xs:string, IP address type--></ipVersion>
                <ipAddress><!--dependent, xs:string--></ipAddress>
                <ipv6Address><!--dependent, xs:string, IPv6 address--></ipv6Address>
            </SrcAddress>
            <dataType opt="popPic,call"><!--optional, xs:string, third-party data type: "popPic"-pop-up image, call--></dataType>
        </GeneralData>
        <dataSourceUrl min="" max=""><!--dependent, xs:string, data source URL, this field is valid only when the material is data source and StorageInfo exists; only 8520 platform saves materials on the storage server--></dataSourceUrl>
    </DynamicMaterial>
</Material>