The MTP Manager API provides functions for gets the object information of certain file in MTP responder.

Required Header

#include <mtp.h>

Overview

The MTP Object Information api provides following functions :

Get object file type
Get object name
Get object size
and, more object information

Related Features

This API is related with the following features:

http://tizen.org/feature/network.mtp

It is recommended to design feature related codes in your application for reliability.

You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.

To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.

More details on featuring your application can be found from Feature Element.

Functions
int	mtp_objectinfo_get_file_name (mtp_device_h mtp_device, mtp_object_h object_handle, char **file_name)
	Gets the filename of the object information.
int	mtp_objectinfo_get_keywords (mtp_device_h mtp_device, mtp_object_h object_handle, char **keywords)
	Gets the keywords of the object information.
int	mtp_objectinfo_get_association_desc (mtp_device_h mtp_device, mtp_object_h object_handle, int *asso_desc)
	Gets the association desc of the object information.
int	mtp_objectinfo_get_association_type (mtp_device_h mtp_device, mtp_object_h object_handle, int *asso_type)
	Gets the association type of the object information.
int	mtp_objectinfo_get_size (mtp_device_h mtp_device, mtp_object_h object_handle, int *size)
	Gets the size of the object information.
int	mtp_objectinfo_get_parent_object_handle (mtp_device_h mtp_device, mtp_object_h object_handle, mtp_object_h *parent_object_handle)
	Gets the parent object handle of the object information.
int	mtp_objectinfo_get_storage (mtp_device_h mtp_device, mtp_object_h object_handle, mtp_storage_h *mtp_storage)
	Gets the mtp storage of the object information.
int	mtp_objectinfo_get_date_created (mtp_device_h mtp_device, mtp_object_h object_handle, int *date_created)
	Gets the object created time of the object information.
int	mtp_objectinfo_get_date_modified (mtp_device_h mtp_device, mtp_object_h object_handle, int *date_modified)
	Gets the object modified time of the object information.
int	mtp_objectinfo_get_file_type (mtp_device_h mtp_device, mtp_object_h object_handle, mtp_filetype_e *file_type)
	Gets the file type of the object information.
int	mtp_objectinfo_get_image_bit_depth (mtp_device_h mtp_device, mtp_object_h object_handle, int *depth)
	Gets the image bit depth of the object information.
int	mtp_objectinfo_get_image_pix_width (mtp_device_h mtp_device, mtp_object_h object_handle, int *width)
	Gets the image pixel width of the object information.
int	mtp_objectinfo_get_image_pix_height (mtp_device_h mtp_device, mtp_object_h object_handle, int *height)
	Gets the image pixel height of the object information.
int	mtp_objectinfo_get_thumbnail_size (mtp_device_h mtp_device, mtp_object_h object_handle, int *size)
	Gets the thumbnail size of the object information.
int	mtp_objectinfo_get_thumbnail_file_type (mtp_device_h mtp_device, mtp_object_h object_handle, mtp_filetype_e *file_type)
	Gets the thumbnail file type of the object information.
int	mtp_objectinfo_get_thumbnail_pix_height (mtp_device_h mtp_device, mtp_object_h object_handle, int *height)
	Gets the thumbnail pixel height of the object information.
int	mtp_objectinfo_get_thumbnail_pix_width (mtp_device_h mtp_device, mtp_object_h object_handle, int *width)
	Gets the thumbnail pixel width of the object information.

Function Documentation

int mtp_objectinfo_get_association_desc	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	asso_desc
	)

Gets the association desc of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	asso_desc	The association description of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_association_type	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	asso_type
	)

Gets the association type of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	asso_type	The association type of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_date_created	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	date_created
	)

Gets the object created time of the object information.

Since :: 3.0

Remarks:: When interpreted as an absolute time value,
date_created represents the number of seconds elapsed since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	date_created	The object created time of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_date_modified	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	date_modified
	)

Gets the object modified time of the object information.

Since :: 3.0

Remarks:: When interpreted as an absolute time value,
date_modified represents the number of seconds elapsed since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	date_modified	The object modified time of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_file_name	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		char **	file_name
	)

Gets the filename of the object information.

Since :: 3.0

Remarks:: The file_name should be freed using free().

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	file_name	The file name of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_file_type	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		mtp_filetype_e *	file_type
	)

Gets the file type of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	file_type	The file type of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_image_bit_depth	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	depth
	)

Gets the image bit depth of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	depth	The image bit depth of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_image_pix_height	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	height
	)

Gets the image pixel height of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	height	The image pixel height of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_image_pix_width	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	width
	)

Gets the image pixel width of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	width	The image pixel width of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_keywords	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		char **	keywords
	)

Gets the keywords of the object information.

Since :: 3.0

Remarks:: The keywords should be freed using free().; The keywords are separated by comma.

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	keywords	The keywords of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_parent_object_handle	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		mtp_object_h *	parent_object_handle
	)

Gets the parent object handle of the object information.

Since :: 3.0

Remarks:: The parent_object_handle should not be released.; The parent_object_handle can be used until the MTP service stops.; The parent_object_handle is managed by the platform when the MTP service stop.

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	parent_object_handle	The parent of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_size	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	size
	)

Gets the size of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	size	The size of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_storage	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		mtp_storage_h *	mtp_storage
	)

Gets the mtp storage of the object information.

Since :: 3.0

Remarks:: The mtp_storage should not be released.; The mtp_storage can be used until the MTP service stops.; The mtp_storage is managed by the platform when the MTP service stop.

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	mtp_storage	The MTP storage of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_thumbnail_file_type	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		mtp_filetype_e *	file_type
	)

Gets the thumbnail file type of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	file_type	The file type of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_thumbnail_pix_height	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	height
	)

Gets the thumbnail pixel height of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	height	The thumbnail pixel height of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_thumbnail_pix_width	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	width
	)

Gets the thumbnail pixel width of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	width	The thumbnail pixel width of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

int mtp_objectinfo_get_thumbnail_size	(	mtp_device_h	mtp_device,
		mtp_object_h	object_handle,
		int *	size
	)

Gets the thumbnail size of the object information.

Since :: 3.0

Parameters:

[in]	mtp_device	The MTP device
[in]	object_handle	The object handle
[out]	size	The thumbnail size of Object information

Returns:: 0 on success, otherwise a negative error value.

Return values:

MTP_ERROR_NONE	Successful
MTP_ERROR_NOT_SUPPORTED	MTP is not supported
MTP_ERROR_INVALID_PARAMETER	Invalid parameter
MTP_ERROR_NOT_INITIALIZED	MTP is not initialized
MTP_ERROR_NOT_ACTIVATED	MTP is not activated
MTP_ERROR_NOT_COMM_INITIALIZED	MTP communication is not initialized
MTP_ERROR_COMM_ERROR	MTP communication error
MTP_ERROR_CONTROLLER	MTP controller error
MTP_ERROR_OUT_OF_MEMORY	Out of memory
MTP_ERROR_NO_DEVICE	MTP have not any device
MTP_ERROR_PLUGIN_FAIL	Plugin failed

See also:: mtp_get_object_handles()

Required Header

Overview

Related Features

Functions

Function Documentation