+ Table: Attribute for presentation mode +
Attribute	Description
EOM_OUTPUT_ATTRIBUTE_NORMAL	Can set normal if none(mirror mode) or normal attribute state
Cannot set normal if exclusive_share or exclusive attribute state
EOM_OUTPUT_ATTRIBUTE_EXCLUSIVE_SHARE	Can set exclusive_share if none(mirror mode), normal or exclusive_share attribute state
Cannot set exclusive_share if exclusive attribute set state
EOM_OUTPUT_ATTRIBUTE_EXCLUSIVE	Can set exclusive if none(mirror mode), normal or exclusive_share attribute state
Cannot set exclusive if exclusive attribute set state

+ Table: EOM Notify event +
Callback Type	Description	Function
eom_output_add_cb	Send event when the external output is connected	eom_set_output_added_cb, eom_unset_output_added_cb
eom_output_remove_cb	Send event when the external output is disconnected	eom_set_output_removed_cb, eom_unset_output_removed_cb
eom_mode_change_cb	Send event when the EOM output mode is changed	eom_set_mode_changed_cb, eom_unset_mode_changed_cb
eom_attribute_change_cb	Send event when the state of the EOM output attribute is changed	eom_set_attribute_changed_cb, eom_unset_attribute_changed_cb

+ Table: APIs for get external output device information +
Function	Description
eom_get_eom_output_ids	Gets the ID of external output devices
eom_get_output_type	Gets the connection type of external output (HDMI, Virtual, VGA, etc)
eom_get_output_mode	Gets the mode of external output (NONE, MIRROR, PRESENTATION)
eom_get_output_attribute	Gets the attribute information (NORMAL, EXCLUSIVE_SHARE, EXCLUSIVE)
eom_get_output_attribute_state	Gets the attribute state information (NONE, ACTIVE, INACTIVE, LOST)
eom_get_output_resolution	Gets the best resolution of external output device
eom_get_output_physical_size	Gets the physical size of external output device

+ Table: APIs for set information +
Function	Description
eom_set_output_attribute	Sets to presentation mode by setting attribute to EOM
eom_set_output_window	Sets window to the external output best resolution of external output device

EOM: Using the External Output Devices

This tutorial demonstrates how you can control external output devices by EOM API.

+ +

Warm-up

Become familiar with the EOM API basics by learning about:

+ +

Initializing EOM +
Initialize the EOM.
Getting Output ID +
Get output device's ID.
Setting Attribute +
Set the attribute.
Setting External Window +
Set external window.
Getting Status of External Output Device +
Get external output device's information

+ +

Show All
Hide All

+ +

+
+
Initializing EOM
+ Hide +
+
+
To use the EOM API, the following header file has to be included:
+
```
#include <eom.h>
```
+
And have to excute eom_init() function.
+
+

Getting Output ID

+ Hide +

Have to find output id to get information of output device and control external window.

Use the eom_get_eom_output_ids() function to find output id.

+int sample_get_output_id (const char *output_name)
+{
+   eom_output_id *output_ids = NULL;
+   eom_output_id output_id = 0;
+   eom_output_type_e output_type = EOM_OUTPUT_TYPE_UNKNOWN;
+   int id_cnt = 0;
+   int i;
+   
+   output_ids = eom_get_eom_output_ids(&id_cnt);
+   if (id_cnt == 0)
+   {
+      printf ("no external outuputs supported\n");
+      return 0;
+   }
+   
+   for (i = 0; i < id_cnt; i++)
+   {
+      eom_get_output_type(output_ids[i], &output_type);
+      if (!strncmp(output_name, "HDMI", 4))
+      {
+         if (output_type == EOM_OUTPUT_TYPE_HDMIA || output_type == EOM_OUTPUT_TYPE_HDMIB)
+         {
+            output_id = output_ids[i];
+            break;
+         }
+      }
+      else if (!strncmp(output_name, "Virtual", 7))
+      {
+         if (output_type == EOM_OUTPUT_TYPE_VIRTUAL)
+         {
+            output_id = output_ids[i];
+            break;
+         }
+      }
+   }
+   
+   if (output_ids)
+      free (output_ids);
+   return output_id;
+}
+

Setting Attribute

+ Hide +

To acquire the right of external output device, use the eom_set_output_attribute() function

If setting is successful, eom module will work presentation mode when external output device connected.

