Options
All
  • Public
  • Public/Protected
  • All
Menu

@kaltura-ott/tvpil

Index

Basic KUX Configuration Enumerations

Other Enumerations

Other Classes

Utils Classes

Basic KUX Configuration Interfaces

Category Interfaces

Other Interfaces

Type aliases

Variables

Authentication Functions

Category Functions

Category Tree Functions

Creator Functions

HouseholdManagement Functions

LogOut Functions

Other Functions

Parental Functions

Purchase Functions

Purchase / Subscriptions Functions

Subscriptions Functions

getCompaundHouseholdDeviceList Functions

getCompoundHouseholdDeviceList Functions

getHousehold Functions

Basic KUX Configuration Object literals

Other Object literals

Type aliases

KalturaCategoryMeta

KalturaCategoryMeta: KalturaBooleanValue | KalturaDoubleValue | KalturaLongValue | KalturaStringValue

KuxImages

KuxImages: {}

Type declaration

MenuItemType

MenuItemType: { image: string; title: string }

Type declaration

  • image: string
  • title: string

RailTypes

RailTypes: RailItemAPP | RailItemLive | RailItemGeneral | RailItemCatchup

RailsItems

RailsItems: {}

Type declaration

Variables

Const ASSET_ACCEPTED_TYPES

ASSET_ACCEPTED_TYPES: (KalturaMediaAsset | KalturaProgramAsset)[] = [KalturaMediaAsset, KalturaLiveAsset, KalturaProgramAsset]

Const ASSET_GROUP_BY_RETRIEVED_PROPERTIES

ASSET_GROUP_BY_RETRIEVED_PROPERTIES: "objectType,name,id,images,tags,metas,epgChannelId,enableCatchUp,enableCdvr,enableStartOver,enableTrickPlay,linearAssetId,type,updateDate,externalId,epgId,endDate,createDate,crid,startDate" = "objectType,name,id,images,tags,metas,epgChannelId,enableCatchUp,enableCdvr,enableStartOver,enableTrickPlay,linearAssetId,type,updateDate,externalId,epgId,endDate,createDate,crid,startDate"

Const BASIC_METAS

BASIC_METAS: string[] = ['Name','Description','ExternalID','Status','EntryID','PlaybackStartDateTime','PlaybackEndDateTime','CatalogStartDateTime','CatalogEndDateTime','CreateDate',CATEGORY_ID_SYSTEM_NAME,]

Const CACHING_PREFIX

CACHING_PREFIX: "cache_" = "cache_"

Const CATEGORY_ID_SYSTEM_NAME

CATEGORY_ID_SYSTEM_NAME: "CategoryId" = "CategoryId"

Const CATEGORY_STRUCT_MOCK

CATEGORY_STRUCT_MOCK: KalturaAssetStruct = new KalturaAssetStruct({multilingualName: [new KalturaTranslationToken({language: 'eng',value: 'struct_name_' + randString(3),}),],systemName: 'struct_system_name_' + randString(3),features: '',pluralName: 'Categories',})

Const CHANNEL_PREFIX

CHANNEL_PREFIX: string = `${CACHING_PREFIX}tvchannel_`

Const CHUNK_SIZE

CHUNK_SIZE: 25 = 25

Const DEFAULT_CHUNK_SIZE

DEFAULT_CHUNK_SIZE: 25 = 25

Const DEFAULT_PROGRAM_REFRESH_FREQUENCY_SEC

DEFAULT_PROGRAM_REFRESH_FREQUENCY_SEC: 300 = 300

Const EPG_PREFIX

EPG_PREFIX: string = `${CACHING_PREFIX}channel_`

Const FAVORITE_PREFIX

FAVORITE_PREFIX: string = `${CACHING_PREFIX}favorite_`

Const KUX_FEATURE_NAME

KUX_FEATURE_NAME: "kuxmanaged" = "kuxmanaged"

Let KuXConfig

KuXConfig: (config: KuxConfig) => KuxConfig | string

Type declaration

Let KuXDms

KuXDms: KuxDms

Const MAIN_VIRTUAL_ASSET_STRUCT_NAME

MAIN_VIRTUAL_ASSET_STRUCT_NAME: "Category" = "Category"

Const MAX_EPG_PERIOD

MAX_EPG_PERIOD: number = 7 * 24 * 60 * 60 * 1000

Const METADATA_FEATURE_NAME

METADATA_FEATURE_NAME: "metadata" = "metadata"

Const META_ENUMERATION_TYPE

META_ENUMERATION_TYPE: "enumeration_type" = "enumeration_type"

Const META_ENUMERATION_TYPE_MULTIPLE

META_ENUMERATION_TYPE_MULTIPLE: "enumeration_type_multiple" = "enumeration_type_multiple"

Const META_KSQL

META_KSQL: string[] = ['filtering_kSQL']

Const META_NULLABLE

META_NULLABLE: "nullable" = "nullable"

Const MIN_PAGE_SIZE_ASSET_HISTORY

MIN_PAGE_SIZE_ASSET_HISTORY: 5 = 5

Const NOT_FOUND_MIN_SIZE_MS

NOT_FOUND_MIN_SIZE_MS: number = 60 * 1000

Const NOT_FOUND_SIZE_MS

NOT_FOUND_SIZE_MS: number = 3 * 60 * 60 * 1000

Const PERSIST_CACHING_TTL

PERSIST_CACHING_TTL: number = 24 * 60 * 60 * 1000

Const READ_ONLY_FEATURE_NAME

READ_ONLY_FEATURE_NAME: "readonly" = "readonly"

Const SET_OF_KUX_METAS

SET_OF_KUX_METAS: KalturaMeta[] = [new KalturaMeta({isProtected: false,systemName: 'page_type_' + randString(5),dataType: KalturaMetaDataType.string,multilingualName: [new KalturaTranslationToken({language: 'eng',value: 'Page Type' + randString(5),}),],features: 'kuxmanaged',}),new KalturaMeta({isProtected: false,systemName: 'display_image_type_' + randString(5),dataType: KalturaMetaDataType.string,multilingualName: [new KalturaTranslationToken({language: 'eng',value: 'Display Image Type' + randString(5),}),],features: 'kuxmanaged',}),new KalturaMeta({isProtected: false,systemName: 'ksql_' + randString(5),dataType: KalturaMetaDataType.string,multilingualName: [new KalturaTranslationToken({language: 'eng',value: 'KSQL_' + randString(5),}),],features: 'kuxmanaged',}),]

Let channelsCache

channelsCache: {}

Type declaration

  • [key: string]: KalturaAssetListResponse

Let client

client: KalturaClient = null

Let clientCache

clientCache: CachingServiceImpl = null

Let epgCache

epgCache: {}

Type declaration

Let epgLimitCache

epgLimitCache: number

Const epgRequestsMap

epgRequestsMap: EpgRequestMap

Let favoriteCache

favoriteCache: {}

Type declaration

  • [key: string]: number[]

Let firstScreensChannels

firstScreensChannels: number[] = []

Const getEpgVodByAssetId

getEpgVodByAssetId: any = getVodByAssetId(KalturaAssetReferenceType.epgInternal, KalturaAssetType.epg)

Const getMeidaVodByAssetId

getMeidaVodByAssetId: any = getVodByAssetId(KalturaAssetReferenceType.media, KalturaAssetType.media)

Const getVodByAssetId

getVodByAssetId: curried = curry((assetReferenceType = KalturaAssetReferenceType.media,assetType = KalturaAssetType.media,assetId: number,): Observable<KuxVodInfo> =>forkJoin({asset: getAssetById(assetId, assetReferenceType),bookmarks: getBookmarks(assetId, assetType),}).pipe(mergeMap(({ asset, bookmarks }) => {if (asset instanceof Error) {return throwError(asset);}return of(assetToVod(asset, bookmarks.objects[0]));}),catchError(() => {return EMPTY;}),),)
param

number

param

KalturaAssetReferenceType

param

KalturaAssetType

Let imageScale

imageScale: number = 2

Const parentingMap

parentingMap: {}

Type declaration

Let priceCache

priceCache: {}

Type declaration

Const problematicItems

problematicItems: any[] = []

Authentication Functions

Const anonymousLogin

  • anonymousLogin(data: OttUserAnonymousLoginActionArgs): Observable<KalturaLoginSession>

  • Build request payload for service 'ottUser' action 'anonymousLogin'.

    Usage: Returns tokens (KS and refresh token) for anonymous access

    function

    Parameters

    • data: OttUserAnonymousLoginActionArgs

    Returns Observable<KalturaLoginSession>

getAuthDevice

getOAuthToken

  • getOAuthToken(__namedParameters: { code: string; codeVerifier: string; redirectUri: string }): Observable<OAuthGetTokenData>

  • Get user token after oAuth

    function

    Parameters

    • __namedParameters: { code: string; codeVerifier: string; redirectUri: string }
      • code: string
      • codeVerifier: string
      • redirectUri: string

    Returns Observable<OAuthGetTokenData>

    Token hash and refresh hash

Const getUser

  • getUser(): Observable<KalturaOTTUser>

Const o2userResetPassword

  • o2userResetPassword(email: string): Observable<KalturaSSOAdapterProfileInvoke>

  • Build request payload for service 'SsoAdapterProfileInvokeAction' action 'invoke'.

    Usage: O2 reset password

    function

    Parameters

    • email: string

    Returns Observable<KalturaSSOAdapterProfileInvoke>

Const userAppTokenAdd

  • userAppTokenAdd(): Observable<KalturaAppToken>

Const userAppTokenDelete

  • userAppTokenDelete(id: string): Observable<boolean>

  • Build request payload for service 'AppToken' action 'Delete'.

    Usage: remove appToken

    function

    Parameters

    • id: string

    Returns Observable<boolean>

Const userAppTokenStartSession

  • userAppTokenStartSession(__namedParameters: { id: string; tokenHash: string; udid: string }): Observable<KalturaSessionInfo>

  • Build request payload for service 'AppToken' action 'StartSession'.

    Usage: start appToken session

    function

    Parameters

    • __namedParameters: { id: string; tokenHash: string; udid: string }
      • id: string
      • tokenHash: string
      • udid: string

    Returns Observable<KalturaSessionInfo>

Const userLogin

  • userLogin(userData: OttUserLoginActionArgs): Observable<KalturaLoginResponse>

  • Build request payload for service 'ottUser' action 'login'.

    Usage: login with user name and password

    function

    Parameters

    • userData: OttUserLoginActionArgs

    Returns Observable<KalturaLoginResponse>

Const userLoginWithExtraParams

  • userLoginWithExtraParams(userData: OttUserLoginActionArgs, extraParams: Array<{ key: string; value: string }>): Observable<KalturaLoginResponse>

  • Build request payload for service 'ottUser' action 'login' with extraParams.

    Usage: login with user name and password with extraParams

    function

    Parameters

    • userData: OttUserLoginActionArgs
    • extraParams: Array<{ key: string; value: string }>

    Returns Observable<KalturaLoginResponse>

Const userLoginWithPin

  • userLoginWithPin(userData: OttUserLoginWithPinActionArgs): Observable<KalturaLoginResponse>

  • Build request payload for service 'ottUser' action 'loginWithPin'.

    Usage: login with predefined PIN

    function

    Parameters

    • userData: OttUserLoginWithPinActionArgs

    Returns Observable<KalturaLoginResponse>

Category Functions

Const deleteCategoryStruct

  • deleteCategoryStruct(id: number): Observable<boolean>

