Kaltura API DocumentationcaptionAsset.list

List caption Assets by filter and pager

Try it out
post https://www.kaltura.com/api_v3/service/caption_captionasset/action/list

Request Parameters

body:object
object
filter:object:KalturaAssetFilter
objectType:string
Enum: KalturaAttachmentAssetFilter, KalturaTranscriptAssetFilter, KalturaCaptionAssetFilter, KalturaCaptionAssetItemFilter, KalturaFlavorAssetFilter, KalturaLiveAssetFilter, KalturaWidevineFlavorAssetFilter, KalturaThumbAssetFilter, KalturaTimedThumbAssetFilter
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], DELETED_AT_ASC [+deletedAt], SIZE_ASC [+size], UPDATED_AT_ASC [+updatedAt], CREATED_AT_DESC [-createdAt], DELETED_AT_DESC [-deletedAt], SIZE_DESC [-size], UPDATED_AT_DESC [-updatedAt]
typeIn:string
KalturaAssetFilter must also match all of:
object:KalturaAssetBaseFilter
pager:object:KalturaFilterPager

The KalturaFilterPager object enables paging management to be applied upon service list actions.

KalturaFilterPager must also match all of:
object:KalturaPager

Response

Success

object:KalturaCaptionAssetListResponse
objects:array[object:KalturaCaptionAsset]
object:KalturaCaptionAsset
accuracy:integer

The Accuracy of the caption content

captionParamsId:integer

insertOnly

The Caption Params used to create this Caption Asset

displayOnPlayer:boolean

The Accuracy of the caption content

format:string
Enum: SRT [1], DFXP [2], WEBVTT [3], CAP [4]

insertOnly

Enum Type: KalturaCaptionType

The caption format

isDefault:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]

Enum Type: KalturaNullableBoolean

Is default caption asset of the entry

label:string

Friendly label

