Class FileApi

Inheritance

System.Object

FileApi

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.Encodings.InputStreams.File

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class FileApi

Constructors

FileApi(IBitmovinApiClientFactory)

Declaration

public FileApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of FileApi

Declaration

public static BitmovinApiBuilder<FileApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<FileApi>

Methods

CreateAsync(String, FileInputStream)

Add File input stream

Declaration

public Task<FileInputStream> CreateAsync(string encodingId, FileInputStream fileInputStream)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
FileInputStream	fileInputStream	The File input stream to be created

Returns

Type	Description
System.Threading.Tasks.Task<FileInputStream>

DeleteAsync(String, String)

Delete File stream

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string inputStreamId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	inputStreamId	Id of the File input stream. (required)

Returns

Type	Description
System.Threading.Tasks.Task<BitmovinResponse>

GetAsync(String, String)

File input stream details

Declaration

public Task<FileInputStream> GetAsync(string encodingId, string inputStreamId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	inputStreamId	Id of the File input stream. (required)

Returns

Type	Description
System.Threading.Tasks.Task<FileInputStream>

ListAsync(String, Func<FileApi.ListQueryParams, FileApi.ListQueryParams>[])

List File input stream

Declaration

public Task<PaginationResponse<FileInputStream>> ListAsync(string encodingId, params Func<FileApi.ListQueryParams, FileApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.Func<FileApi.ListQueryParams, FileApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<FileInputStream>>