Const getCategoryList

  • getCategoryList(filter?: CategoryItemListActionArgs): Observable<KalturaCategoryItemListResponse>

  • Build request payload for service 'categoryItem' action 'list'.

    Usage: Gets all categoryItem items

    Parameters

    • Optional filter: CategoryItemListActionArgs

    Returns Observable<KalturaCategoryItemListResponse>

getCategoryTreeWithAssetById

  • Loads category by provided category ID

    TODO: Function should return full DTO: Category

    • asset
    • metas
    • tags DTO should to be clean and easy to use for displaying page.
    function

    Parameters

    • categoryItemId: number

    Returns Observable<KuxCategoryTreeDTO>

Category Tree Functions

getCategoryTree

  • getCategoryTree(categoryItemId: number): Observable<KalturaCategoryTree>

Creator Functions

Const getMetasList

  • getMetasList(filter?: KalturaMetaFilter): Observable<KalturaMetaListResponse>

  • Load list of all Metas, by default filtered with KUX_FEATURE_NAME in 'features'

    Parameters

    • Optional filter: KalturaMetaFilter

    Returns Observable<KalturaMetaListResponse>

Const syncMetasDynamicData

  • syncMetasDynamicData(): Observable<any>

  • Updates all dynamic data in all metas to contract values. If meta is not in contract, it's not updated. If meta in contract, but has no dynamic data in contract, it's not updated

    Returns Observable<any>

HouseholdManagement Functions

Const householdAddDevice

  • householdAddDevice(deviceData: KalturaHouseholdDeviceArgs): Observable<KalturaHouseholdDevice>

  • Build request payload for service 'Household' action 'DeviceAdd'.

    Usage: get device data

    function

    Parameters

    • deviceData: KalturaHouseholdDeviceArgs

    Returns Observable<KalturaHouseholdDevice>

Const householdGetDevice

  • householdGetDevice(): Observable<KalturaHouseholdDevice>

Const householdGetDeviceList

  • householdGetDeviceList(): Observable<KalturaHouseholdDeviceListResponse>

  • Build request payload for service 'Household' action 'DeviceListAction'.

    Usage: get device list

    function

    Returns Observable<KalturaHouseholdDeviceListResponse>

Const householdRemoveDevice

  • householdRemoveDevice(udid: string): Observable<boolean>

  • Build request payload for service 'Household' action 'DeviceDeleteAction'.

    Usage: remove device

    function

    Parameters

    • udid: string

    Returns Observable<boolean>

LogOut Functions

Const revokeSession

  • revokeSession(): Observable<boolean>

Other Functions

Const abortEpgByChannel

  • abortEpgByChannel(externalId: number): void

Const abortRequest

Const addBookmark

  • addBookmark(assetId: string, position: number, playerData: KalturaBookmarkPlayerData, assetTypeEqual?: KalturaAssetType): Observable<boolean>

  • Get playback context for player

    Parameters

    • assetId: string
    • position: number
    • playerData: KalturaBookmarkPlayerData
    • Default value assetTypeEqual: KalturaAssetType = KalturaAssetType.media

    Returns Observable<boolean>

Const addChannelStats

  • addChannelStats<T>(asset: T, channelsStats?: ChannelStats[]): T & { watchedCount: number }

Const addChildCategoryToParent

addDefaultConfigurationGroup

  • addDefaultConfigurationGroup(groupId: string): Observable<KalturaConfigurationGroup>

Const addEpgRequest

Const addExtendedVirtualTypes

  • addExtendedVirtualTypes(structs: Array<KalturaAssetStruct>): Observable<boolean>

Const addFavoriteStatus

  • addFavoriteStatus<T>(asset: T, favoriteIdList?: number[]): T & { isFavorite: boolean }

Const addFeatures

  • addFeatures(originFeatures: string | undefined, addFeature: string): string

Const addFullPersonalList

  • addFullPersonalList(__namedParameters: { partnerListId: number; recommendationFields: string[]; suggestedCalculationByLastXItems: number; typeArr: string[] }): Observable<any>

  • Parameters

    • __namedParameters: { partnerListId: number; recommendationFields: string[]; suggestedCalculationByLastXItems: number; typeArr: string[] }
      • partnerListId: number
      • recommendationFields: string[]
      • suggestedCalculationByLastXItems: number
      • typeArr: string[]

    Returns Observable<any>

Const addHistoryToRecordAsset

Const addImagesToCategory

  • addImagesToCategory(categoryId: number, images: Array<KalturaImage>): Observable<void>
  • addImagesToCategory(categoryId: number, images: Array<KalturaImage>): Observable<void>

addKsql

  • addKsql(ksql: string, newKsql: string): string

Const addPersonalList

  • addPersonalList(asset: KuxProgram, recommendationFields: string[], partnerListType: number): Observable<any>

Const addPurchaseToCollection

Const addRecordToAsset

Const addRecording

  • addRecording(newRecordingArgs: KalturaRecordingArgs): Observable<KalturaRecording>

Const addSeriesRecording

  • addSeriesRecording(newSeriesRecordingArgs: KalturaSeriesRecordingArgs): Observable<KalturaSeriesRecording>

Const addToFirstScreen

  • addToFirstScreen(channelsId: number[]): number[]

Const appendMetasToCategoryStruct

Const assetHistoryToKuxBookmark

  • assetHistoryToKuxBookmark(assetHistory: KalturaAssetHistory): KuxBookmark

Const assetJsonIntoObject

  • assetJsonIntoObject(jsonAsset: any, language: any): KalturaAssetArgs
  • assetJsonIntoObject(jsonAsset: any, language: any): KalturaAssetArgs

Const assetToChannel

  • assetToChannel(channel: KalturaLiveAsset): KuxChannel

Const assetToChannelCard

Const assetToCollectionCard

Const assetToContinueWatchingCard

Const assetToLinear

Const assetToLinkAsAsset

Const assetToLoginAsset

  • assetToLoginAsset(asset: KalturaMediaAsset): { id: number; image: string; inAppLink: any; title: string; type: ButtonTypes; typeOfAppLink: any }

Const assetToMovie

Const assetToProgram

  • assetToProgram(program: KalturaProgramAsset, imageRatio?: string): KuxProgram
  • assetToProgram(program: KalturaProgramAsset): KuxProgramType

Const assetToProgramCard

Const assetToProgramDetails

  • assetToProgramDetails(program: KalturaProgramAsset, channel: KalturaLiveAsset, assetHistory: KalturaAssetHistory): KuxDetailsProgram

Const assetToProgramForDetails

Const assetToRecord

Const assetToSubscriptionAsset

  • assetToSubscriptionAsset(asset: KalturaMediaAsset): { basePackageId: any; catalogStartDateTime: any; description: string; disclaimer: any; endDate: number; id: number; image: string; images: { isDefault: boolean; ratio: string; url: string }[]; playbackEndDateTime: any; priceDescription: any; startDate: number; subscriptionId: any; title: string }

  • Parameters

    • asset: KalturaMediaAsset

    Returns { basePackageId: any; catalogStartDateTime: any; description: string; disclaimer: any; endDate: number; id: number; image: string; images: { isDefault: boolean; ratio: string; url: string }[]; playbackEndDateTime: any; priceDescription: any; startDate: number; subscriptionId: any; title: string }

    • basePackageId: any
    • catalogStartDateTime: any
    • description: string
    • disclaimer: any
    • endDate: number
    • id: number
    • image: string
    • images: { isDefault: boolean; ratio: string; url: string }[]
    • playbackEndDateTime: any
    • priceDescription: any
    • startDate: number
    • subscriptionId: any
    • title: string

Const assetToType

  • assetToType<P, U>(asset: P): U

Const assetToVideoPlayoutInfo

Const assetToVod

  • assetToVod(asset: KalturaAsset, bookmark: KalturaBookmark): KuxVodInfo

Const assignAssetToCategory

  • assignAssetToCategory(category: any): any

Const assignAssetsToCategories

  • assignAssetsToCategories(tree: any, assets: any, typesMapping: any): any

Const cacheToPersist

  • cacheToPersist(): Promise<void>

calculateAggregatedKSQL

  • calculateAggregatedKSQL(metas: KuxCategoryMetas, parentAggregatedKSQL?: string): string

Const calculateSizePerDevice

calculateUiDesignElements

  • calculateUiDesignElements(metas: KuxCategoryMetas, parentUiDesignElements?: KuxFilteredCategoriesDTO["uiDesignElements"]): KuxFilteredCategoriesDTO["uiDesignElements"]

Const camelize

  • camelize(str: string): string

Const camelizeKeys

  • camelizeKeys(obj: any): any

Const cancelRecording

  • cancelRecording(__namedParameters: { id: number }): Observable<KalturaRecording>

Const cancelSeriesRecording

  • cancelSeriesRecording(__namedParameters: { id: number }): Observable<KalturaSeriesRecording>

Const cancelSeriesRecordingByEpgId

  • cancelSeriesRecordingByEpgId(cancelSeriesByEpgArgs: SeriesRecordingCancelByEpgIdActionArgs): Observable<KalturaSeriesRecording>

categoryItemsIdList

  • categoryItemsIdList(categoriesTree: KalturaCategoryTree[]): number[]

Const checkEpgCacheLimit

  • checkEpgCacheLimit(): void

checkNalogToken

  • checkNalogToken(code: string): Observable<AuthPinData>

Const checkProductPriceStatus

  • checkProductPriceStatus(channel: KuxChannel): Observable<{} | { channel: KuxChannel; updateCache: false }>

Const clearChannelCache

  • clearChannelCache(): void

Const clearEpgCacheDays

  • clearEpgCacheDays(): void

Const clearFavoriteCache

  • clearFavoriteCache(): void

Const clearFilePrices

  • clearFilePrices(): void

Const coverUpProgramsDay

  • coverUpProgramsDay(programs: KuxProgram[], externalId: number, startTime: number): any[]

Const createAsset

  • createAsset(asset: KalturaMediaAssetArgs): Observable<KalturaMediaAsset>

Const createCategoryAndAsset

  • createCategoryAndAsset(category: KalturaCategoryItemArgs, asset: KalturaAssetArgs, images: Array<KalturaImage>): Observable<{ asset: KalturaAsset; category: KalturaCategoryItem }>

Const createCategoryStruct

  • createCategoryStruct(assetStruct: KalturaAssetStructArgs): Observable<KalturaAssetStruct>

Const createCategoryV2

Const createChildCategory

Const createInitialMetas

  • createInitialMetas(initialMetas: {}, language?: string): Observable<any>

Const createMeta

  • createMeta(data: KalturaMetaArgs): Observable<KalturaMeta>

  • Create meta as attribute for structs In 'features' will be added KUX_FEATURE_NAME => 'kuxmanaged' prefix as an identifier

    Parameters

    • data: KalturaMetaArgs

    Returns Observable<KalturaMeta>

Const createMetaTag

Const createMultiCategoryAndAsset

  • createMultiCategoryAndAsset(categoriesData: CreateMLCategory[]): Observable<{ asset: KalturaAsset; category: KalturaCategoryItem }[]>

Const createMultiCategoryV2

  • createMultiCategoryV2(categoriesData: CreateMLCategory[]): Observable<{ asset: KalturaAsset; category: KalturaCategoryItem }[]>

Const createRootCategory

Const createTreeItem

  • createTreeItem(category: KuxKalturaCategoryItemArgs, parentId: number, languageCode: string, __namedParameters: { presentationType: any; structureType: any }): Observable<KalturaCategoryItem>

curry

  • curry(func: any): curried

Const dateToUTC

  • dateToUTC(date: number): number

