Show / Hide Table of Contents

Class WebApi

Inheritance
System.Object
WebApi
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Bitmovin.Api.Sdk.Player.CustomBuilds.Web
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class WebApi

Constructors

WebApi(IBitmovinApiClientFactory)

Declaration
public WebApi(IBitmovinApiClientFactory apiClientFactory)
Parameters
Type Name Description
IBitmovinApiClientFactory apiClientFactory

Properties

Builder

Fluent builder for creating an instance of WebApi

Declaration
public static BitmovinApiBuilder<WebApi> Builder { get; }
Property Value
Type Description
BitmovinApiBuilder<WebApi>

Domains

Declaration
public DomainsApi Domains { get; }
Property Value
Type Description
DomainsApi

Download

Declaration
public DownloadApi Download { get; }
Property Value
Type Description
DownloadApi

Status

Declaration
public StatusApi Status { get; }
Property Value
Type Description
StatusApi

Methods

CreateAsync(CustomPlayerBuildDetails)

Add Custom Web Player Build

Declaration
public Task<CustomPlayerBuildDetails> CreateAsync(CustomPlayerBuildDetails customPlayerBuildDetails)
Parameters
Type Name Description
CustomPlayerBuildDetails customPlayerBuildDetails

The Custom Web Player Build to be added

Returns
Type Description
System.Threading.Tasks.Task<CustomPlayerBuildDetails>

GetAsync(String)

Custom Web Player Build Details

Declaration
public Task<CustomPlayerBuildStatus> GetAsync(string customBuildId)
Parameters
Type Name Description
System.String customBuildId

Id of the custom player build (required)

Returns
Type Description
System.Threading.Tasks.Task<CustomPlayerBuildStatus>

ListAsync()

List Custom Web Player Builds

Declaration
public Task<PaginationResponse<CustomPlayerBuildDetails>> ListAsync()
Returns
Type Description
System.Threading.Tasks.Task<PaginationResponse<CustomPlayerBuildDetails>>

StartAsync(String)

Start Custom Web Player Build

Declaration
public Task<BitmovinResponse> StartAsync(string customBuildId)
Parameters
Type Name Description
System.String customBuildId

Id of the custom player build (required)

Returns
Type Description
System.Threading.Tasks.Task<BitmovinResponse>
Back to top Generated by DocFX