+int set_attribute()
+{
+   m_output_id output_id = 0;
+   int ret;
+   
+   output_id = sample_get_output_id("HDMI");
+   
+   ret = eom_set_output_attribute(output_id, EOM_OUTPUT_ATTRIBUTE_NORMAL);
+   if (ret != EOM_ERROR_NONE) 
+   {
+      //Attribute set fail. Cannot use external output device. Deinitializing.
+      eom_deinit ();
+      return -1;
+   }
+   return 0;
+}
+

There are three attributes for priority. It is recommended to use EOM_OUTPUT_ATTRIBUTE_NORMAL attribute to general application.

Other attributes are for special applications.

+EOM_OUTPUT_ATTRIBUTE_NORMAL
+EOM_OUTPUT_ATTRIBUTE_EXCLUSIVE_SHARE
+EOM_OUTPUT_ATTRIBUTE_EXCLUSIVE
+

If receive EOM_ERROR_NONE by eom_set_output_attribute() funtion, the application can use external output device.

+
+
Setting External Window
+ Hide +
+
+
Application can set window to external by using eom_set_output_window() function.
+
This API moves window to external output and resizes best resolution of external output device automatically.
+
Before excuting this function, application must receive success return from eom_set_output_attribute() function.
+
```
+int make_external_window()
+{
+   Evas_Object *window;
+   window = elm_win_add(NULL, "external_window", ELM_WIN_BASIC);
+   if (eom_set_output_window(output_id, window) == EOM_ERROR_NONE)
+      return 0;
+   else
+   {
+      evas_object_del (window);
+      return -1;
+   }
+}
+      
```
+
+

Getting Status of External Output Device

+ Hide +

Application can get external output device's information by using EOM API callback functions.

mode info

Mirror mode is default mode. If eom_set_output_attribute funtion excuted successfully, the external output will work to presentation mode.

+typedef enum
+{
+   EOM_OUTPUT_MODE_NONE,
+   EOM_OUTPUT_MODE_MIRROR,
+   EOM_OUTPUT_MODE_PRESENTATION,
+   EOM_OUTPUT_MODE_MAX,
+} eom_output_mode_e;
+

+ +

attribute state

If application set attribue, EOM send current attribute state to application.

ACTIVE means application can use external output. INACTIVE means cannot use cause of disconnection.

LOST means application cannot use external output cause of another application's attribute setting.

In case of LOST, application can't recevie attribute state anymore.

+typedef enum
+{
+   EOM_OUTPUT_ATTRIBUTE_STATE_NONE,
+   EOM_OUTPUT_ATTRIBUTE_STATE_ACTIVE,
+   EOM_OUTPUT_ATTRIBUTE_STATE_INACTIVE,
+   EOM_OUTPUT_ATTRIBUTE_STATE_LOST,
+   EOM_OUTPUT_ATTRIBUTE_STATE_MAX,
+} eom_output_attribute_state_e;
+

+ +

get information

Application can get some information by using below APIs.

int eom_get_output_type (eom_output_id output_id, eom_output_type_e *type):Get output device type(HDMI, VIRTUAL, VGA, etc).

int eom_get_output_mode (eom_output_id output_id, eom_output_mode_e *mode):Get mode (NONE, MIRROR, PRESETNTATION).

int eom_get_output_attribute (eom_output_id output_id, eom_output_attribute_e *attribute)Get information of attribute set(NORMAL, EXCLUSIVE_SHARE, EXCLUSIVE).

int eom_get_output_attribute_state (eom_output_id output_id, eom_output_attribute_state_e *state)Get attribute state(ACTIVE, INACTIVE, LOST).

int eom_get_output_resolution (eom_output_id output_id, int *width, int *height)Get best resolution of external output device.

int eom_get_output_physical_size (eom_output_id output_id, int *phy_width, int *phy_height)Get physical size of external output device.

+ +

callback

Application can get status changing event by setting callback functions.

+typedef void (*eom_output_added_cb)(eom_output_id output_id, void *user_data);
+typedef void (*eom_output_removed_cb)(eom_output_id output_id, void *user_data);
+typedef void (*eom_mode_changed_cb)(eom_output_id output_id, void *user_data);
+typedef void (*eom_attribute_changed_cb)(eom_output_id output_id, void *user_data);
+

By using below funtions, application can set and unset callback functions.

