community.getSession
Allows you to retrieve the information concerning a session that has been attached to your website. To know more about how to attach a session, please consult user.attachSession.
Signature:
XmlRpcStruct community.getSession(XmlRpcStruct parameters, int sessionId)
Call:
URL: https://xmlrpc.renderfarm.fi/community.getSession
Method: POST only
Protocol: OAuth v1.0 over XmlRpc formalism, using HMAC-SHA1 for signing the requests
Transport: HTTPS
Handler name: community
Parameters:
Expected parameters are as defined in the protocol:
- XmlRpcStruct parameters: an associative array with all the authentication parameters
- int sessionId: the id of the session that an user has previously attached to your website
Exceptions:
The list of possible exceptions are presented here :
| Code | Reason |
| 100 | Missing parameters |
| 101 | Invalid parameters |
| 103 | Privileges insufficient |
| 104 | Invalid signature |
| 300 | Session doesn't exist |
| 301 | Session not attached yet |
| 400 | Consumer key invalid |
Returns:
An associative array with the information regarding the session.
| Attribute name | Meaning |
| id | The id of the session |
| title | The title of the session |
| startFrame | The start frame |
| endFrame | The end frame |
| xResolution | The width |
| yResolution | The height |
| frameRate | The number of frames per second (fps) |
| partsPerFrame | The number of parts per frame |
| thumbnails | Structure containing the collection of thumbnails [id => url] |
| streamURL | Url to access the streming file |
| cpuTimeRendered | The time in seconds the animation has been rendered |
| inputLicense | The input license. Structure containing [name, url] |
| outputLicense | The output license. Structure containing [name, url] |
| timestamps | Structure containing the collection of timestamps (if available) [register, submit, test_begin, test_end, accept, preprocessing_begin, preprocessing_end, render_begin, render_end, postprocessing_begin, postprocessing_end] |
| attachments | Structure containing the collection of attachment files[ idAttachmentFile => [ url, path, size, description ] ] |
| partsTotal | Number of parts to render |
| framesRendered | Number of frames to render |
| partsRendered | Number of parts already rendered |
| cpuRendered | |
| state | State of the session. Can go from accept to cancel, accept to active, active to cancel. Value can be "sumit", "accept", "active", "cancelled" or "rejected". |
| blendFiles | The blend files sent. Structure containing the collection of blend files. [idBlendFile => [url, size, md5]] |
Sample response:
<?xml version="1.0" encoding="utf-16"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>timestamps</name>
<value>
<struct>
<!—Other values presents can be (depending of the status of the task)
<name>accept</name>
<name>preprocessing_begin</name>
<name>preprocessing_end</name>
<name>render_begin</name>
<name>render_end</name>
<name>postprocessing_begin</name>
<name>postprocessing_end</name>
<name>encode_begin</name>
<name>encode_end</name>
-->
<member>
<name>register</name>
<value>
<i4>1270544373</i4>
</value>
</member>
<member>
<name>submit</name>
<value>
<i4>1270544374</i4>
</value>
</member>
<member>
<name>test_end</name>
<value>
<i4>1270544384</i4>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>endFrame</name>
<value>
<i4>250</i4>
</value>
</member>
<member>
<name>cpuRendered</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>cpuTimeRendered</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<name>partsTotal</name>
<value>
<i4>250</i4>
</value>
</member>
<member>
<name>yResolution</name>
<value>
<i4>1080</i4>
</value>
</member>
<member>
<name>userid</name>
<value>
<i4>881</i4>
</value>
</member>
(...)
<member>
<name>partsRendered</name>
<value>
<i4>0</i4>
</value>
</member>
<member>
<!-- None in this case -->
<name>attachments</name>
<value>
</struct>
</value>
</member>
<member>
<name>partsPerFrame</name>
<value>
<i4>1</i4>
</value>
</member>
<member>
<name>inputLicence</name>
<value>
<struct>
<member>
<name>name</name>
<value>
<string>CC by-nc-sa</string>
</value>
</member>
<member>
<name>url</name>
<value>
<string>http://creativecommons.org/licenses/by-nc-sa/3.0/</string>
</value>
</member>
</struct>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>