Transcoder API v1 - Package cloud.google.com/go/video/transcoder/apiv1 (v1.27.1)

Note: To get more information about this package, such as access to older versions, viewthis package on pkg.go.dev.

Package transcoder is an auto-generated package for theTranscoder API.

This API converts video files into formats suitable for consumerdistribution. For more information, see the TranscoderAPI overview (athttps://cloud.google.com/transcoder/docs/concepts/overview).

General documentation

For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/video/transcoder/apiv1@latestctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed.The methods of Client are safe for concurrent use by multiple goroutines.The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client, mentioned above.

req:=&transcoderpb.CreateJobRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#CreateJobRequest.}resp,err:=c.CreateJob(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp

Use of Context

The ctx passed to NewClient is used for authentication requests andfor creating the underlying connection, but is not used for subsequent calls.Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Functions

func DefaultAuthScopes

funcDefaultAuthScopes()[]string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

CallOptions

typeCallOptionsstruct{CreateJob[]gax.CallOptionListJobs[]gax.CallOptionGetJob[]gax.CallOptionDeleteJob[]gax.CallOptionCreateJobTemplate[]gax.CallOptionListJobTemplates[]gax.CallOptionGetJobTemplate[]gax.CallOptionDeleteJobTemplate[]gax.CallOption}

CallOptions contains the retry settings for each method of Client.

Client

typeClientstruct{// The call options for this service.CallOptions*CallOptions// contains filtered or unexported fields}

Client is a client for interacting with Transcoder API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Using the Transcoder API, you can queue asynchronous jobs for transcodingmedia into various output formats. Output formats may include differentstreaming standards such as HTTP Live Streaming (HLS) and Dynamic AdaptiveStreaming over HTTP (DASH). You can also customize jobs using advancedfeatures such as Digital Rights Management (DRM), audio equalization, contentconcatenation, and digital ad-stitch ready content generation.

func NewClient

funcNewClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewClient creates a new transcoder service client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.

Using the Transcoder API, you can queue asynchronous jobs for transcodingmedia into various output formats. Output formats may include differentstreaming standards such as HTTP Live Streaming (HLS) and Dynamic AdaptiveStreaming over HTTP (DASH). You can also customize jobs using advancedfeatures such as Digital Rights Management (DRM), audio equalization, contentconcatenation, and digital ad-stitch ready content generation.

Example

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func NewRESTClient

funcNewRESTClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewRESTClient creates a new transcoder service rest client.

Using the Transcoder API, you can queue asynchronous jobs for transcodingmedia into various output formats. Output formats may include differentstreaming standards such as HTTP Live Streaming (HLS) and Dynamic AdaptiveStreaming over HTTP (DASH). You can also customize jobs using advancedfeatures such as Digital Rights Management (DRM), audio equalization, contentconcatenation, and digital ad-stitch ready content generation.

Example

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func (*Client) Close

func(c*Client)Close()error

Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.

func (*Client) Connection (deprecated)

func(c*Client)Connection()*grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.

func (*Client) CreateJob

CreateJob creates a job in the specified region.

Example

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.CreateJobRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#CreateJobRequest.}resp,err:=c.CreateJob(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) CreateJobTemplate

CreateJobTemplate creates a job template in the specified region.

Example

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.CreateJobTemplateRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#CreateJobTemplateRequest.}resp,err:=c.CreateJobTemplate(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) DeleteJob

DeleteJob deletes a job.

Example

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.DeleteJobRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#DeleteJobRequest.}err=c.DeleteJob(ctx,req)iferr!=nil{// TODO: Handle error.}}

func (*Client) DeleteJobTemplate

DeleteJobTemplate deletes a job template.

Example

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.DeleteJobTemplateRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#DeleteJobTemplateRequest.}err=c.DeleteJobTemplate(ctx,req)iferr!=nil{// TODO: Handle error.}}

func (*Client) GetJob

GetJob returns the job data.

Example

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.GetJobRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#GetJobRequest.}resp,err:=c.GetJob(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetJobTemplate

GetJobTemplate returns the job template data.

Example

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.GetJobTemplateRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#GetJobTemplateRequest.}resp,err:=c.GetJobTemplate(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) ListJobTemplates

ListJobTemplates lists job templates in the specified region.

Examples

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.ListJobTemplatesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#ListJobTemplatesRequest.}it:=c.ListJobTemplates(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*transcoderpb.ListJobTemplatesResponse)}}
all
packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.ListJobTemplatesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#ListJobTemplatesRequest.}forresp,err:=rangec.ListJobTemplates(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) ListJobs

ListJobs lists jobs in the specified region.

Examples

packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.ListJobsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#ListJobsRequest.}it:=c.ListJobs(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*transcoderpb.ListJobsResponse)}}
all
packagemainimport("context"transcoder"cloud.google.com/go/video/transcoder/apiv1"transcoderpb"cloud.google.com/go/video/transcoder/apiv1/transcoderpb")funcmain(){ctx:=context.Background()// This snippet 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 as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=transcoder.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&transcoderpb.ListJobsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/video/transcoder/apiv1/transcoderpb#ListJobsRequest.}forresp,err:=rangec.ListJobs(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

JobIterator

typeJobIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*transcoderpb.Job,nextPageTokenstring,errerror)// contains filtered or unexported fields}

JobIterator manages a stream of *transcoderpb.Job.

func (*JobIterator) All

func(it*JobIterator)All()iter.Seq2[*transcoderpb.Job,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*JobIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*JobIterator) PageInfo

func(it*JobIterator)PageInfo()*iterator.PageInfo

PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.

JobTemplateIterator

typeJobTemplateIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// InternalFetch is for use by the Google Cloud Libraries only.// It is not part of the stable interface of this package.//// InternalFetch returns results from a single call to the underlying RPC.// The number of results is no greater than pageSize.// If there are no more results, nextPageToken is empty and err is nil.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*transcoderpb.JobTemplate,nextPageTokenstring,errerror)// contains filtered or unexported fields}

JobTemplateIterator manages a stream of *transcoderpb.JobTemplate.

func (*JobTemplateIterator) All

func(it*JobTemplateIterator)All()iter.Seq2[*transcoderpb.JobTemplate,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*JobTemplateIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*JobTemplateIterator) PageInfo

func(it*JobTemplateIterator)PageInfo()*iterator.PageInfo

PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.