PKL_SetPoster()

Description

Set's the view port poster graphic. Only available for skins that have a view port, usually reserved for a video.

Usage

PKL_SetPoster(DataObject:Object) :Void

Parameters

DataObject:Object - An Object, or JSON containing the following values:

- player
- image

Example Code

 

If only one player exists on the page:

<script language="javascript">

PKL_SetPoster( { image: "poster.jpg" } );

</script>

 

Multiple players require including "player" to specify which player

<script language="javascript">

PKL_SetPoster( { player: "MyPlayer1", image: "poster.jpg" } );

</script>

Using an Object instead of JSON

<script language="javascript">

var MyData = new Object():
MyData.player = "MyPlayer1";
MyData.image  = "poster.jpg";
PKL_SetPoster(MyData);

</script>