Const defaultMetaIDs

  • defaultMetaIDs(): Observable<string[]>

defineDmsConfiguration

  • defineDmsConfiguration(version: DmsAppsVersions, assetStructs: MediaTypes, apiUrl: string, partnerId: string, rootCategoryID: string): Observable<KalturaConfigurations>

  • Defines configuration based on dms contract

    Retreives default configuration group If default group exists, defines configurations for default configuration group id If not, creates default configuration group and defines configurations for the newly created group

    Parameters

    Returns Observable<KalturaConfigurations>

defineDmsConfigurationRequest

  • defineDmsConfigurationRequest(groupId: string, version: DmsAppsVersions, assetStructs: MediaTypes, apiUrl: string, partnerId: string, rootCategoryID: string): Observable<KalturaConfigurations>

Const deleteAllPersonalList

  • deleteAllPersonalList(__namedParameters: { partnerListId: number }): Observable<any>

Const deleteCategory

  • deleteCategory(categoryId: number): Observable<any>

Const deleteMeta

  • deleteMeta(id: any): Observable<any>

Const deletePersonalList

  • deletePersonalList(__namedParameters: { id: number }): Observable<any>

Const deleteRecording

  • deleteRecording(__namedParameters: { id: number }): Observable<KalturaRecording>

Const deleteRecordsList

  • deleteRecordsList(records: Record[]): Observable<(KalturaRecording | KalturaSeriesRecording)[]>

Const deleteSeriesRecording

  • deleteSeriesRecording(__namedParameters: { id: number }): Observable<KalturaSeriesRecording>

Const deviceBrandGetList

  • deviceBrandGetList(): Observable<KalturaDeviceBrand[]>

Const doConfig

  • doConfig(config: KuxConfig): (Anonymous function)

Const doImport

  • doImport(JSONtree: any, language: any, withCollections?: boolean, withImages?: boolean, withDynamicData?: boolean): Observable<any>

  • Parameters

    • JSONtree: any
    • language: any
    • Default value withCollections: boolean = false
    • Default value withImages: boolean = false
    • Default value withDynamicData: boolean = false

    Returns Observable<any>

Const doMultiImport

  • doMultiImport(JSONtreeChildren: any[], language: any, withCollections?: boolean, withImages?: boolean, withDynamicData?: boolean): Observable<any>

  • Parameters

    • JSONtreeChildren: any[]
    • language: any
    • Default value withCollections: boolean = false
    • Default value withImages: boolean = false
    • Default value withDynamicData: boolean = false

    Returns Observable<any>

Const downloadTranslation

  • downloadTranslation(downloadUrl: string, proxy?: string): Observable<unknown>

Const duplicateCategory

  • duplicateCategory(newCategoryName: string, originalCategoryId: number): Observable<KalturaCategoryTree>

Const endOfDay

  • endOfDay(date?: Date, delta?: number): number

Const epgArgsToKsql

Const epgArgsToKsqlSingle

Const escapeKsqlValue

  • escapeKsqlValue(value: string): string

Const exportCategoryTree

  • exportCategoryTree(id: any): Observable<any>

Const exportProjectFromPOEditor

Const extractPartnerVirtualAssetInfoFromConfig

  • extractPartnerVirtualAssetInfoFromConfig(config: KalturaPartnerConfigurationListResponse): KalturaObjectVirtualAssetInfo

Const filterByKUXPrefix

  • filterByKUXPrefix(data: any): any

Const findByRatio

Const findByRatioV2

Const findRailImage

Const findRailImageV2

Const generateMenuItem

Const generateMenuLink

Const getAdult

  • getAdult(metas: any): boolean

Const getAssetByCategoryId

  • getAssetByCategoryId(id: number): Observable<KalturaMediaAsset>

Const getAssetById

  • getAssetById<T>(id: number | string, assetReferenceType?: KalturaAssetReferenceType): Observable<T>

  • Get asset by id

    Type parameters

    • T: KalturaAsset

    Parameters

    • id: number | string
    • Default value assetReferenceType: KalturaAssetReferenceType = KalturaAssetReferenceType.media

    Returns Observable<T>

Const getAssetCount

  • getAssetCount(__namedParameters: { groupBy: any; kSql: any; orderBy: string }): Observable<any>

Const getAssetFavoriteList

  • getAssetFavoriteList(__namedParameters: { mediaType: MediaType }): Observable<number[]>

Const getAssetHistory

  • getAssetHistory(assetHistoryListActionArgs: AssetHistoryListActionArgs, groupBy?: string): Observable<any>

Const getAssetHistoryList

  • getAssetHistoryList(__namedParameters: { assetIdIn: string; daysLessThanOrEqual: number; groupBy: string; pageIndex: number; pageSize: number; statusEqual: KalturaWatchStatus; typeIn: string }): Observable<any>

  • Get list of AssetHistory

    Parameters

    • __namedParameters: { assetIdIn: string; daysLessThanOrEqual: number; groupBy: string; pageIndex: number; pageSize: number; statusEqual: KalturaWatchStatus; typeIn: string }
      • assetIdIn: string
      • daysLessThanOrEqual: number
      • groupBy: string
      • pageIndex: number
      • pageSize: number
      • statusEqual: KalturaWatchStatus
      • typeIn: string

    Returns Observable<any>

Const getAssetHistoryListRecursively

  • getAssetHistoryListRecursively<T>(__namedParameters: { chunkSize: number; filter: KalturaAssetHistoryFilter }, groupBy?: string): Observable<T>

  • Type parameters

    • T: KalturaAssetHistoryListResponse

    Parameters

    • __namedParameters: { chunkSize: number; filter: KalturaAssetHistoryFilter }
      • chunkSize: number
      • filter: KalturaAssetHistoryFilter
    • Default value groupBy: string = ""

    Returns Observable<T>

Const getAssetHistoryListV2

  • getAssetHistoryListV2(__namedParameters: { assetIdIn: string; daysLessThanOrEqual: number; groupBy: string; pageIndex: number; pageSize: number; statusEqual: KalturaWatchStatus; typeIn: string }): Observable<KuxBookmark[]>

  • Get list of AssetHistory

    Parameters

    • __namedParameters: { assetIdIn: string; daysLessThanOrEqual: number; groupBy: string; pageIndex: number; pageSize: number; statusEqual: KalturaWatchStatus; typeIn: string }
      • assetIdIn: string
      • daysLessThanOrEqual: number
      • groupBy: string
      • pageIndex: number
      • pageSize: number
      • statusEqual: KalturaWatchStatus
      • typeIn: string

    Returns Observable<KuxBookmark[]>

Const getAssetList

  • getAssetList(assetListActionArgs: AssetListActionArgs, groupBy?: string): Observable<any>

  • Get asset list by action

    Parameters

    • assetListActionArgs: AssetListActionArgs

      : AssetListActionArgs

    • Default value groupBy: string = ""

    Returns Observable<any>

Const getAssetListByEpgIds

  • getAssetListByEpgIds(ids: number[], ksql: string, groupBy?: string): Observable<KalturaAssetListResponse>

Const getAssetListBySeriesIds

  • getAssetListBySeriesIds(ids: string[], ksql: string): Observable<KalturaAssetListResponse>

Const getAssetsByCategoryIds

  • getAssetsByCategoryIds(ids: number[], pageSize?: number): Observable<KalturaAssetListResponse>

Const getAssetsByChannelId

  • getAssetsByChannelId(__namedParameters: { channelId: number; groupBy: string; kSql: string; pageIndex: number; pageSize: number }): Observable<KalturaAssetListResponse>

  • Get Asset List

    Parameters

    • __namedParameters: { channelId: number; groupBy: string; kSql: string; pageIndex: number; pageSize: number }
      • channelId: number
      • groupBy: string
      • kSql: string
      • pageIndex: number
      • pageSize: number

    Returns Observable<KalturaAssetListResponse>

Const getAssetsByFilter

  • getAssetsByFilter(filter: KalturaSearchAssetFilterArgs, pager?: KalturaFilterPagerArgs): Observable<KalturaAssetListResponse>

  • Load Assets list by provided filter.

    Parameters

    • filter: KalturaSearchAssetFilterArgs
    • Optional pager: KalturaFilterPagerArgs

    Returns Observable<KalturaAssetListResponse>

Const getAssetsByIdList

  • getAssetsByIdList(idList: number[], kSql?: string): Observable<KalturaAssetListResponse>

  • TODO DEPRECATED

    Get assets by array of assetsId

    Parameters

    • idList: number[]
    • Optional kSql: string

    Returns Observable<KalturaAssetListResponse>

Const getAssetsRecursively

  • getAssetsRecursively<T>(__namedParameters: { chunkSize: number; filter: KalturaAssetFilter }, groupBy?: string): Observable<T>

  • Load all assets by chunks

    Type parameters

    • T: KalturaAssetListResponse

    Parameters

    • __namedParameters: { chunkSize: number; filter: KalturaAssetFilter }
      • chunkSize: number
      • filter: KalturaAssetFilter
    • Default value groupBy: string = ""

    Returns Observable<T>

Const getBasicMetas

  • getBasicMetas(): Observable<KalturaMeta[]>

Const getBookmarks

  • getBookmarks(assetId: string | number, assetTypeEqual?: KalturaAssetType, orderBy?: string): Observable<KalturaBookmarkListResponse>

  • Get playback context for player

    Parameters

    • assetId: string | number
    • Default value assetTypeEqual: KalturaAssetType = KalturaAssetType.epg
    • Default value orderBy: string = "POSITION_ASC"

    Returns Observable<KalturaBookmarkListResponse>

getCatchUpAirDate

  • getCatchUpAirDate(startDate: number, local: string, primeTime?: number): { values: string[] } | { id: string; value: string }

Const getCategoryById

  • getCategoryById(categoryId: any): Observable<any>

Const getCategoryITemById

  • getCategoryITemById(id: any): void

Const getCategoryIds

  • getCategoryIds(tree: KalturaCategoryTree, catIds?: any[]): any[]

Const getCategoryStruct

  • getCategoryStruct(structId: any): Observable<KalturaAssetStruct>

Const getCategoryStructsList

  • getCategoryStructsList(filter?: KalturaAssetStructFilterArgs): Observable<KalturaAssetStructListResponse>

Const getCategoryVirtualAssetConfig

  • getCategoryVirtualAssetConfig(): Observable<KalturaObjectVirtualAssetInfo>

Const getChannelCache

  • getChannelCache(data: ChannelCache): Promise<KalturaAssetListResponse>

Const getChannelProgramId

Const getChannelRail

Const getChannelRailV2

  • getChannelRailV2<T>(__namedParameters: { channelId: number; channelsStats: ChannelStats[]; firstChannelId: number; groupBy: string; kSql: string; orderBatches: LCBatchesPresentationOrderEnum[]; pageIndex: number; pageSize: number }): Observable<KuxList<T>>

Const getChannels

Const getCollectionRail

  • getCollectionRail(__namedParameters: { channelId: number; groupBy: string; imageOptions: KuxRailImageArg; kSql: string; pageIndex: number; pageSize: number }): Observable<KuxRail<KuxCollectionCard>>

Const getCollectionRailV2

  • getCollectionRailV2<T>(__namedParameters: { channelId: number; groupBy: string; kSql: string; pageIndex: number; pageSize: number }): Observable<KuxList<T>>

  • Get collection rail

    Type parameters

    Parameters

    • __namedParameters: { channelId: number; groupBy: string; kSql: string; pageIndex: number; pageSize: number }
      • channelId: number
      • groupBy: string
      • kSql: string
      • pageIndex: number
      • pageSize: number

    Returns Observable<KuxList<T>>

