Kaltura API DocumentationbaseEntry.getContextData

This action delivers entry-related data, based on the user's context: access control, restriction, playback format and storage information.

Try it out
post https://www.kaltura.com/api_v3/service/baseentry/action/getContextData

Request Parameters

body:object
object
contextDataParams*:object:KalturaEntryContextDataParams

Object which contains contextual entry-related data.

flavorAssetId:string

Id of the current flavor.

flavorTags:string

The tags of the flavors that should be used for playback.

mediaProtocol:string

Protocol of the specific media object.

objectType:string
Enum: KalturaEntryContextDataParams, KalturaPlaybackContextOptions
streamerType:string

Playback streamer type: RTMP, HTTP, appleHttps, rtsp, sl.

KalturaEntryContextDataParams must also match all of:
object:KalturaAccessControlScope
KalturaEntryContextDataParams must also match any of:
object:KalturaEntryContextDataParamsobject:KalturaPlaybackContextOptions
entryId*:string

Response

Success

object:KalturaEntryContextDataResult
accessControlActions:array[object:KalturaRuleAction]
object:KalturaRuleAction

abstract

objectType:string
Enum: KalturaAccessControlBlockAction, KalturaAccessControlDrmPolicyAction, KalturaAccessControlLimitDeliveryProfilesAction, KalturaAccessControlLimitFlavorsAction, KalturaAccessControlLimitThumbnailCaptureAction, KalturaAccessControlModifyRequestHostRegexAction, KalturaAccessControlPreviewAction, KalturaAccessControlServeRemoteEdgeServerAction, KalturaAddEntryVendorTaskAction, KalturaStorageAddAction
type:string
Enum: DRM_POLICY [drm.DRM_POLICY], ADD_ENTRY_VENDOR_TASK [reach.ADD_ENTRY_VENDOR_TASK], BLOCK [1], PREVIEW [2], LIMIT_FLAVORS [3], ADD_TO_STORAGE [4], LIMIT_DELIVERY_PROFILES [5], SERVE_FROM_REMOTE_SERVER [6], REQUEST_HOST_REGEX [7], LIMIT_THUMBNAIL_CAPTURE [8]

readOnly

Enum Type: KalturaRuleActionType

The type of the action

accessControlMessages:array[object:KalturaString]
object:KalturaString

A string representation to return an array of strings

value:string
flavorAssets:array[object:KalturaFlavorAsset]
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
isAdmin:boolean
isCountryRestricted:boolean
isIpAddressRestricted:boolean
isScheduledNow:boolean
isSessionRestricted:boolean
isSiteRestricted:boolean
isUserAgentRestricted:boolean
mediaProtocol:string

http/https, rtmp/rtmpe

msDuration:integer

The duration of the entry in milliseconds

pluginData:array[object:KalturaPluginData]
object:KalturaPluginData
objectType:string
Enum: KalturaPluginData, KalturaDrmPlaybackPluginData, KalturaDrmEntryContextPluginData, KalturaFairplayEntryContextPluginData, KalturaFairPlayPlaybackPluginData
previewLength:integer
storageProfilesXML:string
streamerType:string

http/rtmp/hdnetwork

KalturaEntryContextDataResult must also match all of:
object:KalturaContextDataResult