LivestreamService - Documentation

Constructor

new LivestreamService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new LivestreamService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

createAsset(request, callback) → {undefined}

Calls CreateAsset.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.ICreateAssetRequest	CreateAssetRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.CreateAssetCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createAsset(request) → {Promise.<google.longrunning.Operation>}

Calls CreateAsset.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.ICreateAssetRequest	CreateAssetRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createChannel(request, callback) → {undefined}

Calls CreateChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.ICreateChannelRequest	CreateChannelRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.CreateChannelCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createChannel(request) → {Promise.<google.longrunning.Operation>}

Calls CreateChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.ICreateChannelRequest	CreateChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

createEvent(request, callback) → {undefined}

Calls CreateEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.ICreateEventRequest	CreateEventRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.CreateEventCallback	Node-style callback called with the error, if any, and Event

Returns:

Type	Description
undefined

createEvent(request) → {Promise.<google.cloud.video.livestream.v1.Event>}

Calls CreateEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.ICreateEventRequest	CreateEventRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.Event>	Promise

createInput(request, callback) → {undefined}

Calls CreateInput.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.ICreateInputRequest	CreateInputRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.CreateInputCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createInput(request) → {Promise.<google.longrunning.Operation>}

Calls CreateInput.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.ICreateInputRequest	CreateInputRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteAsset(request, callback) → {undefined}

