Google Apps Meet V2beta Client - Class ConferenceRecordsServiceClient (0.2.3)

Reference documentation and code samples for the Google Apps Meet V2beta Client class ConferenceRecordsServiceClient.

Service Description: REST API for services dealing with conference records.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Apps \ Meet \ V2beta \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.
↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "
↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

getConferenceRecord

Developer Preview.

Gets a conference record by conference ID.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::getConferenceRecordAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetConferenceRecordRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Apps\Meet\V2beta\ConferenceRecord
Example 
use Google\ApiCore\ApiException;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\ConferenceRecord;
use Google\Apps\Meet\V2beta\GetConferenceRecordRequest;

/**
 * @param string $formattedName Resource name of the conference. Please see
 *                              {@see ConferenceRecordsServiceClient::conferenceRecordName()} for help formatting this field.
 */
function get_conference_record_sample(string $formattedName): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new GetConferenceRecordRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var ConferenceRecord $response */
        $response = $conferenceRecordsServiceClient->getConferenceRecord($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ConferenceRecordsServiceClient::conferenceRecordName('[CONFERENCE_RECORD]');

    get_conference_record_sample($formattedName);
}

getParticipant

Developer Preview.

Gets a participant by participant ID.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::getParticipantAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetParticipantRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Apps\Meet\V2beta\Participant
Example 
use Google\ApiCore\ApiException;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\GetParticipantRequest;
use Google\Apps\Meet\V2beta\Participant;

/**
 * @param string $formattedName Resource name of the participant. Please see
 *                              {@see ConferenceRecordsServiceClient::participantName()} for help formatting this field.
 */
function get_participant_sample(string $formattedName): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new GetParticipantRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Participant $response */
        $response = $conferenceRecordsServiceClient->getParticipant($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ConferenceRecordsServiceClient::participantName(
        '[CONFERENCE_RECORD]',
        '[PARTICIPANT]'
    );

    get_participant_sample($formattedName);
}

getParticipantSession

Developer Preview.

Gets a participant session by participant session ID.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::getParticipantSessionAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetParticipantSessionRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Apps\Meet\V2beta\ParticipantSession
Example 
use Google\ApiCore\ApiException;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\GetParticipantSessionRequest;
use Google\Apps\Meet\V2beta\ParticipantSession;

/**
 * @param string $formattedName Resource name of the participant. Please see
 *                              {@see ConferenceRecordsServiceClient::participantSessionName()} for help formatting this field.
 */
function get_participant_session_sample(string $formattedName): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new GetParticipantSessionRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var ParticipantSession $response */
        $response = $conferenceRecordsServiceClient->getParticipantSession($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ConferenceRecordsServiceClient::participantSessionName(
        '[CONFERENCE_RECORD]',
        '[PARTICIPANT]',
        '[PARTICIPANT_SESSION]'
    );

    get_participant_session_sample($formattedName);
}

getRecording

Developer Preview.

Gets a recording by recording ID.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::getRecordingAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetRecordingRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Apps\Meet\V2beta\Recording
Example 
use Google\ApiCore\ApiException;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\GetRecordingRequest;
use Google\Apps\Meet\V2beta\Recording;

/**
 * @param string $formattedName Resource name of the recording. Please see
 *                              {@see ConferenceRecordsServiceClient::recordingName()} for help formatting this field.
 */
function get_recording_sample(string $formattedName): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new GetRecordingRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Recording $response */
        $response = $conferenceRecordsServiceClient->getRecording($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ConferenceRecordsServiceClient::recordingName(
        '[CONFERENCE_RECORD]',
        '[RECORDING]'
    );

    get_recording_sample($formattedName);
}

getTranscript

Developer Preview.

Gets a transcript by transcript ID.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::getTranscriptAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetTranscriptRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Apps\Meet\V2beta\Transcript
Example 
use Google\ApiCore\ApiException;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\GetTranscriptRequest;
use Google\Apps\Meet\V2beta\Transcript;

/**
 * @param string $formattedName Resource name of the transcript. Please see
 *                              {@see ConferenceRecordsServiceClient::transcriptName()} for help formatting this field.
 */
function get_transcript_sample(string $formattedName): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new GetTranscriptRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Transcript $response */
        $response = $conferenceRecordsServiceClient->getTranscript($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ConferenceRecordsServiceClient::transcriptName(
        '[CONFERENCE_RECORD]',
        '[TRANSCRIPT]'
    );

    get_transcript_sample($formattedName);
}