Const getConfig

  • getConfig(f: any): (Anonymous function)

Const getContinueWatchingRail

  • getContinueWatchingRail(__namedParameters: { daysLessThanOrEqual: number; groupBy: string; imageOptions: KuxRailImageArg; kSql: string; pageIndex: number; pageSize: number; statusEqual: KalturaWatchStatus; typeIn: string }): Observable<KuxRail<KuxContinueWatchingCard>>

  • Get continue watching rail

    Parameters

    • __namedParameters: { daysLessThanOrEqual: number; groupBy: string; imageOptions: KuxRailImageArg; kSql: string; pageIndex: number; pageSize: number; statusEqual: KalturaWatchStatus; typeIn: string }
      • daysLessThanOrEqual: number
      • groupBy: string
      • imageOptions: KuxRailImageArg
      • kSql: string
      • pageIndex: number
      • pageSize: number
      • statusEqual: KalturaWatchStatus
      • typeIn: string

    Returns Observable<KuxRail<KuxContinueWatchingCard>>

Const getContinueWatchingRailV2

  • getContinueWatchingRailV2<T>(__namedParameters: { daysLessThanOrEqual: number; groupBy: string; kSql: string; pageIndex: number; pageSize: number; statusEqual: KalturaWatchStatus; typeIn: string }): Observable<KuxList<T>>

  • Type parameters

    Parameters

    • __namedParameters: { daysLessThanOrEqual: number; groupBy: string; kSql: string; pageIndex: number; pageSize: number; statusEqual: KalturaWatchStatus; typeIn: string }
      • daysLessThanOrEqual: number
      • groupBy: string
      • kSql: string
      • pageIndex: number
      • pageSize: number
      • statusEqual: KalturaWatchStatus
      • typeIn: string

    Returns Observable<KuxList<T>>

Const getCurrentProgramByLinearList

  • getCurrentProgramByLinearList(__namedParameters: { externalIdList: number[] }): Observable<KuxProgramType[]>

getDefaultConfigurationGroup

  • getDefaultConfigurationGroup(): Observable<KalturaConfigurationGroup>

Const getDetailsProgramByInternalId

  • getDetailsProgramByInternalId(internalId: number): Observable<{ program: KuxDetailsProgram; updateCache: boolean }>

getDms

getDmsAppVersions

getDmsConfigurationsList

  • getDmsConfigurationsList(): Observable<KalturaConfigurations[]>

getDmsContract

  • getDmsContract(assetStructs: MediaTypes, apiUrl: string, partnerId: string, rootCategoryID: string): DmsInterface

Const getEnumKeyByEnumValue

  • getEnumKeyByEnumValue(myEnum: any, enumValue: any): string

Const getEpgByChannel

Const getEpgByChannels

  • getEpgByChannels(externalIdList: number[], startTime: number, endTime: number): Observable<KuxProgram[]>

Const getEpgCacheDays

Const getEpgData

  • TODO DEPRECATED Loads EPG data I most cases application doesn't need to know when event ends, but only when it starts.

    NOTE: data.startTimeFrom translated into KsQl start_date >= xxx and data.startTimeTo translated to start_date <= xxx

    Parameters

    Returns Observable<KuxProgram[]>

Const getEpgDataV2

Const getExpiredByTime

  • getExpiredByTime(time: number): number

Const getExtendedTitle

  • getExtendedTitle(title: string, meta: any): string

Const getFavoriteCache

getFilteredCategoryTree

getFullCategoryTree

  • getFullCategoryTree(categoryItemId: number, size?: number): Observable<KuxCategoriesDTO>

Const getHouseholdPaymentMethodList

  • getHouseholdPaymentMethodList(): Observable<KalturaHouseholdPaymentMethodListResponse>

Const getHouseholdQuota

  • getHouseholdQuota(): Observable<KalturaHouseholdQuota>

Const getIdsOnly

  • getIdsOnly(metas: (number | KalturaMeta)[]): (string | number)[]

Const getIsPurchasedByFileId

  • getIsPurchasedByFileId(items: T[], withCaching?: boolean): Observable<T[]>

Const getLoginAssets

  • getLoginAssets(channelId: any): Observable<{ id: number; image: string; inAppLink: any; title: string; type: ButtonTypes; typeOfAppLink: any }[]>

Const getMainVirtualMeta

  • getMainVirtualMeta(): Observable<KalturaMeta>

Const getMainVirtualStruct

  • getMainVirtualStruct(): Observable<KalturaAssetStruct>

Const getMediaAssetsByAssetHistory

  • getMediaAssetsByAssetHistory(history: KalturaAssetHistory[], kSql?: string): Observable<any>

Const getMediaAssetsByIdList

  • getMediaAssetsByIdList<T>(idList: number[], kSql?: string): Observable<T[]>

Const getMediaFileId

  • getMediaFileId<T>(asset: T): KalturaMediaFile

Const getMenuItems

Const getNotFoundArray

  • getNotFoundArray(startTime: number, endTime: number, externalId: number): any[]

Const getPageNumberArr

  • getPageNumberArr(totalCount: number, chunkSize: number, startPage: number): number[]

Const getParentalRating

Const getParserAssetMap

  • getParserAssetMap(): {}

Const getPersonalList

  • getPersonalList(__namedParameters: { pageIndex: number; pageSize: number; partnerListTypes: number[] }): Observable<KalturaPersonalListListResponse>

  • Parameters

    • __namedParameters: { pageIndex: number; pageSize: number; partnerListTypes: number[] }
      • pageIndex: number
      • pageSize: number
      • partnerListTypes: number[]

    Returns Observable<KalturaPersonalListListResponse>

Const getProductList

  • getProductList(getProductListArgs: KalturaProductPriceFilterArgs): Observable<KalturaProductPriceListResponse>

Const getProductPricesCache

Const getProgramByChannelId

Const getProgramByChannelIdV2

  • getProgramByChannelIdV2(channelId: number): Observable<KuxProgramType>

Const getProgramsByChannels

Const getRatioByAsset

Const getRatioByAssetV2

Const getRecommendationAssets

  • getRecommendationAssets(__namedParameters: { groupBy: string; kSql: string; pageIndex: any; pageSize: any; partnerListTypeIn: any }): Observable<KalturaAssetListResponse>

  • Get recommendation assets

    Parameters

    • __namedParameters: { groupBy: string; kSql: string; pageIndex: any; pageSize: any; partnerListTypeIn: any }
      • groupBy: string
      • kSql: string
      • pageIndex: any
      • pageSize: any
      • partnerListTypeIn: any

    Returns Observable<KalturaAssetListResponse>

Const getRecommendationRail

  • getRecommendationRail(__namedParameters: { groupBy: string; imageOptions: KuxRailImageArg; kSql: string; pageIndex: number; pageSize: number; partnerListTypeIn: number }): Observable<KuxRail<KuxCollectionCard>>

Const getRecommendationRailV2

  • getRecommendationRailV2<T>(__namedParameters: { groupBy: string; kSql: string; pageIndex: number; pageSize: number; partnerListTypeIn: number }): Observable<KuxList<T>>

  • Type parameters

    Parameters

    • __namedParameters: { groupBy: string; kSql: string; pageIndex: number; pageSize: number; partnerListTypeIn: number }
      • groupBy: string
      • kSql: string
      • pageIndex: number
      • pageSize: number
      • partnerListTypeIn: number

    Returns Observable<KuxList<T>>

Const getRecordHistory

  • getRecordHistory(recordId: number): Observable<KalturaAssetHistory>

Const getRecordingById

  • getRecordingById(id: number): Observable<any>

Const getRecordingList

  • getRecordingList(recordingListActionArgs: RecordingListActionArgs): Observable<any>

Const getRecordingsRecursively

  • getRecordingsRecursively<T>(__namedParameters: { chunkSize: number; filter: KalturaRecordingFilter }): Observable<T>

Const getResizerUrl

  • getResizerUrl(url: string, height?: number, width?: number): string

Const getScreenEpg

  • getScreenEpg(__namedParameters: { channelId: number; channelsStats: ChannelStats[]; currentAssetId: number; currentIndex: number; deltaDays: number; orderBatches: LCBatchesPresentationOrderEnum[]; screenLength: number; startExternalId: number; startLCN: number }): Observable<{ channels: KuxEpgItem[]; end: number; start: number }>

getSeasonsList

  • getSeasonsList(seriesId: string, assetType?: KalturaAssetType): Observable<Season[]>

Const getSelfServiceLinks

getSeriesList

  • getSeriesList(__namedParameters: { seasonNumber: any; seriesId: any }): Observable<KuxDetailsProgram[]>

Const getSeriesRecordingList

  • getSeriesRecordingList(): Observable<KalturaSeriesRecordingListResponse>

getServicesTokenByUsernameAndPassword

  • getServicesTokenByUsernameAndPassword(username: string, password: string, udid: string, service: string): Observable<any>

  • Perform plain authorization and obtain a token for Services list request

    Parameters

    • username: string
    • password: string
    • udid: string
    • service: string

    Returns Observable<any>

Const getSingleAndSeriesRecordList

Const getSingleRecordsAssets

  • getSingleRecordsAssets(__namedParameters: { groupBy: string; imageOptions: KuxRailImageArg; kSql: string; orderBy: string; pageIndex: number; pageSize: number; statusIn: string }): Observable<RecordList<RecordAsset>>

Const getSingleRecordsAssetsV2

  • getSingleRecordsAssetsV2<T>(__namedParameters: { groupBy: string; kSql: string; orderBy: string; pageIndex: number; pageSize: number; statusIn: string }): Observable<KuxList<T>>

Const getTagsByMeta

  • getTagsByMeta(metaId: number, pager?: KalturaFilterPager): Observable<KalturaTagListResponse>

Const getTvChannels

  • getTvChannels(channelId: number, kSql?: string, groupBy?: string): Observable<KalturaAssetListResponse>

  • Get all linear assets filter by channelId and kSql (function has cache)

    Parameters

    • channelId: number
    • Optional kSql: string
    • Optional groupBy: string

    Returns Observable<KalturaAssetListResponse>

Const getUserRules

  • getUserRules(assetIdEqual: number, assetTypeEqual: 0 | 1): Observable<any>

Const getWidthByHeight

Const importTree

  • importTree(JSONtree: any, forkRequests?: any[], language: any, withCollections?: boolean, withImages?: boolean, withDynamicData?: boolean): any[]

  • Parameters

    • JSONtree: any
    • Default value forkRequests: any[] = []
    • language: any
    • Default value withCollections: boolean = false
    • Default value withImages: boolean = false
    • Default value withDynamicData: boolean = false

    Returns any[]

Const importTreeV2

  • importTreeV2(JSONtree: any, forkRequests?: any[], language: any, withCollections?: boolean, withImages?: boolean, withDynamicData?: boolean): any[]

  • Parameters

    • JSONtree: any
    • Default value forkRequests: any[] = []
    • language: any
    • Default value withCollections: boolean = false
    • Default value withImages: boolean = false
    • Default value withDynamicData: boolean = false

    Returns any[]

Const initCategoryVirtualAssetConfig

  • initCategoryVirtualAssetConfig(): Observable<boolean>

Const isInProgressEpgRequest

Const kalturaClient

  • kalturaClient(): KalturaClient

kuxSetConfig

Const kuxSetDMS

  • kuxSetDMS(dms: KuxDms): void

