Kmsapi

Use this module to enable the KMS Go application on your mobile device.

For more information about the KMS Go mobile app, see the articles about Kaltura MediaSpace Go (KMS Go).

Field

Description

enabled

Enable the Kmsapi module.

IOSAppId

The Apple Application ID that will be used when smart banners on iOS Safari will be displayed.

iOSBundleId

The Apple application id that will be used when smart banners on IOS Safari will be displayed.

AndroidAppId

The Android Application ID that will be used when smart banners on Android mobile browsers will be displayed.

deepLinkSubDomain

The iOS/Andorid branded application subdomain. Used for deep-linking

storeAppName

The name of the branded mobile application

appStoreAppId

(iOS) Your app's App Store ID, used to send users to the App Store when the app isn't installed

storeAppLogoUrl

The URL for the branded application logo. Image dimensions: 64x64 pixels. Keep empty to use default

homeCarouselModeUse Web home carousel configuration or configure it manually for mobile. 

Home_Playlists

Define the playlists for the native home screen. You can add and delete playlists using this field.

DELETE or +Add Home_Playlists

 

type

Select the type of playlist from the drop down menu.

name

Enter the playlist name that will be displayed.

channelId

(Channel Playlists only) Enter the custom channel id for Channel Playlists

playlistID

(Custom Playlists only) Enter the custom playlist id.

detailsView

(Custom Playlists only) When set to 'No', the default view of playlist (Thumbnail view) will be used.

playerAutoPlayOnLoad

When entry page loads, should the video begin playing automatically?

mobileSessionLifeTime

The length of a mobile KMS user session (in seconds). Note that every KMS SaaS version deployment will force a new session (on the appColorR  of the value input here).


appColorR

The R value for RGB that is used as the custom brand color of the application. Input a number between 0-255. Note: RGB.alpha fields cannot be partially filled out.

appColorG

The G value for RGB that is used as the custom brand color of the app. Input a number between 0-255. Note: RGB alpha fields cannot be partially filled out.

appColorB

The B value for RGB that is used as the custom brand color of the app. Input a number between 0-255.

Note: RGB alpha fields cannot be partially filled out.

splashImageUrl

Set an image URL for the KMS app splash screen. Use an image size of 192x131. The URL must be a secured URL (begin with https://).

downloadEnabled

Enable to allow downloading media for offline viewing.

downloadQuality

Chooses the rendition/flavor of the video to be available for users to download for offline playback. High will download the highest quality possible (in terms of dimensions and bitrate) and low the lowest.

smartBannerEnabled

Enable smart banner for Android and iOS applications

dontShowLoginInMyPage

Don't show login button in my page.

uploadEnabled

Enable displaying the upload functionality.

showMySubscriptionSection

Enable displaying the list of channels the user is subscribed to, on top of the home screen.

playlistContinuousPlay

Select whether the playlist entries should play automatically one after the other.

allowPushNotifications

Allow push notifications.

hideInspireMe

Selects whether to hide the inspire me section

hidePublisherName

Selects whether to hide the entry's publisher name

iosTermsOfUse

Add the terms of use that will be displayed to the user on IOS devices.
Note: For translation fill this field with 'terms_of_use_ios' and translate via PO file

androidTermsOfUse

Add the terms of use that will be displayed to the user on Android devices.
Note: For translation fill this field with 'terms_of_use_android' and translate via PO file

spotlightSearchEnabled

Enable spotlight Search from outside the application on IOS.

adTagUrl
Add the URL for the IMA (Interactive Media Ads) to enable DFP (DoubleClick for Publishers - showing ads on top of videos)
idleTimeout
Max allowed idle time before sessions timeout (in seconds). To disable idle timeout, enter 0.
disableIosBackgroundSnapshot
Disable the cache background snapshot in iOS.
shareUrlAsDeepLinksSelects whether the share URLs will be deep links.
deleteRecordedContentOnce enabled, content that is recorded using KMS Go will not be stored on the user's device after upload. 
In This Article
Was this article helpful?
Thank you for your feedback!