language:string
Enum: Abaza, Abkhazian, Abnaki Western, Abure, Achang, Achinese, Achterhooks, Achumawi, Adioukrou, Adyghe; Adygei, Adynyamathanha, Afade, Afar, Afrikaans, Aghem, Aghul, Aguacateco, Aguaruna, Ainu (Japan), Akkadian, Aklanon, Akum, Alabama, Albanian, Albanian (Gheg), Albanian (Tosk), Aleut, Algonquian languages, Algonquin, Altai (Southern), Amharic, Angloromani, Apache (Jicarilla), Apache (Western), Arabic, Arabic (standard), Arabic Tunisian Spoken, Aramaic, Aramaic Samaritan, Arapaho, Araucanian, Arikara, Armenian, Aromanian, Assamese, Assiniboine, Assyrian Neo-Aramaic, Asturian, Athapascan languages, Atikamekw, Awadhi, Aymara, Azerbaijani, Babine, Badaga, Bai, Balinese, Balochi Southern, Balti, Baluchi, Basa (Cameroon), Bashkir, Basque, Bavarian, Beaver, Beja, Bemba (Zambia), Bengali (Bangla), Betawi, Bezhta, Bhili, Bhojpuri, Bhutani, Bihari, Bikol, Bini, Bishnupriya Manipuri, Bislama, Breton, Buginese, Bulgarian, Buriat, Burmese, Byelorussian (Belarusian), Caddo, Cambodian, Cantonese, Carrier, Carrier Southern, Catalan, Catawba, Cayuga, Cebuano, Chagatai, Chaldean Neo-Aramaic, Cherokee, Cheyenne, Chickasaw, Chilcotin, Chinese, Chinook jargon, Chipewyan, Chippewa, Choctaw, Chor, Chukot, Cimbrian, Clallam Klallam, Cochimi, Cocopa, Colognian, Comanche, Comorian, Comox, Coptic, Corsican, Cree, Creek, Crimean Tatar, Croatian, Cupeo, Czech, Dakota, Danish, Dargwa, Dari (Persian), Dari Zoroastrian, Dehu, Delaware, Dinka, Dogri (generic), Dogrib, Dolgan, Dong, Duala, Dungan, Dutch, Dyula, E, Emilian, English, English (American), English (British), English Middle (1100-1500), Erzya, Esperanto, Estonian, Even, Evenki, Faeroese, Fala, Fang (Equatorial Guinea), Farsi, Fiji, Filipino, Finnish, Finnish (Tornedalen), Fon, Franco-Prove, Frankish, French, Frisian, Frisian Northern, Friulian, Fur, Ga, Gaelic (Manx), Gaelic (Scottish), Gagauz, Galician, Gan, Geez, Georgian, German, German Hutterite, German Pennsylvania, Gilbertese, Gilyak Nivkh, Gitxsan, Greek, Greek Ancient (to 1453), Greenlandic, Guarani, Gujarati, Gwichin, Haida, Hainanese, Haisla, Hakka, Halkomelem, Han, Hani, Hausa, Hawaiian, Hebrew, Heiltsuk, Hidatsa, Hiligaynon, Hindi, Hmong, Hokkien, Hopi, Huizhou Chinese, Hungarian, Icelandic, Ikposo, Iloko, Inari Sami, Indonesian, Ingrian, Ingush, Interlingua, Interlingue, Inuinnaqtun, Inuktitut, Inupiak, Irish, Iroquoian languages, Italian, Itelmen, Japanese, Javanese, Jinyu Chinese, Jju, Judeo-Crimean Tatar, Judeo-Georgian, Jutish, Kabardian, Kabuverdianu, Kabyle, Kachchi, Kaikavian literary language (Kajkavian), Kalmyk Oirat, Kannada, Kansa, Karachay-Balkar, Karagas, Karaim, Karakalpak, Karelian, Kashmiri, Kashubian, Kaska, Kawi, Kazakh, Khakas, Khalaj Turkic, Khanty, Khasi, Khmer Northern, Kickapoo, Kinyarwanda (Ruanda), Kiowa, Kirghiz, Kirundi (Rundi), Klingon tlhIngan-Hol, Kodava, Komi-Permyak, Konkani (generic), Konkani (specific), Konkani Goan, Korean, Koryak, Kosraean, Kotava, Kpelle, Kumiai, Kumyk, Kurdish, Kutenai, Kwakiutl, Laal, Ladin, Ladino, Lahnda, Lahu, Lak, Laki, Lakota, Laothian, Latin, Latvian (Lettish), Laz, Lezghian, Ligurian, Lillooet, Limbu, Limburgish ( Limburger), Lingala, Lithuanian, Lojban, Loma (Liberia), Lombard, Low German Low Saxon, Lozi, Luba-Lulua, Lucumi, Ludian, Lule Sami, Lunda, Luo (Kenya and Tanzania), Lushootseed, Luxembourgish (Letzeburgesch), Macedonian, Madurese, Magahi, Maithili, Malagasy, Malay, Malayalam, Malecite-Passamaquoddy, Maltese, Manchu, Mandaic, Mandan, Mandarin Chinese, Mansi, Maori, Maranao, Marathi, Mari (Russia), Marwari, Masai, Mayo, Meitei, Mende (Sierra Leone), Menominee, Michif, Micmac, Min Bei Chinese, Min Dong Chinese, Minangkabau, Mingrelian, Mirandese, Mohawk, Moksha, Moldavian, Mon, Mongolian, Montagnais, Morisyen, Mossi, Mozarabic, Multilingual, Muong, Nama (Namibia), Nanai, Naskapi, Nauru, Neapolitan, Nepali, Newari Nepal Bhasa, Nganasan, Nisgaa, Niuean, No linguistic content, Nogai, Norse Old, Northern Sotho Pedi Sepedi, Norwegian, Novial, Nyamwezi, Nyoro, Nyungah, Occitan, Ojibwa Central, Ojibwa Eastern, Ojibwa Northwestern, Ojibwa Severn, Ojibwa Western, Ojibwe, Ojibwa, Okanagan, Okinawan Central, Old English, Oneida, Onondaga, Oriya, Oromo (Afan, Galla), Ottawa, Paipai, Palauan, Pampanga, Pangasinan, Papiamento, Pashto (Pushto), Persian, Persian (Dari), Pfaelzisch, Picard, Piedmontese, Pirah, Pitcairn-Norfolk, Plautdietsch, Polish, Pontic, Portuguese, Potawatomi, Prussian, Pulaar, Punjabi, Qashqai, Qawasqar, Quechua, Quich Central, Rapanui, Rarotongan, Reserved for local use., Rhaeto-Romance, Romagnol, Romani Kalo Finnish, Romani Sinte, Romanian, Romanian Istro, Romanian Megleno, Romany, Runion Creole French, Russian, Rusyn, Saint Lucian Creole French, Sakha, Salar, Salish Straits, Salishan languages, Sami Kildin, Sami languages, Samoan, Sangro, Sanskrit, Santali, Saramaccan, Sardinian Sassarese, Saterland Frisian, Saxon Upper, Scots, Sechelt, Seediq, Sekani, Selkup, Seneca, Serbian, Serbo-Croatian, Seri, Sesotho, Setswana, Shawnee, Shona, Shor, Shoshoni, Shuswap, Sicilian, Sidamo, Siksika, Silesian, Sindhi, Sinhalese, Siswati, Skolt Sami, Slavey North, Slavey South, Slovak, Slovenian, Somali, Soninke, Sorbian Lower, Sorbian Upper, Southern Sami, Southern Tutchone, Spanish, Sranan, Stoney, Sudovian, Sumerian, Sundanese, Svan, Swabian, Swahili (Kiswahili), Swedish, Swedish Sign Language, Swiss German Alemannic Alsatian, Syriac, Tabassaran, Tachawit, Tachelhit, Tagalog, Tagbanwa, Tagish, Tahltan, Tai Na, Tajik, Talysh, Tamajaq Tawallammat, Tamasheq, Tamazight Central Atlas, Tamil, Tarahumara Central, Tat Muslim, Tatar, Telugu, Teo Chew, Tetum, Thai, Thai (Northern), Thai Northeastern, Thompson, Tibetan, Tigre, Tigrinya, Tlingit, Toda, Tohono Oodham, Tok Pisin, Tonga, Tonga (Nyasa), Tsez, Tsimshian, Tsonga, Tulu, Tumbuka, Tumzabt, Tupinamb, Turkana, Turkish, Turkish Ottoman, Turkmen, Tuscarora, Tuvalu, Tuvinian, Twi, Ubykh, Udi, Udmurt, Uighur, Ukrainian, Undefined, Urdu, Urum, Uzbek, Venetian, Veps, Vietnamese, Volapuk, Voro, Votic, Vro, Waorani, Waray (Philippines), Welsh, Western Farsi, Western Neo-Aramaic, Wiyot, Wolof, Wu Chinese, Wymysorys, Xhosa, Yanesha, Yiddish, Yoruba, Zapotec Isthmus, Zarma, Zulu

