External Screen API

Connection State & General Functions

Example Result JavaScript API Calls Used
Connection State kp_ExternalScreen_requestStateOfConnection
returns kp_ExternalScreen_connectionStateDidChange
kp_ExternalScreen_connectToScreen
returns kp_ExternalScreen_connectionStateDidChange
kp_ExternalScreen_disconnectFromScreen
returns kp_ExternalScreen_connectionStateDidChange
Screen Properties kp_ExternalScreen_requestProperties
returns custom callback
Width:   Height:
kp_ExternalScreen_setScreenMode
returns custom callback
Mode:
kp_ExternalScreen_setOverscanCompensationMode
returns custom callback

HTML & Document Display

Example Result JavaScript API Calls Used
Background Color kp_ExternalScreen_getBrowserBgColor
returns custom callback
R,G,B color:
kp_ExternalScreen_setBrowserBgColor
returns custom callback
Page URL or filepath:
kp_ExternalScreen_openDocument
returns custom callback
Script:
kp_ExternalScreen_doJScript
no callback available
PDF URL or filepath:
kp_ExternalScreen_openDocument
returns custom callback
kp_ExternalScreen_requestNumberOfPdfPages
returns custom callback
kp_ExternalScreen_requestNumberOfCurrentPdfPage
returns custom callback
Page number:
kp_ExternalScreen_showPdfPage
returns custom callback
Image URL or filepath:
kp_ExternalScreen_showImage
returns custom callback
Content Mode (0 = ScaleToFill, 1 = ScaleAspectFit, 2 = ScaleAspectFill, 3 = NoScaleCenter, 4 = NoScaleTopCenter, 5 = NoScaleBottomCenter, 6 = NoScaleCenterLeft, 7 = NoScaleCenterRight, 8 = NoScaleTopLeft, 9 = NoScaleTopRight, 10 = NoScaleBottomLeft, 11 = NoScaleBottomRight):
kp_ExternalScreen_showImage
returns custom callback

Video Playback

Example Result JavaScript API Calls Used
Video Options kp_ExternalScreen_getPlayVideoParams
returns custom callback
Fade duration:
Background:
kp_ExternalScreen_setPlayVideoParams
returns custom callback
Video Playback State returned after any change in playback state through
kp_ExternalScreen_videoPlaybackStateDidChange
kp_ExternalScreen_getCurrentVideoPlaybackState
returns custom callback
Video URL or filepath:
Repeat {0 = no, 1 = yes}:
kp_ExternalScreen_playVideo
returns kp_ExternalScreen_videoPlaybackStateDidChange
kp_ExternalScreen_stopVideo
returns kp_ExternalScreen_videoPlaybackStateDidChange
kp_ExternalScreen_stopVideoWithFading
returns kp_ExternalScreen_videoPlaybackStateDidChange
kp_ExternalScreen_pauseVideo
returns kp_ExternalScreen_videoPlaybackStateDidChange
kp_ExternalScreen_resumeVideo
returns kp_ExternalScreen_videoPlaybackStateDidChange
Timestamp(seconds):
kp_ExternalScreen_changeCurrentTimeOfVideo
returns kp_ExternalScreen_videoPlaybackStateDidChange

Audio Playback


Example Result JavaScript API Calls Used
Audio Playback State returned after any change in playback state through
kp_AudioPlayer_playbackDidChange
or kp_AudioPlayer_playingDidFailWithError
Audio URL or filepath:
Timestamp (seconds):
Volume {between 0 = silent & 1 = max}:
Repeat {0 = no, 1 = yes}:
kp_AudioPlayer_play
returns kp_AudioPlayer_playbackDidChange
or kp_AudioPlayer_playingDidFailWithError
kp_AudioPlayer_stop
returns kp_AudioPlayer_playbackDidChange
kp_AudioPlayer_pause
returns kp_AudioPlayer_playbackDidChange
kp_AudioPlayer_resume
returns kp_AudioPlayer_playbackDidChange
Volume {between 0 = silent & 1 = max}:
kp_AudioPlayer_changeVolume
returns kp_AudioPlayer_playbackDidChange
Timestamp (seconds):
kp_AudioPlayer_changeCurrentTime
returns kp_AudioPlayer_playbackDidChange