Kaltura Enums Related to REACH API

In this article we list Kaltura ENUMs which are used in Reach jobs in Reach integration flows.

KalturaEntryVendorTaskStatus

https://developer.kaltura.com/api-docs/General_Objects/Enums/KalturaEntryVendorTaskStatus

At the time of writing this document, we support the following statuses:

Name

Value

PENDING

1

READY

2

PROCESSING

3

PENDING_MODERATION

4

REJECTED

5

ERROR

6

ABORTED

7

PENDING_ENTRY_READY

8

SCHEDULED

9

This is a description of the status values:

  • PENDING  The job is ready to be picked up by the vendor (This is the status the vendor should use to filter jobs that are waiting to be handled)

  • READY This status is one of the final job statuses available. By setting this status, the vendor states that the processing of the task and the ingestion of the results were successful. 

  • PROCESSING This status is set after vendor picked up the job and started handling it.

  • PENDING_MODERATION (internal in Kaltura) States the job was not yet approved for execution on the vendor side. The accounts admin still needs to approve it for execution by "moving" the job to PENDING status.

  • REJECTED (internal in Kaltura)  The account admin rejected the job from being executed.

  • ERROR The vendor should use this status when an error occurred on his end while handling the request. The error could be related to issues originating from Kaltura or from the Vendor itself (accessKey expired, Kaltura API returned an error, failure process Task by the vendor, etc.). When setting this status the errDescription field should always be filled with a short description about the failure cause.

  • ABORTED (internal in Kaltura) The job was aborted by either the account admin or the user that initiated the task 

  • PENDING ENTRY READY (internal in Kaltura)

In case of an error where the vendor’s REACH deliverables are ready but cannot be sent back to Kaltura, it alright to keep them for few more days, in order to re-try or investigate issues manually. That said, you should immediately raise a support ticket for investigation in order to avoid stale files that are not deleted according to the customers' deletion policy.

KalturaVendorServiceType

https://developer.kaltura.com/api-docs/General_Objects/Enums/KalturaVendorServiceType

At the time of writing of this document, we support the following Service Types:

Name

Value

HUMAN

1

MACHINE

2

KalturaCatalogItemLanguage

List of all languages which can be used for source language and target language parameter values. API calls expect and return the values, not the key name:

KalturaCatalogItemLanguage - Kaltura VPaaS API Documentation

At the time of writing this document, we support the following Catalog Item Languages:

Name

Value

AR

Arabic

YUE

Cantonese

CA

Catalan

ZH

Chinese

CS

Czech

DA

Danish

NL

Dutch

EN

English

EN_US

English (American)

EN_GB

English (British)

FI

Finnish

FR

French

FR_CA

French (Canada)

GD

Gaelic (Scottish)

DE

German

EL

Greek

HE

Hebrew

HI

Hindi

HU

Hungarian

IS

Icelandic

IN

Indonesian

GA

Irish

IT

Italian

JA

Japanese

KO

Korean

ML

Malayalam

CMN

Mandarin Chinese

NO

Norwegian

PL

Polish

PT

Portuguese

PT_BR

Portuguese (Brazil)

RO

Romanian

RU

Russian

ES

Spanish

ES_XL

Spanish (Latin America)

SV

Swedish

ZH_TW

Taiwanese Mandarin

TA

Tamil

TH

Thai

TR

Turkish

UK

Ukrainian

UR

Urdu

VI

Vietnamese

CY

Welsh

ZU

Zulu

AF

Afrikaans

BG

Bulgarian

ET

Estonian

LV

Latvian

LT

Lithuanian

SK

Slovak

BA

Bashkir

EU

Basque

BE

Belarusian

HR

Croatian

EO

Esperanto

FA

Farsi

GL

Galician

IA

Interlingua

MS

Malay

MR

Marathi

MN

Mongolian

SL

Slovenian

TE

Telugu

UG

Uighur

ENAU

English (Australian)

AZ

Azerbaijani

BN

Bengali

MY

Burmese

BS

Bosnian

KA

Georgian

