Welcome to Infantium’s SDK documentation!¶

Dependencies¶

This SDK requires the library LoopJ v1.4.3 to be included in the project for proper functioning. You can find it in the following link: LoopJ Library 1.4.3

Android Permissions¶

The present SDK requires the following Android Permissions in the App manifest:

• INTERNET
• ACCESS_NETWORK_STATE

Singleton Pattern¶

InfantiumSDK has been created using a Singleton pattern, so the only way to get an instance of the class is by calling the function: getInfantiumSDK(Context context). The SDK requires the Context of the Android Activity.

InfantiumSDK infantium = InfantiumSDK.getInfantiumSDK(this.getBaseContext());

The Handler¶

As most functions work asynchronously, an HttpHandler must be implemented. In order to simplify this task Infantium created a class called InfantiumAsyncResponseHandler that provides the methods that must be implemented by the Developers. Its methods are called after making a request to the API, such as creating a new player, getting logged or sending an e-book rawdata.

Here we can see an example of how to implement an InfantiumasyncResponseHandler:

InfantiumAsyncResponseHandler infantiumHandler = new InfantiumAsyncResponseHandler() {
               @Override
               public void onSuccessCloseGameplay(){
                       System.out.println("---Gameplay closed successfully---");
               }

               @Override
               public void onFailureCloseGameplay(String description){
                       System.out.println(description);
               }
};

In this example, if the user creates the Gameplay successfully, the SDK will call the onSuccessCloseGameplay(). If a problem comes up, it will call the onFailureCloseGameplay(String description). The description is a short descriptive message that explains where or why the problem has arised.

1. Configure the SDK¶

First of all, we have to configure the SDK with some data. This data will be, on one hand, the developer API credentials for contacting with Infantium (setDeveloperCredentials(String api_user, String api_key)). The other function we should call is the setDeviceInfo(w_dev, h_dev) function in order to set the current device pixels. Finally, if you want to receive feedback from the SDK, you will need to implement a Handler. This will be further explained in the Handler section. You can do that with the setDeveloperHandler(InfantiumAsyncResponseHandler handler) function.

// Configure the SDK
infantium.setDeveloperCredentials(api_user, api_key);
infantium.setDeviceInfo(w_dev, h_dev);
infantium.setDeveloperHandler(handler);

2. Set Game ContentApp UUID¶

The next step if to set the contentapp_uuid, which will identify the App against the server. To configure it the method setContentAppUUID(String contentapp_uuid) should be used.

// Set the App contentapp_uuid
infantium.setContentAppUUID(contentapp_uuid);

3. Create Gameplay:¶

When we have set the contentapp_uuid we can create a Gameplay with: createGameplay(String subcontent_uuid). The subcontent_uuid will be provided to you by Infantium, which will be a unique identifier for your activity.

// Create the Gameplay with the SubContent UUID
infantium.createGameplay(subcontent_uuid);

4. Rawdata Functions:¶

The GamePlay is created once every time the kid starts a game session. Now, for every activity played during that time, a RawData object is sent, which will contain the information we need to analyze. This contains, among other generic stats, the elements in the screen and the goals to achieve, and finally the actions the kid performs.

When the kid enters one of the activities of the game (i.e. starts playing the game), the RawData is filled in three phases:

1. Register the elements in the screen.

This is done adding the Elements in the screen (addElement(Element element)) and the Goals the kid has to complete to succeed in this game (addGoal(Goal goal)).

An example Element could be:

// Add an element for a dog
PaintedElement dog_element = new PaintedElement("dog_figure");
infantium.addElement(dog_element);

// A ball
PaintedElement ball_element = new PaintedElement("ball");
infantium.addElement(ball_element);

// Add a number element
NumberElement number_three = new NumberElement(3);
infantium.addElement(number_three);

// Add a text element
TextElement sentence_element = new TextElement("en-US",
    "This little puppy wants to play with the ball! Can you help him?");
infantium.addElement(sentence_element);

An example Goal could be:

// The Goal is to move the ball to the dog
Goal g = new Goal("drag_the_ball", "selection");
infantium.addGoal(g);

Please refer to the advanced guides for Elements and Goals for more detailed information.

2. Start the timers and register the actions of the kid.

When the kid starts interacting with the screen, we will call the startPlaying() method. This will trigger the timers inside the SDK. The SDK will automatically handle the timestamps when the kid taps the screen and the elements show up, which will allow us to get a lot of statistics about the child’s development, relieving the developer of that task.

For each time the kid interacts with the screen, this can be registered with the newBasicInteraction(String t, String object_type, String goal_type) method. In this method, the t equals to the type of the interaction, which can be “success”, “failure”, “none” or some others explained in the BasicInteraction section.

