照片OSD设置
PUT
http://ip:port/LAPI/V1.0/Media/PicOSD?BaseCfgType=0
接口描述
照片OSD设置
请求参数
参数名
类型
描述
必填
FontSpace
int
叠加字间间隔，取值范围[0,10]，单位：像素
必填
Mode
int
OSD叠加模式，对外接口不涉及操作，默认填充0即可
必填
OSDPrame
int
OSD基本参数，对外接口不涉及操作，默认填充0即可
必填
OSDSource
int
OSD来源，对外接口不涉及操作，默认填充0即可
必填
BaseCfgType
int
OSD配置类型，对外接口不涉及操作，默认填充0即可
必填
BackColor
int
字体背景颜色，RGB格式，仅当字体风格为背景类型时该字段生效，例：16777215（0xffffff）代表白色
必填
FontStyle
int
字体风格，涉及：0-背景；1-描边；2-空心；3-正常；4-反色
必填
FontSize
int
字体大小，涉及：0-大；1-中；2-小；3-超大
必填
FontType
int
字体，对外接口不涉及操作，默认填充0即可
必填
Color
int
字体颜色，RGB格式，例：0（0x000000）代表黑色
必填
Alpha
int
字体透明度，对外接口不涉及操作，默认填充0即可
必填
TimeFormat
int
时间格式，涉及：0-hh:mm:ss；5-hh:mm:ss.aaa
必填
DateFormat
int
日期格式，涉及：0-yyyy-mm-dd；1-mm-dd-yyyy；2-yyyy年mm月dd日；3-mm月dd日yyyy年；4-yyyy年mm月dd日 星期x
必填
OSDNum
int
OSD配置项数目
必填
OSDType
int
OSD类型，涉及：0-时间（格式由OSDStyle中时间及日期配置决定）；8-车牌号码；110-自定义内容1；111-自定义内容2
必填
Enable
int
配置使能，涉及：0-不使能；1-使能
必填
SpaceNum
int
可空格数，对外接口不涉及操作，默认填充1即可
必填
NewLineNum
int
可换行数，对外接口不涉及操作，默认填充0即可
必填
Location
int
对外接口不涉及操作，默认填充0即可
必填
AreaIndex
int
叠加区域，取值范围[1,7]，对应区域1-8
必填
OSDName
string
OSDType为110或111时，该字段为自定义填充的内容，其余类型默认填充""即可
必填
OSDForm
string
对外接口不涉及操作，默认填充""即可
必填
响应参数
参数名
类型
描述
必填
ResponseURL
string
响应URL，例：/LAPI/V1.0/Media/PicOSD?BaseCfgType=0
必填
CreatedID
int
仅新增订阅用户时，该字段有意义，其余无意义，默认：-1
必填
ResponseCode
int
响应结果码，涉及：0-成功；1-通用错误；2-参数非法；3-未鉴权；4-设备不支持
必填
SubResponseCode
int
子响应结果，仅ResponseCode为3时字段有意义，涉及：0-正常鉴权失败；1-需要二次鉴权
必填
ResponseString
string
响应结果描述，涉及：0-Succeed；1-Common Error；2-Invalid Arguments；3-Not Authorized；4-Not Supported
必填
StatusCode
int
标准响应码，涉及：200；401
必填
StatusString
string
响应描述，涉及：200-Succeed；401-Unauthorized
必填
Data
string
数据
必填