kuxUpdateConfig

  • kuxUpdateConfig(config: Partial<KuxConfig>): void

Const languageList

  • languageList(): Observable<KalturaLanguageListResponse>

Const mergeDevicesWithStreamingDevices

  • mergeDevicesWithStreamingDevices(deviceList: any, streamingDeviceList: any): any

mergeObjectValues

  • mergeObjectValues(list: any): any

Const normalizeCategoryMetas

Const normalizeCategoryTagGroup

  • normalizeCategoryTagGroup(tag: any): string[]

Const normalizeCategoryTags

Const normalizingRecord

  • normalizingRecord(record: any): Record

Const parseMenuItem

Const parseMenuItems

Const parseSelfServiceLinks

Const parseTree

  • parseTree(tree: KalturaCategoryTree, assets?: any): any

Const randString

  • randString(length: any): string

Const randomEnum

  • randomEnum<T>(anEnum: T): T[keyof T]

Const removeEpgRequest

Const removeEpgRequestChannel

  • removeEpgRequestChannel(channelId: number): void

Const removeMetasFromCategoryStruct

Const removeOverlap

Const setChannelCache

  • setChannelCache(data: ChannelCache, value: KalturaAssetListResponse): KalturaAssetListResponse

Const setEpgCacheDays

Const setEpgLimitCache

  • setEpgLimitCache(limit?: number): number

Const setFavoriteCache

  • setFavoriteCache(data: FavoriteCache, value: number[]): number[]

Const setImageScale

  • setImageScale(newImageScale: number): void

Const setMetasOnCategoryStruct

Const setProductPricesCache

setUidaToCategoryTree

  • setUidaToCategoryTree(categoriesTree: KalturaCategoryTree[], uidaAssets: KalturaAsset[]): KuxCategoriesDTO[]

Const sliceArrayOnChunks

  • sliceArrayOnChunks(arr: number[], chunckSize: number): Array<number[]>

Const sortByOrderBatches

Const startOfDay

  • startOfDay(date?: Date, delta?: number): number

Const startOfMonth

  • startOfMonth(delta?: number, date?: Date): number

Const startOfWeek

  • startOfWeek(delta?: number, date?: Date): number

Const stringToTranslationToken

  • stringToTranslationToken(value: string, language?: string): KalturaTranslationToken

Const timeStringToDate

  • timeStringToDate(timeString: string): Date

toBoolean

  • toBoolean(variable: number | string | boolean): boolean

Const toKuxImages

  • toKuxImages(images: KalturaMediaImage[]): KuxImages

Const toSingleEpgOutput

Const transactionsHistory

  • transactionsHistory(): Observable<KalturaBillingTransaction[]>

Const transactionsPurchase

  • transactionsPurchase(purchaseData: TransactionPurchaseActionArgs): Observable<KalturaTransaction>

Const tvpilGetLocalCache

Const tvpilSetCacheService

Const updateAsset

  • updateAsset(id: number, asset: KalturaMediaAssetArgs): Observable<KalturaMediaAsset>

Const updateCategory

  • updateCategory(category: KalturaCategoryItem, updateParent?: boolean): Observable<KalturaCategoryItem>

Const updateCategoryStruct

  • updateCategoryStruct(data: AssetStructUpdateActionArgs): Observable<KalturaAssetStruct>

updateDmsConfiguration

  • updateDmsConfiguration(id: string, version: DmsAppsVersions, content: any): Observable<KalturaConfigurations>

  • Retreives default configuration group If default configuration group exists, updates given configuration by id

    Parameters

    • id: string

      Id of configuration to update

    • version: DmsAppsVersions

      Contains appName, clientVersion and platform

    • content: any

      json content of conifiguration

    Returns Observable<KalturaConfigurations>

Const updateDynamicData

  • updateDynamicData(__namedParameters: { key: DynamicDataTypeEnum; value: string }): Observable<KalturaOTTUserDynamicData>

Const updateMeta

  • updateMeta(id: any, data: KalturaMetaArgs): Observable<any>

Const upgradeWindowDates

  • upgradeWindowDates(startTimeString: string, endTimeString: string, nowDate?: Date): Date[]

Const validateEmail

  • validateEmail(value: string): boolean

Parental Functions

Const pinUpdateParental

  • pinUpdateParental(pin: string): Observable<KalturaPin>

  • Build request payload for service 'Pin' action 'Validate', type parental.

    Usage: Parental PinUpdateAction

    function

    Parameters

    • pin: string

      number

    Returns Observable<KalturaPin>

Purchase Functions

Const collectionGetAssetList

  • collectionGetAssetList(__namedParameters: { assetType: any; collectionId: any; packageSubscriptionIds: any; subscriptionExcludeIds: any; userCustomerType: any }): Observable<{ basePackageId: any; catalogStartDateTime: any; description: string; disclaimer: any; endDate: number; id: number; image: string; images: { isDefault: boolean; ratio: string; url: string }[]; playbackEndDateTime: any; priceDescription: any; startDate: number; subscriptionId: any; title: string }[]>

  • Get subscription asset list for “Some offers for you” and “Hero banner” Usage: get user subscription asset list

    function

    Parameters

    • __namedParameters: { assetType: any; collectionId: any; packageSubscriptionIds: any; subscriptionExcludeIds: any; userCustomerType: any }
      • assetType: any
      • collectionId: any
      • packageSubscriptionIds: any
      • subscriptionExcludeIds: any
      • userCustomerType: any

    Returns Observable<{ basePackageId: any; catalogStartDateTime: any; description: string; disclaimer: any; endDate: number; id: number; image: string; images: { isDefault: boolean; ratio: string; url: string }[]; playbackEndDateTime: any; priceDescription: any; startDate: number; subscriptionId: any; title: string }[]>

Const filesGetProductPrices

Const formatKalturaProductPrice

  • formatKalturaProductPrice(productPrice: KalturaSubscriptionPrice): { endDate: number; productId: string; productType: KalturaTransactionType; purchaseStatus: KalturaPurchaseStatus; price: object }

  • Format asset to corresponded view: from KalturaProductPrice to viewable KalturaSubscriptionPrice

    Usage: subscriptionsGetProductPrices - format product price to subscription price

    function

    Parameters

    • productPrice: KalturaSubscriptionPrice

    Returns { endDate: number; productId: string; productType: KalturaTransactionType; purchaseStatus: KalturaPurchaseStatus; price: object }

    • endDate: number
    • productId: string
    • productType: KalturaTransactionType
    • purchaseStatus: KalturaPurchaseStatus
    • price: object
      • amount: number
      • currency: string
      • currencySign: string

Const formatKalturaProductPricePpv

Const getProductPrices

  • getProductPrices(type?: string, ids?: number[]): Observable<KalturaProductPrice[]>

  • Build request payload for service 'ProductPrice' action 'List'.

    Usage: get product prices

    function

    Parameters

    • Default value type: string = "subscription"
    • Default value ids: number[] = []

    Returns Observable<KalturaProductPrice[]>

Const getSubscriptionsList

  • getSubscriptionsList(subscriptionIds: string[], mediaFileId?: number): Observable<{ dependencyType: KalturaSubscriptionDependencyType; id: string; price: object }[]>

  • Build request payload for service 'Subscription' action 'List'.

    Usage: get user subscriptions

    function

    Parameters

    • subscriptionIds: string[]
    • Default value mediaFileId: number = 0

    Returns Observable<{ dependencyType: KalturaSubscriptionDependencyType; id: string; price: object }[]>

Const householdGetPaymentGateways

  • householdGetPaymentGateways(): Observable<KalturaHouseholdPaymentGatewayListResponse>

  • Build request payload for service 'Household' action 'PaymentGatewayList'.

    Usage: get PaymentGatewayList

    function

    Returns Observable<KalturaHouseholdPaymentGatewayListResponse>

Const householdInvokePaymentGateways

  • householdInvokePaymentGateways(paymentGatewayId: number): Observable<KalturaPaymentGatewayConfiguration>

  • Build request payload for service 'Household' action 'PaymentGatewayInvoke'.

    Usage: invoke PaymentGateway

    function

    Parameters

    • paymentGatewayId: number

    Returns Observable<KalturaPaymentGatewayConfiguration>

Const mediaFileGetSubscription

  • mediaFileGetSubscription(mediaFileId: number): Observable<{ dependencyType: KalturaSubscriptionDependencyType; id: string; price: object }[]>

  • Build request payload for service 'Subscription' action 'List'.

    Usage: get corresponded subscription for some media file

    function

    Parameters

    • mediaFileId: number

    Returns Observable<{ dependencyType: KalturaSubscriptionDependencyType; id: string; price: object }[]>

Const subscriptionToSubscription

  • subscriptionToSubscription(subscription: KalturaSubscription): { dependencyType: KalturaSubscriptionDependencyType; id: string; price: object }

  • Format asset to corresponded view: from KalturaSubscription to viewable

    Usage: collectionGetAssetList - format asset

    function

    Parameters

    • subscription: KalturaSubscription

    Returns { dependencyType: KalturaSubscriptionDependencyType; id: string; price: object }

    • dependencyType: KalturaSubscriptionDependencyType
    • id: string
    • price: object
      • amount: number
      • currency: string
      • currencySign: string

Const subscriptionsCancel

  • subscriptionsCancel(subscriptionId: number): Observable<void>

Const subscriptionsGetAssets

  • subscriptionsGetAssets(subscriptionIds: any, assetType: any): Observable<{ basePackageId: any; catalogStartDateTime: any; description: string; disclaimer: any; endDate: number; id: number; image: string; images: { isDefault: boolean; ratio: string; url: string }[]; playbackEndDateTime: any; priceDescription: any; startDate: number; subscriptionId: any; title: string }[]>

  • Get subscription assets Usage: get user assets from subscriptions

    function

    Parameters

    • subscriptionIds: any
    • assetType: any

    Returns Observable<{ basePackageId: any; catalogStartDateTime: any; description: string; disclaimer: any; endDate: number; id: number; image: string; images: { isDefault: boolean; ratio: string; url: string }[]; playbackEndDateTime: any; priceDescription: any; startDate: number; subscriptionId: any; title: string }[]>

Const subscriptionsGetEntitlements

  • subscriptionsGetEntitlements(): Observable<KalturaEntitlementListResponse>

Const subscriptionsGetList

  • subscriptionsGetList(subscriptionIds: string[]): Observable<{ dependencyType: KalturaSubscriptionDependencyType; id: string; price: object }[]>

  • Build request payload for service 'Subscription' action 'List'.

    Usage: get user subscriptions for settings

    function

    Parameters

    • subscriptionIds: string[]

    Returns Observable<{ dependencyType: KalturaSubscriptionDependencyType; id: string; price: object }[]>

Const subscriptionsGetSets

  • subscriptionsGetSets(): Observable<KalturaSubscriptionDependencySet[]>

Const subscriptionsPurchaseTransaction

  • subscriptionsPurchaseTransaction(__namedParameters: { currency: any; price: any; subscriptionId: any }): Observable<KalturaTransaction | { message: string; state: string } | { paymentGatewayId: number; state: string }>

  • Build request payload for service 'Entitlement' action 'Purchase'.

    Usage: Purchase subscription

    function

    Parameters

    • __namedParameters: { currency: any; price: any; subscriptionId: any }
      • currency: any
      • price: any
      • subscriptionId: any

    Returns Observable<KalturaTransaction | { message: string; state: string } | { paymentGatewayId: number; state: string }>

Purchase / Subscriptions Functions