// Start the timers
infantium.startPlaying();

// Dragging the ball to the dog is the goal of the activity,
//  and thus it is represented a "success".
InfantiumResponse res = infantium.newBasicInteraction("success", "ball", "drag_the_ball");

// Another example, if the kid drags the "smartphone" element,
//  but was not the goal of this activity.
infantium.newBasicInteraction("error", "smartphone", "drag_the_ball");

5. Send Game Rawdata:¶

We finally call sendGameRawData() when we want to send the RawData. After sending the data, and the kid starts a new activity, the flow would go again to the 4th step! If the kid goes back to the main menu, proceed to step 6.

// Send the previously introduced data
infantium.sendGameRawData();

6. Close Gameplay¶

Last step but not least important: closeGameplay(). If the GamePlay is not closed, the SDK will not be able to create new ones.

7. Conclusions¶

And with this the full cycle for sending data is complete. The integration can be enriched with many more methods and variables, but we hope this gave you an insight of the process to integrate your app with Infantium!

Now you can refer to the Advanced Guides section for more info.

Docs version: 2.3
Last update: April 24, 2014

Dependencies¶

This SDK requires the library LoopJ v1.4.3 to be included in the project for proper functioning. You can find it in the following link: LoopJ Library 1.4.3

Android Permissions¶

The present SDK requires the following Android Permissions in the App manifest:

• INTERNET
• ACCESS_NETWORK_STATE

Singleton Pattern¶

InfantiumSDK has been created using a Singleton pattern, so the only way to get an instance of the class is by calling the function: getInfantiumSDK(Context context). The SDK requires the Context of the Android Activity.

InfantiumSDK infantium = InfantiumSDK.getInfantiumSDK(this.getBaseContext());

The Handler¶

As most functions work asynchronously, an HttpHandler must be implemented. In order to simplify this task Infantium created a class called InfantiumAsyncResponseHandler that provides the methods that must be implemented by the Developers. Its methods are called after making a request to the API, such as creating a new player, getting logged or sending an e-book rawdata.

Here we can see an example of how to implement an InfantiumasyncResponseHandler:

InfantiumAsyncResponseHandler infantiumHandler = new InfantiumAsyncResponseHandler() {
               @Override
               public void onSuccessCloseGameplay(){
                       System.out.println("---Gameplay closed successfully---");
               }

               @Override
               public void onFailureCloseGameplay(String description){
                       System.out.println(description);
               }
};

In this example, if the user creates the Gameplay successfully, the SDK will call the onSuccessCloseGameplay(). If a problem comes up, it will call the onFailureCloseGameplay(String description). The description is a short descriptive message that explains where or why the problem has arised.

1. Configure the SDK¶

First of all, we have to configure the SDK with some data. This data will be, on one hand, the developer API credentials for contacting with Infantium (setDeveloperCredentials(String api_user, String api_key)). The other function we should call is the setDeviceInfo(w_dev, h_dev) function in order to set the current device pixels. Finally, if you want to receive feedback from the SDK, you will need to implement a Handler. This will be further explained in the Handler section. You can do that with the setDeveloperHandler(InfantiumAsyncResponseHandler handler) function.

// Configure the SDK
infantium.setDeveloperCredentials(api_user, api_key);
infantium.setDeviceInfo(w_dev, h_dev);
infantium.setDeveloperHandler(handler);

2. Set EBook ContentApp UUID¶

The next step if to set the contentapp_uuid, which will identify the App against the server. To configure it the method setContentAppUUID(String contentapp_uuid) should be used.

// Set the App contentapp_uuid
infantium.setContentAppUUID(contentapp_uuid);

3. Set EBook Content UUID¶

The method setContentUUID(String content_uuid) will set the EBook content UUID, required before creating a new Gameplay.

// Set the Content's UUID
infantium.setContentUUID(content_uuid);

If the content is not correct, the error will appear when calling the sendEbookRawdata.

4. Create Gameplay:¶

When we have set the contentapp_uuid and the content_uuid we can create a Gameplay with: createGameplay().

// Create the Gameplay
infantium.createGameplay();

5. Rawdata Functions:¶

The GamePlay is created once every time the kid starts a reading session. Now, for every activity played or page turned during that time, a RawData object is sent, which will contain the information we need to analyze. This contains, among other generic stats, the elements in the screen and the goals to achieve, and finally the actions the kid performs.

When the kid enters one of the activities of the ebook (i.e. starts reading the ebook), the RawData is filled in three phases:

1. Register the elements in the screen.

This is done adding the Elements in the screen (addElement(Element element)) and the Goals the kid has to complete to succeed in this game (addGoal(Goal goal)).

An example Element could be:

