Class IframeApi

Inheritance

System.Object

IframeApi

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.Manifests.Hls.Streams.Iframe

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class IframeApi

Constructors

IframeApi(IBitmovinApiClientFactory)

Declaration

public IframeApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of IframeApi

Declaration

public static BitmovinApiBuilder<IframeApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<IframeApi>

Methods

CreateAsync(String, String, IFramePlaylist)

Add I-frame playlist to variant stream

Declaration

public Task<IFramePlaylist> CreateAsync(string manifestId, string streamId, IFramePlaylist iFramePlaylist)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.String	streamId	Id of the variant stream. (required)
IFramePlaylist	iFramePlaylist	The I-frame playlist to be added

Returns

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

DeleteAsync(String, String, String)

Delete I-frame playlist

Declaration

public Task<BitmovinResponse> DeleteAsync(string manifestId, string streamId, string iframeId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.String	streamId	Id of the variant stream. (required)
System.String	iframeId	Id of the Iframe-Playlist. (required)

Returns

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

GetAsync(String, String, String)

I-frame playlist Details

Declaration

public Task<IFramePlaylist> GetAsync(string manifestId, string streamId, string iframeId)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.String	streamId	Id of the variant stream. (required)
System.String	iframeId	Id of the Iframe-Playlist. (required)

Returns

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

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

List all I-frame playlists of a variant stream

Declaration

public Task<PaginationResponse<IFramePlaylist>> ListAsync(string manifestId, string streamId, params Func<IframeApi.ListQueryParams, IframeApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	manifestId	Id of the hls manifest. (required)
System.String	streamId	Id of the variant stream. (required)
System.Func<IframeApi.ListQueryParams, IframeApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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