com.bitmovin.api.sdk.encoding.encodings.streams.qc.psnr

Class PsnrApi

java.lang.Object

com.bitmovin.api.sdk.encoding.encodings.streams.qc.psnr.PsnrApi

public class PsnrApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PsnrApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<PsnrApi>	builder() Fluent builder for creating an instance of PsnrApi
BitmovinResponse	create(String encodingId, String streamId) Activate PSNR quality metrics for the selected stream
PaginationResponse<PsnrQualityMetric>	list(String encodingId, String streamId) Get Stream PSNR metrics
PaginationResponse<PsnrQualityMetric>	list(String encodingId, String streamId, PsnrQualityMetricListQueryParams queryParams) Get Stream PSNR metrics

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PsnrApi

public PsnrApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<PsnrApi> builder()

Fluent builder for creating an instance of PsnrApi

create

public BitmovinResponse create(String encodingId,
                               String streamId)
                        throws BitmovinException

Activate PSNR quality metrics for the selected stream

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<PsnrQualityMetric> list(String encodingId,
                                                  String streamId)
                                           throws BitmovinException

Get Stream PSNR metrics

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

Returns:

List<PsnrQualityMetric>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<PsnrQualityMetric> list(String encodingId,
                                                  String streamId,
                                                  PsnrQualityMetricListQueryParams queryParams)
                                           throws BitmovinException

Get Stream PSNR metrics

Parameters:

encodingId - Id of the encoding. (required)

streamId - Id of the stream. (required)

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

Returns:

List<PsnrQualityMetric>

Throws:

BitmovinException - if fails to make API call