TheCoreElements XML-RPC API 1.0
Thecoreelements_flash_api

EraseStore

Erase loaded

Returns
integer result value

Example Usage:

[root@dev-5 API.html]# xmlrpc localhost:10000 TheCoreElementsFlash.EraseStore
Result:
Integer: 0
result TheCoreElementsFlash EraseStore ()
 

GetImage

Get currently loaded

Returns
string value

Example Usage:

[root@dev-5 API.html]# xmlrpc localhost:10000 TheCoreElementsFlash.GetImage
Result:
String: 'empty.png'
result TheCoreElementsFlash GetImage ()
 

LoadImage

Load image

Returns
integer result value

Example Usage:

[root@dev-5 app_xmlrpc]# xmlrpc localhost:10000 TheCoreElementsFlash.LoadImage s/"m1_logo_1080i50.swf"
Result:
.
Integer: 0
result TheCoreElementsFlash LoadImage ()
 

QueryFiles

Get list of files available for download

Returns
struct that contains array of files

Example Usage:

[root@dev-5 app_xmlrpc]# xmlrpc localhost:10000 TheCoreElementsFlash.QueryFiles
Result:
Struct of 2 members:
Key: String: 'result'
Value: Integer: 0
Key: String: 'list'
Value: Array of 9 items:
Index 0 String: 'empty.png'
Index 1 String: 'm1_logo_1080i50.swf'
Index 2 String: 'demo02_whois_req.swf'
Index 3 String: 'demo01_debug_api.swf'
Index 4 String: 'test1.swf'
Index 5 String: 'm1_title.swf'
Index 6 String: 'm1_logo_1080i50_BIG.swf'
Index 7 String: 'test8_1-2_v2.swf'
Index 8 String: 'Untitled.png'
result TheCoreElementsFlash QueryFiles ()
 

RenderBox

Render text box

Parameters
[in]box_idtext box to render or 255 to render all
Returns
integer result value

Example Usage:

[root@dev-5 app_xmlrpc]# xmlrpc localhost:10000 TheCoreElementsFlash.RenderBox i/0
Result:
Integer: 0
result TheCoreElementsFlash RenderBox ()
 

RestartAnimation

Restart Animation

Returns
integer result value

Example Usage:

[root@dev-5 app_xmlrpc]# xmlrpc localhost:10000 TheCoreElementsFlash.RestartAnimation
Result:
Integer: 0
result TheCoreElementsFlash Restart ()
 

SelectAnimationFrame

Select Animation Frame

Parameters
[in]frame_no
Returns
integer result value

Example Usage:

[root@dev-5 app_xmlrpc]# xmlrpc localhost:10000 TheCoreElementsFlash.SelectAnimationFrame i/0
Result:
Integer: 0
result TheCoreElementsFlash SelectAnimationFrame ()
 

SetGlobalDatasource

Set Global Datasource

Parameters
[in]flagsinteger
[in]namestring
[in]textstring
Returns
integer result value

Example Usage:

[root@dev-5 app_xmlrpc]# xmlrpc localhost:10000 TheCoreElementsFlash.SetGlobalDatasource i/0 s/foo s/bar
Result:
Integer: 0
result TheCoreElementsFlash SetGlobalDatasource ()
 

RestartAnimation

Restart Animation

Returns
integer result value

Example Usage:

[root@dev-5 app_xmlrpc]# xmlrpc localhost:10000 TheCoreElementsFlash.StartAnimation
Result:
Integer: 0
result TheCoreElementsFlash Start ()
 

StopAnimation

Stop Animation

Parameters
[in]immediateinteger (0 = Complete cycle, then stop , 1 = Immediate stop)
Returns
integer result value

Example Usage:

[root@dev-5 app_xmlrpc]# xmlrpc localhost:10000 TheCoreElementsFlash.StopAnimation i/1
Result:
Integer: 0
result TheCoreElementsFlash StopAnimation ()
 

UpdateTextField

Update Text Field

Parameters
[in]fieldNuminteger
[in]textstring
[in]renderinteger
[in]appendinteger
Returns
integer result value

Example Usage:

[root@dev-5 app_xmlrpc]# xmlrpc localhost:10000 TheCoreElementsFlash.UpdateTextField i/0 s/HIHERE i/1 i/0
Result:
Integer: 0
result TheCoreElementsFlash UpdateTextField ()
 

Detailed Description