bitmovin_api_sdk.notifications.webhooks.encoding.encodings.encoding_status_changed package

Submodules

bitmovin_api_sdk.notifications.webhooks.encoding.encodings.encoding_status_changed.encoding_status_changed_api module

class bitmovin_api_sdk.notifications.webhooks.encoding.encodings.encoding_status_changed.encoding_status_changed_api.EncodingStatusChangedApi(**kwargs)[source]

Bases: BaseApi

create(webhook_notification_with_stream_conditions_request: WebhookNotificationWithStreamConditionsRequest, **kwargs: dict) → WebhookNotificationWithStreamConditions[source]

Add Encoding Changed Webhook Notification (All Encodings)

Parameters: webhook_notification_with_stream_conditions_request (WebhookNotificationWithStreamConditionsRequest, required) – 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: Notification Details
Return type: WebhookNotificationWithStreamConditions

create_by_encoding_id(encoding_id: string_types, webhook_notification_with_stream_conditions_request: WebhookNotificationWithStreamConditionsRequest, **kwargs: dict) → WebhookNotificationWithStreamConditions[source]

Add Encoding Changed Webhook Notification (Specific Encoding)

Parameters

encoding_id (string_types, required) – Id of the encoding resource
webhook_notification_with_stream_conditions_request (WebhookNotificationWithStreamConditionsRequest, required) – 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

Notification Details

Return type

WebhookNotificationWithStreamConditions

delete_by_webhook_id(notification_id: string_types, **kwargs: dict) → BitmovinResponse[source]

Delete Encoding Status Changed Webhook

Parameters: notification_id (string_types, required) – Id of the webhook
Returns: Id of the webhook
Return type: BitmovinResponse

update(notification_id: string_types, webhook_notification_with_stream_conditions_request: WebhookNotificationWithStreamConditionsRequest, **kwargs: dict) → WebhookNotificationWithStreamConditions[source]

Replace Encoding Status Changed Webhook Notification