Video Stitcher v1 API - Class VideoStitcherService.VideoStitcherServiceBase (3.3.0)

[BindServiceMethod(typeof(VideoStitcherService), "BindService")]
public abstract class VideoStitcherService.VideoStitcherServiceBase

Reference documentation and code samples for the Video Stitcher v1 API class VideoStitcherService.VideoStitcherServiceBase.

Base class for server-side implementations of VideoStitcherService

Inheritance

object > VideoStitcherService.VideoStitcherServiceBase

Namespace

Google.Cloud.Video.Stitcher.V1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Methods

CreateCdnKey(CreateCdnKeyRequest, ServerCallContext)

public virtual Task<Operation> CreateCdnKey(CreateCdnKeyRequest request, ServerCallContext context)

Creates a new CDN key.

Parameters
Name Description
request CreateCdnKeyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateLiveConfig(CreateLiveConfigRequest, ServerCallContext)

public virtual Task<Operation> CreateLiveConfig(CreateLiveConfigRequest request, ServerCallContext context)

Registers the live config with the provided unique ID in the specified region.

Parameters
Name Description
request CreateLiveConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateLiveSession(CreateLiveSessionRequest, ServerCallContext)

public virtual Task<LiveSession> CreateLiveSession(CreateLiveSessionRequest request, ServerCallContext context)

Creates a new live session.

Parameters
Name Description
request CreateLiveSessionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskLiveSession

The response to send back to the client (wrapped by a task).

CreateSlate(CreateSlateRequest, ServerCallContext)

public virtual Task<Operation> CreateSlate(CreateSlateRequest request, ServerCallContext context)

Creates a slate.

Parameters
Name Description
request CreateSlateRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateVodConfig(CreateVodConfigRequest, ServerCallContext)

public virtual Task<Operation> CreateVodConfig(CreateVodConfigRequest request, ServerCallContext context)

Registers the VOD config with the provided unique ID in the specified region.

Parameters
Name Description
request CreateVodConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateVodSession(CreateVodSessionRequest, ServerCallContext)

public virtual Task<VodSession> CreateVodSession(CreateVodSessionRequest request, ServerCallContext context)

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

Parameters
Name Description
request CreateVodSessionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskVodSession

The response to send back to the client (wrapped by a task).

DeleteCdnKey(DeleteCdnKeyRequest, ServerCallContext)

public virtual Task<Operation> DeleteCdnKey(DeleteCdnKeyRequest request, ServerCallContext context)

Deletes the specified CDN key.

Parameters
Name Description
request DeleteCdnKeyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteLiveConfig(DeleteLiveConfigRequest, ServerCallContext)

public virtual Task<Operation> DeleteLiveConfig(DeleteLiveConfigRequest request, ServerCallContext context)

Deletes the specified live config.

Parameters
Name Description
request DeleteLiveConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteSlate(DeleteSlateRequest, ServerCallContext)

public virtual Task<Operation> DeleteSlate(DeleteSlateRequest request, ServerCallContext context)

Deletes the specified slate.

Parameters
Name Description
request DeleteSlateRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteVodConfig(DeleteVodConfigRequest, ServerCallContext)

public virtual Task<Operation> DeleteVodConfig(DeleteVodConfigRequest request, ServerCallContext context)

Deletes the specified VOD config.

Parameters
Name Description
request DeleteVodConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

GetCdnKey(GetCdnKeyRequest, ServerCallContext)

public virtual Task<CdnKey> GetCdnKey(GetCdnKeyRequest request, ServerCallContext context)

Returns the specified CDN key.

Parameters
Name Description
request GetCdnKeyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskCdnKey

The response to send back to the client (wrapped by a task).

GetLiveAdTagDetail(GetLiveAdTagDetailRequest, ServerCallContext)

public virtual Task<LiveAdTagDetail> GetLiveAdTagDetail(GetLiveAdTagDetailRequest request, ServerCallContext context)

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

Parameters
Name Description
request GetLiveAdTagDetailRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskLiveAdTagDetail

The response to send back to the client (wrapped by a task).

GetLiveConfig(GetLiveConfigRequest, ServerCallContext)

public virtual Task<LiveConfig> GetLiveConfig(GetLiveConfigRequest request, ServerCallContext context)

Returns the specified live config managed by the Video Stitcher service.

Parameters
Name Description
request GetLiveConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskLiveConfig

The response to send back to the client (wrapped by a task).

GetLiveSession(GetLiveSessionRequest, ServerCallContext)

public virtual Task<LiveSession> GetLiveSession(GetLiveSessionRequest request, ServerCallContext context)

Returns the details for the specified live session.

Parameters
Name Description
request GetLiveSessionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskLiveSession

The response to send back to the client (wrapped by a task).

GetSlate(GetSlateRequest, ServerCallContext)

public virtual Task<Slate> GetSlate(GetSlateRequest request, ServerCallContext context)

Returns the specified slate.

Parameters
Name Description
request GetSlateRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSlate

The response to send back to the client (wrapped by a task).

GetVodAdTagDetail(GetVodAdTagDetailRequest, ServerCallContext)