// Add an element for a dog
PaintedElement dog_element = new PaintedElement("dog_figure");
infantium.addElement(dog_element);

// A ball
PaintedElement ball_element = new PaintedElement("ball");
infantium.addElement(ball_element);

// Add a number element
NumberElement number_three = new NumberElement(3);
infantium.addElement(number_three);

// Add a text element
TextElement sentence_element = new TextElement("en-US",
    "This little puppy wants to play with the ball! Can you help him?");
infantium.addElement(sentence_element);

An example Goal could be:

// The Goal is to move the ball to the dog
Goal g = new Goal("drag_the_ball", "selection");
infantium.addGoal(g);

Please refer to the advanced guides for Elements and Goals for more detailed information.

2. Start the timers and register the actions of the kid.

When the kid starts interacting with the screen, we will call the startPlaying() method. This will trigger the timers inside the SDK. The SDK will automatically handle the timestamps when the kid taps the screen and the elements show up, which will allow us to get a lot of statistics about the child’s development, relieving the developer of that task.

For each time the kid interacts with the screen, this can be registered with the newBasicInteraction(String t, String object_type, String goal_type) method. In this method, the t equals to the type of the interaction, which can be “success”, “failure”, “none” or some others explained in the BasicInteraction section.

// Dragging the ball to the dog is the goal of the activity,
//  and thus it is represented a "success".
InfantiumResponse res = infantium.newBasicInteraction("success", "ball", "drag_the_ball");

// Another example, if the kid drags the "smartphone" element,
//  but was not the goal of this activity.
infantium.newBasicInteraction("error", "smartphone", "drag_the_ball");

6. Send Ebook Rawdata:¶

We finally call sendEbookRawData(int numPage, boolean text, boolean readToMe) when we want to send the RawData. After sending the data, and the kid starts a new activity/page, the flow would go again to the 4th step! If the kid goes back to the main menu, proceed to step 6.

// Send the previously introduced data
infantium.sendEbookRawData(1, true, false);

We finally call this function when we want to send the rawdata.

7. Close Gameplay¶

Last step but not least important: closeGameplay(). If the GamePlay is not closed, the SDK will not be able to create new ones.

8. Conclusions¶

And with this the full cycle for sending data is complete. The integration can be enriched with many more methods and variables, but we hope this gave you an insight of the process to integrate your ebooks with Infantium!

Now you can refer to the Advanced Guides section for more info.

Docs version: 2.3
Last update: April 24, 2014

Generic Events¶

Generic events do not give much information, as they do not specify which kind of event the kid is seeing. Nevertheless, they are useful for us as they allow our analytic system to know if there is any kind of reward the kid is having after performing the different actions on the screen, and thus that is important data to take into account when analyzing the different interactions declared during play time.

Here is the example code:

// Add a simple generic event with its ID
Event ev = new Event("sun_starts_shining");
InfantiumResponse res = infantium.addEvent(ev);

Sound Events¶

When an event represents a sound being played at a specific time or after a specific action, this should be registered with the SoundEvent class. This event is very useful for us, as it may include the text read, the language of the text, the sound or song which may be sung, etc. We can know how many times a kid has been exposed to a previous concept before the current game, so we greatly encourage developers to register this kind of events!

In the previous example, every time the kid taps on one of the Elements on the screen, he can hear the name of the animal he is touching. In this example, one SoundEvent would be declared per Element on the screen, and it would be Triggered every time the kid taps on the picture (explained in the next subsection).

// Add a simple Sound Event
SoundEvent ev1 = new SoundEvent("lion_name_sound_basic");
InfantiumResponse res1 = infantium.addEvent(ev1);

// It is also recommended to add the text and type of Sound:
SoundEvent ev2 = new SoundEvent("lion_name_sound_w_text", "voice");
ev2.set_associated_text("Lion", "en-US");
InfantiumResponse res2 = infantium.addEvent(ev2);

// We allow also to reuse other text elements used before
// (for example instructions in the games)
TextElement help_text_element = new TextElement("help_text", "en-US",
        "MAKE A SHADOW PUPPET");
infantium.addElement(help_text_element);
SoundEvent ev3 = new SoundEvent("lion_name_sound_with_element", "voice",
        "help_text_element");
InfantiumResponse res3 = infantium.addEvent(ev3);

// Add a full Sound Event with the optional parameters
//  imprecise_sound_volume: the approximate sound level
//  duration: the milliseconds of duration of the sound
SoundEvent ev4 = new SoundEvent("full_lion_name_sound_w_text", "voice");
ev4.set_associated_text("Lion", "en-US");
ev4.set_imprecise_sound_volume(0.5);
ev4.set_duration(5000L);
InfantiumResponse res4 = infantium.addEvent(ev4);