tencent cloud

Overview

This document provides an overview of APIs and SDK code samples for submitting a voice/sound separation job.

Submitting Voice/Sound Separation Job

Feature description

This API is used to submit a voice/sound separation job.

Method prototype

public Guzzle\Service\Resource\Model createMediaVoiceSeparateJobs(array $args = array());

Sample request

Sample 1. Using a template

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual `SecretId`, which can be viewed and managed in the CAM console at https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual `SecretKey`, which can be viewed and managed in the CAM console at https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; // Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket.
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol, which is `http` by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));
try {
  $result = $cosClient->createMediaVoiceSeparateJobs(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-Appid`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
      'Tag' => 'VoiceSeparate',
      'QueueId' => '',
      'CallBack' => '',
      'Input' => array(
          'Object' => 'test.mp3'
      ),
      'Operation' => array(
          'TemplateId' => '',
          'Output' => array(
              'Region' => $region,
              'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-Appid`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
              'Object' => 'VoiceSeparate01.mp3',
              'AuObject' => 'VoiceSeparate02.mp3',
          ),
//            'UserData' => 'xxx', // The user information passed through.
//            'JobLevel' => '0', // Job priority. The greater the value, the higher the priority. Valid values: `0`, `1`, `2`. Default value: `0`.
      ),
  ));
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo($e);
}

Sample 2. Customizing parameters

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual `SecretId`, which can be viewed and managed in the CAM console at https://console.tencentcloud.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual `SecretKey`, which can be viewed and managed in the CAM console at https://console.tencentcloud.com/cam/capi
$region = "ap-beijing"; // Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket.
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol, which is `http` by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));
try {
  $result = $cosClient->createMediaVoiceSeparateJobs(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-Appid`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
      'Tag' => 'VoiceSeparate',
      'QueueId' => '',
      'CallBack' => '',
      'Input' => array(
          'Object' => 'test.mp3'
      ),
      'Operation' => array(
          'Output' => array(
              'Region' => $region,
              'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-Appid`, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket.
              'Object' => 'VoiceSeparate01.mp3',
              'AuObject' => 'VoiceSeparate02.mp3',
          ),
          'VoiceSeparate' => array(
              'AudioMode' => 'AudioAndBackground',
              'AudioConfig' => array(
                  'Codec' => 'mp3',
                  'Samplerate' => '11025',
                  'Bitrate' => '256',
                  'Channels' => '2',
              ),
          ),
//            'UserData' => 'xxx', // The user information passed through.
//            'JobLevel' => '0', // Job priority. The greater the value, the higher the priority. Valid values: `0`, `1`, `2`. Default value: `0`.
      ),
  ));
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo($e);
}

Parameter description

Request has the following sub-nodes:

Input has the following sub-nodes:

Operation has the following sub-nodes:

Note：

TemplateId is used first. If TemplateId is unavailable, VoiceSeparate is used.

VoiceSeparate has the following sub-nodes:

Output has the following sub-nodes:

Sample response

GuzzleHttp\Command\Result Object
(
  [Body] => GuzzleHttp\Psr7\Stream Object
      (
          [stream:GuzzleHttp\Psr7\Stream:private] => Resource id #88
          [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] => NjI2MjIyOTHADOHDOADJHOjQ0OV8yMmU0OWM=
  [ContentType] => application/xml
  [ContentLength] => 857
  [Bucket] => examplebucket-1250000000
  [Location] => examplebucket-1250000000.ci.ap-beijing.myqcloud.com/jobs
  [Response] => Array
      (
          [JobsDetail] => Array
              (
                  [Code] => Success
                  [CreationTime] => 2022-04-22T11:35:47+0800
                  [EndTime] => -
                  [Input] => Array
                      (
                          [BucketId] => examplebucket-1250000000
                          [Object] => test.mp3
                          [Region] => ap-beijing
                      )
                   [JobId] => j4c70446zxc780z98xc09zxc6eb232
                  [Message] => 
                  [Operation] => Array
                      (
                          [Output] => Array
                              (
                                  [AuObject] => VoiceSeparate02.mp3
                                  [Bucket] => examplebucket-1250000000
                                  [Object] => VoiceSeparate01.mp3
                                  [Region] => ap-beijing
                              )
                           [TemplateId] => t1456ea89fczx8c0z8c09z8c0985
                          [TemplateName] => VoiceSeparate-1
                          [UserData] => xxx
                          [JobLevel] => 0
                      )
                   [QueueId] => p81e648af2azc709zx8c09z8xc0z7be086
                  [StartTime] => -
                  [State] => Submitted
                  [Tag] => VoiceSeparate
              )
       )
)