Class PrewarmedEncoderPoolsApi
Inheritance
System.Object
PrewarmedEncoderPoolsApi
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.Encoding.Infrastructure.PrewarmedEncoderPools
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class PrewarmedEncoderPoolsApiConstructors
PrewarmedEncoderPoolsApi(IBitmovinApiClientFactory)
Declaration
public PrewarmedEncoderPoolsApi(IBitmovinApiClientFactory apiClientFactory)Parameters
| Type | Name | Description |
|---|---|---|
| IBitmovinApiClientFactory | apiClientFactory |
Properties
Builder
Fluent builder for creating an instance of PrewarmedEncoderPoolsApi
Declaration
public static BitmovinApiBuilder<PrewarmedEncoderPoolsApi> Builder { get; }Property Value
| Type | Description |
|---|---|
| BitmovinApiBuilder<PrewarmedEncoderPoolsApi> |
Schedules
Declaration
public SchedulesApi Schedules { get; }Property Value
| Type | Description |
|---|---|
| SchedulesApi |
Methods
CreateAsync(PrewarmedEncoderPool)
Create prewarmed encoder pool
Declaration
public Task<PrewarmedEncoderPool> CreateAsync(PrewarmedEncoderPool prewarmedEncoderPool)Parameters
| Type | Name | Description |
|---|---|---|
| PrewarmedEncoderPool | prewarmedEncoderPool | The prewarmed encoder pool to be created |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PrewarmedEncoderPool> |
DeleteAsync(String)
Delete prewarmed encoder pool
Declaration
public Task<BitmovinResponse> DeleteAsync(string poolId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | poolId | Id of the prewarmed encoder pool (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BitmovinResponse> |
GetAsync(String)
Prewarmed encoder pool details
Declaration
public Task<PrewarmedEncoderPool> GetAsync(string poolId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | poolId | Id of the prewarmed encoder pool (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PrewarmedEncoderPool> |
ListAsync(Func<PrewarmedEncoderPoolsApi.ListQueryParams, PrewarmedEncoderPoolsApi.ListQueryParams>[])
List prewarmed encoder pools
Declaration
public Task<PaginationResponse<PrewarmedEncoderPool>> ListAsync(params Func<PrewarmedEncoderPoolsApi.ListQueryParams, PrewarmedEncoderPoolsApi.ListQueryParams>[] queryParams)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<PrewarmedEncoderPoolsApi.ListQueryParams, PrewarmedEncoderPoolsApi.ListQueryParams>[] | queryParams | The query parameters for sorting, filtering and paging options (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PaginationResponse<PrewarmedEncoderPool>> |
StartAsync(String)
Start prewarmed encoder pool
Declaration
public Task<BitmovinResponse> StartAsync(string poolId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | poolId | Id of the prewarmed encoder pool to be started (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BitmovinResponse> |
StopAsync(String)
Stop prewarmed encoder pool
Declaration
public Task<BitmovinResponse> StopAsync(string poolId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | poolId | Id of the prewarmed encoder pool to be stopped (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BitmovinResponse> |