Class AerialView.AerialViewClient
Client for AerialView
Inherited Members
Namespace: Google.Maps.AerialView.V1
Assembly: Google.Maps.AerialView.V1.dll
Syntax
public class AerialView.AerialViewClient : ClientBase<AerialView.AerialViewClient>
Constructors
AerialViewClient()
Protected parameterless constructor to allow creation of test doubles.
Declaration
protected AerialViewClient()
AerialViewClient(CallInvoker)
Creates a new client for AerialView that uses a custom CallInvoker
.
Declaration
public AerialViewClient(CallInvoker callInvoker)
Parameters
Type | Name | Description |
---|---|---|
CallInvoker | callInvoker | The callInvoker to use to make remote calls. |
AerialViewClient(ChannelBase)
Creates a new client for AerialView
Declaration
public AerialViewClient(ChannelBase channel)
Parameters
Type | Name | Description |
---|---|---|
ChannelBase | channel | The channel to use to make remote calls. |
AerialViewClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
Declaration
protected AerialViewClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBase.ClientBaseConfiguration | configuration | The client configuration. |
Methods
LookupVideo(LookupVideoRequest, CallOptions)
Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.
Declaration
public virtual Video LookupVideo(LookupVideoRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
LookupVideoRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
Video | The response received from the server. |
LookupVideo(LookupVideoRequest, Metadata, DateTime?, CancellationToken)
Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.
Declaration
public virtual Video LookupVideo(LookupVideoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
LookupVideoRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
Video | The response received from the server. |
LookupVideoAsync(LookupVideoRequest, CallOptions)
Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.
Declaration
public virtual AsyncUnaryCall<Video> LookupVideoAsync(LookupVideoRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
LookupVideoRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<Video> | The call object. |
LookupVideoAsync(LookupVideoRequest, Metadata, DateTime?, CancellationToken)
Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.
Declaration
public virtual AsyncUnaryCall<Video> LookupVideoAsync(LookupVideoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
LookupVideoRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<Video> | The call object. |
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration
.
Declaration
protected override AerialView.AerialViewClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBase.ClientBaseConfiguration | configuration |
Returns
Type | Description |
---|---|
AerialView.AerialViewClient |
Overrides
RenderVideo(RenderVideoRequest, CallOptions)
Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.
Declaration
public virtual RenderVideoResponse RenderVideo(RenderVideoRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RenderVideoRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
RenderVideoResponse | The response received from the server. |
RenderVideo(RenderVideoRequest, Metadata, DateTime?, CancellationToken)
Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.
Declaration
public virtual RenderVideoResponse RenderVideo(RenderVideoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
RenderVideoRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
RenderVideoResponse | The response received from the server. |
RenderVideoAsync(RenderVideoRequest, CallOptions)
Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.
Declaration
public virtual AsyncUnaryCall<RenderVideoResponse> RenderVideoAsync(RenderVideoRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
RenderVideoRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<RenderVideoResponse> | The call object. |
RenderVideoAsync(RenderVideoRequest, Metadata, DateTime?, CancellationToken)
Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.
Declaration
public virtual AsyncUnaryCall<RenderVideoResponse> RenderVideoAsync(RenderVideoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
RenderVideoRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<RenderVideoResponse> | The call object. |