开发者指南

视频审核

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权限

代码示例:

$source = 'bos://YourBucket/YourObject';
$config = array(
    'preset' => 'YourPreset',
    'notification' => 'YourNotification'
);
$response = $vcrClient->putMedia($source, $config);

审核 VOD 媒资原视频

根据 VOD 媒资ID直接发起审核。

代码示例:

$source = 'vod://vod-mediaId';
$config = array(
    'preset' => 'YourPreset',
    'notification' => 'YourNotification'
);
$response = $vcrClient->putMedia($source, $config);

审核 VOD 媒资转码后视频

根据 VOD 媒资ID和转码模板名称发起审核。

代码示例:

$source = 'vod://vod-mediaId-preset';
$config = array(
    'preset' => 'YourPreset',
    'notification' => 'YourNotification'
);
$response = $vcrClient->putMedia($source, $config);

审核 URL 视频

根据视频 URL 直接发起审核。

代码示例:

$source = 'http://test.domain.com/dir/video.mp4';
$config = array(
    'preset' => 'YourPreset',
    'notification' => 'YourNotification'
);
$response = $vcrClient->putMedia($source, $config);

说明:发起视频审核时支持配置审核模板和通知名称等可选参数(全部放到$config中),完整参数列表参考VCR API

查询视频审核结果

指定视频路径查询视频的审核结果。

代码示例:

$source = 'vod://vod-mediaId';
$response = $vcrClient->getMedia($source);
echo json_encode($response);

视频审核结果格式和各字段含义参考VCR API

直播审核

发起直播审核

指定直播流地址发起直播审核。

代码示例:

$source = 'stream_url';
$config = array(
    'preset' => 'YourPreset',
    'notification' => 'YourNotification'
);
$response = $vcrClient->putStream($source, $config);

说明:发起直播审核时支持配置审核模板和通知名称。

查询直播审核结果

指定直播流地址查询直播的审核结果。

代码示例:

$source = 'stream_url';
$config = array(
    'startTime' => 'StreamStartTime',
    'endTime' => 'StreamEndTime'
);
$response = $vcrClient->getStream($source, $config);

说明:

直播审核查询支持指定时间段的审核结果查询,如果不设置startTime和endTime默认查询最近1个小时的审核结果。

视频审核结果格式和各字段含义参考VCR API

图片审核

VCR支持 BOS 图片、HTTP图片审核。对于不同来源的视频,需要按照如下规则拼接图片路径source:

  • 对于BOS图片,source=bos://{bucket}/{object}
  • 对于HTTP图片,source={url}

代码示例:

$source = 'image_url';
$response = $vcrClient->putImage($source);

图片审核结果格式和各字段含义参考VCR API

文本审核

对文本进行审核。

代码示例:

$text = 'your_text';
$response = $vcrClient->putText($text);

文本审核结果格式和各字段含义参考VCR API

自定义face库

face库集素材添加

添加库集图片。

代码示例:

$lib = 'lib_name';
$brief = 'brief_name';
$image = 'http://a.jpg';
$response = $vcrClient->addFaceImage($lib, $brief, $image);

face库集素材删除

删除指定的face库集素材,需指定face库集名称。

代码示例:

$lib = 'lib_name';
$brief = 'brief_name';
$image = 'http://a.jpg';
$response = $vcrClient->delFaceImage($lib, $brief, $image);

face库集素材列表

根据face库集名称查询face库集素材列表。

代码示例:

$lib = 'lib_name';
$brief = 'brief_name';
$response = $vcrClient->getFaceBrief($lib, $brief);

face库集删除

根据face库集名称删除face库集。

代码示例:

$lib = 'lib_name';
$brief = 'brief_name';
$response = $vcrClient->delFaceBrief($lib, $brief);

face库集列表查询

根据face库名查询库集名称集合。

代码示例:

$lib = 'lib_name';
$response = $vcrClient->getFaceLib($lib);

自定义face库集格式和各字段含义参考VCR API

自定义logo库

logo库集素材添加

添加库集图片。

代码示例:

$lib = 'lib_name';
$brief = 'brief_name';
$image = 'http://a.jpg';
$response = $vcrClient->addLogoImage($lib, $brief, $image);

logo库集素材删除

删除指定的logo库集素材。

代码示例:

$lib = 'lib_name';
$image = 'http://a.jpg';
$response = $vcrClient->delLogoImage($lib, $image);

logo库集素材列表

根据logo库集名称查询logo库集素材列表。

代码示例:

$lib = 'lib_name';
$brief = 'brief_name';
$response = $vcrClient->getLogoBrief($lib, $brief);

logo库集删除

删除指定的logo库集。

代码示例:

$lib = 'lib_name';
$brief = 'brief_name';
$response = $vcrClient->delLogoBrief($lib, $brief);

logo库列表查询

根据logo库名查询库集合。

代码示例:

$lib = 'lib_name';
$response = $vcrClient->getLogoLib($lib);

自定义face库集格式和各字段含义参考VCR API