Class v1.VideoStitcherServiceClient (0.3.1)

Video-On-Demand content stitching API allows you to insert ads into (VoD) video on demand files. You will be able to render custom scrubber bars with highlighted ads, enforce ad policies, allow seamless playback and tracking on native players and monetize content with any standard VMAP compliant ad server. v1

Package

@google-cloud/video-stitcher

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of VideoStitcherServiceClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof gax.fallback` : loaded instance of `google-gax`. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new VideoStitcherServiceClient({fallback: 'rest'}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

videoStitcherServiceStub

videoStitcherServiceStub?: Promise<{
        [name: string]: Function;
    }>;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

cdnKeyPath(project, location, cdnKey)

cdnKeyPath(project: string, location: string, cdnKey: string): string;

Return a fully-qualified cdnKey resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`cdnKey`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
`Promise<void>`	{Promise} A promise that resolves when the client is closed.

createCdnKey(request, options)

createCdnKey(request?: protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ICdnKey,
        protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest | undefined,
        {} | undefined
    ]>;

Creates a new CDN key.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project in which the CDN key should be created, in the form of
   *  `projects/{project_number}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The CDN key resource to create.
   */
  // const cdnKey = {}
  /**
   *  Required. The ID to use for the CDN key, which will become the final component of
   *  the CDN key's resource name.
   *  This value should conform to RFC-1034, which restricts to
   *  lower-case letters, numbers, and hyphen, with the first character a
   *  letter, the last a letter or a number, and a 63 character maximum.
   */
  // const cdnKeyId = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callCreateCdnKey() {
    // Construct request
    const request = {
      parent,
      cdnKey,
      cdnKeyId,
    };

    // Run request
    const response = await stitcherClient.createCdnKey(request);
    console.log(response);
  }

  callCreateCdnKey();

createCdnKey(request, options, callback)