Calls DeleteAsset.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IDeleteAssetRequest	DeleteAssetRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.DeleteAssetCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteAsset(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteAsset.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IDeleteAssetRequest	DeleteAssetRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteChannel(request, callback) → {undefined}

Calls DeleteChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IDeleteChannelRequest	DeleteChannelRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.DeleteChannelCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteChannel(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IDeleteChannelRequest	DeleteChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteEvent(request, callback) → {undefined}

Calls DeleteEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IDeleteEventRequest	DeleteEventRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.DeleteEventCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteEvent(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IDeleteEventRequest	DeleteEventRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

deleteInput(request, callback) → {undefined}

Calls DeleteInput.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IDeleteInputRequest	DeleteInputRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.DeleteInputCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteInput(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteInput.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IDeleteInputRequest	DeleteInputRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

getAsset(request, callback) → {undefined}

Calls GetAsset.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetAssetRequest	GetAssetRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.GetAssetCallback	Node-style callback called with the error, if any, and Asset

Returns:

Type	Description
undefined

getAsset(request) → {Promise.<google.cloud.video.livestream.v1.Asset>}

Calls GetAsset.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetAssetRequest	GetAssetRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.Asset>	Promise

getChannel(request, callback) → {undefined}

Calls GetChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetChannelRequest	GetChannelRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.GetChannelCallback	Node-style callback called with the error, if any, and Channel

Returns:

Type	Description
undefined

getChannel(request) → {Promise.<google.cloud.video.livestream.v1.Channel>}

Calls GetChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetChannelRequest	GetChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.Channel>	Promise

getEvent(request, callback) → {undefined}

Calls GetEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetEventRequest	GetEventRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.GetEventCallback	Node-style callback called with the error, if any, and Event

Returns:

Type	Description
undefined

getEvent(request) → {Promise.<google.cloud.video.livestream.v1.Event>}

Calls GetEvent.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetEventRequest	GetEventRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.Event>	Promise

getInput(request, callback) → {undefined}

Calls GetInput.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetInputRequest	GetInputRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.GetInputCallback	Node-style callback called with the error, if any, and Input

Returns:

Type	Description
undefined

getInput(request) → {Promise.<google.cloud.video.livestream.v1.Input>}

Calls GetInput.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetInputRequest	GetInputRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.Input>	Promise

getPool(request, callback) → {undefined}

Calls GetPool.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetPoolRequest	GetPoolRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.GetPoolCallback	Node-style callback called with the error, if any, and Pool

Returns:

Type	Description
undefined

getPool(request) → {Promise.<google.cloud.video.livestream.v1.Pool>}

Calls GetPool.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IGetPoolRequest	GetPoolRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.Pool>	Promise

listAssets(request, callback) → {undefined}

Calls ListAssets.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IListAssetsRequest	ListAssetsRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.ListAssetsCallback	Node-style callback called with the error, if any, and ListAssetsResponse

Returns:

Type	Description
undefined

listAssets(request) → {Promise.<google.cloud.video.livestream.v1.ListAssetsResponse>}

Calls ListAssets.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IListAssetsRequest	ListAssetsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.ListAssetsResponse>	Promise

listChannels(request, callback) → {undefined}

Calls ListChannels.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IListChannelsRequest	ListChannelsRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.ListChannelsCallback	Node-style callback called with the error, if any, and ListChannelsResponse

Returns:

Type	Description
undefined

listChannels(request) → {Promise.<google.cloud.video.livestream.v1.ListChannelsResponse>}

Calls ListChannels.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IListChannelsRequest	ListChannelsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.ListChannelsResponse>	Promise

listEvents(request, callback) → {undefined}

Calls ListEvents.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IListEventsRequest	ListEventsRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.ListEventsCallback	Node-style callback called with the error, if any, and ListEventsResponse

Returns:

Type	Description
undefined

listEvents(request) → {Promise.<google.cloud.video.livestream.v1.ListEventsResponse>}

Calls ListEvents.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IListEventsRequest	ListEventsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.ListEventsResponse>	Promise

listInputs(request, callback) → {undefined}

Calls ListInputs.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IListInputsRequest	ListInputsRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.ListInputsCallback	Node-style callback called with the error, if any, and ListInputsResponse

Returns:

Type	Description
undefined

listInputs(request) → {Promise.<google.cloud.video.livestream.v1.ListInputsResponse>}

Calls ListInputs.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IListInputsRequest	ListInputsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.video.livestream.v1.ListInputsResponse>	Promise

startChannel(request, callback) → {undefined}

Calls StartChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IStartChannelRequest	StartChannelRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.StartChannelCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

startChannel(request) → {Promise.<google.longrunning.Operation>}

Calls StartChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IStartChannelRequest	StartChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

stopChannel(request, callback) → {undefined}

Calls StopChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IStopChannelRequest	StopChannelRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.StopChannelCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

stopChannel(request) → {Promise.<google.longrunning.Operation>}

Calls StopChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IStopChannelRequest	StopChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updateChannel(request, callback) → {undefined}

Calls UpdateChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IUpdateChannelRequest	UpdateChannelRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.UpdateChannelCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateChannel(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateChannel.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IUpdateChannelRequest	UpdateChannelRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updateInput(request, callback) → {undefined}

Calls UpdateInput.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IUpdateInputRequest	UpdateInputRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.UpdateInputCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateInput(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateInput.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IUpdateInputRequest	UpdateInputRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updatePool(request, callback) → {undefined}

Calls UpdatePool.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IUpdatePoolRequest	UpdatePoolRequest message or plain object
`callback`	google.cloud.video.livestream.v1.LivestreamService.UpdatePoolCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updatePool(request) → {Promise.<google.longrunning.Operation>}

Calls UpdatePool.

Parameters:

Name	Type	Description
`request`	google.cloud.video.livestream.v1.IUpdatePoolRequest	UpdatePoolRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {LivestreamService}

Creates new LivestreamService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
LivestreamService	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateAssetCallback(error, responseopt)

Callback as used by createAsset.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateChannelCallback(error, responseopt)

Callback as used by createChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateEventCallback(error, responseopt)

Callback as used by createEvent.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.Event	<optional>	Event

CreateInputCallback(error, responseopt)

Callback as used by createInput.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteAssetCallback(error, responseopt)

Callback as used by deleteAsset.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteChannelCallback(error, responseopt)

Callback as used by deleteChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteEventCallback(error, responseopt)

Callback as used by deleteEvent.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

DeleteInputCallback(error, responseopt)

Callback as used by deleteInput.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

GetAssetCallback(error, responseopt)

Callback as used by getAsset.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.Asset	<optional>	Asset

GetChannelCallback(error, responseopt)

Callback as used by getChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.Channel	<optional>	Channel

GetEventCallback(error, responseopt)

Callback as used by getEvent.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.Event	<optional>	Event

GetInputCallback(error, responseopt)

Callback as used by getInput.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.Input	<optional>	Input

GetPoolCallback(error, responseopt)

Callback as used by getPool.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.Pool	<optional>	Pool

ListAssetsCallback(error, responseopt)

Callback as used by listAssets.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.ListAssetsResponse	<optional>	ListAssetsResponse

ListChannelsCallback(error, responseopt)

Callback as used by listChannels.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.ListChannelsResponse	<optional>	ListChannelsResponse

ListEventsCallback(error, responseopt)

Callback as used by listEvents.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.ListEventsResponse	<optional>	ListEventsResponse

ListInputsCallback(error, responseopt)

Callback as used by listInputs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.video.livestream.v1.ListInputsResponse	<optional>	ListInputsResponse

StartChannelCallback(error, responseopt)

Callback as used by startChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

StopChannelCallback(error, responseopt)

Callback as used by stopChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateChannelCallback(error, responseopt)

Callback as used by updateChannel.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateInputCallback(error, responseopt)

Callback as used by updateInput.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdatePoolCallback(error, responseopt)

Callback as used by updatePool.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation