com.bitmovin.api.sdk.notifications.webhooks.encoding.encodings.encodingStatusChanged

Class EncodingStatusChangedApi

java.lang.Object

com.bitmovin.api.sdk.notifications.webhooks.encoding.encodings.encodingStatusChanged.EncodingStatusChangedApi

public class EncodingStatusChangedApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EncodingStatusChangedApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<EncodingStatusChangedApi>	builder() Fluent builder for creating an instance of EncodingStatusChangedApi
WebhookNotificationWithStreamConditions	create(WebhookNotificationWithStreamConditionsRequest webhookNotificationWithStreamConditionsRequest) Add Encoding Changed Webhook Notification (All Encodings)
WebhookNotificationWithStreamConditions	createByEncodingId(String encodingId, WebhookNotificationWithStreamConditionsRequest webhookNotificationWithStreamConditionsRequest) Add Encoding Changed Webhook Notification (Specific Encoding)
BitmovinResponse	deleteByWebhookId(String notificationId) Delete Encoding Status Changed Webhook
WebhookNotificationWithStreamConditions	update(String notificationId, WebhookNotificationWithStreamConditionsRequest webhookNotificationWithStreamConditionsRequest) Replace Encoding Status Changed Webhook Notification

Methods inherited from class java.lang.Object

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

Constructor Detail

EncodingStatusChangedApi

public EncodingStatusChangedApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<EncodingStatusChangedApi> builder()

Fluent builder for creating an instance of EncodingStatusChangedApi

create

public WebhookNotificationWithStreamConditions create(WebhookNotificationWithStreamConditionsRequest webhookNotificationWithStreamConditionsRequest)
                                               throws BitmovinException

Add Encoding Changed Webhook Notification (All Encodings)

Parameters:

webhookNotificationWithStreamConditionsRequest - The webhook notifications object. For conditions, following attributes are possible: 'type': 'Input file download', 'Input file analysis', 'Per-Title analysis', 'Encoding', 'Progressive Muxing' 'progress': number in range of 0-100 'status': 'RUNNING', 'FINISHED', 'ERROR' Examples: To only get notified about the encoding process, create a Condition object and set attribute='type', value='Encoding', operator=EQUAL To only get notified if a workflow step is finished, create a Condition object and set attribute='status', value='FINISHED', operator=EQUAL To only get notified if a workflow step is over 50%, create a Condition object and set attribute='progress', value='50', operator=GREATER_THAN (required)

Returns:

WebhookNotificationWithStreamConditions

Throws:

BitmovinException - if fails to make API call

createByEncodingId

public WebhookNotificationWithStreamConditions createByEncodingId(String encodingId,
                                                                  WebhookNotificationWithStreamConditionsRequest webhookNotificationWithStreamConditionsRequest)
                                                           throws BitmovinException

Add Encoding Changed Webhook Notification (Specific Encoding)

Parameters:

encodingId - Id of the encoding resource (required)

webhookNotificationWithStreamConditionsRequest - The webhook notifications object. For conditions, following attributes are possible: 'type': 'Input file download', 'Input file analysis', 'Per-Title analysis', 'Encoding', 'Progressive Muxing' 'progress': number in range of 0-100 'status': 'RUNNING', 'FINISHED', 'ERROR' Examples: To only get notified about the encoding process, create a Condition object and set attribute='type', value='Encoding', operator=EQUAL To only get notified if a workflow step is finished, create a Condition object and set attribute='status', value='FINISHED', operator=EQUAL To only get notified if a workflow step is over 50%, create a Condition object and set attribute='progress', value='50', operator=GREATER_THAN (required)

Returns:

WebhookNotificationWithStreamConditions

Throws:

BitmovinException - if fails to make API call

deleteByWebhookId

public BitmovinResponse deleteByWebhookId(String notificationId)
                                   throws BitmovinException

Delete Encoding Status Changed Webhook

Parameters:

notificationId - Id of the webhook (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

update

public WebhookNotificationWithStreamConditions update(String notificationId,
                                                      WebhookNotificationWithStreamConditionsRequest webhookNotificationWithStreamConditionsRequest)
                                               throws BitmovinException

Replace Encoding Status Changed Webhook Notification

Parameters:

notificationId - Id of the webhook notification (required)

webhookNotificationWithStreamConditionsRequest - The webhook notification with the updated values (required)

Returns:

WebhookNotificationWithStreamConditions

Throws:

BitmovinException - if fails to make API call