public virtual Task<VodAdTagDetail> GetVodAdTagDetail(GetVodAdTagDetailRequest request, ServerCallContext context)

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

Parameters
Name Description
request GetVodAdTagDetailRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskVodAdTagDetail

The response to send back to the client (wrapped by a task).

GetVodConfig(GetVodConfigRequest, ServerCallContext)

public virtual Task<VodConfig> GetVodConfig(GetVodConfigRequest request, ServerCallContext context)

Returns the specified VOD config managed by the Video Stitcher API service.

Parameters
Name Description
request GetVodConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskVodConfig

The response to send back to the client (wrapped by a task).

GetVodSession(GetVodSessionRequest, ServerCallContext)

public virtual Task<VodSession> GetVodSession(GetVodSessionRequest request, ServerCallContext context)

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

Parameters
Name Description
request GetVodSessionRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskVodSession

The response to send back to the client (wrapped by a task).

GetVodStitchDetail(GetVodStitchDetailRequest, ServerCallContext)

public virtual Task<VodStitchDetail> GetVodStitchDetail(GetVodStitchDetailRequest request, ServerCallContext context)

Returns the specified stitching information for the specified VOD session.

Parameters
Name Description
request GetVodStitchDetailRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskVodStitchDetail

The response to send back to the client (wrapped by a task).

ListCdnKeys(ListCdnKeysRequest, ServerCallContext)

public virtual Task<ListCdnKeysResponse> ListCdnKeys(ListCdnKeysRequest request, ServerCallContext context)

Lists all CDN keys in the specified project and location.

Parameters
Name Description
request ListCdnKeysRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListCdnKeysResponse

The response to send back to the client (wrapped by a task).

ListLiveAdTagDetails(ListLiveAdTagDetailsRequest, ServerCallContext)

public virtual Task<ListLiveAdTagDetailsResponse> ListLiveAdTagDetails(ListLiveAdTagDetailsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListLiveAdTagDetailsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListLiveAdTagDetailsResponse

The response to send back to the client (wrapped by a task).

ListLiveConfigs(ListLiveConfigsRequest, ServerCallContext)

public virtual Task<ListLiveConfigsResponse> ListLiveConfigs(ListLiveConfigsRequest request, ServerCallContext context)

Lists all live configs managed by the Video Stitcher that belong to the specified project and region.

Parameters
Name Description
request ListLiveConfigsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListLiveConfigsResponse

The response to send back to the client (wrapped by a task).

ListSlates(ListSlatesRequest, ServerCallContext)

public virtual Task<ListSlatesResponse> ListSlates(ListSlatesRequest request, ServerCallContext context)

Lists all slates in the specified project and location.

Parameters
Name Description
request ListSlatesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListSlatesResponse

The response to send back to the client (wrapped by a task).

ListVodAdTagDetails(ListVodAdTagDetailsRequest, ServerCallContext)

public virtual Task<ListVodAdTagDetailsResponse> ListVodAdTagDetails(ListVodAdTagDetailsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListVodAdTagDetailsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListVodAdTagDetailsResponse

The response to send back to the client (wrapped by a task).

ListVodConfigs(ListVodConfigsRequest, ServerCallContext)

public virtual Task<ListVodConfigsResponse> ListVodConfigs(ListVodConfigsRequest request, ServerCallContext context)

Lists all VOD configs managed by the Video Stitcher API that belong to the specified project and region.

Parameters
Name Description
request ListVodConfigsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListVodConfigsResponse

The response to send back to the client (wrapped by a task).

ListVodStitchDetails(ListVodStitchDetailsRequest, ServerCallContext)

public virtual Task<ListVodStitchDetailsResponse> ListVodStitchDetails(ListVodStitchDetailsRequest request, ServerCallContext context)

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

Parameters
Name Description
request ListVodStitchDetailsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListVodStitchDetailsResponse

The response to send back to the client (wrapped by a task).

UpdateCdnKey(UpdateCdnKeyRequest, ServerCallContext)

public virtual Task<Operation> UpdateCdnKey(UpdateCdnKeyRequest request, ServerCallContext context)

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

Parameters
Name Description
request UpdateCdnKeyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateLiveConfig(UpdateLiveConfigRequest, ServerCallContext)

public virtual Task<Operation> UpdateLiveConfig(UpdateLiveConfigRequest request, ServerCallContext context)

Updates the specified LiveConfig. Only update fields specified in the call method body.

Parameters
Name Description
request UpdateLiveConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateSlate(UpdateSlateRequest, ServerCallContext)

public virtual Task<Operation> UpdateSlate(UpdateSlateRequest request, ServerCallContext context)

Updates the specified slate.

Parameters
Name Description
request UpdateSlateRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateVodConfig(UpdateVodConfigRequest, ServerCallContext)

public virtual Task<Operation> UpdateVodConfig(UpdateVodConfigRequest request, ServerCallContext context)

Updates the specified VOD config. Only update fields specified in the call method body.

Parameters
Name Description
request UpdateVodConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).