.TH "LIBMTP_mtpdevice_struct" 3 "Version 1.1.21" "libmtp" \" -*- nroff -*- .ad l .nh .SH NAME libmtp \- .SH SYNOPSIS .br .PP .PP \fC#include \fP .SS "Data Fields" .in +1c .ti -1c .RI "uint8_t \fBobject_bitsize\fP" .br .ti -1c .RI "void * \fBparams\fP" .br .ti -1c .RI "void * \fBusbinfo\fP" .br .ti -1c .RI "\fBLIBMTP_devicestorage_t\fP * \fBstorage\fP" .br .ti -1c .RI "\fBLIBMTP_error_t\fP * \fBerrorstack\fP" .br .ti -1c .RI "uint8_t \fBmaximum_battery_level\fP" .br .ti -1c .RI "uint32_t \fBdefault_music_folder\fP" .br .ti -1c .RI "uint32_t \fBdefault_playlist_folder\fP" .br .ti -1c .RI "uint32_t \fBdefault_picture_folder\fP" .br .ti -1c .RI "uint32_t \fBdefault_video_folder\fP" .br .ti -1c .RI "uint32_t \fBdefault_organizer_folder\fP" .br .ti -1c .RI "uint32_t \fBdefault_zencast_folder\fP" .br .ti -1c .RI "uint32_t \fBdefault_album_folder\fP" .br .ti -1c .RI "uint32_t \fBdefault_text_folder\fP" .br .ti -1c .RI "void * \fBcd\fP" .br .ti -1c .RI "\fBLIBMTP_device_extension_t\fP * \fBextensions\fP" .br .ti -1c .RI "int \fBcached\fP" .br .ti -1c .RI "\fBLIBMTP_mtpdevice_t\fP * \fBnext\fP" .br .in -1c .SH "Detailed Description" .PP Main MTP device object struct .PP \fBExamples\fP .in +1c \fBdelfile\&.c\fP, \fBdetect\&.c\fP, \fBfiles\&.c\fP, \fBfolders\&.c\fP, \fBgetfile\&.c\fP, \fBgetplaylist\&.c\fP, \fBnewfolder\&.c\fP, \fBplaylists\&.c\fP, \fBsendfile\&.c\fP, \fBsendtr\&.c\fP, \fBtracks\&.c\fP, and \fBtrexist\&.c\fP\&. .SH "Field Documentation" .PP .SS "int LIBMTP_mtpdevice_struct::cached" Whether the device uses caching, only used internally .PP Referenced by \fBLIBMTP_Get_Children()\fP, \fBLIBMTP_Get_Filemetadata()\fP, \fBLIBMTP_Get_Files_And_Folders()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "void* LIBMTP_mtpdevice_struct::cd" Per device iconv() converters, only used internally .SS "uint32_t LIBMTP_mtpdevice_struct::default_album_folder" Default Album folder .PP Referenced by \fBLIBMTP_Create_New_Album()\fP, \fBLIBMTP_Dump_Device_Info()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "uint32_t LIBMTP_mtpdevice_struct::default_music_folder" Default music folder .PP Referenced by \fBLIBMTP_Create_New_Album()\fP, \fBLIBMTP_Create_New_Playlist()\fP, \fBLIBMTP_Dump_Device_Info()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "uint32_t LIBMTP_mtpdevice_struct::default_organizer_folder" Default organizer folder .PP Referenced by \fBLIBMTP_Dump_Device_Info()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "uint32_t LIBMTP_mtpdevice_struct::default_picture_folder" Default picture folder .PP Referenced by \fBLIBMTP_Dump_Device_Info()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "uint32_t LIBMTP_mtpdevice_struct::default_playlist_folder" Default playlist folder .PP Referenced by \fBLIBMTP_Create_New_Playlist()\fP, \fBLIBMTP_Dump_Device_Info()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "uint32_t LIBMTP_mtpdevice_struct::default_text_folder" Default Text folder .PP Referenced by \fBLIBMTP_Dump_Device_Info()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "uint32_t LIBMTP_mtpdevice_struct::default_video_folder" Default video folder .PP Referenced by \fBLIBMTP_Dump_Device_Info()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "uint32_t LIBMTP_mtpdevice_struct::default_zencast_folder" Default ZENcast folder (only Creative devices\&.\&.\&.) .PP Referenced by \fBLIBMTP_Dump_Device_Info()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "\fBLIBMTP_error_t\fP* LIBMTP_mtpdevice_struct::errorstack" The error stack\&. This shall be handled using the error getting and clearing functions, not by dereferencing this list\&. .PP Referenced by \fBLIBMTP_Clear_Errorstack()\fP, \fBLIBMTP_Dump_Errorstack()\fP, \fBLIBMTP_Get_Errorstack()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "\fBLIBMTP_device_extension_t\fP* LIBMTP_mtpdevice_struct::extensions" Extension list .PP Referenced by \fBLIBMTP_Dump_Device_Info()\fP, \fBLIBMTP_Open_Raw_Device_Uncached()\fP, and \fBLIBMTP_Release_Device()\fP\&. .SS "uint8_t LIBMTP_mtpdevice_struct::maximum_battery_level" The maximum battery level for this device .PP Referenced by \fBLIBMTP_Get_Batterylevel()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "\fBLIBMTP_mtpdevice_t\fP* LIBMTP_mtpdevice_struct::next" Pointer to next device in linked list; NULL if this is the last device .PP Referenced by \fBLIBMTP_Number_Devices_In_List()\fP, and \fBLIBMTP_Release_Device_List()\fP\&. .SS "uint8_t LIBMTP_mtpdevice_struct::object_bitsize" Object bitsize, typically 32 or 64\&. .PP Referenced by \fBLIBMTP_Dump_Device_Info()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "void* LIBMTP_mtpdevice_struct::params" Parameters for this device, must be cast into \fC\fP(PTPParams*) before internal use\&. .PP Referenced by \fBLIBMTP_Check_Capability()\fP, \fBLIBMTP_Copy_Object()\fP, \fBLIBMTP_Create_Folder()\fP, \fBLIBMTP_Custom_Operation()\fP, \fBLIBMTP_Delete_Object()\fP, \fBLIBMTP_Dump_Device_Info()\fP, \fBLIBMTP_Format_Storage()\fP, \fBLIBMTP_Get_Album()\fP, \fBLIBMTP_Get_Album_List_For_Storage()\fP, \fBLIBMTP_Get_Allowed_Property_Values()\fP, \fBLIBMTP_Get_Batterylevel()\fP, \fBLIBMTP_Get_Children()\fP, \fBLIBMTP_Get_Device_By_SerialNumber()\fP, \fBLIBMTP_Get_Deviceversion()\fP, \fBLIBMTP_Get_File_To_File_Descriptor()\fP, \fBLIBMTP_Get_File_To_Handler()\fP, \fBLIBMTP_Get_Filelisting_With_Callback()\fP, \fBLIBMTP_Get_Filemetadata()\fP, \fBLIBMTP_Get_Files_And_Folders()\fP, \fBLIBMTP_Get_Folder_List_For_Storage()\fP, \fBLIBMTP_Get_Friendlyname()\fP, \fBLIBMTP_Get_Manufacturername()\fP, \fBLIBMTP_Get_Modelname()\fP, \fBLIBMTP_Get_Playlist()\fP, \fBLIBMTP_Get_Playlist_List()\fP, \fBLIBMTP_Get_Representative_Sample()\fP, \fBLIBMTP_Get_Representative_Sample_Format()\fP, \fBLIBMTP_Get_Serialnumber()\fP, \fBLIBMTP_Get_Storage()\fP, \fBLIBMTP_Get_Supported_Filetypes()\fP, \fBLIBMTP_Get_Syncpartner()\fP, \fBLIBMTP_Get_Thumbnail()\fP, \fBLIBMTP_Get_Tracklisting_With_Callback_For_Storage()\fP, \fBLIBMTP_Get_Trackmetadata()\fP, \fBLIBMTP_Is_Property_Supported()\fP, \fBLIBMTP_Move_Object()\fP, \fBLIBMTP_Open_Raw_Device_Uncached()\fP, \fBLIBMTP_Read_Event()\fP, \fBLIBMTP_Read_Event_Async()\fP, \fBLIBMTP_Release_Device()\fP, \fBLIBMTP_Reset_Device()\fP, \fBLIBMTP_Send_File_From_File_Descriptor()\fP, \fBLIBMTP_Send_File_From_Handler()\fP, \fBLIBMTP_Send_Representative_Sample()\fP, \fBLIBMTP_Send_Track_From_File_Descriptor()\fP, \fBLIBMTP_Send_Track_From_Handler()\fP, \fBLIBMTP_Set_Friendlyname()\fP, \fBLIBMTP_Set_Syncpartner()\fP, \fBLIBMTP_Track_Exists()\fP, \fBLIBMTP_Update_Track_Metadata()\fP, \fButf16_to_utf8()\fP, and \fButf8_to_utf16()\fP\&. .SS "\fBLIBMTP_devicestorage_t\fP* LIBMTP_mtpdevice_struct::storage" The storage for this device, do not use strings in here without copying them first, and beware that this list may be rebuilt at any time\&. .PP \fBSee also\fP .RS 4 \fBLIBMTP_Get_Storage()\fP .RE .PP .PP \fBExamples\fP .in +1c \fBdetect\&.c\fP, \fBfiles\&.c\fP, \fBfolders\&.c\fP, \fBsendtr\&.c\fP, and \fBtracks\&.c\fP\&. .PP Referenced by \fBLIBMTP_Dump_Device_Info()\fP, \fBLIBMTP_Get_Storage()\fP, and \fBLIBMTP_Open_Raw_Device_Uncached()\fP\&. .SS "void* LIBMTP_mtpdevice_struct::usbinfo" USB device for this device, must be cast into \fC\fP(PTP_USB*) before internal use\&. .PP Referenced by \fBLIBMTP_Create_Folder()\fP, \fBLIBMTP_Create_New_Playlist()\fP, \fBLIBMTP_Dump_Device_Info()\fP, \fBLIBMTP_Get_Batterylevel()\fP, \fBLIBMTP_Get_File_To_File_Descriptor()\fP, \fBLIBMTP_Get_File_To_Handler()\fP, \fBLIBMTP_Get_Playlist()\fP, \fBLIBMTP_Get_Playlist_List()\fP, \fBLIBMTP_Get_Supported_Filetypes()\fP, \fBLIBMTP_Get_Tracklisting_With_Callback_For_Storage()\fP, \fBLIBMTP_Get_Trackmetadata()\fP, \fBLIBMTP_Open_Raw_Device_Uncached()\fP, \fBLIBMTP_Release_Device()\fP, \fBLIBMTP_Send_File_From_File_Descriptor()\fP, \fBLIBMTP_Send_File_From_Handler()\fP, \fBLIBMTP_Send_Representative_Sample()\fP, \fBLIBMTP_Send_Track_From_File_Descriptor()\fP, \fBLIBMTP_Send_Track_From_Handler()\fP, \fBLIBMTP_Update_Playlist()\fP, and \fBLIBMTP_Update_Track_Metadata()\fP\&. .SH "Author" .PP Generated automatically by Doxygen for libmtp from the source code\&.