REST Resource: projects.locations.notebooks.audioOverviews

Resource: AudioOverview

An audio overview of a notebook. This is a summary of the notebook in audio format.

JSON representation 
{
  "name": string,
  "audioOverviewId": string,
  "status": enum (AudioOverviewStatus),
  "audio": string,
  "mimeType": enum (MimeType),
  "playbackUrl": string,
  "languageCode": string
}
Fields
name

string

Identifier. The full resource name of the notebook. Format: projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audioOverviewId}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.
audioOverviewId

string

Output only. Unique id of the audio overview.
status

enum (AudioOverviewStatus)

The status of the audio overview.
audio

string (bytes format)

The audio overview in wav format. This is only present if the status is AUDIO_OVERVIEW_STATUS_COMPLETE.

A base64-encoded string.
mimeType

enum (MimeType)

The mime type of the audio overview.
playbackUrl

string

The url used to play the audio overview.
languageCode

string

The language code of the generated audio overview. Use the BCP 47 language code (e.g. "en", "es", "hi", etc.). Examples: google3/i18n/identifiers/tools/language_code_constants.txt

AudioOverviewStatus

The status of an audio overview.

Enums
AUDIO_OVERVIEW_STATUS_UNSPECIFIED The status has not been set.
AUDIO_OVERVIEW_STATUS_NOT_STARTED The audio overview has not started being generated.
AUDIO_OVERVIEW_STATUS_IN_PROGRESS The audio overview is in the process of being generated.
AUDIO_OVERVIEW_STATUS_COMPLETE The audio overview has been generated and is available.
AUDIO_OVERVIEW_STATUS_FAILED The audio overview failed to be generated.

MimeType

Supported mime types for audio overviews.

Enums
MIME_TYPE_UNKNOWN The mime type has not been set.
MIME_TYPE_WAV The mime type is audio/wav.
MIME_TYPE_MP4 The mime type is audio/mp4.

Methods

create

 Generates a new audio overview.

delete

 Deletes an audio overview.