多媒体
所有文档

          AR开放平台

          多媒体

          FramePicture

          此类描述json序列帧图片相关字段

          Fields
          number batchNum
          分布加载批次id
          FramePicture keepAspectRatio
          保持随屏节点原有比例大小
          FramePicture offScreenGuidanceTarget
          离屏引导主节点配置开关
          FramePicture offScreenGuidanceNodeConfig
          离屏引导主节点配置
          FramePicture bufferVolume
          图片缓存
          FramePicture children
          子节点
          FramePicture common
          通用material配置
          number depthPosition
          随屏深度信息
          number endNumber
          结束帧的编号
          number frameInterval
          帧间隔时间
          FramePicture framePictureSuppl
          图片序列帧参数配置
          FramePicture hudDisplay
          随屏参数配置
          number marginLeft
          节点(中心点)距离屏幕左边百分比
          number marginTop
          节点(中心点)距离屏幕上方百分比
          FramePicture material
          material配置
          string name
          开发者自定义,建议名称有具体含义
          string pictureFmtExtend
          视频帧图片格式
          string pictureName
          视频帧图片对应名称的前缀
          string picturePath
          视频帧图片对应路径
          string position
          模型在三维空间的位置
          string record
          HUD物体是否录进屏幕
          string rotation
          模型旋转角度
          string scale
          模型在各个方向放大或缩小倍数
          number screenHeightRatio
          节点模型所占屏幕高度百分比
          FramePicture screenRatio
          随屏模型屏占比
          number screenWidthRatio
          节点模型所占屏幕宽度百分比
          number startNumber
          开始帧的编号
          FramePicture textureList
          需要贴图时采用textureList格式
          string texturePath
          贴图路径
          number touchable
          是否可点击
          string type
          当前节点类型
          number visible
          是否显示
          Public methods
          FramePicture FramePictureDemo ()
          FramePicture示例

          FramePictureDemo ()

          FramePicture示例

          sample:
          {
          "name": "custom",
          "type": "framePicture",
          "visible": 1,
          "touchable": 1,
          "batchNum":1,
          "offScreenGuidanceNodeConfig": 
          {
             "offScreenGuidanceTarget":1
          },
          "framePictureSuppl":
          {
             "picturePath": "res/media/custom",
             "pictureName": "xxx",
             "pictureFmtExtend": ".png",
             "startNumber": 1,
             "endNumber": 33,
             "frameInterval": 1,
             "bufferVolume": 10
          },
          "material": 
          {
             "common": 
             {
                "textureList": 
                [
                {
                   "texturePath": "res/texture/xxx1.png"
                }
                ]
             }
          },
          "hudDisplay": 
          {
             "marginLeft": 0,
             "marginTop": 0,
             "depthPosition": 19000,
             "screenRatio": 
             {
             "screenWidthRatio": 1,
             "screenHeightRatio": 1,
             "keepAspectRatio":1
             }
          },
          "record":1,
          "position": "0,0,0",
          "scale": "100,100,100",
          "rotation": "90,0,0",
          "children": []
          }

          batchNum

          version 23

          分布加载批次id

          sample:
          "batchNum":1  

          keepAspectRatio

          version 23

          保持随屏节点原有比例大小, 默认为0,配置为1生效(有"screenWidthRatio"字段,会以此字段计算图片宽度,再反算高度,保持序列帧长宽比不变;无"screenWidthRatio"字段,有"screenHeightRatio"字段,会以screenHeightRatio字段计算序列帧高度,以此反算宽度,保持随屏节点长宽比不变;若两者都无,则宽度高度保持原始图片大小)

          sample:
          keepAspectRatio”:1

          offScreenGuidanceNodeConfig

          version 23

          离屏引导主节点配置,当需要配置该节点为主节点时添加

          sample:
          "offScreenGuidanceNodeConfig":
          {
             "offScreenGuidanceTarget":1
          }

          offScreenGuidanceTarget

          version 23

          离屏引导主节点配置开关 1表示该节点是主节点,0表示不是

          sample:
          详见offScreenGuidanceNodeConfig字段

          bufferVolume

          version 8

          图片缓存

          sample:
          使用见:framePictureSuppl 

          children

          version 8

          子节点,里面元素类型也是node类型,children包含可以包含任意类型的子节点,子节点格式同对应类型的配置一样

          sample:
          "children":[]

          common

          version 8

          通用material配置,其他的有Android和ios平台配置

          sample:
          使用见:material字段 

          depthPosition

          version 8

          随屏深度信息,用于控制多个随屏模型前后的叠加位置, 默认为19000

          sample:
          详见:"hudDisplay"字段

          endNumber

          version 8

          结束帧的编号, 视频帧对应最后一张图片名字的前缀编号, 必选

          sample:
          使用见:framePictureSuppl 

          frameInterval

          version 8

          帧间隔时间, 默认为1

          sample:
          使用见:framePictureSuppl 

          framePictureSuppl

          version 8

          图片序列帧参数配置

          sample:
          "framePictureSuppl":
          {
             "picturePath": "res/media/custom",
             "pictureName": "xxx",
             "pictureFmtExtend": ".png",
             "startNumber": 1,
             "endNumber": 33,
             "frameInterval": 1,
             "bufferVolume": 10
          },

          hudDisplay

          version 8

          随屏参数配置(非随屏元素无需添加该字段)

          sample:
          "hudDisplay": 
          {
             "marginLeft": 0,
             "marginTop": 0,
             "depthPosition": 19000,
             "screenRatio":
              {
                 "screenWidthRatio": 1,
                 "screenHeightRatio": 1
              }
          }

          marginLeft

          version 8

          节点(中心点)距离屏幕左边百分比,取值范围0.0~1.0, 默认为0

          sample:
          详见:"hudDisplay"字段

          marginTop

          version 8

          节点(中心点)距离屏幕上方百分比,取值范围0.0~1.0, 默认为0

          sample:
          详见:"hudDisplay"字段

          material

          version 8

          material配置

          sample:
          "material": 
          {
             "common": 
             {
                "textureList": 
                   [ 
                   {
                    "texturePath": "res/texture/xxx1.png"
                   }
                   ]
             }
          },

          name

          version 8

          开发者自定义,建议名称有具体含义

          sample:
          "name":"xxx"

          pictureFmtExtend

          version 8

          视频帧图片格式 支持png jpg

          sample:
          使用见:framePictureSuppl 

          pictureName

          version 8

          视频帧图片对应名称的前缀

          sample:
          使用见:framePictureSuppl code

          picturePath

          version 8

          视频帧图片对应路径

          sample:
          使用见:framePictureSuppl code

          position

          version 8

          模型在三维空间的位置,三个数分别对应x、y、z坐标,如"1,1,0",默认为"0,0,0" (string 类型)

          sample:
          "position":"1,1,1"

          record

          version 8

          HUD物体是否录进屏幕,默认值是1, 0表示不录进屏幕

          sample:
          "record":"1"

          rotation

          version 8

          模型旋转角度,三个数依次表示绕x、y、z周旋转的角度, 默认为"0,0,0" (string 类型)

          sample:
          "rotation":"90,0,0"
           
          [注意:2D资源在空间中属于水平放置,所以需要X旋转90°,才能看到]

          scale

          version 8

          模型在各个方向放大或缩小倍数,默认为"1,1,1",放大(scale > 1),缩小 (0 < scale < 1) (string 类型)

          sample:
          "scale":"1,1,1"

          screenHeightRatio

          version 8

          节点模型所占屏幕高度百分比, 默认为1

          sample:
          详见:"screenRatio"字段

          screenRatio

          version 8

          随屏模型屏占比,控制在屏幕上显示的大小,该属性会覆盖scale字段

          sample:
          "screenRatio": 
          {
             "screenWidthRatio": 1,
             "screenHeightRatio": 1
          }

          startNumber

          version 8

          开始帧的编号, 视频帧对应第一张图片名字的前缀编号, 必选

          sample:
          使用见:framePictureSuppl code

          textureList

          version 8

          需要贴图时采用textureList格式,不包括视频和pod模型

          sample:
          使用见:material字段 code

          texturePath

          version 8

          贴图路径

          sample:
          使用见:material字段 code

          touchable

          version 8

          是否可点击 (1 可点击 0 不可点击)

          sample:
          "visible":0

          type

          version 8

          当前节点类型

          sample:
          "type":"framePicture"

          visible

          version 8

          是否显示 (1 显示 0 隐藏)

          sample:
          "visible":0

          Video

          此类描述json 视频相关字段

          Fields
          Video batchNum
          分布加载批次id
          Video keepAspectRatio
          保持随屏节点原有比例大小
          Video offScreenGuidanceNodeConfig
          离屏引导主节点配置,当需要配置该节点为主节点时添加
          Video offScreenGuidanceTarget
          离屏引导主节点配置开关
          Video children
          子节点
          Video common
          通用material配置
          Video defaultShaderName
          shader名
          Video depthPosition
          随屏深度信息
          Video hudDisplay
          随屏参数配置(非随屏元素无需添加该字段)
          Video marginLeft
          节点(中心点)距离屏幕左边百分比
          Video marginTop
          节点(中心点)距离屏幕上方百分比
          Video material
          material配置
          Video name
          开发者自定义,建议名称有具体含义
          Video position
          模型在三维空间的位置
          Video record
          HUD物体是否录进屏幕
          Video rotation
          模型旋转角度
          Video scale
          模型在各个方向放大或缩小倍数
          Video screenHeightRatio
          节点模型所占屏幕高度百分比
          Video screenRatio
          随屏模型屏占比
          Video screenWidthRatio
          节点模型所占屏幕宽度百分比
          Video textureType
          贴图类型
          Video touchable
          是否可点击
          Video type
          当前节点类型
          Video uvUnwrapedTextureName
          包裹UV的贴图名称
          Video visible
          是否显示
          Public methods
          Video VideoDemo()
          Video示例

          VideoDemo ()

          Video示例

          sample:
          {
          "name": "custom",
          "type": "video",
          "visible": 1,
          "touchable": 1,
          "batchNum":1,
          "offScreenGuidanceNodeConfig": 
          {
             "offScreenGuidanceTarget":1
          },
          "material": 
          {
             "common": 
             {
                "textureType": "video",
                "uvUnwrapedTextureName": "res/media/xxx.mp4"
             },
             "android": 
             {
                "defaultShaderName": "androidVideoShader",
                "textureType": "video",
                "uvUnwrapedTextureName": "res/media/xxx.mp4"
             }
          },
          "hudDisplay": 
          {
             "marginLeft": 0,
             "marginTop": 0,
             "depthPosition": 19000,
             "screenRatio": 
             {
                "screenWidthRatio": 1,
                "screenHeightRatio": 1,
                "keepAspectRatio":1
             }
          },
          "record":1,
          "position": "0,-0,0",
          "scale": "1,1,1",
          "rotation": "90,0,0",
          "children": []
          },

          batchNum

          version 23

          分布加载批次id

          sample:
          "batchNum":1

          keepAspectRatio

          version 23

          保持随屏节点原有比例大小,默认为0,配置为1生效,生效后使视频默认保持比例为1:1(有"screenWidthRatio"字段,会以此字段计算视频宽度,再反算高度,保持视频长宽比为1:1;无"screenWidthRatio"字段,有"screenHeightRatio"字段,会以screenHeightRatio字段计算视频高度,以此反算宽度,保持视频长宽比为1:1;若两者都无,则宽度高度保持视频原始大小)

          sample:
          keepAspectRatio”:1

          offScreenGuidanceNodeConfig

          version 23

          离屏引导主节点配置,当需要配置该节点为主节点时添加

          sample:
          "offScreenGuidanceNodeConfig": 
          {
          "offScreenGuidanceTarget":1
          }

          offScreenGuidanceTarget

          version 23

          离屏引导主节点配置开关 1表示该节点是主节点,0表示不是

          sample:
          详见offScreenGuidanceNodeConfig字段

          children

          version 8

          子节点,里面元素类型也是node类型,children包含可以包含任意类型的子节点,子节点格式同对应类型的配置一样

          sample:
          "children":[]

          common

          version 8

          通用material配置,其他的有Android和ios平台配置

          sample:
          使用见:material字段 

          defaultShaderName

          version 8

          不同类型根据common_config.json 内name 保持一致即可

          sample:
          使用见:material字段 

          depthPosition

          version 8

          随屏深度信息,用于控制多个随屏模型前后的叠加位置, 默认为19000

          sample:
          详见:"hudDisplay"字段

          hudDisplay

          version 8

          随屏参数配置(非随屏元素无需添加该字段)

          sample:
          "hudDisplay": 
          {
             "marginLeft": 0,
             "marginTop": 0,
             "depthPosition": 19000,
             "screenRatio": 
             {
                "screenWidthRatio": 1,
                "screenHeightRatio": 1
             }
          }

          marginLeft

          version 8

          节点(中心点)距离屏幕左边百分比,取值范围0.0~1.0, 默认为0

          sample:
          "hudDisplay": 
          详见:"hudDisplay"字段

          marginTop

          version 8

          节点(中心点)距离屏幕上方百分比,取值范围0.0~1.0, 默认为0

          sample:
          详见:"hudDisplay"字段

          material

          version 8

          material配置

          sample:
          "material": 
          {
             "common": 
             {
                "textureType": "video",
                "uvUnwrapedTextureName": "res/media/xxx.mp4"
             },
          "android": 
          {
             "defaultShaderName": "androidVideoShader",
             "textureType": "video",
             "uvUnwrapedTextureName": "res/media/xxx.mp4"
          }
          }

          name

          version 8

          开发者自定义,建议名称有具体含义 (string 类型)

          sample:
          "name":"xxx"

          position

          version 8

          模型在三维空间的位置,三个数分别对应x、y、z坐标,如"1,1,0",默认为"0,0,0" (string 类型)

          sample:
          "position":"1,1,1"

          record

          version 8

          HUD物体是否录进屏幕,默认值是1, 0表示不录进屏幕

          sample:
          "record":"1"

          rotation

          version 8

          模型旋转角度,三个数依次表示绕x、y、z周旋转的角度, 默认为"0,0,0" (string 类型)

          sample:
          "rotation":"90,0,0"
          
          [注意:2D资源在空间中属于水平放置,所以需要X旋转90°,才能看到]

          scale

          version 8

          模型在各个方向放大或缩小倍数,默认为"1,1,1",放大(scale > 1),缩小 (0 < scale < 1) (string 类型)

          sample:
          "scale":"1,1,1"

          screenHeightRatio

          version 8

          节点模型所占屏幕高度百分比, 默认为1

          sample:
          详见:"screenRatio"字段

          screenRatio

          version 8

          随屏模型屏占比,控制在屏幕上显示的大小,该属性会覆盖scale字段

          sample:
          "screenRatio": 
          {
             "screenWidthRatio": 1,
             "screenHeightRatio": 1
          }

          screenWidthRatio

          version 8

          节点模型所占屏幕宽度百分比, 默认为1

          sample:
          详见:"screenRatio"字段

          textureType

          version 8

          贴图类型

          sample:
          使用见:material字段

          touchable

          version 8

          是否可点击 (1 可点击 0 不可点击)(number 类型)

          sample:
          "touchable": 1,

          type

          version 8

          当前节点类型 (string 类型)

          sample:
          "type":"Video"

          uvUnwrapedTextureName

          version 8

          包裹UV的贴图名称

          sample:
          使用见:material字段

          visible

          version 8

          是否显示 (1 显示 0 隐藏)(number 类型)

          sample:
          "visible":0
          上一篇
          3D
          下一篇
          光照