createCdnKey(request: protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createCdnKey(request, callback)

createCdnKey(request: protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.ICreateCdnKeyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createLiveSession(request, options)

createLiveSession(request?: protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ILiveSession,
        (protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest | undefined),
        {} | undefined
    ]>;

Creates a new live session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.ILiveSession, (protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project and location in which the live session should be created,
   *  in the form of `projects/{project_number}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Parameters for creating a live session.
   */
  // const liveSession = {}

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callCreateLiveSession() {
    // Construct request
    const request = {
      parent,
      liveSession,
    };

    // Run request
    const response = await stitcherClient.createLiveSession(request);
    console.log(response);
  }

  callCreateLiveSession();

createLiveSession(request, options, callback)

createLiveSession(request: protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.ILiveSession, protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ILiveSession, protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createLiveSession(request, callback)

createLiveSession(request: protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.ILiveSession, protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ILiveSession, protos.google.cloud.video.stitcher.v1.ICreateLiveSessionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createSlate(request, options)

createSlate(request?: protos.google.cloud.video.stitcher.v1.ICreateSlateRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ISlate,
        protos.google.cloud.video.stitcher.v1.ICreateSlateRequest | undefined,
        {} | undefined
    ]>;

Creates a slate.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateSlateRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.ICreateSlateRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project in which the slate should be created, in the form of
   *  `projects/{project_number}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The unique identifier for the slate.
   *  This value should conform to RFC-1034, which restricts to
   *  lower-case letters, numbers, and hyphen, with the first character a
   *  letter, the last a letter or a number, and a 63 character maximum.
   */
  // const slateId = 'abc123'
  /**
   *  Required. The slate to create.
   */
  // const slate = {}

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callCreateSlate() {
    // Construct request
    const request = {
      parent,
      slateId,
      slate,
    };

    // Run request
    const response = await stitcherClient.createSlate(request);
    console.log(response);
  }

  callCreateSlate();

createSlate(request, options, callback)

createSlate(request: protos.google.cloud.video.stitcher.v1.ICreateSlateRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.ICreateSlateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateSlateRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.ICreateSlateRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createSlate(request, callback)

createSlate(request: protos.google.cloud.video.stitcher.v1.ICreateSlateRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.ICreateSlateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateSlateRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.ICreateSlateRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createVodSession(request, options)

createVodSession(request?: protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.IVodSession,
        (protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest | undefined),
        {} | undefined
    ]>;

Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.IVodSession, (protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project and location in which the VOD session should be created, in the
   *  form of `projects/{project_number}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Parameters for creating a session.
   */
  // const vodSession = {}

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callCreateVodSession() {
    // Construct request
    const request = {
      parent,
      vodSession,
    };

    // Run request
    const response = await stitcherClient.createVodSession(request);
    console.log(response);
  }

  callCreateVodSession();

createVodSession(request, options, callback)

createVodSession(request: protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.IVodSession, protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.IVodSession, protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

createVodSession(request, callback)

createVodSession(request: protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.IVodSession, protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.IVodSession, protos.google.cloud.video.stitcher.v1.ICreateVodSessionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteCdnKey(request, options)

deleteCdnKey(request?: protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest | undefined,
        {} | undefined
    ]>;

Deletes the specified CDN key.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the CDN key to be deleted, in the form of
   *  `projects/{project_number}/locations/{location}/cdnKeys/{id}`.
   */
  // const name = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callDeleteCdnKey() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await stitcherClient.deleteCdnKey(request);
    console.log(response);
  }

  callDeleteCdnKey();

deleteCdnKey(request, options, callback)

deleteCdnKey(request: protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteCdnKey(request, callback)

deleteCdnKey(request: protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest`
`callback`	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteCdnKeyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteSlate(request, options)

deleteSlate(request?: protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest | undefined,
        {} | undefined
    ]>;

Deletes the specified slate.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the slate to be deleted, in the form of
   *  `projects/{project_number}/locations/{location}/slates/{id}`.
   */
  // const name = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callDeleteSlate() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await stitcherClient.deleteSlate(request);
    console.log(response);
  }

  callDeleteSlate();

deleteSlate(request, options, callback)

deleteSlate(request: protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

deleteSlate(request, callback)

deleteSlate(request: protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest`
`callback`	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.video.stitcher.v1.IDeleteSlateRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getCdnKey(request, options)

getCdnKey(request?: protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ICdnKey,
        protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest | undefined,
        {} | undefined
    ]>;

Returns the specified CDN key.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the CDN key to be retrieved, in the form of
   *  `projects/{project}/locations/{location}/cdnKeys/{id}`.
   */
  // const name = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callGetCdnKey() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await stitcherClient.getCdnKey(request);
    console.log(response);
  }

  callGetCdnKey();

getCdnKey(request, options, callback)

getCdnKey(request: protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getCdnKey(request, callback)

getCdnKey(request: protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IGetCdnKeyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getLiveAdTagDetail(request, options)

getLiveAdTagDetail(request?: protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail,
        (protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest | undefined),
        {} | undefined
    ]>;

Returns the specified ad tag detail for the specified live session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail, (protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name in the form of
   *  `projects/{project}/locations/{location}/liveSessions/{live_session}/liveAdTagDetails/{live_ad_tag_detail}`.
   */
  // const name = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callGetLiveAdTagDetail() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await stitcherClient.getLiveAdTagDetail(request);
    console.log(response);
  }

  callGetLiveAdTagDetail();

getLiveAdTagDetail(request, options, callback)

getLiveAdTagDetail(request: protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail, protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail, protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getLiveAdTagDetail(request, callback)

getLiveAdTagDetail(request: protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail, protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail, protos.google.cloud.video.stitcher.v1.IGetLiveAdTagDetailRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getLiveSession(request, options)

getLiveSession(request?: protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ILiveSession,
        protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest | undefined,
        {} | undefined
    ]>;

Returns the details for the specified live session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.ILiveSession, protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the live session, in the form of
   *  `projects/{project_number}/locations/{location}/liveSessions/{id}`.
   */
  // const name = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callGetLiveSession() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await stitcherClient.getLiveSession(request);
    console.log(response);
  }

  callGetLiveSession();

getLiveSession(request, options, callback)

getLiveSession(request: protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.ILiveSession, protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ILiveSession, protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getLiveSession(request, callback)

getLiveSession(request: protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.ILiveSession, protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ILiveSession, protos.google.cloud.video.stitcher.v1.IGetLiveSessionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
`Promise<string>`

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
`callback`	`Callback<string, undefined, undefined>`

Returns
Type	Description
`void`

getSlate(request, options)

getSlate(request?: protos.google.cloud.video.stitcher.v1.IGetSlateRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ISlate,
        protos.google.cloud.video.stitcher.v1.IGetSlateRequest | undefined,
        {} | undefined
    ]>;

Returns the specified slate.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetSlateRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IGetSlateRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the slate to be retrieved, of the slate, in the form of
   *  `projects/{project_number}/locations/{location}/slates/{id}`.
   */
  // const name = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callGetSlate() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await stitcherClient.getSlate(request);
    console.log(response);
  }

  callGetSlate();

getSlate(request, options, callback)

getSlate(request: protos.google.cloud.video.stitcher.v1.IGetSlateRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IGetSlateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetSlateRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IGetSlateRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getSlate(request, callback)

getSlate(request: protos.google.cloud.video.stitcher.v1.IGetSlateRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IGetSlateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetSlateRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IGetSlateRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getVodAdTagDetail(request, options)

getVodAdTagDetail(request?: protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.IVodAdTagDetail,
        (protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest | undefined),
        {} | undefined
    ]>;

Returns the specified ad tag detail for the specified VOD session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.IVodAdTagDetail, (protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the ad tag detail for the specified VOD session, in the form of
   *  `projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodAdTagDetails/{vod_ad_tag_detail}`.
   */
  // const name = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callGetVodAdTagDetail() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await stitcherClient.getVodAdTagDetail(request);
    console.log(response);
  }

  callGetVodAdTagDetail();

getVodAdTagDetail(request, options, callback)

getVodAdTagDetail(request: protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.IVodAdTagDetail, protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.IVodAdTagDetail, protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getVodAdTagDetail(request, callback)

getVodAdTagDetail(request: protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.IVodAdTagDetail, protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.IVodAdTagDetail, protos.google.cloud.video.stitcher.v1.IGetVodAdTagDetailRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getVodSession(request, options)

getVodSession(request?: protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.IVodSession,
        protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest | undefined,
        {} | undefined
    ]>;

Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.IVodSession, protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the VOD session to be retrieved, in the form of
   *  `projects/{project_number}/locations/{location}/vodSessions/{id}`.
   */
  // const name = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callGetVodSession() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await stitcherClient.getVodSession(request);
    console.log(response);
  }

  callGetVodSession();

getVodSession(request, options, callback)

getVodSession(request: protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.IVodSession, protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.IVodSession, protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getVodSession(request, callback)

getVodSession(request: protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.IVodSession, protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.IVodSession, protos.google.cloud.video.stitcher.v1.IGetVodSessionRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getVodStitchDetail(request, options)

getVodStitchDetail(request?: protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.IVodStitchDetail,
        (protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest | undefined),
        {} | undefined
    ]>;

Returns the specified stitching information for the specified VOD session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.IVodStitchDetail, (protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest \| undefined), {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the stitch detail in the specified VOD session, in the form of
   *  `projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodStitchDetails/{id}`.
   */
  // const name = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callGetVodStitchDetail() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await stitcherClient.getVodStitchDetail(request);
    console.log(response);
  }

  callGetVodStitchDetail();

getVodStitchDetail(request, options, callback)

getVodStitchDetail(request: protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.IVodStitchDetail, protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.IVodStitchDetail, protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getVodStitchDetail(request, callback)

getVodStitchDetail(request: protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.IVodStitchDetail, protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.IVodStitchDetail, protos.google.cloud.video.stitcher.v1.IGetVodStitchDetailRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
`Promise<{ [name: string]: Function; }>`	{Promise} A promise that resolves to an authenticated service stub.

listCdnKeys(request, options)

listCdnKeys(request?: protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ICdnKey[],
        protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest | null,
        protos.google.cloud.video.stitcher.v1.IListCdnKeysResponse
    ]>;

Lists all CDN keys in the specified project and location.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.video.stitcher.v1.ICdnKey[],
        protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest | null,
        protos.google.cloud.video.stitcher.v1.IListCdnKeysResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCdnKeysAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listCdnKeys(request, options, callback)

listCdnKeys(request: protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest, protos.google.cloud.video.stitcher.v1.IListCdnKeysResponse | null | undefined, protos.google.cloud.video.stitcher.v1.ICdnKey>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest, protos.google.cloud.video.stitcher.v1.IListCdnKeysResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.ICdnKey>`

Returns
Type	Description
`void`

listCdnKeys(request, callback)

listCdnKeys(request: protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest, protos.google.cloud.video.stitcher.v1.IListCdnKeysResponse | null | undefined, protos.google.cloud.video.stitcher.v1.ICdnKey>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest, protos.google.cloud.video.stitcher.v1.IListCdnKeysResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.ICdnKey>`

Returns
Type	Description
`void`

listCdnKeysAsync(request, options)

listCdnKeysAsync(request?: protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.video.stitcher.v1.ICdnKey>;

Equivalent to listCdnKeys, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

AsyncIterable<protos.google.cloud.video.stitcher.v1.ICdnKey>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project that contains the list of CDN keys, in the form of
   *  `projects/{project_number}/locations/{location}`.
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} =
    require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callListCdnKeys() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await stitcherClient.listCdnKeysAsync(request);
    for await (const response of iterable) {
      console.log(response);
    }
    console.log(iterable);
  }

  callListCdnKeys();

listCdnKeysStream(request, options)

listCdnKeysStream(request?: protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListCdnKeysRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCdnKeysAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listLiveAdTagDetails(request, options)

listLiveAdTagDetails(request?: protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail[],
        protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest | null,
        protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsResponse
    ]>;

Return the list of ad tag details for the specified live session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail[],
        protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest | null,
        protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listLiveAdTagDetailsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listLiveAdTagDetails(request, options, callback)

listLiveAdTagDetails(request: protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest, protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsResponse | null | undefined, protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest, protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail>`

Returns
Type	Description
`void`

listLiveAdTagDetails(request, callback)

listLiveAdTagDetails(request: protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest, protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsResponse | null | undefined, protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest, protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail>`

Returns
Type	Description
`void`

listLiveAdTagDetailsAsync(request, options)

listLiveAdTagDetailsAsync(request?: protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail>;

Equivalent to listLiveAdTagDetails, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

AsyncIterable<protos.google.cloud.video.stitcher.v1.ILiveAdTagDetail>

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource parent in the form of
   *  `projects/{project}/locations/{location}/liveSessions/{live_session}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The pagination token returned from a previous List request.
   */
  // const pageToken = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callListLiveAdTagDetails() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await stitcherClient.listLiveAdTagDetailsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListLiveAdTagDetails();

listLiveAdTagDetailsStream(request, options)

listLiveAdTagDetailsStream(request?: protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListLiveAdTagDetailsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listLiveAdTagDetailsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSlates(request, options)

listSlates(request?: protos.google.cloud.video.stitcher.v1.IListSlatesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ISlate[],
        protos.google.cloud.video.stitcher.v1.IListSlatesRequest | null,
        protos.google.cloud.video.stitcher.v1.IListSlatesResponse
    ]>;

Lists all slates in the specified project and location.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListSlatesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.video.stitcher.v1.ISlate[],
        protos.google.cloud.video.stitcher.v1.IListSlatesRequest | null,
        protos.google.cloud.video.stitcher.v1.IListSlatesResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listSlatesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSlates(request, options, callback)

listSlates(request: protos.google.cloud.video.stitcher.v1.IListSlatesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListSlatesRequest, protos.google.cloud.video.stitcher.v1.IListSlatesResponse | null | undefined, protos.google.cloud.video.stitcher.v1.ISlate>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListSlatesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListSlatesRequest, protos.google.cloud.video.stitcher.v1.IListSlatesResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.ISlate>`

Returns
Type	Description
`void`

listSlates(request, callback)

listSlates(request: protos.google.cloud.video.stitcher.v1.IListSlatesRequest, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListSlatesRequest, protos.google.cloud.video.stitcher.v1.IListSlatesResponse | null | undefined, protos.google.cloud.video.stitcher.v1.ISlate>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListSlatesRequest`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListSlatesRequest, protos.google.cloud.video.stitcher.v1.IListSlatesResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.ISlate>`

Returns
Type	Description
`void`

listSlatesAsync(request, options)

listSlatesAsync(request?: protos.google.cloud.video.stitcher.v1.IListSlatesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.video.stitcher.v1.ISlate>;

Equivalent to listSlates, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListSlatesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

AsyncIterable<protos.google.cloud.video.stitcher.v1.ISlate>

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project to list slates, in the form of `projects/{project_number}`.
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callListSlates() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await stitcherClient.listSlatesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListSlates();

listSlatesStream(request, options)

listSlatesStream(request?: protos.google.cloud.video.stitcher.v1.IListSlatesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListSlatesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSlatesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listVodAdTagDetails(request, options)

listVodAdTagDetails(request?: protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.IVodAdTagDetail[],
        protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest | null,
        protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsResponse
    ]>;

Return the list of ad tag details for the specified VOD session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.video.stitcher.v1.IVodAdTagDetail[],
        protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest | null,
        protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listVodAdTagDetailsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listVodAdTagDetails(request, options, callback)

listVodAdTagDetails(request: protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest, protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsResponse | null | undefined, protos.google.cloud.video.stitcher.v1.IVodAdTagDetail>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest, protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.IVodAdTagDetail>`

Returns
Type	Description
`void`

listVodAdTagDetails(request, callback)

listVodAdTagDetails(request: protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest, protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsResponse | null | undefined, protos.google.cloud.video.stitcher.v1.IVodAdTagDetail>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest, protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.IVodAdTagDetail>`

Returns
Type	Description
`void`

listVodAdTagDetailsAsync(request, options)

listVodAdTagDetailsAsync(request?: protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.video.stitcher.v1.IVodAdTagDetail>;

Equivalent to listVodAdTagDetails, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

AsyncIterable<protos.google.cloud.video.stitcher.v1.IVodAdTagDetail>

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The VOD session which the ad tag details belong to, in the form of
   *  `projects/{project}/locations/{location}/vodSessions/{vod_session_id}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callListVodAdTagDetails() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await stitcherClient.listVodAdTagDetailsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListVodAdTagDetails();

listVodAdTagDetailsStream(request, options)

listVodAdTagDetailsStream(request?: protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodAdTagDetailsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listVodAdTagDetailsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listVodStitchDetails(request, options)

listVodStitchDetails(request?: protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.IVodStitchDetail[],
        protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest | null,
        protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsResponse
    ]>;

Returns a list of detailed stitching information of the specified VOD session.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[
        protos.google.cloud.video.stitcher.v1.IVodStitchDetail[],
        protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest | null,
        protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listVodStitchDetailsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listVodStitchDetails(request, options, callback)

listVodStitchDetails(request: protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest, protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsResponse | null | undefined, protos.google.cloud.video.stitcher.v1.IVodStitchDetail>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest, protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.IVodStitchDetail>`

Returns
Type	Description
`void`

listVodStitchDetails(request, callback)

listVodStitchDetails(request: protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest, callback: PaginationCallback<protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest, protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsResponse | null | undefined, protos.google.cloud.video.stitcher.v1.IVodStitchDetail>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest`
`callback`	`PaginationCallback<protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest, protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsResponse \| null \| undefined, protos.google.cloud.video.stitcher.v1.IVodStitchDetail>`

Returns
Type	Description
`void`

listVodStitchDetailsAsync(request, options)

listVodStitchDetailsAsync(request?: protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.video.stitcher.v1.IVodStitchDetail>;

Equivalent to listVodStitchDetails, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

AsyncIterable<protos.google.cloud.video.stitcher.v1.IVodStitchDetail>

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The VOD session where the stitch details belong to, in the form of
   *  `projects/{project}/locations/{location}/vodSessions/{id}`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callListVodStitchDetails() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await stitcherClient.listVodStitchDetailsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListVodStitchDetails();

listVodStitchDetailsStream(request, options)

listVodStitchDetailsStream(request?: protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IListVodStitchDetailsRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listVodStitchDetailsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

liveAdTagDetailPath(project, location, liveSession, liveAdTagDetail)

liveAdTagDetailPath(project: string, location: string, liveSession: string, liveAdTagDetail: string): string;

Return a fully-qualified liveAdTagDetail resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`liveSession`	`string`
`liveAdTagDetail`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

liveSessionPath(project, location, liveSession)

liveSessionPath(project: string, location: string, liveSession: string): string;

Return a fully-qualified liveSession resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`liveSession`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

matchCdnKeyFromCdnKeyName(cdnKeyName)

matchCdnKeyFromCdnKeyName(cdnKeyName: string): string | number;

Parse the cdn_key from CdnKey resource.

Parameter
Name	Description
`cdnKeyName`	`string` A fully-qualified path representing CdnKey resource.

Returns
Type	Description
`string \| number`	{string} A string representing the cdn_key.

matchLiveAdTagDetailFromLiveAdTagDetailName(liveAdTagDetailName)

matchLiveAdTagDetailFromLiveAdTagDetailName(liveAdTagDetailName: string): string | number;

Parse the live_ad_tag_detail from LiveAdTagDetail resource.

Parameter
Name	Description
`liveAdTagDetailName`	`string` A fully-qualified path representing LiveAdTagDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the live_ad_tag_detail.

matchLiveSessionFromLiveAdTagDetailName(liveAdTagDetailName)

matchLiveSessionFromLiveAdTagDetailName(liveAdTagDetailName: string): string | number;

Parse the live_session from LiveAdTagDetail resource.

Parameter
Name	Description
`liveAdTagDetailName`	`string` A fully-qualified path representing LiveAdTagDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the live_session.

matchLiveSessionFromLiveSessionName(liveSessionName)

matchLiveSessionFromLiveSessionName(liveSessionName: string): string | number;

Parse the live_session from LiveSession resource.

Parameter
Name	Description
`liveSessionName`	`string` A fully-qualified path representing LiveSession resource.

Returns
Type	Description
`string \| number`	{string} A string representing the live_session.

matchLocationFromCdnKeyName(cdnKeyName)

matchLocationFromCdnKeyName(cdnKeyName: string): string | number;

Parse the location from CdnKey resource.

Parameter
Name	Description
`cdnKeyName`	`string` A fully-qualified path representing CdnKey resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromLiveAdTagDetailName(liveAdTagDetailName)

matchLocationFromLiveAdTagDetailName(liveAdTagDetailName: string): string | number;

Parse the location from LiveAdTagDetail resource.

Parameter
Name	Description
`liveAdTagDetailName`	`string` A fully-qualified path representing LiveAdTagDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromLiveSessionName(liveSessionName)

matchLocationFromLiveSessionName(liveSessionName: string): string | number;

Parse the location from LiveSession resource.

Parameter
Name	Description
`liveSessionName`	`string` A fully-qualified path representing LiveSession resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromSlateName(slateName)

matchLocationFromSlateName(slateName: string): string | number;

Parse the location from Slate resource.

Parameter
Name	Description
`slateName`	`string` A fully-qualified path representing Slate resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromVodAdTagDetailName(vodAdTagDetailName)

matchLocationFromVodAdTagDetailName(vodAdTagDetailName: string): string | number;

Parse the location from VodAdTagDetail resource.

Parameter
Name	Description
`vodAdTagDetailName`	`string` A fully-qualified path representing VodAdTagDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromVodSessionName(vodSessionName)

matchLocationFromVodSessionName(vodSessionName: string): string | number;

Parse the location from VodSession resource.

Parameter
Name	Description
`vodSessionName`	`string` A fully-qualified path representing VodSession resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchLocationFromVodStitchDetailName(vodStitchDetailName)

matchLocationFromVodStitchDetailName(vodStitchDetailName: string): string | number;

Parse the location from VodStitchDetail resource.

Parameter
Name	Description
`vodStitchDetailName`	`string` A fully-qualified path representing VodStitchDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the location.

matchProjectFromCdnKeyName(cdnKeyName)

matchProjectFromCdnKeyName(cdnKeyName: string): string | number;

Parse the project from CdnKey resource.

Parameter
Name	Description
`cdnKeyName`	`string` A fully-qualified path representing CdnKey resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromLiveAdTagDetailName(liveAdTagDetailName)

matchProjectFromLiveAdTagDetailName(liveAdTagDetailName: string): string | number;

Parse the project from LiveAdTagDetail resource.

Parameter
Name	Description
`liveAdTagDetailName`	`string` A fully-qualified path representing LiveAdTagDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromLiveSessionName(liveSessionName)

matchProjectFromLiveSessionName(liveSessionName: string): string | number;

Parse the project from LiveSession resource.

Parameter
Name	Description
`liveSessionName`	`string` A fully-qualified path representing LiveSession resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name	Description
`locationName`	`string` A fully-qualified path representing Location resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name	Description
`projectName`	`string` A fully-qualified path representing Project resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromSlateName(slateName)

matchProjectFromSlateName(slateName: string): string | number;

Parse the project from Slate resource.

Parameter
Name	Description
`slateName`	`string` A fully-qualified path representing Slate resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromVodAdTagDetailName(vodAdTagDetailName)

matchProjectFromVodAdTagDetailName(vodAdTagDetailName: string): string | number;

Parse the project from VodAdTagDetail resource.

Parameter
Name	Description
`vodAdTagDetailName`	`string` A fully-qualified path representing VodAdTagDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromVodSessionName(vodSessionName)

matchProjectFromVodSessionName(vodSessionName: string): string | number;

Parse the project from VodSession resource.

Parameter
Name	Description
`vodSessionName`	`string` A fully-qualified path representing VodSession resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchProjectFromVodStitchDetailName(vodStitchDetailName)

matchProjectFromVodStitchDetailName(vodStitchDetailName: string): string | number;

Parse the project from VodStitchDetail resource.

Parameter
Name	Description
`vodStitchDetailName`	`string` A fully-qualified path representing VodStitchDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the project.

matchSlateFromSlateName(slateName)

matchSlateFromSlateName(slateName: string): string | number;

Parse the slate from Slate resource.

Parameter
Name	Description
`slateName`	`string` A fully-qualified path representing Slate resource.

Returns
Type	Description
`string \| number`	{string} A string representing the slate.

matchVodAdTagDetailFromVodAdTagDetailName(vodAdTagDetailName)

matchVodAdTagDetailFromVodAdTagDetailName(vodAdTagDetailName: string): string | number;

Parse the vod_ad_tag_detail from VodAdTagDetail resource.

Parameter
Name	Description
`vodAdTagDetailName`	`string` A fully-qualified path representing VodAdTagDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the vod_ad_tag_detail.

matchVodSessionFromVodAdTagDetailName(vodAdTagDetailName)

matchVodSessionFromVodAdTagDetailName(vodAdTagDetailName: string): string | number;

Parse the vod_session from VodAdTagDetail resource.

Parameter
Name	Description
`vodAdTagDetailName`	`string` A fully-qualified path representing VodAdTagDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the vod_session.

matchVodSessionFromVodSessionName(vodSessionName)

matchVodSessionFromVodSessionName(vodSessionName: string): string | number;

Parse the vod_session from VodSession resource.

Parameter
Name	Description
`vodSessionName`	`string` A fully-qualified path representing VodSession resource.

Returns
Type	Description
`string \| number`	{string} A string representing the vod_session.

matchVodSessionFromVodStitchDetailName(vodStitchDetailName)

matchVodSessionFromVodStitchDetailName(vodStitchDetailName: string): string | number;

Parse the vod_session from VodStitchDetail resource.

Parameter
Name	Description
`vodStitchDetailName`	`string` A fully-qualified path representing VodStitchDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the vod_session.

matchVodStitchDetailFromVodStitchDetailName(vodStitchDetailName)

matchVodStitchDetailFromVodStitchDetailName(vodStitchDetailName: string): string | number;

Parse the vod_stitch_detail from VodStitchDetail resource.

Parameter
Name	Description
`vodStitchDetailName`	`string` A fully-qualified path representing VodStitchDetail resource.

Returns
Type	Description
`string \| number`	{string} A string representing the vod_stitch_detail.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

slatePath(project, location, slate)

slatePath(project: string, location: string, slate: string): string;

Return a fully-qualified slate resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`slate`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

updateCdnKey(request, options)

updateCdnKey(request?: protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ICdnKey,
        protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest | undefined,
        {} | undefined
    ]>;

Updates the specified CDN key. Only update fields specified in the call method body.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The CDN key resource which replaces the resource on the server.
   */
  // const cdnKey = {}
  /**
   *  Required. The update mask applies to the resource.
   *  For the `FieldMask` definition, see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
   */
  // const updateMask = {}

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callUpdateCdnKey() {
    // Construct request
    const request = {
      cdnKey,
      updateMask,
    };

    // Run request
    const response = await stitcherClient.updateCdnKey(request);
    console.log(response);
  }

  callUpdateCdnKey();

updateCdnKey(request, options, callback)

updateCdnKey(request: protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateCdnKey(request, callback)

updateCdnKey(request: protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ICdnKey, protos.google.cloud.video.stitcher.v1.IUpdateCdnKeyRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateSlate(request, options)

updateSlate(request?: protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest, options?: CallOptions): Promise<[
        protos.google.cloud.video.stitcher.v1.ISlate,
        protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest | undefined,
        {} | undefined
    ]>;

Updates the specified slate.

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Promise<[ protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource with updated fields.
   */
  // const slate = {}
  /**
   *  Required. The update mask which specifies fields which should be updated.
   */
  // const updateMask = {}

  // Imports the Stitcher library
  const {VideoStitcherServiceClient} = require('@google-cloud/video-stitcher').v1;

  // Instantiates a client
  const stitcherClient = new VideoStitcherServiceClient();

  async function callUpdateSlate() {
    // Construct request
    const request = {
      slate,
      updateMask,
    };

    // Run request
    const response = await stitcherClient.updateSlate(request);
    console.log(response);
  }

  callUpdateSlate();

updateSlate(request, options, callback)

updateSlate(request: protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest, options: CallOptions, callback: Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

updateSlate(request, callback)

updateSlate(request: protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest, callback: Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest`
`callback`	`Callback<protos.google.cloud.video.stitcher.v1.ISlate, protos.google.cloud.video.stitcher.v1.IUpdateSlateRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

vodAdTagDetailPath(project, location, vodSession, vodAdTagDetail)

vodAdTagDetailPath(project: string, location: string, vodSession: string, vodAdTagDetail: string): string;

Return a fully-qualified vodAdTagDetail resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`vodSession`	`string`
`vodAdTagDetail`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

vodSessionPath(project, location, vodSession)

vodSessionPath(project: string, location: string, vodSession: string): string;

Return a fully-qualified vodSession resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`vodSession`	`string`

Returns
Type	Description
`string`	{string} Resource name string.

vodStitchDetailPath(project, location, vodSession, vodStitchDetail)

vodStitchDetailPath(project: string, location: string, vodSession: string, vodStitchDetail: string): string;

Return a fully-qualified vodStitchDetail resource name string.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`vodSession`	`string`
`vodStitchDetail`	`string`

Returns
Type	Description
`string`	{string} Resource name string.