Tizen Native API
5.5
|
The External Output Manager provides APIs for external outputs.
#include <eom.h>
The External Output Manager (EOM) is for managing external outputs. User can get the information of external outputs and control them via eom API.
Features :
Functions | |
int | eom_init (void) |
Initializes External Output Manager (EOM). | |
void | eom_deinit (void) |
Finalizes External Output Manager (EOM). | |
int | eom_set_output_added_cb (eom_output_added_cb callback, void *user_data) |
Registers a callback function to get output connection notification from External Output Manager (EOM) module. | |
int | eom_unset_output_added_cb (eom_output_added_cb callback) |
Unregisters the callback function. | |
int | eom_set_output_removed_cb (eom_output_removed_cb callback, void *user_data) |
Registers a callback function to get output disconnection notification from External Output Manager (EOM) module. | |
int | eom_unset_output_removed_cb (eom_output_removed_cb callback) |
Unregisters the callback function. | |
int | eom_set_mode_changed_cb (eom_mode_changed_cb callback, void *user_data) |
Registers a callback function to get output mode changing notification from External Output Manager (EOM) module. | |
int | eom_unset_mode_changed_cb (eom_mode_changed_cb callback) |
Unregisters the callback function. | |
int | eom_set_attribute_changed_cb (eom_attribute_changed_cb callback, void *user_data) |
Registers a callback function to get output attribute changing notification from External Output Manager (EOM) module. | |
int | eom_unset_attribute_changed_cb (eom_attribute_changed_cb callback) |
Unregisters the callback function. | |
eom_output_id * | eom_get_eom_output_ids (int *count) |
Gets the IDs and count of external output. | |
int | eom_get_output_type (eom_output_id output_id, eom_output_type_e *type) |
Gets type of external output. | |
int | eom_get_output_mode (eom_output_id output_id, eom_output_mode_e *mode) |
Gets mode of external output. | |
int | eom_get_output_attribute (eom_output_id output_id, eom_output_attribute_e *attribute) |
Gets attribute of external output. | |
int | eom_get_output_attribute_state (eom_output_id output_id, eom_output_attribute_state_e *state) |
Gets attribute state of external output. | |
int | eom_get_output_resolution (eom_output_id output_id, int *width, int *height) |
Gets resolution of external output. | |
int | eom_get_output_physical_size (eom_output_id output_id, int *phy_width, int *phy_height) |
Gets physical width/height (millimeters) of external output. | |
int | eom_set_output_attribute (eom_output_id output_id, eom_output_attribute_e attr) |
Sets the attribute of the external output ID. | |
int | eom_set_output_window (eom_output_id output_id, Evas_Object *win) |
Sets window to the external output best resolution of external output device. | |
Typedefs | |
typedef unsigned int | eom_output_id |
Definition for external output ID. | |
typedef void(* | eom_output_added_cb )(eom_output_id output_id, void *user_data) |
Called when External Output Manager (EOM) module sends output connection notification. | |
typedef void(* | eom_output_removed_cb )(eom_output_id output_id, void *user_data) |
Called when External Output Manager (EOM) module sends output disconnection notification. | |
typedef void(* | eom_mode_changed_cb )(eom_output_id output_id, void *user_data) |
Called when External Output Manager (EOM) module sends output mode changing notification. | |
typedef void(* | eom_attribute_changed_cb )(eom_output_id output_id, void *user_data) |
Called when External Output Manager (EOM) module sends output attribute changing notification. |
typedef void(* eom_attribute_changed_cb)(eom_output_id output_id, void *user_data) |
Called when External Output Manager (EOM) module sends output attribute changing notification.
[in] | output_id | The output id which is connected output |
[in] | user_data | The pointer of user data which is passed to eom_attribute_changed_cb() function |
typedef void(* eom_mode_changed_cb)(eom_output_id output_id, void *user_data) |
Called when External Output Manager (EOM) module sends output mode changing notification.
[in] | output_id | The output id which is connected output |
[in] | user_data | The pointer of user data which is passed to eom_mode_changed_cb() function |
typedef void(* eom_output_added_cb)(eom_output_id output_id, void *user_data) |
Called when External Output Manager (EOM) module sends output connection notification.
[in] | output_id | The output id which is connected output |
[in] | user_data | The pointer of user data which is passed to eom_output_added_cb() function |
typedef unsigned int eom_output_id |
Definition for external output ID.
typedef void(* eom_output_removed_cb)(eom_output_id output_id, void *user_data) |
Called when External Output Manager (EOM) module sends output disconnection notification.
[in] | output_id | The output id which is connected output |
[in] | user_data | The pointer of user data which is passed to eom_output_removed_cb() function |
enum eom_error_e |
Enumeration of External Output Manager (EOM) error type.
Enumeration of External Output Manager (EOM) attributes.
Enumeration of External Output Manager (EOM) attribute state.
enum eom_output_mode_e |
enum eom_output_type_e |
Enumeration of external output type.
void eom_deinit | ( | void | ) |
Finalizes External Output Manager (EOM).
User should call this function after using EOM to release all resources of EOM.
eom_output_id* eom_get_eom_output_ids | ( | int * | count | ) |
Gets the IDs and count of external output.
This function returns the IDs of external output which are available to connect to target device, and the count of them also. User can get the id of external output. which user want to watch.
[out] | count | The count of the eom_output_id supported by system |
The | pointer of eom_output_id |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
EOM_ERROR_OUT_OF_MEMORY | Memory allocation failure |
int eom_get_output_attribute | ( | eom_output_id | output_id, |
eom_output_attribute_e * | attribute | ||
) |
Gets attribute of external output.
[in] | output_id | The id of external output device |
[out] | attribute | The attribute of external output instance |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
EOM_ERROR_NO_SUCH_DEVICE | Invalid external output instance |
int eom_get_output_attribute_state | ( | eom_output_id | output_id, |
eom_output_attribute_state_e * | state | ||
) |
Gets attribute state of external output.
[in] | output_id | The id of external output device |
[out] | state | The attribute state of external output instance |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
EOM_ERROR_NO_SUCH_DEVICE | Invalid external output instance |
int eom_get_output_mode | ( | eom_output_id | output_id, |
eom_output_mode_e * | mode | ||
) |
Gets mode of external output.
[in] | output_id | The id of external output device |
[out] | mode | The mode of external output instance |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
EOM_ERROR_NO_SUCH_DEVICE | Invalid external output instance |
int eom_get_output_physical_size | ( | eom_output_id | output_id, |
int * | phy_width, | ||
int * | phy_height | ||
) |
Gets physical width/height (millimeters) of external output.
[in] | output_id | The id of external output device |
[out] | phy_width | The physical mm width of external output instance |
[out] | phy_height | The physical mm height of external output instance |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
EOM_ERROR_NO_SUCH_DEVICE | Invalid external output instance |
int eom_get_output_resolution | ( | eom_output_id | output_id, |
int * | width, | ||
int * | height | ||
) |
Gets resolution of external output.
[in] | output_id | The id of external output device |
[out] | width | The width of external output instance |
[out] | height | The height of external output instance |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
EOM_ERROR_NO_SUCH_DEVICE | Invalid external output instance |
int eom_get_output_type | ( | eom_output_id | output_id, |
eom_output_type_e * | type | ||
) |
Gets type of external output.
[in] | output_id | The id of external output device |
[out] | type | The type of external output instance |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
int eom_init | ( | void | ) |
Initializes External Output Manager (EOM).
User should call this function previously for using EOM.
EOM_ERROR_NONE | Successful |
EOM_ERROR_CONNECTION_FAILURE | The EOM connection failure |
int eom_set_attribute_changed_cb | ( | eom_attribute_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function to get output attribute changing notification from External Output Manager (EOM) module.
[in] | callback | The function pointer of eom_attribute_changed_cb() callback function |
[in] | user_data | The pointer of user data which is passed to eom_attribute_changed_cb() function |
EOM_ERROR_NONE | Successful |
EOM_ERROR_OUT_OF_MEMORY | Memory allocation failure |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
int eom_set_mode_changed_cb | ( | eom_mode_changed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function to get output mode changing notification from External Output Manager (EOM) module.
[in] | callback | The function pointer of eom_mode_changed_cb() callback function |
[in] | user_data | The pointer of user data which is passed to eom_mode_changed_cb() function |
EOM_ERROR_NONE | Successful |
EOM_ERROR_OUT_OF_MEMORY | Memory allocation failure |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
int eom_set_output_added_cb | ( | eom_output_added_cb | callback, |
void * | user_data | ||
) |
Registers a callback function to get output connection notification from External Output Manager (EOM) module.
[in] | callback | The function pointer of eom_output_added_cb() callback function |
[in] | user_data | The pointer of user data which is passed to eom_output_added_cb() function |
EOM_ERROR_NONE | Successful |
EOM_ERROR_OUT_OF_MEMORY | Memory allocation failure |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
int eom_set_output_attribute | ( | eom_output_id | output_id, |
eom_output_attribute_e | attr | ||
) |
Sets the attribute of the external output ID.
The application can set the External Output Manager (EOM) attribute to the external output ID. The EOM module manages the windows to display on external output and control the policy of external output. The application can recognize the attribute state and manage the resources when the application receives several notification callback from EOM module.
[in] | output_id | The id of external output device |
[in] | attr | The attribute of the external output |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
EOM_ERROR_NO_SUCH_DEVICE | Invalid external output instance |
EOM_ERROR_MESSAGE_SENDING_FAILURE | Communication failure with EOM module |
EOM_ERROR_MESSAGE_OPERATION_FAILURE | Operation failure |
int eom_set_output_removed_cb | ( | eom_output_removed_cb | callback, |
void * | user_data | ||
) |
Registers a callback function to get output disconnection notification from External Output Manager (EOM) module.
[in] | callback | The function pointer of eom_output_removed_cb() callback function |
[in] | user_data | The pointer of user data which is passed to eom_output_removed_cb() function |
EOM_ERROR_NONE | Successful |
EOM_ERROR_OUT_OF_MEMORY | Memory allocation failure |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
int eom_set_output_window | ( | eom_output_id | output_id, |
Evas_Object * | win | ||
) |
Sets window to the external output best resolution of external output device.
[in] | output_id | The id of external output device |
[in] | win | The pointer of evas object |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
EOM_ERROR_NO_SUCH_DEVICE | Invalid external output instance |
EOM_ERROR_MESSAGE_SENDING_FAILURE | Communication failure with EOM module |
EOM_ERROR_MESSAGE_OPERATION_FAILURE | Operation failure |
int eom_unset_attribute_changed_cb | ( | eom_attribute_changed_cb | callback | ) |
Unregisters the callback function.
[in] | callback | The function pointer of eom_attribute_changed_cb() callback function |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
int eom_unset_mode_changed_cb | ( | eom_mode_changed_cb | callback | ) |
Unregisters the callback function.
[in] | callback | The function pointer of eom_mode_changed_cb() callback function |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
int eom_unset_output_added_cb | ( | eom_output_added_cb | callback | ) |
Unregisters the callback function.
[in] | callback | The function pointer of eom_output_added_cb() callback function |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |
int eom_unset_output_removed_cb | ( | eom_output_removed_cb | callback | ) |
Unregisters the callback function.
[in] | callback | The function pointer of eom_output_removed_cb() callback function |
EOM_ERROR_NONE | Successful |
EOM_ERROR_INVALID_PARAMETER | Invalid parameter |