Const pinUpdate

  • pinUpdate(pin: KalturaPin, type: KalturaPinType, by: KalturaEntityReferenceBy): Observable<KalturaPin>

  • Build request payload for service 'Pin' action 'Validate'.

    Usage: Purchase / Parental subscription PinUpdateAction

    function

    Parameters

    • pin: KalturaPin

      number

    • type: KalturaPinType
    • by: KalturaEntityReferenceBy

    Returns Observable<KalturaPin>

Const pinUpdatePurchase

  • pinUpdatePurchase(pin: string): Observable<KalturaPin>

  • Build request payload for service 'Pin' action 'Validate', type purchase.

    Usage: Purchase subscription PinUpdateAction

    function

    Parameters

    • pin: string

      number

    Returns Observable<KalturaPin>

Const pinValidate

  • pinValidate(pin: string, type: KalturaPinType): Observable<boolean>

  • Build request payload for service 'Pin' action 'Validate'.

    Usage: Purchase subscription PinValidateAction

    function

    Parameters

    • pin: string

      number

    • type: KalturaPinType

    Returns Observable<boolean>

Const pinValidateParental

  • pinValidateParental(pin: string): Observable<boolean>

  • Build request payload for service 'Pin' action 'Validate', type parental.

    Usage: Purchase subscription PinValidateAction

    function

    Parameters

    • pin: string

      number

    Returns Observable<boolean>

Const pinValidatePurchase

  • pinValidatePurchase(pin: string): Observable<boolean>

  • Build request payload for service 'Pin' action 'Validate', type purchase.

    Usage: Purchase subscription PinValidateAction

    function

    Parameters

    • pin: string

      number

    Returns Observable<boolean>

Subscriptions Functions

Const subscriptionsGetProductPrices

  • subscriptionsGetProductPrices(subscriptionIds: number[]): Observable<{ endDate: number; productId: string; productType: KalturaTransactionType; purchaseStatus: KalturaPurchaseStatus; price: object }[]>

  • Get subscriptions prices

    function

    Parameters

    • subscriptionIds: number[]

    Returns Observable<{ endDate: number; productId: string; productType: KalturaTransactionType; purchaseStatus: KalturaPurchaseStatus; price: object }[]>

getCompaundHouseholdDeviceList Functions

Const getCompoundHouseholdStreamingDeviceList

  • getCompoundHouseholdStreamingDeviceList(): Observable<{ items: any[]; totalCount: number }>

getCompoundHouseholdDeviceList Functions

Const householdGetDeviceListWithStreams

  • householdGetDeviceListWithStreams(): Observable<any>

getHousehold Functions

Const getHousehold

  • getHousehold(): Observable<KalturaHousehold>

Const getStreamingDeviceList

  • getStreamingDeviceList(): Observable<KalturaStreamingDeviceListResponse>

  • Build request payload for service ' StreamingDevice' action 'List'.

    Usage: get household data

    function

    Returns Observable<KalturaStreamingDeviceListResponse>

Basic KUX Configuration Object literals

Const BASE_KUX_METAS

BASE_KUX_METAS: object

UIDA_presentation_type

UIDA_presentation_type: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE]

helpText

helpText: string = "The actual UI definition of certain presentations."

multipleValue

multipleValue: true = true

name

name: string = "UIDA Presentation Type"

tags

tags: ("subscription" | "menu" | "container" | "hero" | "cw" | "collection" | "footer" | "apps" | "zapper" | "folder" | "login" | "settings" | "blocked_channels" | "parental_control" | "asset_details_page" | "epg" | "applications" | "language" | "favorites" | "devices" | "link_list" | "transaction_history" | "npvr" | "preferred_video_quality" | "series_catch_up" | "grid" | "menu_item" | "menu_sub" | "tvod" | "suggested" | "channel_api")[] = ['container','menu','hero','cw','collection','footer','apps','zapper','folder','login','settings','subscription','blocked_channels','parental_control','asset_details_page','epg','applications','language','favorites','devices','link_list','transaction_history','npvr','preferred_video_quality','series_catch_up','grid','menu_item','menu_sub','tvod','suggested', // Rail'channel_api', // Rail]

UIDAPresentationTypeEnum

UIDA_structure_type

UIDA_structure_type: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE]

helpText

helpText: string = "The type of UI. Num."

multipleValue

multipleValue: true = true

name

name: string = "UIDA Structure Type"

tags

tags: ("aside" | "root" | "page" | "widget" | "menu" | "subpage")[] = ['aside', 'root', 'page', 'widget', 'menu', 'subpage']

UIDAStructureTypeEnum

Const CATEGORY_ID

CATEGORY_ID: object

[CATEGORY_ID_SYSTEM_NAME]

[CATEGORY_ID_SYSTEM_NAME]: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME, READ_ONLY_FEATURE_NAME, METADATA_FEATURE_NAME]

helpText

helpText: string = "For internal use only!!!"

isProtected

isProtected: true = true

name

name: string = "Category ID (don't use it)"

Const CONTENT_KUX_METAS

CONTENT_KUX_METAS: object

addon_collection

addon_collection: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Collection id holding all available add-ons for purchase "

name

name: string = "Addons Collection Id"

allow_cancellation

allow_cancellation: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Flag to indicate presenting the user with cancel button for add-on type subscriptions "

name

name: string = "Allow Cancellation"

asset_struct

asset_struct: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Asset Type for Asset Details Page (Struct)"

name

name: string = "Asset Type"

cache_linear_channel_list

cache_linear_channel_list: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `To Cache or Not Linear Channels`

name

name: string = "On Load Caching"

device_brand_denial_list_for_ui_components

device_brand_denial_list_for_ui_components: object

See Presentation component filtering

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `List of brand ids to be denied access to the page.`

multipleValue

multipleValue: true = true

name

name: string = "Brand Denial List For UI Components"

external_portal_url

external_portal_url: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "URL reference to the external portal/self-care to make purchases "

name

name: string = "External URL (portal/self care)"

filtering_kSQL

filtering_kSQL: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The filtering kSQL is added to any asset request on the widget with an 'AND' operator.\nThe containing page’s or other filtering requests are also concatenated.`

name

name: string = "Filtering K-SQL"

global_linear_channels_collection_id

global_linear_channels_collection_id: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The collection id of the collection that groups linear channels.To be cached at the session initiation process and use on the application at Hero, Zapper, and EPG page.`

name

name: string = "The collection id of the collection that groups linear channels."

hero_collection

hero_collection: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Collection id holding the hero id"

name

name: string = "Hero Collection Id"

hide_adult_assets

hide_adult_assets: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The assets with the 'adult' flag with 'True' value,will be hidden according to the presence of the TRUE value.The assets will be hidden on all the widgets of the page.`

name

name: string = "Hide Adult Assets"

hide_adult_assets_kSQL

hide_adult_assets_kSQL: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The kSQL will be added and used on any page/widgetwhich will turn on the 'hide_adult_assets' flag.`

name

name: string = "Hide Adult Filtering K-SQL"

hide_parental_assets

hide_parental_assets: object

See Presentation component filtering

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The assets with the 'parental rating' higher than the user’s'age_threshold', will be hidden according to the presence of the TRUE value.The assets will be hidden on all the widgets of the page`

name

name: string = "Hide Parental Assets"

hide_parental_assets_kSQL

hide_parental_assets_kSQL: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The kSQL will be added and used on any page/widgetwhich will turn on the 'hide_parental_assets' flag.`

name

name: string = "Hide Parental Filtering K-SQL"

hide_prices

hide_prices: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Flag to indicate hiding prices for purchased add-ones"

name

name: string = "Hide Price"

linear_channels_filtering_kSQL

linear_channels_filtering_kSQL: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The filtering kSQL is added to any asset request on the Linears channel request,with an “AND“ operator. The other filtering requests are also concatenated.`

name

name: string = "Linear Channels Filtering K-SQL"

parental_age_groups

parental_age_groups: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "List of parental age groups."

name

name: string = "Parental Age Group"

parental_pin_protected

parental_pin_protected: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `Will require parental PIN`

name

name: string = "Protect With Parental PIN"

present_entitlement_indicator

present_entitlement_indicator: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `Each item on the widget will present an entitlement indicator,(usually a currency sign), in case the user is not entitled to the asset.`

name

name: string = "Entitlement Indicator"

present_favorite_indicator

present_favorite_indicator: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `Each item on the widget will present a favoriteindicator, in case it was favorite by the user.`

name

name: string = "Favorite Indicator"

prime_time

prime_time: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Prime Time Hour"

name

name: string = "Prime Time"

user_type_denial_list_for_ui_components

user_type_denial_list_for_ui_components: object

See Presentation component filtering

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `List of user types to be denied access to the page.`

multipleValue

multipleValue: true = true

name

name: string = "User Type Denial List For UI Components"

Const STYLING_KUX_METAS

STYLING_KUX_METAS: object

background_color

background_color: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "The background color of the page. Hex Color Code"

name

name: string = "Background Color"

btn_background_color

btn_background_color: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "The background color of the btn. Hex Color Code"

name

name: string = "Btn Default Background Color"

btn_background_color_focus

btn_background_color_focus: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "The background color of the focused btn. Hex Color Code"

name

name: string = "Btn Focused Background Color"

btn_background_opacity

btn_background_opacity: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "The opacity of background color on the btn. Numerical (0-100)"

name

name: string = "Btn Background Opacity"

btn_font_size

btn_font_size: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Text size in button (relative number)"

name

name: string = "Btn Font Size"

btn_text_color

btn_text_color: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Default Text Color. Hex Color Code"

name

name: string = "Btn Default Text Color"

btn_text_color_focus

btn_text_color_focus: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Focused Text Color. Hex Color Code"

name

name: string = "Btn Focused Text Color"

color_future

color_future: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Future Events Color (Zapper/EPG). Hex Color Code"

name

name: string = "Future Color"

color_past

color_past: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Past Events Color (Zapper/EPG). Hex Color Code"

name

name: string = "Past Color"

color_present

color_present: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Present Events Color (Zapper/EPG). Hex Color Code"

name

name: string = "Present Color"

focus_color

focus_color: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Text focused Color. Hex Color Code"

name

name: string = "Focus Color"

font_size

font_size: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Font Size Numerical (relative number)"

name

name: string = "Font Size"

font_type

font_type: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Design component. Font Type (Font Family). String."

name

name: string = "Font Type"

selected_color

selected_color: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Text Selected Color. Hex Color Code"

name

name: string = "Selected Color"

text_color

text_color: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "The background color of the page. Hex Color Code"

name

name: string = "Text Color"

Const WIDGET_KUX_METAS

WIDGET_KUX_METAS: object

anchors

anchors: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_NULLABLE]

helpText

helpText: string = "Tag with multiple values. Unique values across the Category Tree"

multipleValue

multipleValue: true = true

name

name: string = "Page Anchors"

asset_image_height

asset_image_height: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Design component. The representation of image height, basically Rail height"

name

name: string = "Asset Image Height"

dynamicData

dynamicData: object

defaultValue

defaultValue: number = 160

required

required: true = true

asset_image_source

asset_image_source: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE, META_NULLABLE]

helpText

helpText: string = "Design component. The source of image for each asset"

multipleValue

multipleValue: true = true

name

name: string = "Asset Image Source"

tags

tags: "manual"[] = ['manual']

AssetPresentationFormEnum

asset_presentation_form

asset_presentation_form: object

TODO: AssetPresentationForm

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE, META_NULLABLE]

helpText

helpText: string = "Design component. The presentation of the assets."

multipleValue

multipleValue: true = true

name

name: string = "Asset Image Type"

tags

tags: "circle"[] = ['circle']

AssetPresentationFormEnum

asset_presentation_ratio

asset_presentation_ratio: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE]

helpText

helpText: string = "Design component. The presentation of the assets."

multipleValue

multipleValue: true = true

name

name: string = "Asset Image Ratio"

tags

tags: ("1x1" | "16x9" | "3x4" | "2x3" | "5x3")[] = ['1x1', '16x9', '3x4', '2x3', '5x3']

AssetPresentationRatioEnum

button_type

button_type: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = ['metadata', KUX_FEATURE_NAME, META_ENUMERATION_TYPE]

helpText

helpText: string = "If asset used as BUTTON"

name

name: string = "Button Type"

tags

tags: ("login" | "sign_up")[] = ['login', 'sign_up']

concurrency_buymore

concurrency_buymore: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `Boolean parameter to indicate if “Buy More Stream” shall be presented `

name

name: string = "Buy More Stream"

concurrency_player_error_ttl

concurrency_player_error_ttl: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `This value will hold the expiry, in second for the error message shown on the Maxi player in case of cunncurency limit reached`

name

name: string = "Player Error TTL"

default_channel

default_channel: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "The asset id of the default asset to stream on the load."

name

name: string = "Default Asset on the Load"

display_type

display_type: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE]

helpText

helpText: string = "Menu link presentation mode"

multipleValue

multipleValue: true = true

name

name: string = "Display on Menu"

tags

tags: ("text" | "image" | "both")[] = ['text', 'image', 'both']

group_by

group_by: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = 'In case the value will be empty, not grouping will occur. \n' +'In case the value will contain any asset’s meta field value, the assets in the rail to be aggregated by the mentioned value. '

name

name: string = "Group By Meta"

in_app_link

in_app_link: object

See Application Links Types

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = ['metadata', KUX_FEATURE_NAME]

helpText

helpText: string = "Link to specific Page or Asset or external"

name

name: string = "In Application Link"

linear_channels_batches_presentation_order

linear_channels_batches_presentation_order: object

TODO: Need to be defined what type of custom field should be used. NOTE: order of tags/values is important. See Channel Presentation Flow

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The array with 1-3 values will appear.If the enum representing the batch appears, it means that the batch will be presented.`

