Kaltura API DocumentationflavorAsset.getFlavorAssetsWithParams

Get Flavor Asset with the relevant Flavor Params (Flavor Params can exist without Flavor Asset & vice versa)

Try it out
post https://www.kaltura.com/api_v3/service/flavorasset/action/getFlavorAssetsWithParams

Request Parameters

body:object
object
entryId*:string

Response

Success

array[object:KalturaFlavorAssetWithParams]
object:KalturaFlavorAssetWithParams
entryId:string

The entry id

flavorAsset:object:KalturaFlavorAsset
bitrate:integer

readOnly

The overall bitrate (in KBits) of the Flavor Asset

containerFormat:string

readOnly

The container format

flavorParamsId:integer

insertOnly

The Flavor Params used to create this Flavor Asset

frameRate:number

readOnly

The frame rate (in FPS) of the Flavor Asset

height:integer

readOnly

The height of the Flavor Asset

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

Enum Type: KalturaNullableBoolean

Is default flavor asset of the entry (This field will be taken into account selectign which audio flavor will be selected as default)

isOriginal:boolean

readOnly

True if this Flavor Asset is the original source

isWeb:boolean

readOnly

True if this Flavor Asset is playable in KDP

label:string

The label of the flavor asset

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, French (Canada), 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, Portuguese (Brazil), 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, Spanish (Latin America), 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, Taiwanese Mandarin, 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 flavor asset

objectType:string
Enum: KalturaFlavorAsset, KalturaLiveAsset, KalturaWidevineFlavorAsset
status:integer
Enum: ERROR [-1], QUEUED [0], CONVERTING [1], READY [2], DELETED [3], NOT_APPLICABLE [4], TEMP [5], WAIT_FOR_CONVERT [6], IMPORTING [7], VALIDATING [8], EXPORTING [9]

readOnly

Enum Type: KalturaFlavorAssetStatus

The status of the Flavor Asset

videoCodecId:string

readOnly

The video codec

width:integer

readOnly

The width of the Flavor Asset

KalturaFlavorAsset must also match all of:
object:KalturaAsset
KalturaFlavorAsset must also match any of:
object:KalturaFlavorAssetobject:KalturaLiveAssetobject:KalturaWidevineFlavorAsset
flavorParams:object:KalturaFlavorParams
anamorphicPixels:number
aspectRatioProcessingMode:integer
audioBitrate:integer

The audio bitrate (in KBits) of the Flavor Params

audioChannels:integer

The number of audio channels for "downmixing"

audioCodec:string
Enum: NONE [], AAC [aac], AACHE [aache], AC3 [ac3], AMRNB [amrnb], COPY [copy], EAC3 [eac3], MP3 [mp3], MPEG2 [mpeg2], PCM [pcm], VORBIS [vorbis], WMA [wma], WMAPRO [wmapro]

Enum Type: KalturaAudioCodec

The audio codec of the Flavor Params

audioSampleRate:integer

The audio sample rate of the Flavor Params

chunkedEncodeMode:integer
clipDuration:integer
clipOffset:integer
contentAwareness:number
conversionEngines:string

The list of conversion engines (comma separated)

conversionEnginesExtraParams:string

The list of conversion engines extra params (separated with "|")

deinterlice:integer
engineVersion:integer
forceFrameToMultiplication16:integer
forcedKeyFramesMode:integer
format:string
Enum: _3GP [3gp], APPLEHTTP [applehttp], AVI [avi], BIF [bif], BMP [bmp], COPY [copy], FLV [flv], HLS [hls], ISMA [isma], ISMV [ismv], JPG [jpg], M2TS [m2ts], M4V [m4v], MKV [mkv], MOV [mov], MP3 [mp3], MP4 [mp4], MPEG [mpeg], MPEGTS [mpegts], MXF [mxf], OGG [ogg], OGV [ogv], PDF [pdf], PNG [png], SWF [swf], WAV [wav], WEBM [webm], WMA [wma], WMV [wmv], WVM [wvm]

Enum Type: KalturaContainerFormat

The container format of the Flavor Params

frameRate:number

The frame rate of the Flavor Params

gopSize:integer

The gop size of the Flavor Params

height:integer

The desired height of the Flavor Params

isAvoidForcedKeyFrames:integer
isAvoidVideoShrinkBitrateToSource:integer
isAvoidVideoShrinkFramesizeToSource:integer
isCropIMX:integer
isEncrypted:integer
isGopInSec:integer
isVideoFrameRateForLowBrAppleHls:integer
maxFrameRate:integer
multiStream:string
objectType:string
Enum: KalturaFlavorParams, KalturaFlavorParamsOutput, KalturaDocumentFlavorParams, KalturaImageFlavorParams, KalturaLiveParams, KalturaMediaFlavorParams, KalturaPdfFlavorParams, KalturaSwfFlavorParams, KalturaWidevineFlavorParams, KalturaDocumentFlavorParamsOutput, KalturaImageFlavorParamsOutput, KalturaMediaFlavorParamsOutput, KalturaPdfFlavorParamsOutput, KalturaSwfFlavorParamsOutput, KalturaWidevineFlavorParamsOutput
operators:string
optimizationPolicy:integer
rotate:integer
subtitlesData:string
twoPass:boolean
videoBitrate:integer

The video bitrate (in KBits) of the Flavor Params

videoBitrateTolerance:integer
videoCodec:string
Enum: NONE [], APCH [apch], APCN [apcn], APCO [apco], APCS [apcs], AV1 [av1], COPY [copy], DNXHD [dnxhd], DV [dv], FLV [flv], H263 [h263], H264 [h264], H264B [h264b], H264H [h264h], H264M [h264m], H265 [h265], MPEG2 [mpeg2], MPEG4 [mpeg4], THEORA [theora], VP6 [vp6], VP8 [vp8], VP9 [vp9], WMV2 [wmv2], WMV3 [wmv3], WVC1A [wvc1a]

Enum Type: KalturaVideoCodec

The video codec of the Flavor Params

videoConstantBitrate:integer
watermarkData:string
width:integer

The desired width of the Flavor Params

KalturaFlavorParams must also match all of:
object:KalturaAssetParams