Class EncodingStatusChangedApi

Inheritance

System.Object

EncodingStatusChangedApi

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.Notifications.Webhooks.Encoding.Encodings.EncodingStatusChanged

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class EncodingStatusChangedApi

Constructors

EncodingStatusChangedApi(IBitmovinApiClientFactory)

Declaration

public EncodingStatusChangedApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of EncodingStatusChangedApi

Declaration

public static BitmovinApiBuilder<EncodingStatusChangedApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<EncodingStatusChangedApi>

Methods

CreateAsync(WebhookNotificationWithStreamConditionsRequest)

Add Encoding Changed Webhook Notification (All Encodings)

Declaration

public Task<WebhookNotificationWithStreamConditions> CreateAsync(WebhookNotificationWithStreamConditionsRequest webhookNotificationWithStreamConditionsRequest)

Parameters

Type	Name	Description
WebhookNotificationWithStreamConditionsRequest	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

Returns

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

CreateByEncodingIdAsync(String, WebhookNotificationWithStreamConditionsRequest)

Add Encoding Changed Webhook Notification (Specific Encoding)

Declaration

public Task<WebhookNotificationWithStreamConditions> CreateByEncodingIdAsync(string encodingId, WebhookNotificationWithStreamConditionsRequest webhookNotificationWithStreamConditionsRequest)

Parameters

Type	Name	Description
System.String	encodingId	Id of the encoding resource (required)
WebhookNotificationWithStreamConditionsRequest	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

Returns

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

DeleteByWebhookIdAsync(String)

Delete Encoding Status Changed Webhook

Declaration

public Task<BitmovinResponse> DeleteByWebhookIdAsync(string notificationId)

Parameters

Type	Name	Description
System.String	notificationId	Id of the webhook (required)

Returns

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

UpdateAsync(String, WebhookNotificationWithStreamConditionsRequest)

Replace Encoding Status Changed Webhook Notification

Declaration

public Task<WebhookNotificationWithStreamConditions> UpdateAsync(string notificationId, WebhookNotificationWithStreamConditionsRequest webhookNotificationWithStreamConditionsRequest)

Parameters

Type	Name	Description
System.String	notificationId	Id of the webhook notification (required)
WebhookNotificationWithStreamConditionsRequest	webhookNotificationWithStreamConditionsRequest	The webhook notification with the updated values

Returns

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