简介
本文档提供关于音频降噪任务接口的 API 概览和 SDK 示例代码。
API | 操作描述 |
提交音频降噪任务 |
提交音频降噪任务
功能说明
提交一个音频降噪任务。
方法原型
public Guzzle\\Service\\Resource\\Model createMediaNoiseReductionJobs(array $args = array());
请求示例
示例一:使用模板
<?phprequire dirname(__FILE__, 2) . '/vendor/autoload.php';$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client(array('region' => $region,'schema' => 'https', //协议头部,默认为 http'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {$result = $cosClient->createMediaNoiseReductionJobs(array('Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket'Tag' => 'NoiseReduction','Input' => array('Object' => 'sound01.mp3',),'Operation' => array('TemplateId' => '', // 模板ID'Output' => array('Region' => $region,'Bucket' => 'examplebucket-125000000','Object' => 'NoiseReduction.mp3',),// 'UserData' => 'xxx', // 透传用户信息// 'JobLevel' => '0', // 任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0),// 'CallBack' => '',// 'CallBackFormat' => '',// 'CallBackType' => '',// 'CallBackMqConfig' => array(// 'MqRegion' => '',// 'MqMode' => '',// 'MqName' => '',// ),));// 请求成功print_r($result);} catch (\\Exception $e) {// 请求失败echo($e);}
示例二:自定义参数
<?phprequire dirname(__FILE__, 2) . '/vendor/autoload.php';$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client(array('region' => $region,'schema' => 'https', //协议头部,默认为 http'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {$result = $cosClient->createMediaNoiseReductionJobs(array('Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket'Tag' => 'NoiseReduction','Input' => array('Object' => 'sound01.mp3',),'Operation' => array('NoiseReduction' => array('Format' => '','SampleRate' => '',), // 自定义参数'Output' => array('Region' => $region,'Bucket' => 'examplebucket-125000000','Object' => 'NoiseReduction.mp3',),// 'UserData' => 'xxx', // 透传用户信息// 'JobLevel' => '0', // 任务优先级,级别限制:0 、1 、2。级别越大任务优先级越高,默认为0),// 'CallBack' => '',// 'CallBackFormat' => '',// 'CallBackType' => '',// 'CallBackMqConfig' => array(// 'MqRegion' => '',// 'MqMode' => '',// 'MqName' => '',// ),));// 请求成功print_r($result);} catch (\\Exception $e) {// 请求失败echo($e);}
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Tag | Request | 创建任务的 Tag:NoiseReduction | String | 是 |
Input | Request | 待操作的文件信息 | Container | 是 |
Operation | Request | 操作规则 | Container | 是 |
CallBackFormat | Request | 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式 | String | 否 |
CallBackType | Request | 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型 | String | 否 |
CallBack | Request | 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调 | String | 否 |
CallBackMqConfig | Request | Container | 否 |
Container 类型 Input 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 执行音频降噪任务的文件路径 1. 目前只支持文件大小在10M之内的音频 2. 如果输入为视频文件或者多通道的音频,只会保留单通道的音频流 3. 目前暂不支持m3u8格式输入 | String | 是 |
Container 类型 Operation 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Output | Request.Operation | 结果输出配置 | Container | 是 |
TemplateId | Request.Operation | 降噪任务参数模板Id,不与NoiseReduction同时生效 | String | 否 |
NoiseReduction | Request.Operation | 降噪任务参数,不与TemplateId同时生效 | Container | 否 |
JobLevel | Request.Operation | 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0 | String | 否 |
UserData | Request.Operation | 透传用户信息, 可打印的 ASCII 码, 长度不超过1024 | String | 否 |
说明
对于降噪任务参数,优先使用 TemplateId,无 TemplateId 时使用 NoiseReduction,当 TemplateId 和 NoiseReduction 都不使用时,默认 NoiseReduction.Format 为 wav,NoiseReduction.SampleRate 为 16000
Container 类型 NoiseReduction 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Format | Request.Operation.NoiseReduction | 封装格式,取值:wav、mp3、m4a,默认值为wav | String | 是 |
SampleRate | Request.Operation.NoiseReduction | 采样率,单位Hz,取值:16000,默认值为16000 | String | 是 |
Container 类型 Output 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
Region | Request.Operation.Output | 存储桶的地域 | String | 是 |
Bucket | Request.Operation.Output | 存储结果的存储桶 | String | 是 |
Object | Request.Operation.Output | 输出结果的文件名 | String | 是 |
返回结果示例
GuzzleHttp\\Command\\Result Object([Body] => GuzzleHttp\\Psr7\\Stream Object([stream:GuzzleHttp\\Psr7\\Stream:private] => Resource id #89[size:GuzzleHttp\\Psr7\\Stream:private] =>[seekable:GuzzleHttp\\Psr7\\Stream:private] => 1[readable:GuzzleHttp\\Psr7\\Stream:private] => 1[writable:GuzzleHttp\\Psr7\\Stream:private] => 1[uri:GuzzleHttp\\Psr7\\Stream:private] => php://temp[customMetadata:GuzzleHttp\\Psr7\\Stream:private] => Array())[RequestId] => NjRjYjNjRjMjIxODBfMzUxNGSIOJOIDAJOIDg=[ContentType] => application/xml[ContentLength] => 890[Bucket] => examplebucket-1250000000[Location] => examplebucket-1250000000.ci.ap-guangzhou.myqcloud.com/jobs[Response] => Array([JobsDetail] => Array([Code] => Success[CreationTime] => 2023-08-03T15:05:31+0800[EndTime] => -[Input] => Array([BucketId] => examplebucket-1250000000[Object] => sound01.mp3[Region] => ap-guangzhou)[JobId] => j226pc7a00f19asf798sd7f89s7f2e646[Message] => Array()[Operation] => Array([JobLevel] => 0[NoiseReduction] => Array([Format] => wav[Samplerate] => 16000)[Output] => Array([Bucket] => examplebucket-1250000000[Object] => tmp/NoiseReduction.mp3[Region] => ap-guangzhou)[UserData] => xxx)[QueueId] => p0c99cpc7a00f19asf798sd7f89s7f2e646[QueueType] => Speeching[StartTime] => -[State] => Submitted[Tag] => NoiseReduction)))