multipleValue

multipleValue: true = true

name

name: string = "LC Presentation Order"

tags

tags: ("fav" | "top_x" | "lcn")[] = ['fav', 'top_x', 'lcn']

LCBatchesPresentationOrderEnum

menu_item_pined

menu_item_pined: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE, META_NULLABLE]

helpText

helpText: string = "Pin menu item to left or right side"

multipleValue

multipleValue: true = true

name

name: string = "Pin Menu Item"

tags

tags: ("left" | "right")[] = ['left', 'right']

UIDAStructureTypeEnum

npvr_unlimited_quota

npvr_unlimited_quota: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = 'Will be boolean value to indicate if unlimited storage will be used,\n' +'If set to True, Quota won’t be displayed.'

name

name: string = "Unlimited NPvR Quota"

present_X_most_watched_count

present_X_most_watched_count: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "The number of X most-watched assets on the device."

name

name: string = "X Most Watched Assets"

present_X_most_watched_period

present_X_most_watched_period: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The number of weeks to go back to count the watch attempts.Max 12 weeks`

name

name: string = "X Weeks for Most Watched Assets"

present_app_icon_platform_denylist

present_app_icon_platform_denylist: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "List of the brand ids on which the app icon will not be presented on the menu."

multipleValue

multipleValue: true = true

name

name: string = "App Icon by Brand Deny List"

present_clock_platform_denylist

present_clock_platform_denylist: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "List of the brand ids on which the CLOCK icon will NOT be shown."

multipleValue

multipleValue: true = true

name

name: string = "Clock Icon by Brand Deny List"

present_current_programs

present_current_programs: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `Defines whether the current program for each linear channel will be presented or not.`

name

name: string = "Present Current Program"

present_filter_X_watched

present_filter_X_watched: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `default value: 1`

name

name: string = "Present Filter X Watched"

present_filter_entitled

present_filter_entitled: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `default value: 1`

name

name: string = "Present Filter Entitled"

present_filter_favorite

present_filter_favorite: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `default value: 1`

name

name: string = "Present Filter Favorite"

present_mute_platform_denylist

present_mute_platform_denylist: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `List of the brand ids on which the mute will not be presented on the menu.`

multipleValue

multipleValue: true = true

name

name: string = "Present Mute_platform_denylist"

present_player

present_player: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Controls the presentation of the player above the linear channel rail."

name

name: string = "Present Player"

present_rating

present_rating: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Presenting the rating on the rail item."

name

name: string = "Present Rating"

present_rating_source_logo

present_rating_source_logo: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Presenting the source of the rating. "

name

name: string = "Present Rating Provider Logo"

present_show_more

present_show_more: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `If the value is True → present the “more“ button on the end of the rail.` +`If the value is False → do not present the “more“ button on the end of the rail.` +`The link from the “more“ button`

name

name: string = "Show more in END of the rail"

program_refresh_frequency

program_refresh_frequency: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Frequency of program data refreshing. In SECOND default = 300 (5 min)"

name

name: string = "Program Refresh Frequency"

purchase_allow_coupons

purchase_allow_coupons: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "This flag will indicate if the purchase page of this asset shall preset the coupon input option"

name

name: string = "Allow Coupons"

purchase_device_brand_denial_list

purchase_device_brand_denial_list: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `List of brand ids where purchase button will be replaced with “purchase not allowed“ message`

multipleValue

multipleValue: true = true

name

name: string = "Brand Denial List for Purchase"

rail_items_limit

rail_items_limit: object

dataType

dataType: number = KalturaMetaDataType.number

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "The number of items to present on the rail."

name

name: string = "Limit Items on Rail "

rating_provider

rating_provider: object

TODO: Need to be defined the list of providers See Rating provider source DMS definition

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE, META_NULLABLE]

helpText

helpText: string = "Presenting the rating on the rail item."

name

name: string = "Rating Provider"

tags

tags: ("imdb" | "kp" | "star" | "o2" | "tvprofi")[] = ['imdb', 'kp', 'star', 'o2', 'tvprofi']

RatingProviderEnum

recommendation_fields

recommendation_fields: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "The list of the meta fields on which the recommendations are built "

multipleValue

multipleValue: true = true

name

name: string = "Recommendations Fields"

recording_expiration_boundary

recording_expiration_boundary: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = 'Will be used as a boundary for displaying the Expiration Badges on the card,\n' +'The expiration badge will be displayed only if expiration time was equal \\ lower then this field value,\n' +'Will be measured in days.'

name

name: string = "Recording Badge Expiration"

recording_type

recording_type: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE]

helpText

helpText: string = "What type of recordings should be displayed"

multipleValue

multipleValue: true = true

name

name: string = "Recordings Type"

tags

tags: ("all" | "latest" | "series")[] = ['all', 'latest', 'series']

AssetPresentationFormEnum

rental_badge_boundary

rental_badge_boundary: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = 'Will be used as a boundary for displaying the expiration badge.\n' +'Badge will be displayed only if expiration time passed the value of this field.\n' +'Will be measured in hours. '

name

name: string = "Rental Badge Expiration"

search_channel_package_phrase

search_channel_package_phrase: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "Primary Search for the package"

name

name: string = "Primary Search for the package"

search_channel_phrase

search_channel_phrase: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = `The Content Administrator will put the keyword in the USDA's ` +`“search_channel_phrase“ and the first channel whose “channelDisplayName” ` +`contains this phrase will be connected to the rail.`

name

name: string = "Search Channel Phrase"

signup_url

signup_url: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "URL for the sign up page in external systems "

name

name: string = "Sign Up Url"

statusEqual

statusEqual: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME, META_ENUMERATION_TYPE]

helpText

helpText: string = 'Which type of recently watched media to include in the result – those that finished watching, \n' +'those that are in progress or both. If omitted or specified filter = all – return all types. \n' +'Allowed values: progress – return medias that are in-progress, done – return medias that finished watching.'

multipleValue

multipleValue: true = true

name

name: string = "Type of Recently Watched"

tags

tags: ("ALL" | "PROGRESS" | "DONE")[] = ['ALL', 'PROGRESS', 'DONE']

TypesContinueWatching

target_grid_category_id

target_grid_category_id: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = "To open the exact type of the “Grid” page the “Tree Category Item Id“ of the “Grid“ page should be sent as a parameter"

name

name: string = "Target Grid Page"

typeIn

typeIn: object

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = ['metadata', KUX_FEATURE_NAME]

helpText

helpText: string = 'If omitted all types should be included. All types include VOD, Episodes, Linear.\n' +'The value is taken from the list of types defined in the DMS for Movies, Episodes, Series.'

name

name: string = "Types of Medias"

type_of_app_link

type_of_app_link: object

See Application Links Types

dataType

dataType: string = KalturaMetaDataType.string

features

features: string[] = ['metadata', KUX_FEATURE_NAME, META_ENUMERATION_TYPE]

helpText

helpText: string = "Presenting if link is external, internal or something else"

multipleValue

multipleValue: true = true

name

name: string = "In Application Link Type"

tags

tags: ("page" | "grid" | "asset" | "external")[] = ['page', 'asset', 'external', 'grid']

TypeOfApplicationLink

use_suppress

use_suppress: object

dataType

dataType: boolean = KalturaMetaDataType.boolean

features

features: string[] = [KUX_FEATURE_NAME]

helpText

helpText: string = 'If this field set to True,\n' +'Specific modification need to be used on the API,\n' +'Then only last watched episode on the series will be available on the service.'

name

name: string = "Use Suppress"

Other Object literals

Const ALLBASICMETAS

ALLBASICMETAS: object

Const ASSET_MOCK

ASSET_MOCK: object

externalId

externalId: string = randString(16)

metas

metas: {}

Type declaration

multilingualName

multilingualName: KalturaTranslationToken[] = [new KalturaTranslationToken({ language: 'eng', value: 'kux_test_asset' })]

Const BASIC_CATEGORY_STRUCTS

BASIC_CATEGORY_STRUCTS: object

[MAIN_VIRTUAL_ASSET_STRUCT_NAME]

[MAIN_VIRTUAL_ASSET_STRUCT_NAME]: object

features

features: string[] = [KUX_FEATURE_NAME]

isProtected

isProtected: true = true

metas

metas: string[] = [CATEGORY_ID_SYSTEM_NAME]

name

name: string = MAIN_VIRTUAL_ASSET_STRUCT_NAME

applications_widget

applications_widget: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_presentation_form','asset_image_height','present_show_more','type_of_app_link','in_app_link','rail_items_limit',]

name

name: string = "Applications (Widget)"

apps_page

apps_page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_image_height','background_color','text_color','font_type','font_size','focus_color','selected_color','anchors',]

name

name: string = "Applications PAge"

aside

aside: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type', 'UIDA_presentation_type']

name

name: string = "Aside Folder"

asset_details_page

asset_details_page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','asset_struct','asset_presentation_ratio','asset_image_height','background_color','text_color','font_type','font_size','focus_color','selected_color','purchase_allow_coupons','rental_badge_boundary','anchors',]

name

name: string = "Asset Details Page"

blocked_channels

blocked_channels: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_image_height','background_color','text_color','font_type','font_size','focus_color','selected_color',]

name

name: string = "Blocked Channels"

category_menu_item

