开发者指南
视频审核
VCR 支持对BOS视频、VOD媒资、URL视频审核。对于不同来源的视频,需要按照如下规则拼接视频路径source
:
- 对于 BOS 视频,
source=bos://{bucket}/{object}
- 对于 VOD 媒资原视频,
source=vod://{mediaId}
- 对于 VOD 媒资转码后视频,
source="vod://<vod-media-id>-<preset>"
- 对于 URL 视频,
source="<http(s)-url">
发起视频审核
指定视频路径发起视频审核。
审核 BOS 视频
根据BOS bucket和BOS key直接发起审核。需要说明,使用本方法需要将object配置公共GetObject权限,参考设置BOS bucket权限。简述为:在BOS 的控制台中 Bucket 设置-权限设置-自定义权限中添加 VCR 服务账号: fa5f9a177f54454b9076a57c6280f61b。
代码示例:
source = "bos://YourBucket/YourObject"
response = vcr_client.put_media(source)
审核 VOD 媒资原视频
根据 VOD 媒资ID直接发起审核。
代码示例:
source = "vod://vod-mediaId"
response = vcr_client.put_media(source)
审核 VOD 媒资转码后视频
根据 VOD 媒资ID和 VOD 转码模板名称发起审核。
代码示例:
source = "vod://vod-mediaId-preset"
response = vcr_client.put_media(source)
审核 URL 视频
根据视频 URL 直接发起审核。
代码示例:
source = "http://test.domain.com/dir/video.mp4"
response = vcr_client.put_media(source)
审核带鉴权参数的 URL 视频
根据视频 URL 和鉴权参数发起审核。
代码示例:
source = "http://test.domain.com/dir/video.mp4"
auth = "token=424d555d"
response = vcr_client.put_media(source, auth)
审核视频配置审核模板等参数
提交视频时可以配置视频描述、审核模板和通知名称等可选参数。
代码示例:
source = "http://test.domain.com/dir/video.mp4"
auth = "token=424d555d"
description = "this is a test media"
preset = "YourPreset"
notification = "YourNotification"
response = vcr_client.put_media(source, auth=auth, description=description,
preset=preset, notification=notification)
说明:
各参数含义参考VCR API。
查询视频审核结果
指定视频路径查询视频的审核结果。
代码示例:
source = 'vod://vod-mediaId'
response = vcr_client.get_media(source)
视频审核结果格式和各字段含义参考VCR API。
音频审核
发起音频审核
与视频审核类似,提交音频时可以配置音频描述、审核模板和通知名称等可选参数。
代码示例:
source = "audio_url"
preset = "YourPreset"
notification = "YourNotification"
description = "this is a test audio"
response = vcr_client.put_audio(source, description=description, preset=preset, notification=notification)
说明:发起音频审核时支持配置审核模板和通知名称。
查询音频审核结果
指定音频路径查询音频的审核结果。
代码示例:
source = "audio_url"
response = vcr_client.get_audio(source)
音频审核结果格式和各字段含义参考VCR API。
图片审核
VCR 支持BOS图片、HTTP图片审核。对于不同来源的图片,需要按照如下规则拼接图片路径source
:
- 对于BOS图片,
source=bos://{bucket}/{object}
- 对于HTTP图片,
source={url}
同步接口
发起图片审核,同步返回审核结果。
代码示例:
source = "image_url"
preset = "YourPreset"
response = vcr_client.put_image(source, preset)
异步接口
发起异步图片审核
发起图片审核,异步回调审核结果(配置notification时)。
代码示例:
source = "image_url"
preset = "YourPreset"
notification = "YourNotification"
description = "this is a test image"
put_image_async_check(source, description=description, preset=preset, notification=notification)
查询异步图片审核结果
查询异步图片审核的结果。
代码示例:
source = "image_url"
preset = "YourPreset"
response = vcr_client.get_image_async_check_result(source, preset)
图片审核结果格式和各字段含义参考VCR API。
文本审核
对文本进行审核。
代码示例:
text = "your_text"
preset = "YourPreset"
response = vcr_client.put_text(text, preset)
文本审核结果格式和各字段含义参考VCR API。
自定义face库
face库集素材添加
添加库集素材图片。
代码示例:
lib = 'lib_name'
brief = 'brief_name'
image = 'http://a.jpg'
response = vcr_client.add_face_image(lib, brief, image)
face库集素材删除
删除指定的face库集素材,需指定face库集名称。
代码示例:
lib = 'lib_name'
brief = 'brief_name'
image = 'http://a.jpg'
response = vcr_client.del_face_image(lib, brief, image)
face库集素材列表
根据face库集名称查询face库集素材列表。
代码示例:
lib = 'lib_name'
brief = 'brief_name'
response = vcr_client.get_face_brief(lib, brief)
face库集删除
根据face库集名称删除face库集。
代码示例:
lib = 'lib_name'
brief = 'brief_name'
response = vcr_client.del_face_brief(lib, brief)
face库列表查询
根据face库名查询库集合。
代码示例:
lib = 'lib_name'
response = vcr_client.get_face_lib(lib)
自定义face库集格式和各字段含义参考VCR API。
自定义logo库
logo库集素材添加
添加库集图片。
代码示例:
lib = 'lib_name'
brief = 'brief_name'
image = 'http://a.jpg'
response = vcr_client.add_logo_image(lib, brief, image)
logo库集素材删除
删除指定的logo库集素材。
代码示例:
lib = 'lib_name'
image = 'http://a.jpg'
response = vcr_client.del_logo_image(lib, image)
logo库集素材列表
根据logo库集名称查询logo库集素材列表。
代码示例:
lib = 'lib_name'
brief = 'brief_name'
response = vcr_client.get_logo_brief(lib, brief)
logo库集删除
删除指定的logo库集。
代码示例:
lib = 'lib_name'
brief = 'brief_name'
response = vcr_client.del_logo_brief(lib, brief)
logo库列表查询
根据logo库名查询库集合。
代码示例:
lib = 'lib_name'
response = vcr_client.get_logo_lib(lib)
自定义logo库集格式和各字段含义参考VCR API。