+int eom_set_output_added_cb (eom_output_added_cb callback, void *user_data);            //external output connection event
+int eom_unset_output_added_cb (eom_output_added_cb callback);                           //external output connection event
+int eom_set_output_removed_cb (eom_output_removed_cb callback, void *user_data);        //external output disconnection event
+int eom_unset_output_removed_cb (eom_output_removed_cb callback);                       //external output disconnection event
+int eom_set_mode_changed_cb (eom_mode_changed_cb callback, void *user_data);            //external output mode changing event
+int eom_unset_mode_changed_cb (eom_mode_changed_cb callback);                           //external output mode changing event
+int eom_set_attribute_changed_cb (eom_attribute_changed_cb callback, void *user_data);  //external output attribute state changing event
+int eom_unset_attribute_changed_cb (eom_attribute_changed_cb callback);                 //external output attribute state changing event
+

This is sample code about callback funtion.

+typedef struct
+{
+   Evas_Object *external_window;
+   int output_id;
+} SampleInfo;
+
+static void
+sample_notify_cb_output_add (eom_output_id output_id, void *user_data)
+{
+   SampleInfo *info = (SampleInfo*)user_data;
+   if (!info->external_window)
+   {
+      //make external window
+      make_external_window(info->external_window);
+   }
+}
+
+static void
+sample_notify_cb_output_remove (eom_output_id output_id, void *user_data)
+{
+   SampleInfo *info = (SampleInfo*)user_data;
+   if (!info->external_window)
+   {
+      evas_object_del (info->external_window)
+      info->external_window = NULL;
+   }
+}
+
+static void
+sample_notify_cb_attribute_changed (eom_output_id output_id, void *user_data)
+{
+   SampleInfo *info = (SampleInfo*)user_data;
+   eom_output_attribute_e attribute = EOM_OUTPUT_ATTRIBUTE_NONE;
+   eom_output_attribute_state_e state = EOM_OUTPUT_ATTRIBUTE_STATE_NONE;
+   
+   eom_get_output_attribute(output_id, &attribute);
+   eom_get_output_attribute_satate(output_id, &state);
+   
+   if (state == EOM_OUTPUT_ATTRIBUTE_STATE_ACTIVE)
+   {
+      //start displaying image to external output(info->external_window);
+   }
+   else if (state == EOM_OUTPUT_ATTRIBUTE_STATE_INACTIVE)
+   {
+      //stop displaying image
+      //destory external_window
+      if (info->external_window)
+      {
+         evas_object_del (info->external_window);
+         info->external_window = NULL;
+      }
+   }
+   else if (state == EOM_OUTPUT_ATTRIBUTE_STATE_LOST)
+   {
+      //stop displaying image
+      //destory external_window
+      if (info->external_window)
+      {
+         evas_object_del (info->external_window);
+         info->external_window = NULL;
+      }
+      //remove callback
+      eom_unset_output_added_cb(sample_notify_cb_output_add);
+      eom_unset_output_removed_cb(sample_notify_cb_output_remove);
+      eom_unset_attribute_changed_cb(sample_notify_cb_attribute_changed);
+      eom_deinit ();
+   }
+}
+
+int elm_main()
+{
+   SampleInfo *info;
+   eom_output_mode_e output_mode = EOM_OUTPUT_MODE_NONE;
+   int ret;
+   
+   info = calloc(sizeof(SampleInfo));
+   
+   eom_init ();
+   info->output_id = sample_get_output_id ("HDMI");
+   
+   ret = eom_set_output_attribute(info->hdmi_output_id, EOM_OUTPUT_ATTRIBUTE_NORMAL);
+   if (ret != EOM_ERROR_NONE)
+   {
+      //cannot use external output device
+      eom_deinit ();
+   }
+   else
+   {
+      eom_get_output_mode(info->output_id, &output_mode);
+      if (output_mode != EOM_OUTPUT_MODE_NONE)
+      {
+         //make external window
+         make_external_window(info->external_window);
+      }
+      
+      //add callback
+      eom_set_output_added_cb(sample_notify_cb_output_add, info);
+      eom_set_output_removed_cb(sample_notify_cb_output_remove, info);
+      eom_set_attribute_changed_cb(sample_notify_cb_attribute_changed, info);
+   }
+   
+   elm_run();
+   
+   //remove callback
+   eom_unset_output_added_cb(sample_notify_cb_output_add);
+   eom_unset_output_removed_cb(sample_notify_cb_output_remove);
+   eom_unset_attribute_changed_cb(sample_notify_cb_attribute_changed);
+   eom_deinit ();
+   elm_shutdown();
+   return 0;
+}
+

+ + + + +

External Output Manager (EOM)

Mode

Attribute for Presentation Mode

Notify to application

Get Information of External Output Device

Set to External Output Device

EOM: Using the External Output Devices

Warm-up

Initializing EOM

Getting Output ID

Setting Attribute

Setting External Window

Getting Status of External Output Device

mode info

attribute state

get information

callback