API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.setLooopPlayerConfig

Set looop player type and configuration variables.
Category: looop functions
Subcategory: looop player setup
Description: Set looop player type and configuration variables.

Parameters

Only mandatory parameters must be present for an API call on this function. Parameters marked as a list can occur multiple times in both SOAP and HTTP-RPC style requests.
Name Type Mandatory is List Description
looopID uuid required ID of the looop to load meta data for
name string internal looop player name
playerConfig map looop player configuration. For possible values, take a look at the available playerConfig Parameters

Return Values

The presence of return values depend on the meaning of the API function and status of the requested object. For example, the description value of a looop will not be returned, if it has not been set.
Name Type is List Description
name string internal looop player name. Empty string, if no web player configured.
playerConfig map looop player configuration. Empty map, if no web player configured.

Errors / Exceptions

Error Code Name
2001 imagelooop.InvalidApiKeyException
2005 imagelooop.InternalErrorException
2002 imagelooop.InvalidParameterNameException
3004 imagelooop.PermissionDeniedException
3000 imagelooop.PrimaryObjectNotFoundException
 

playerConfig parameters

parameter name possible values
textColor A hexadecimal string in the notation '0x000000', depicting a valid 24-bit RGB value, that is used for display of image titles.
textDisplay A boolean value, expressed withe either '1' (true) or '0' (false), indicating if text is to be displayed along to the images in this slideshow.
width Integer value, given in pixels, depicting the width of the display area.
height Integer value, given in pixels, depicting the height of the display area.
skinType Comma-delimited string of integers, standing for the various available skins known from the imageloop homepage.
Currently available values:
skinType skin
0
No skin
1,31,33,83,33
Old tv
2,40,36,42,39
Football
3,46,49,47,49
Friends
4,73,8,69,10
Holiday
5,25,9,29,13
Classic
6,24,24,23,25
Hip Hop
7,23,25,32,27
Hawaii
8,16,21,16,22
Smilies
9,35,38,30,39
Rock
10,21,24,97,23
Party
11,12,36,13,38
Film
12,42,47,43,47
Wood
13,31,9,60,35
MP3
14,35,21,38,19
Make-up
15,24,23,51,33
Hearts
skinType skin
17,19,19,19,57
LCD
18,52,49,54,59
Music
19,48,19,50,49
Music 2
20,38,48,44,60
Mobile
23,66,16,67,17
iPhone
24,16,50,18,15
Four Music
26,32,32,32,28
Border
27,46,53,53,45
Light
28,35,36,27,31
Matrix
30,31,31,30,28
Marmor
31,30,26,28,30
Rose
32,40,34,35,47
Night
33,35,41,36,45
Border2
34,43,43,47,42
Germany
35,42,42,46,47
Turkey
36,41,40,40,40
Italy
skinType skin
37,50,50,48,51
Spain
38,44,44,45,45
France
39,45,45,46,46
England
40,54,54,53,53
Stamp
41,45,45,45,49
Industry
52,36,47,35,54
Freaks
53,39,53,38,53
Barbie
54,50,43,30,40
Flowers
55,31,35,24,24
Sunshine
101,49,47,50,52
American Football
103,47,51,52
Icehockey
104,49,47,51,52
X-Mas
105,49,47,51,52
Halloween
106,49,47,51,52
Carnival
201,34,29,47,23
Bunny 2
202,28,52,57,34
Bunny 3
skinType skin
203,35,28,46,30
Flower 2
204,36,39,35,46
Flower 3
205,37,31,43,38
Flower 4
206,31,24,49,33
Flower Metallic
207,55,56,52,52
Balls
208,36,47,35,54
Balls Metallic
209,59,63,49,44
Leopard
210,54,43,56,60
Smart
transitionType Integer value, standing for the various available transitions as known from the imageloop homepage.
Currently available values:
transitionType transition
-1
Random
0
Slider
10
Fading
11
Pixels
12
Collage
13
Show
transitionType transition
14
Gallery
15
Spin
16
Stars
17
Film
18
Cinema
19
Blinds
transitionType transition
21
Rotate
22
Bounce
22
Show up
themeColor A hexadecimal string in the notation '0x000000', depicting a valid 24-bit RGB value, that is used for display of themes that are used within the slideshow.
playerBgOpacity Integer value from 0 - 100, describing the opacity of the player background. (0 = transparent / 100 = opaque).
bgColor A hexadecimal string in the notation '0x000000', depicting a valid 24-bit RGB value, that is used for display of the slideshow's background.
textSize Either "small", "medium" or "large". Default is "medium".
rendition A string value having one of the values, that can be obtained via the API-Method 'imagelooop.getAvailableRenditions'.
This value decides the source quality of the images shown in the slideshow.
playerBgColor A hexadecimal string in the notation '0x000000', depicting a valid 24-bit RGB value, that is used for the background of the player's menu.
themeType Integer value, standing for the various available themes as known from the imageloop homepage.
Currently available values:
themeType theme
0
No theme
1
Stars
2
Hearts
3
Bubbles
5
Matrix
themeType theme
6
Dollar
7
Snow
8
Fireworks
9
Flowers
10
Sparkle

API Call examples

HTTP-RPC

Request:
The line breaks and white spaces are for better reading only. All request parameters can be passed in the HTTP POST request body instead of a HTTP GET parameter in a URL. Valid HTTP POST content types are multipart/form-data for file uploads and application/x-www-form-urlencoded for usual HTML forms.

http://www.imageloop.com/httprpc/?apiKey=YOUR-API-KEY
    &f=imagelooop.setLooopPlayerConfig
    &h=yourwebsite.com  - or -  &accessToken=application-access-token
    &looopID=uuiduuid-uuid-uuid-uuid-uuiduuiduuid
    &name=string-value (optional)
    &playerConfig= (optional)



Sample response

Sample Response to illustrate what's returned (XML schema) :
The line breaks and white spaces are for better reading only.

<imag:Response xmlns:imag="http://www.imageloop.com/imagelooop-api-xsd/">
   <response name="name">
      <value>string-value</value>
   </response>
   <response name="playerConfig">
      <value></value>
   </response>
</imag:Response>
If the function call resulted in an error, no response element but an error element is returned in the above XML. See list of possible errors/exception for the function described on this page.
<imag:Response xmlns:imag="http://www.imageloop.com/imagelooop-api-xsd/">
   <error>
      <errorCode>error-code</errorCode>
      <errorType>error-name</errorType>
      <message>optional error message</message>
   </error>
</imag:Response>

SOAP

General overview including SOAP and XML schema types is available here. See http://www.imageloop.com/soap/api/api.wsdl for WSDL definition. http://www.imageloop.com/soap/api/api.xsd for XSD definition.