getTranscriptEntry

Developer Preview.

Gets a TranscriptEntry resource by entry ID.

Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::getTranscriptEntryAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetTranscriptEntryRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Apps\Meet\V2beta\TranscriptEntry
Example 
use Google\ApiCore\ApiException;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\GetTranscriptEntryRequest;
use Google\Apps\Meet\V2beta\TranscriptEntry;

/**
 * @param string $formattedName Resource name of the `TranscriptEntry`. Please see
 *                              {@see ConferenceRecordsServiceClient::transcriptEntryName()} for help formatting this field.
 */
function get_transcript_entry_sample(string $formattedName): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new GetTranscriptEntryRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var TranscriptEntry $response */
        $response = $conferenceRecordsServiceClient->getTranscriptEntry($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = ConferenceRecordsServiceClient::transcriptEntryName(
        '[CONFERENCE_RECORD]',
        '[TRANSCRIPT]',
        '[ENTRY]'
    );

    get_transcript_entry_sample($formattedName);
}

listConferenceRecords

Developer Preview.

Lists the conference records by start time and in descending order.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::listConferenceRecordsAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListConferenceRecordsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\ConferenceRecord;
use Google\Apps\Meet\V2beta\ListConferenceRecordsRequest;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_conference_records_sample(): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = new ListConferenceRecordsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $conferenceRecordsServiceClient->listConferenceRecords($request);

        /** @var ConferenceRecord $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listParticipantSessions

Developer Preview.

Lists the participant sessions of a participant in a conference record, by default ordered by join time and in descending order. This API supports fields as standard parameters like every other API. However, when the fields request parameter is omitted this API defaults to 'participantsessions/*, next_page_token'.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::listParticipantSessionsAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListParticipantSessionsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\ListParticipantSessionsRequest;
use Google\Apps\Meet\V2beta\ParticipantSession;

/**
 * @param string $formattedParent Format:
 *                                `conferenceRecords/{conference_record}/participants/{participant}`
 *                                Please see {@see ConferenceRecordsServiceClient::participantName()} for help formatting this field.
 */
function list_participant_sessions_sample(string $formattedParent): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new ListParticipantSessionsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $conferenceRecordsServiceClient->listParticipantSessions($request);

        /** @var ParticipantSession $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ConferenceRecordsServiceClient::participantName(
        '[CONFERENCE_RECORD]',
        '[PARTICIPANT]'
    );

    list_participant_sessions_sample($formattedParent);
}

listParticipants

Developer Preview.

Lists the participants in a conference record, by default ordered by join time and in descending order. This API supports fields as standard parameters like every other API. However, when the fields request parameter is omitted, this API defaults to 'participants/*, next_page_token'.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::listParticipantsAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListParticipantsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\ListParticipantsRequest;
use Google\Apps\Meet\V2beta\Participant;

/**
 * @param string $formattedParent Format: `conferenceRecords/{conference_record}`
 *                                Please see {@see ConferenceRecordsServiceClient::conferenceRecordName()} for help formatting this field.
 */
function list_participants_sample(string $formattedParent): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new ListParticipantsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $conferenceRecordsServiceClient->listParticipants($request);

        /** @var Participant $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ConferenceRecordsServiceClient::conferenceRecordName('[CONFERENCE_RECORD]');

    list_participants_sample($formattedParent);
}

listRecordings

Developer Preview.

Lists the recording resources from the conference record.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::listRecordingsAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListRecordingsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\ListRecordingsRequest;
use Google\Apps\Meet\V2beta\Recording;

/**
 * @param string $formattedParent Format: `conferenceRecords/{conference_record}`
 *                                Please see {@see ConferenceRecordsServiceClient::conferenceRecordName()} for help formatting this field.
 */
function list_recordings_sample(string $formattedParent): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new ListRecordingsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $conferenceRecordsServiceClient->listRecordings($request);

        /** @var Recording $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ConferenceRecordsServiceClient::conferenceRecordName('[CONFERENCE_RECORD]');

    list_recordings_sample($formattedParent);
}

listTranscriptEntries

Developer Preview.

Lists the structured transcript entries per transcript. By default, ordered by start time and in ascending order.

Note: The transcript entries returned by the Google Meet API might not match the transcription found in the Google Docs transcript file. This can occur when the Google Docs transcript file is modified after generation.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::listTranscriptEntriesAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListTranscriptEntriesRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\ListTranscriptEntriesRequest;
use Google\Apps\Meet\V2beta\TranscriptEntry;

/**
 * @param string $formattedParent Format:
 *                                `conferenceRecords/{conference_record}/transcripts/{transcript}`
 *                                Please see {@see ConferenceRecordsServiceClient::transcriptName()} for help formatting this field.
 */
