Class DolbyVisionApi

Inheritance

System.Object

DolbyVisionApi

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.Hdr.DolbyVision

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class DolbyVisionApi

Constructors

DolbyVisionApi(IBitmovinApiClientFactory)

Declaration

public DolbyVisionApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of DolbyVisionApi

Declaration

public static BitmovinApiBuilder<DolbyVisionApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<DolbyVisionApi>

Methods

CreateAsync(String, String, DolbyVisionMetadata)

Add Dolby Vision Metadata

Declaration

public Task<DolbyVisionMetadata> CreateAsync(string encodingId, string streamId, DolbyVisionMetadata dolbyVisionMetadata)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
DolbyVisionMetadata	dolbyVisionMetadata	The Dolby Vision Metadata to be added

Returns

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

DeleteAsync(String, String, String)

Delete Dolby Vision Metadata

Declaration

public Task<BitmovinResponse> DeleteAsync(string encodingId, string streamId, string hdrId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.String	hdrId	Id of the Dolby Vision Metadata. (required)

Returns

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

GetAsync(String, String, String)

Dolby Vision Metadata Details

Declaration

public Task<DolbyVisionMetadata> GetAsync(string encodingId, string streamId, string hdrId)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding. (required)
System.String	streamId	Id of the stream. (required)
System.String	hdrId	Id of the Dolby Vision Metadata. (required)

Returns

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

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

List Dolby Vision Metadata

Declaration

public Task<PaginationResponse<DolbyVisionMetadata>> ListAsync(string encodingId, string streamId, params Func<DolbyVisionApi.ListQueryParams, DolbyVisionApi.ListQueryParams>[] queryParams)

Parameters

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

Returns

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