Reference documentation and code samples for the Google Cloud Video Transcoder V1 Client class TranscoderServiceClient.
Service Description: Using the Transcoder API, you can queue asynchronous jobs for transcoding media into various output formats. Output formats may include different streaming standards such as HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can also customize jobs using advanced features such as Digital Rights Management (DRM), audio equalization, content concatenation, and digital ad-stitch ready content generation.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$transcoderServiceClient = new TranscoderServiceClient();
try {
$formattedParent = $transcoderServiceClient->locationName('[PROJECT]', '[LOCATION]');
$job = new Job();
$response = $transcoderServiceClient->createJob($formattedParent, $job);
} finally {
$transcoderServiceClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This service has a new (beta) implementation. See Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient to use the new surface.
Namespace
Google \ Cloud \ Video \ Transcoder \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createJob
Creates a job in the specified region.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent location to create and process this job.
Format: |
job |
Google\Cloud\Video\Transcoder\V1\Job
Required. Parameters for creating transcoding job. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Video\Transcoder\V1\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\CreateJobRequest;
use Google\Cloud\Video\Transcoder\V1\Job;
/**
* @param string $formattedParent The parent location to create and process this job.
* Format: `projects/{project}/locations/{location}`
* Please see {@see TranscoderServiceClient::locationName()} for help formatting this field.
*/
function create_job_sample(string $formattedParent): void
{
// Create a client.
$transcoderServiceClient = new TranscoderServiceClient();
// Prepare the request message.
$job = new Job();
$request = (new CreateJobRequest())
->setParent($formattedParent)
->setJob($job);
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $transcoderServiceClient->createJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = TranscoderServiceClient::locationName('[PROJECT]', '[LOCATION]');
create_job_sample($formattedParent);
}
createJobTemplate
Creates a job template in the specified region.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent location to create this job template.
Format: |
jobTemplate |
Google\Cloud\Video\Transcoder\V1\JobTemplate
Required. Parameters for creating job template. |
jobTemplateId |
string
Required. The ID to use for the job template, which will become the final component of the job template's resource name. This value should be 4-63 characters, and valid characters must match the
regular expression |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Video\Transcoder\V1\JobTemplate |
use Google\ApiCore\ApiException;
use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\CreateJobTemplateRequest;
use Google\Cloud\Video\Transcoder\V1\JobTemplate;
/**
* @param string $formattedParent The parent location to create this job template.
* Format: `projects/{project}/locations/{location}`
* Please see {@see TranscoderServiceClient::locationName()} for help formatting this field.
* @param string $jobTemplateId The ID to use for the job template, which will become the final
* component of the job template's resource name.
*
* This value should be 4-63 characters, and valid characters must match the
* regular expression `[a-zA-Z][a-zA-Z0-9_-]*`.
*/
function create_job_template_sample(string $formattedParent, string $jobTemplateId): void
{
// Create a client.
$transcoderServiceClient = new TranscoderServiceClient();
// Prepare the request message.
$jobTemplate = new JobTemplate();
$request = (new CreateJobTemplateRequest())
->setParent($formattedParent)
->setJobTemplate($jobTemplate)
->setJobTemplateId($jobTemplateId);
// Call the API and handle any network failures.
try {
/** @var JobTemplate $response */
$response = $transcoderServiceClient->createJobTemplate($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = TranscoderServiceClient::locationName('[PROJECT]', '[LOCATION]');
$jobTemplateId = '[JOB_TEMPLATE_ID]';
create_job_template_sample($formattedParent, $jobTemplateId);
}
deleteJob
Deletes a job.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the job to delete.
Format: |
optionalArgs |
array
Optional. |
↳ allowMissing |
bool
If set to true, and the job is not found, the request will succeed but no action will be taken on the server. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\DeleteJobRequest;
/**
* @param string $formattedName The name of the job to delete.
* Format: `projects/{project}/locations/{location}/jobs/{job}`
* Please see {@see TranscoderServiceClient::jobName()} for help formatting this field.
*/
function delete_job_sample(string $formattedName): void
{
// Create a client.
$transcoderServiceClient = new TranscoderServiceClient();
// Prepare the request message.
$request = (new DeleteJobRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$transcoderServiceClient->deleteJob($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = TranscoderServiceClient::jobName('[PROJECT]', '[LOCATION]', '[JOB]');
delete_job_sample($formattedName);
}
deleteJobTemplate
Deletes a job template.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the job template to delete.
|
optionalArgs |
array
Optional. |
↳ allowMissing |
bool
If set to true, and the job template is not found, the request will succeed but no action will be taken on the server. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\DeleteJobTemplateRequest;
/**
* @param string $formattedName The name of the job template to delete.
* `projects/{project}/locations/{location}/jobTemplates/{job_template}`
* Please see {@see TranscoderServiceClient::jobTemplateName()} for help formatting this field.
*/
function delete_job_template_sample(string $formattedName): void
{
// Create a client.
$transcoderServiceClient = new TranscoderServiceClient();
// Prepare the request message.
$request = (new DeleteJobTemplateRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$transcoderServiceClient->deleteJobTemplate($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = TranscoderServiceClient::jobTemplateName(
'[PROJECT]',
'[LOCATION]',
'[JOB_TEMPLATE]'
);
delete_job_template_sample($formattedName);
}
getJob
Returns the job data.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the job to retrieve.
Format: |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Video\Transcoder\V1\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\GetJobRequest;
use Google\Cloud\Video\Transcoder\V1\Job;
/**
* @param string $formattedName The name of the job to retrieve.
* Format: `projects/{project}/locations/{location}/jobs/{job}`
* Please see {@see TranscoderServiceClient::jobName()} for help formatting this field.
*/
function get_job_sample(string $formattedName): void
{
// Create a client.
$transcoderServiceClient = new TranscoderServiceClient();
// Prepare the request message.
$request = (new GetJobRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $transcoderServiceClient->getJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = TranscoderServiceClient::jobName('[PROJECT]', '[LOCATION]', '[JOB]');
get_job_sample($formattedName);
}
getJobTemplate
Returns the job template data.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the job template to retrieve.
Format:
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Video\Transcoder\V1\JobTemplate |
use Google\ApiCore\ApiException;
use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\GetJobTemplateRequest;
use Google\Cloud\Video\Transcoder\V1\JobTemplate;
/**
* @param string $formattedName The name of the job template to retrieve.
* Format:
* `projects/{project}/locations/{location}/jobTemplates/{job_template}`
* Please see {@see TranscoderServiceClient::jobTemplateName()} for help formatting this field.
*/
function get_job_template_sample(string $formattedName): void
{
// Create a client.
$transcoderServiceClient = new TranscoderServiceClient();
// Prepare the request message.
$request = (new GetJobTemplateRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var JobTemplate $response */
$response = $transcoderServiceClient->getJobTemplate($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = TranscoderServiceClient::jobTemplateName(
'[PROJECT]',
'[LOCATION]',
'[JOB_TEMPLATE]'
);
get_job_template_sample($formattedName);
}
listJobTemplates
Lists job templates in the specified region.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent location from which to retrieve the collection of job
templates. Format: |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
The filter expression, following the syntax outlined in https://google.aip.dev/160. |
↳ orderBy |
string
One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\JobTemplate;
use Google\Cloud\Video\Transcoder\V1\ListJobTemplatesRequest;
/**
* @param string $formattedParent The parent location from which to retrieve the collection of job
* templates. Format: `projects/{project}/locations/{location}`
* Please see {@see TranscoderServiceClient::locationName()} for help formatting this field.
*/
function list_job_templates_sample(string $formattedParent): void
{
// Create a client.
$transcoderServiceClient = new TranscoderServiceClient();
// Prepare the request message.
$request = (new ListJobTemplatesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $transcoderServiceClient->listJobTemplates($request);
/** @var JobTemplate $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = TranscoderServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_job_templates_sample($formattedParent);
}
listJobs
Lists jobs in the specified region.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. Format: |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
The filter expression, following the syntax outlined in https://google.aip.dev/160. |
↳ orderBy |
string
One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Video\Transcoder\V1\Client\TranscoderServiceClient;
use Google\Cloud\Video\Transcoder\V1\Job;
use Google\Cloud\Video\Transcoder\V1\ListJobsRequest;
/**
* @param string $formattedParent Format: `projects/{project}/locations/{location}`
* Please see {@see TranscoderServiceClient::locationName()} for help formatting this field.
*/
function list_jobs_sample(string $formattedParent): void
{
// Create a client.
$transcoderServiceClient = new TranscoderServiceClient();
// Prepare the request message.
$request = (new ListJobsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $transcoderServiceClient->listJobs($request);
/** @var Job $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = TranscoderServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_jobs_sample($formattedParent);
}
static::jobName
Formats a string containing the fully-qualified path to represent a job resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
job |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted job resource. |
static::jobTemplateName
Formats a string containing the fully-qualified path to represent a job_template resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
jobTemplate |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted job_template resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted location resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- job: projects/{project}/locations/{location}/jobs/{job}
- jobTemplate: projects/{project}/locations/{location}/jobTemplates/{job_template}
- location: projects/{project}/locations/{location}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |
Constants
SERVICE_NAME
Value: 'google.cloud.video.transcoder.v1.TranscoderService'
The name of the service.
SERVICE_ADDRESS
Value: 'transcoder.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.