function list_transcript_entries_sample(string $formattedParent): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new ListTranscriptEntriesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $conferenceRecordsServiceClient->listTranscriptEntries($request);

        /** @var TranscriptEntry $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ConferenceRecordsServiceClient::transcriptName(
        '[CONFERENCE_RECORD]',
        '[TRANSCRIPT]'
    );

    list_transcript_entries_sample($formattedParent);
}

listTranscripts

Developer Preview.

Lists the set of transcripts from the conference record.

The async variant is Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient::listTranscriptsAsync() .

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListTranscriptsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Apps\Meet\V2beta\Client\ConferenceRecordsServiceClient;
use Google\Apps\Meet\V2beta\ListTranscriptsRequest;
use Google\Apps\Meet\V2beta\Transcript;

/**
 * @param string $formattedParent Format: `conferenceRecords/{conference_record}`
 *                                Please see {@see ConferenceRecordsServiceClient::conferenceRecordName()} for help formatting this field.
 */
function list_transcripts_sample(string $formattedParent): void
{
    // Create a client.
    $conferenceRecordsServiceClient = new ConferenceRecordsServiceClient();

    // Prepare the request message.
    $request = (new ListTranscriptsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $conferenceRecordsServiceClient->listTranscripts($request);

        /** @var Transcript $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = ConferenceRecordsServiceClient::conferenceRecordName('[CONFERENCE_RECORD]');

    list_transcripts_sample($formattedParent);
}

getConferenceRecordAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetConferenceRecordRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getParticipantAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetParticipantRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getParticipantSessionAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetParticipantSessionRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getRecordingAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetRecordingRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getTranscriptAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetTranscriptRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getTranscriptEntryAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\GetTranscriptEntryRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listConferenceRecordsAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListConferenceRecordsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listParticipantSessionsAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListParticipantSessionsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listParticipantsAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListParticipantsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listRecordingsAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListRecordingsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listTranscriptEntriesAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListTranscriptEntriesRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listTranscriptsAsync

Parameters
Name Description
request Google\Apps\Meet\V2beta\ListTranscriptsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

static::conferenceRecordName

Formats a string containing the fully-qualified path to represent a conference_record resource.

Parameter
Name Description
conferenceRecord string
Returns
Type Description
string The formatted conference_record resource.

static::participantName

Formats a string containing the fully-qualified path to represent a participant resource.

Parameters
Name Description
conferenceRecord string
participant string
Returns
Type Description
string The formatted participant resource.

static::participantSessionName

Formats a string containing the fully-qualified path to represent a participant_session resource.

Parameters
Name Description
conferenceRecord string
participant string
participantSession string
Returns
Type Description
string The formatted participant_session resource.

static::recordingName

Formats a string containing the fully-qualified path to represent a recording resource.

Parameters
Name Description
conferenceRecord string
recording string
Returns
Type Description
string The formatted recording resource.

static::transcriptName

Formats a string containing the fully-qualified path to represent a transcript resource.

Parameters
Name Description
conferenceRecord string
transcript string
Returns
Type Description
string The formatted transcript resource.

static::transcriptEntryName

Formats a string containing the fully-qualified path to represent a transcript_entry resource.

Parameters
Name Description
conferenceRecord string
transcript string
entry string
Returns
Type Description
string The formatted transcript_entry resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • conferenceRecord: conferenceRecords/{conference_record}
  • participant: conferenceRecords/{conference_record}/participants/{participant}
  • participantSession: conferenceRecords/{conference_record}/participants/{participant}/participantSessions/{participant_session}
  • recording: conferenceRecords/{conference_record}/recordings/{recording}
  • transcript: conferenceRecords/{conference_record}/transcripts/{transcript}
  • transcriptEntry: conferenceRecords/{conference_record}/transcripts/{transcript}/entries/{entry}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name Description
formattedName string

The formatted name string
template string

Optional name of template to match
Returns
Type Description
array An associative array from name component IDs to component values.