Show / Hide Table of Contents

Class StreamsApi

Inheritance
System.Object
StreamsApi
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.Streams
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class StreamsApi

Constructors

StreamsApi(IBitmovinApiClientFactory)

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

Properties

Bifs

Declaration
public BifsApi Bifs { get; }
Property Value
Type Description
BifsApi

Builder

Fluent builder for creating an instance of StreamsApi

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

BurnInSubtitles

Declaration
public BurnInSubtitlesApi BurnInSubtitles { get; }
Property Value
Type Description
BurnInSubtitlesApi

Captions

Declaration
public CaptionsApi Captions { get; }
Property Value
Type Description
CaptionsApi

Customdata

Declaration
public CustomdataApi Customdata { get; }
Property Value
Type Description
CustomdataApi

Filters

Declaration
public FiltersApi Filters { get; }
Property Value
Type Description
FiltersApi

Hdr

Declaration
public HdrApi Hdr { get; }
Property Value
Type Description
HdrApi

Input

Declaration
public InputApi Input { get; }
Property Value
Type Description
InputApi

Inputs

Declaration
public InputsApi Inputs { get; }
Property Value
Type Description
InputsApi

Qc

Declaration
public QcApi Qc { get; }
Property Value
Type Description
QcApi

Sprites

Declaration
public SpritesApi Sprites { get; }
Property Value
Type Description
SpritesApi

Thumbnails

Declaration
public ThumbnailsApi Thumbnails { get; }
Property Value
Type Description
ThumbnailsApi

Watermarking

Declaration
public WatermarkingApi Watermarking { get; }
Property Value
Type Description
WatermarkingApi

Methods

CreateAsync(String, Stream)

Add Stream

Declaration
public Task<Stream> CreateAsync(string encodingId, Stream stream)
Parameters
Type Name Description
System.String encodingId

Id of the encoding. (required)

Stream stream

The Stream to be created

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

DeleteAsync(String, String)

Delete Stream

Declaration
public Task<BitmovinResponse> DeleteAsync(string encodingId, string streamId)
Parameters
Type Name Description
System.String encodingId

Id of the encoding. (required)

System.String streamId

Id of the stream. (required)

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

GetAsync(String, String)

Stream Details

Declaration
public Task<Stream> GetAsync(string encodingId, string streamId)
Parameters
Type Name Description
System.String encodingId

Id of the encoding. (required)

System.String streamId

Id of the stream. (required)

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

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

List Streams

Declaration
public Task<PaginationResponse<Stream>> ListAsync(string encodingId, params Func<StreamsApi.ListQueryParams, StreamsApi.ListQueryParams>[] queryParams)
Parameters
Type Name Description
System.String encodingId

Id of the encoding. (required)

System.Func<StreamsApi.ListQueryParams, StreamsApi.ListQueryParams>[] queryParams

The query parameters for sorting, filtering and paging options (optional)

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