StreamsClient

A stream is a two-way audio bridge with a call. You operate a stream with the StreamCall method. You supply a unique, user-generated stream resource name, and then bridge a call to the stream using the Stream VoiceML action.

Constructor

new StreamsClient(optionsopt)

Construct an instance of StreamsClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. See the subsequent parameters for more details.

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

aliasPath(project, sip_domain, alias) → {string}

Return a fully-qualified alias resource name string.

Parameters:

Name	Type	Description
`project`	string
`sip_domain`	string
`alias`	string

Returns:

Type	Description
string	Resource name string.

callPath(project, call) → {string}

Return a fully-qualified call resource name string.

Parameters:

Name	Type	Description
`project`	string
`call`	string

Returns:

Type	Description
string	Resource name string.

close()

Terminate the GRPC channel and close the client.

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

getProjectId(callback)

Return the project ID used by this class.

Parameters:

Name	Type	Description
`callback`	function	the callback to be called with the current project Id.

initialize() → {Promise}

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	A promise that resolves to an authenticated service stub.

matchAliasFromAliasName(aliasName) → {string}

Parse the alias from Alias resource.

Parameters:

Name	Type	Description
`aliasName`	string	A fully-qualified path representing Alias resource.

Returns:

Type	Description
string	A string representing the alias.

matchCallFromCallName(callName) → {string}

Parse the call from Call resource.

Parameters:

Name	Type	Description
`callName`	string	A fully-qualified path representing Call resource.

Returns:

Type	Description
string	A string representing the call.

matchCallFromRecordingName(recordingName) → {string}

Parse the call from Recording resource.

Parameters:

Name	Type	Description
`recordingName`	string	A fully-qualified path representing Recording resource.

Returns:

Type	Description
string	A string representing the call.

matchCallFromSipInfoName(sipInfoName) → {string}

Parse the call from SipInfo resource.

Parameters:

Name	Type	Description
`sipInfoName`	string	A fully-qualified path representing SipInfo resource.

Returns:

Type	Description
string	A string representing the call.

matchCallFromTranscriptionName(transcriptionName) → {string}

Parse the call from Transcription resource.

Parameters:

Name	Type	Description
`transcriptionName`	string	A fully-qualified path representing Transcription resource.

Returns:

Type	Description
string	A string representing the call.

matchProjectFromAliasName(aliasName) → {string}

Parse the project from Alias resource.

Parameters:

Name	Type	Description
`aliasName`	string	A fully-qualified path representing Alias resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromCallName(callName) → {string}

Parse the project from Call resource.

Parameters:

Name	Type	Description
`callName`	string	A fully-qualified path representing Call resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromRecordingName(recordingName) → {string}

Parse the project from Recording resource.

Parameters:

Name	Type	Description
`recordingName`	string	A fully-qualified path representing Recording resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromSipDomainName(sipDomainName) → {string}

Parse the project from SipDomain resource.

Parameters:

Name	Type	Description
`sipDomainName`	string	A fully-qualified path representing SipDomain resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromSipInfoName(sipInfoName) → {string}

Parse the project from SipInfo resource.

Parameters:

Name	Type	Description
`sipInfoName`	string	A fully-qualified path representing SipInfo resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromStreamName(streamName) → {string}

Parse the project from Stream resource.

Parameters:

Name	Type	Description
`streamName`	string	A fully-qualified path representing Stream resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTranscriptionName(transcriptionName) → {string}

Parse the project from Transcription resource.

Parameters:

Name	Type	Description
`transcriptionName`	string	A fully-qualified path representing Transcription resource.

Returns:

Type	Description
string	A string representing the project.

matchRecordingFromRecordingName(recordingName) → {string}

Parse the recording from Recording resource.

Parameters:

Name	Type	Description
`recordingName`	string	A fully-qualified path representing Recording resource.

Returns:

Type	Description
string	A string representing the recording.

matchSipDomainFromAliasName(aliasName) → {string}

Parse the sip_domain from Alias resource.

Parameters:

Name	Type	Description
`aliasName`	string	A fully-qualified path representing Alias resource.

Returns:

Type	Description
string	A string representing the sip_domain.

matchSipDomainFromSipDomainName(sipDomainName) → {string}

Parse the sip_domain from SipDomain resource.

Parameters:

Name	Type	Description
`sipDomainName`	string	A fully-qualified path representing SipDomain resource.

Returns:

Type	Description
string	A string representing the sip_domain.

matchStreamsFromStreamName(streamName) → {string}

Parse the streams from Stream resource.

Parameters:

Name	Type	Description
`streamName`	string	A fully-qualified path representing Stream resource.

Returns:

Type	Description
string	A string representing the streams.

matchTranscriptionFromTranscriptionName(transcriptionName) → {string}

Parse the transcription from Transcription resource.

Parameters:

Name	Type	Description
`transcriptionName`	string	A fully-qualified path representing Transcription resource.

Returns:

Type	Description
string	A string representing the transcription.

recordingPath(project, call, recording) → {string}

Return a fully-qualified recording resource name string.

Parameters:

Name	Type	Description
`project`	string
`call`	string
`recording`	string

Returns:

Type	Description
string	Resource name string.

sipDomainPath(project, sip_domain) → {string}

Return a fully-qualified sipDomain resource name string.

Parameters:

Name	Type	Description
`project`	string
`sip_domain`	string

Returns:

Type	Description
string	Resource name string.

sipInfoPath(project, call) → {string}

Return a fully-qualified sipInfo resource name string.

Parameters:

Name	Type	Description
`project`	string
`call`	string

Returns:

Type	Description
string	Resource name string.

streamCall(optionsopt) → {Stream}

Operates a stream which can be bridged to by a call. This allows bi-directional audio to be passed. This method is only available via the gRPC API (not REST). If the stream is not connected to a call within 30 seconds of establishment, this method will fail.

Parameters:

Name	Type	Attributes	Description
`options`	object	<optional>	Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which is both readable and writable. It accepts objects representing StreamCallRequest for write() method, and will emit objects representing StreamCallResponse on 'data' event asynchronously.

streamPath(project, streams) → {string}

Return a fully-qualified stream resource name string.

Parameters:

Name	Type	Description
`project`	string
`streams`	string

Returns:

Type	Description
string	Resource name string.

transcriptionPath(project, call, transcription) → {string}

Return a fully-qualified transcription resource name string.

Parameters:

Name	Type	Description
`project`	string
`call`	string
`transcription`	string

Returns:

Type	Description
string	Resource name string.