category_menu_item: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type', // menu'UIDA_presentation_type', // menu_item'type_of_app_link','in_app_link','asset_presentation_ratio','asset_image_height','presentation_type','menu_item_pined','display_type',]

name

name: string = "Menu Item"

category_sub_menu

category_sub_menu: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type', // menu'UIDA_presentation_type', // menu_sub]

name

name: string = "Sub Menu"

channel_api

channel_api: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','search_channel_phrase','search_channel_package_phrase',]

name

name: string = "Channel API (Widget)"

collection_widget

collection_widget: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','present_favorite_indicator','present_entitlement_indicator','parental_pin_protected','filtering_kSQL','hide_adult_assets','hide_adult_assets_kSQL','hide_parental_assets','hide_parental_assets_kSQL','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','present_app_icon_platform_denylist','present_clock_platform_denylist','asset_presentation_form','asset_presentation_ratio','asset_image_height','asset_image_source','present_show_more','type_of_app_link','in_app_link','rail_items_limit','default_channel','present_player','present_X_most_watched_count','present_X_most_watched_period','linear_channels_batches_presentation_order','present_current_programs','program_refresh_frequency','present_mute_platform_denylist','present_rating','rating_provider','present_rating_source_logo','group_by',]

name

name: string = "Collection (Widget)"

continue_watching_widget

continue_watching_widget: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','present_favorite_indicator','present_entitlement_indicator','filtering_kSQL','hide_adult_assets','hide_adult_assets_kSQL','hide_parental_assets','hide_parental_assets_kSQL','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','present_app_icon_platform_denylist','present_clock_platform_denylist','statusEqual','typeIn','asset_presentation_form','asset_presentation_ratio','asset_image_height','asset_image_source','present_show_more','type_of_app_link','in_app_link','rail_items_limit','default_channel','present_player','present_X_most_watched_count','present_X_most_watched_period','linear_channels_batches_presentation_order','present_current_programs','program_refresh_frequency','present_mute_platform_denylist','present_rating','rating_provider','present_rating_source_logo','target_grid_category_id','use_suppress','group_by',]

name

name: string = "Continue Watching (Widget)"

devices_subpage

devices_subpage: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_image_height','background_color','text_color','font_type','font_size','focus_color','selected_color',]

name

name: string = "Devices Mngmnt (Settings Subpage)"

epg_page

epg_page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','asset_presentation_ratio','color_past','color_present','color_future','hide_adult_assets','hide_adult_assets_kSQL','filtering_kSQL','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','present_X_most_watched_count','present_X_most_watched_period','present_favorite_indicator','present_entitlement_indicator','linear_channels_batches_presentation_order','present_filter_entitled','present_filter_favorite','present_filter_X_watched','anchors',]

name

name: string = "EPG Grid (Page)"

favorites_page

favorites_page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_image_height','background_color','text_color','font_type','font_size','focus_color','selected_color','anchors',]

name

name: string = "Favorites (Settings Subpage)"

generic_subpage

generic_subpage: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','background_color','text_color','font_type','font_size','focus_color','selected_color',]

name

name: string = "Generic Subpage (Settings Subpage)"

grid_page

grid_page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','present_favorite_indicator','present_entitlement_indicator','asset_presentation_form','asset_presentation_ratio','asset_image_height','present_rating','rating_provider','present_rating_source_logo','anchors',]

name

name: string = "Page Grid"

grid_widget

grid_widget: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','hide_adult_assets','hide_parental_assets','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','filtering_kSQL','present_favorite_indicator','present_entitlement_indicator','asset_presentation_form','asset_presentation_ratio','asset_image_height','present_rating','rating_provider','present_rating_source_logo','present_show_more','type_of_app_link','in_app_link','grid_lines_limit','group_by',]

name

name: string = "Widget Grid"

hero_widget

hero_widget: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','present_favorite_indicator','present_entitlement_indicator','filtering_kSQL','hide_adult_assets','hide_adult_assets_kSQL','hide_parental_assets','hide_parental_assets_kSQL','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','present_app_icon_platform_denylist','present_clock_platform_denylist','default_channel','present_player','present_X_most_watched_count','present_X_most_watched_period','linear_channels_batches_presentation_order','present_current_programs','program_refresh_frequency','asset_presentation_form','asset_presentation_ratio','asset_image_height','asset_image_source','present_show_more','type_of_app_link','in_app_link','rail_items_limit','present_mute_platform_denylist','present_rating','rating_provider','present_rating_source_logo','group_by',]

name

name: string = "Hero (Widget)"

home_page

home_page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','present_favorite_indicator','present_entitlement_indicator','parental_pin_protected','filtering_kSQL','hide_adult_assets','hide_adult_assets_kSQL','hide_parental_assets','hide_parental_assets_kSQL','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','present_app_icon_platform_denylist','present_clock_platform_denylist','asset_presentation_form','default_channel','present_player','present_X_most_watched_count','present_X_most_watched_period','linear_channels_batches_presentation_order','present_current_programs','program_refresh_frequency','present_mute_platform_denylist','present_rating','rating_provider','present_rating_source_logo','anchors',]

name

name: string = "Home Page (Container/Theme)"

in_application_link_asset

in_application_link_asset: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['type_of_app_link', 'in_app_link', 'asset_presentation_ratio', 'asset_image_height', 'button_type']

name

name: string = "Link as Asset"

language_subpage

language_subpage: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_image_height','background_color','text_color','font_type','font_size','focus_color','selected_color',]

name

name: string = "Language (Settings Subpage)"

link_list_subpage

link_list_subpage: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_image_height','background_color','text_color','font_type','font_size','focus_color','selected_color',]

name

name: string = "Link List (Settings Subpage)"

login_page

login_page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','signup_url','background_color','text_color','font_type','font_size','focus_color','selected_color','anchors',]

name

name: string = "Login Page (Aside)"

menu_widget

menu_widget: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','present_favorite_indicator','present_entitlement_indicator','filtering_kSQL','hide_adult_assets','hide_adult_assets_kSQL','hide_parental_assets','hide_parental_assets_kSQL','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','present_app_icon_platform_denylist','present_clock_platform_denylist','default_channel','present_X_most_watched_count','present_X_most_watched_period','linear_channels_batches_presentation_order','present_current_programs','program_refresh_frequency','present_mute_platform_denylist','asset_presentation_form','asset_presentation_ratio','asset_image_height','asset_image_source',]

name

name: string = "Menu (Widget)"

npvr_page

npvr_page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','recording_expiration_boundary','npvr_unlimited_quota','background_color','text_color','font_type','font_size','focus_color','selected_color','asset_presentation_form','asset_presentation_ratio','anchors',]

name

name: string = "Recordings - NpVR (Page)"

npvr_widget

npvr_widget: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','recording_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_presentation_form','asset_presentation_ratio','asset_image_height','present_show_more','type_of_app_link','in_app_link','rail_items_limit',]

name

name: string = "Recordings - NpVR (Widget)"

page

page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','present_favorite_indicator','parental_pin_protected','present_entitlement_indicator','filtering_kSQL','hide_adult_assets','hide_adult_assets_kSQL','hide_parental_assets','hide_parental_assets_kSQL','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','present_app_icon_platform_denylist','present_clock_platform_denylist','asset_presentation_form','asset_image_height','default_channel','present_player','present_X_most_watched_count','present_X_most_watched_period','linear_channels_batches_presentation_order','present_current_programs','program_refresh_frequency','present_mute_platform_denylist','present_rating','rating_provider','present_rating_source_logo','anchors',]

name

name: string = "General Page (Container)"

parent_control

parent_control: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_image_height','background_color','text_color','font_type','font_size','focus_color','selected_color','parental_age_groups',]

name

name: string = "Parent Control (Settings Subpage)"

root_category

root_category: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','btn_font_size','btn_text_color','btn_text_color_focus','btn_background_color','btn_background_color_focus','btn_background_opacity','color_past','color_present','color_future','present_favorite_indicator','present_entitlement_indicator','filtering_kSQL','hide_adult_assets','hide_adult_assets_kSQL','hide_parental_assets','hide_parental_assets_kSQL','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','present_app_icon_platform_denylist','present_clock_platform_denylist','asset_presentation_form','concurrency_buymore','concurrency_player_error_ttl','prime_time','default_channel','present_player','recommendation_fields','cache_linear_channel_list','global_linear_channels_collection_id','linear_channels_filtering_kSQL','linear_channels_batches_presentation_order','present_X_most_watched_count','present_X_most_watched_period','asset_image_height','present_current_programs','program_refresh_frequency','present_mute_platform_denylist','present_rating','rating_provider','present_rating_source_logo','purchase_device_brand_denial_list',]

name

name: string = "Root Category"

subscription_page

subscription_page: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','background_color','text_color','font_type','font_size','focus_color','selected_color','hide_prices','external_portal_url','addon_collection','hero_collection','allow_cancellation','anchors',]

name

name: string = "Subscription (Settings Subpage)"

transaction_history

transaction_history: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','asset_image_height','background_color','text_color','font_type','font_size','focus_color','selected_color',]

name

name: string = "Transaction History (Settings Subpage)"

tvod_widget

tvod_widget: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','present_favorite_indicator','present_entitlement_indicator','parental_pin_protected','filtering_kSQL','hide_adult_assets','hide_adult_assets_kSQL','hide_parental_assets','hide_parental_assets_kSQL','user_type_denial_list_for_ui_components','device_brand_denial_list_for_ui_components','present_app_icon_platform_denylist','present_clock_platform_denylist','asset_presentation_form','asset_presentation_ratio','asset_image_height','asset_image_source','present_show_more','type_of_app_link','in_app_link','rail_items_limit','target_grid_category_id','present_rating','rating_provider','present_rating_source_logo','group_by',]

name

name: string = "TVOD Rail (Widget)"

zapper_widget

zapper_widget: object

features

features: string[] = [KUX_FEATURE_NAME]

metas

metas: string[] = ['UIDA_structure_type','UIDA_presentation_type','background_color','text_color','font_type','font_size','focus_color','selected_color','color_past','color_present','color_future','hide_adult_assets','hide_adult_assets_kSQL','device_brand_denial_list_for_ui_components','asset_image_height','asset_presentation_ratio','present_X_most_watched_count','present_X_most_watched_period','linear_channels_batches_presentation_order',]

name

name: string = "Zapper (Widget)"

Const CATEGORY_MOCK

CATEGORY_MOCK: object

assetId

assetId: null = null

multilingualName

multilingualName: KalturaTranslationToken[] = [new KalturaTranslationToken({language: 'eng',value: 'Category Title ' + randString(2),}),]

Const META_VALUES_MOCK

META_VALUES_MOCK: object

NUMBER

NUMBER: KalturaDoubleValue = new KalturaDoubleValue({ value: 9999999 })

STRING

STRING: KalturaStringValue = new KalturaStringValue({ value: 'Meta string test Value' })

Const PRODUCT_PRICE_TYPES

PRODUCT_PRICE_TYPES: object

file

file: string = "file"

subscription

subscription: string = "subscription"

Const PurchaseStates

PurchaseStates: object

enterPin

enterPin: string = "ENTER_PIN"

error

error: string = "ERROR"

errorPin

errorPin: string = "ERROR_PIN"

noPaymentGateways

noPaymentGateways: string = "NO_PAYMENT_GATEWAYS"

ok

ok: string = "OK"

redirect

redirect: string = "Redirect"

Const metaTypeMap

metaTypeMap: object

NUMBER

NUMBER: KalturaDoubleValue = KalturaDoubleValue

STRING

STRING: KalturaStringValue = KalturaStringValue

Generated using TypeDoc