Enum Type: KalturaLanguage

The language of the caption asset content

languageCode:string
Enum: AA [aa], AB [ab], AF [af], ALG [alg], AM [am], AR [ar], AS_ [as], ATH [ath], AY [ay], AZ [az], BA [ba], BE [be], BG [bg], BH [bh], BI [bi], BLA [bla], BN [bn], BO [bo], BR [br], CA [ca], CO [co], CR [cr], CRG [crg], CS [cs], CY [cy], DA [da], DE [de], DZ [dz], EL [el], EN [en], EN_GB [en_gb], EN_US [en_us], EO [eo], ES [es], ET [et], EU [eu], FA [fa], FI [fi], FJ [fj], FO [fo], FR [fr], FY [fy], GA [ga], GD [gd], GL [gl], GN [gn], GU [gu], GV [gv], HA [ha], HE [he], HI [hi], HR [hr], HU [hu], HY [hy], IA [ia], ID [id], IE [ie], IK [ik], IKT [ikt], IN [in], IRO [iro], IS [is], IT [it], IU [iu], IW [iw], JA [ja], JI [ji], JV [jv], KA [ka], KK [kk], KL [kl], KM [km], KN [kn], KO [ko], KS [ks], KU [ku], KY [ky], LA [la], LB [lb], LI [li], LN [ln], LO [lo], LT [lt], LV [lv], MG [mg], MI [mi], MIC [mic], MK [mk], ML [ml], MN [mn], MO [mo], MOE [moe], MR [mr], MS [ms], MT [mt], MU [mu], MY [my], NA [na], NE [ne], NL [nl], NO [no], OC [oc], OJ [oj], OJS [ojs], OJW [ojw], OKA [oka], OM [om], OR_ [or], PA [pa], PL [pl], PS [ps], PT [pt], QU [qu], RM [rm], RN [rn], RO [ro], RU [ru], RW [rw], SA [sa], SAL [sal], SD [sd], SG [sg], SH [sh], SI [si], SK [sk], SL [sl], SM [sm], SMI [smi], SN [sn], SO [so], SQ [sq], SR [sr], SS [ss], ST [st], SU [su], SV [sv], SW [sw], TA [ta], TCE [tce], TE [te], TG [tg], TH [th], TI [ti], TK [tk], TL [tl], TN [tn], TO [to], TR [tr], TS [ts], TT [tt], TW [tw], UG [ug], UK [uk], UN [un], UR [ur], UZ [uz], VI [vi], VO [vo], WO [wo], XH [xh], YI [yi], YO [yo], ZH [zh], ZU [zu], ZXX [zxx]

readOnly

Enum Type: KalturaLanguageCode

The language of the caption asset content

parentId:string

insertOnly

The parent id of the asset

status:integer
Enum: ERROR [-1], QUEUED [0], READY [2], DELETED [3], IMPORTING [7], EXPORTING [9]

readOnly

Enum Type: KalturaCaptionAssetStatus

The status of the asset

KalturaCaptionAsset must also match all of:
object:KalturaAsset
KalturaCaptionAssetListResponse must also match all of:
object:KalturaListResponse