GU

Gujarati

JV

Javanese

KN

Kannada

KK

Kazakh

KM

Khmer

LO

Lao

MK

Macedonian

NE

Nepali

FAIR

Persian (Iran)

PA

Punjabi

SR

Serbian

SI

Sinhala

SKSK

Slovakian

SU

Sudanese

SW

Swahili

TL

Tagalog (Filipino)

UZ

Uzbek

XH

Xhosa

ZHCN

Simplified Chinese

ZHHK

Traditional Chinese


KalturaVendorServiceFeature

https://developer.kaltura.com/api-docs/General_Objects/Enums/KalturaVendorServiceFeature

At the time of writing of this document, we support the following Service features:

Name

Value

CAPTIONS

1

TRANSLATION

2

ALIGNMENT

3

AUDIO_DESCRIPTION

4

CHAPTERING

5

INTELLIGENT_TAGGING

6

DUBBING

7

LIVE_CAPTION

8

EXTENDED_AUDIO_DESCRIPTION

9

KalturaVendorServiceTurnAroundTime

https://developer.kaltura.com/api-docs/General_Objects/Enums/KalturaVendorServiceTurnAroundTime

At the time of writing of this document, we support the following Turn Around Times:

Name

Value

BEST_EFFORT

-1

IMMEDIATE

0

ONE_BUSINESS_DAY

1

TWO_BUSINESS_DAYS

2

THREE_BUSINESS_DAYS

3

FOUR_BUSINESS_DAYS

4

FIVE_BUSINESS_DAYS

5

SIX_BUSINESS_DAYS

6

SEVEN_BUSINESS_DAYS

7

THIRTY_MINUTES

1800

TWO_HOURS

7200

THREE_HOURS

10800

SIX_HOURS

21600

EIGHT_HOURS

28800

TWELVE_HOURS

43200

TWENTY_FOUR_HOURS

86400

FORTY_EIGHT_HOURS

172800

FOUR_DAYS

345600

FIVE_DAYS

432000

TEN_DAYS

864000

KalturaVendorCatalogItemOutputFormat

https://developer.kaltura.com/api-docs/General_Objects/Enums/KalturaVendorCatalogItemOutputFormat

At the time of writing of this document, we support the following output formats:

Name

Value

SRT

1

DFXP

2

VTT

3

Deletion Policy

Kaltura users are very sensitive about their content. Thus, each task will contain a deletion policy which the vendor is required to obey. Each Task will contain an attribute called contentDeletionPolicy (inside reach_vendor_profile) which will define if and for how long the vendor is allowed to store the media file obtained from Kaltura on their servers. The available deletion policies are:

https://developer.kaltura.com/api-docs/General_Objects/Enums/KalturaReachProfileContentDeletionPolicy

At the time of writing of this document, we support the following deletion settings:

Name

Value

DO_NOTHING

1

DELETE_ONCE_PROCESSED

2

DELETE_AFTER_WEEK

3

DELETE_AFTER_MONTH

4

DELETE_AFTER_THREE_MONTHS

5

KalturaVendorTaskProcessingRegion

This value is configured on the reach profile object and its purpose is to inform the vendor on which region should the task processing take place. Some of the clients are very aware of where is their content being processed and do not allow for it to leave their state (For example US customers don't want their content to be processed outside the US).

KalturaVendorTaskProcessingRegion - Kaltura VPaaS API Documentation

At the time of writing of this document, we support the following region settings:

Name

Value

US

1

EU

2

CA

3

 

KalturaCaptionUsage

This value is configured on the caption object and its purpose is to inform Kaltura whether the caption file should be treated as a Captions file or as an Extended Audio Descriptions file.

At the time of writing of this document, we support the following caption usage settings:

Name

Value

CAPTION

0

EXTENDED_AUDIO_DESCRIPTION

1

0 or nothing is Caption.


Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted.

In This Article
Related Articles
Back to top

Never miss a thing!

Subscribe to our customer newsletter and our release notes updates, so you always get the best out of Kaltura.
Newsletter