Module: mtp

mtp

mtp struct types

Source:

struct.js, line 1

Members

<inner> cached

Whether the device uses caching, only used internally

Source:

struct.js, line 173

<inner> cd

Per device iconv() converters, only used internally

Source:

struct.js, line 169

<inner> datatype

The datatype specifying which of the above is used. LIBMTP_datatype_t

Source:

struct.js, line 249

<inner> default_album_folder

Default Album folder

Source:

struct.js, line 165

<inner> default_music_folder

Default music folder

Source:

struct.js, line 153

<inner> default_organizer_folder

Default organizer folder

Source:

struct.js, line 161

<inner> default_picture_folder

Default picture folder

Source:

struct.js, line 157

<inner> default_playlist_folder

Default playlist folder

Source:

struct.js, line 155

<inner> default_text_folder

Default Text folder

Source:

struct.js, line 167

<inner> default_video_folder

Default video folder

Source:

struct.js, line 159

<inner> default_zencast_folder

Default ZENcast folder (only Creative devices...)

Source:

struct.js, line 163

<inner> errorstack

The error stack. This shall be handled using the error getting and clearing functions, not by dereferencing this list.

Source:

struct.js, line 149

<inner> extensions

Extension list

Source:

struct.js, line 171

<inner> is_range

Non zero for range, 0 for enum

Source:

struct.js, line 253

<inner> major

Major revision of extension

Source:

struct.js, line 106

<inner> maximum_battery_level

The maximum battery level for this device

Source:

struct.js, line 151

<inner> minor

Minor revision of extension

Source:

struct.js, line 110

<inner> name

Name of extension e.g. "foo.com"

Source:

struct.js, line 102

<inner> num_entries

Number of entries in the vals array

Source:

struct.js, line 244

<inner> object_bitsize

Object bitsize, typically 32 or 64.

Source:

struct.js, line 127

<inner> params

Parameters for this device, must be cast into \c (PTPParams*) before internal use.

Source:

struct.js, line 132

<inner> 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.

Source:

struct.js, line 144

See:

LIBMTP_Get_Storage()

<inner> usbinfo

USB device for this device, must be cast into \c (PTP_USB*) before internal use.

Source:

struct.js, line 137

Methods

<inner> LIBMTP_Clear_Errorstack() → {void}

LIBMTP_Clear_Errorstack

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 79

Returns:

Type: void

<inner> LIBMTP_Detect_Raw_Devices() → {int}

LIBMTP_Detect_Raw_Devices

Parameters:

Type	Description
LIBMTP_raw_device_structPtrPtr
intPtr

Source:

index.js, line 55

Returns:

Type: int

<inner> LIBMTP_Dump_Device_Info() → {void}

LIBMTP_Dump_Device_Info'

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 87

Returns:

Type: void

<inner> LIBMTP_Dump_Errorstack() → {void}

LIBMTP_Dump_Errorstack

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 71

Returns:

Type: void

<inner> LIBMTP_Get_Batterylevel() → {int}

LIBMTP_Get_Batterylevel

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
uint8Ptr
uint8Ptr

Source:

index.js, line 145

Returns:

Type: int

<inner> LIBMTP_Get_Device_Certificate() → {int}

LIBMTP_Get_Device_Certificate

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
stringPtr

Source:

index.js, line 182

Returns:

Type: int

<inner> LIBMTP_Get_Deviceversion() → {string}

LIBMTP_Get_Deviceversion

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 127

Returns:

Type: string

<inner> LIBMTP_Get_Filelisting_With_Callback() → {LIBMTP_file_structPtr}

LIBMTP_Get_Filelisting_With_Callback

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
LIBMTP_progressfunc_t
voidPtr

Source:

index.js, line 200

Returns:

Type: LIBMTP_file_structPtr

<inner> LIBMTP_Get_Filetype_Description() → {string}

LIBMTP_Get_Filetype_Description

Parameters:

Type	Description
int

Source:

index.js, line 163

Returns:

Type: string

<inner> LIBMTP_Get_Friendlyname() → {string}

LIBMTP_Get_Friendlyname

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 95

Returns:

Type: string

<inner> LIBMTP_Get_Manufacturername() → {string}

LIBMTP_Get_Manufacturername

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 103

Returns:

Type: string

<inner> LIBMTP_Get_Modelname() → {string}

LIBMTP_Get_Modelname

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 111

Returns:

Type: string

<inner> LIBMTP_Get_Secure_Time() → {int}

LIBMTP_Get_Secure_Time Crashes Samsung Galaxy S5.

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
stringPtr

Source:

index.js, line 173

Returns:

Type: int

<inner> LIBMTP_Get_Serialnumber() → {string}

LIBMTP_Get_Serialnumber

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 119

Returns:

Type: string

<inner> LIBMTP_Get_Supported_Filetypes() → {int}

LIBMTP_Get_Supported_Filetypes

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
uint16PtrPtr
uint16Ptr

Source:

index.js, line 155

Returns:

Type: int

<inner> LIBMTP_Get_Syncpartner() → {string}

LIBMTP_Get_Syncpartner

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 135

Returns:

Type: string

<inner> LIBMTP_Get_Track_To_File_Descriptor() → {int}

LIBMTP_Get_Track_To_File_Descriptor

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
uint32
int
LIBMTP_progressfunc_t
voidPtr

Source:

index.js, line 213

Returns:

Type: int

<inner> LIBMTP_Init() → {void}

LIBMTP_Init

Source:

index.js, line 38

Returns:

Type: void

<inner> LIBMTP_Open_Raw_Device() → {LIBMTP_mtpdevice_structPtr}

LIBMTP_Open_Raw_Device

Parameters:

Type	Description
LIBMTP_raw_device_structPtr

Source:

index.js, line 63

Returns:

Type: LIBMTP_mtpdevice_structPtr

<inner> LIBMTP_progressfunc_t(sent, total, data) → {int}

The callback type definition. Notice that a progress percentage ratio is easy to calculate by dividing sent by total.

Parameters:

Name	Type	Description
`sent`	uint64	the number of bytes sent so far
`total`	uint64	the total number of bytes to send
`data`	voidPtr	a user-defined dereferencable pointer

Source:

index.js, line 28

Returns:

if anything else than 0 is returned, the current transfer will be interrupted / cancelled.

Type: int

<inner> LIBMTP_Release_Device() → {void}

LIBMTP_Release_Device

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 190

Returns:

Type: void

<inner> LIBMTP_Set_Debug() → {void}

LIBMTP_Set_Debug

Parameters:

Type	Description
int

Source:

index.js, line 46

Returns:

Type: void

mtp

Media transfer protocol module for Node.js

Source:

index.js, line 1

Members

<inner> cached

Whether the device uses caching, only used internally

Source:

struct.js, line 173

<inner> cd

Per device iconv() converters, only used internally

Source:

struct.js, line 169

<inner> datatype

The datatype specifying which of the above is used. LIBMTP_datatype_t

Source:

struct.js, line 249

<inner> default_album_folder

Default Album folder

Source:

struct.js, line 165

<inner> default_music_folder

Default music folder

Source:

struct.js, line 153

<inner> default_organizer_folder

Default organizer folder

Source:

struct.js, line 161

<inner> default_picture_folder

Default picture folder

Source:

struct.js, line 157

<inner> default_playlist_folder

Default playlist folder

Source:

struct.js, line 155

<inner> default_text_folder

Default Text folder

Source:

struct.js, line 167

<inner> default_video_folder

Default video folder

Source:

struct.js, line 159

<inner> default_zencast_folder

Default ZENcast folder (only Creative devices...)

Source:

struct.js, line 163

<inner> errorstack

The error stack. This shall be handled using the error getting and clearing functions, not by dereferencing this list.

Source:

struct.js, line 149

<inner> extensions

Extension list

Source:

struct.js, line 171

<inner> is_range

Non zero for range, 0 for enum

Source:

struct.js, line 253

<inner> major

Major revision of extension

Source:

struct.js, line 106

<inner> maximum_battery_level

The maximum battery level for this device

Source:

struct.js, line 151

<inner> minor

Minor revision of extension

Source:

struct.js, line 110

<inner> name

Name of extension e.g. "foo.com"

Source:

struct.js, line 102

<inner> num_entries

Number of entries in the vals array

Source:

struct.js, line 244

<inner> object_bitsize

Object bitsize, typically 32 or 64.

Source:

struct.js, line 127

<inner> params

Parameters for this device, must be cast into \c (PTPParams*) before internal use.

Source:

struct.js, line 132

<inner> 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.

Source:

struct.js, line 144

See:

LIBMTP_Get_Storage()

<inner> usbinfo

USB device for this device, must be cast into \c (PTP_USB*) before internal use.

Source:

struct.js, line 137

Methods

<inner> LIBMTP_Clear_Errorstack() → {void}

LIBMTP_Clear_Errorstack

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 79

Returns:

Type: void

<inner> LIBMTP_Detect_Raw_Devices() → {int}

LIBMTP_Detect_Raw_Devices

Parameters:

Type	Description
LIBMTP_raw_device_structPtrPtr
intPtr

Source:

index.js, line 55

Returns:

Type: int

<inner> LIBMTP_Dump_Device_Info() → {void}

LIBMTP_Dump_Device_Info'

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 87

Returns:

Type: void

<inner> LIBMTP_Dump_Errorstack() → {void}

LIBMTP_Dump_Errorstack

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 71

Returns:

Type: void

<inner> LIBMTP_Get_Batterylevel() → {int}

LIBMTP_Get_Batterylevel

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
uint8Ptr
uint8Ptr

Source:

index.js, line 145

Returns:

Type: int

<inner> LIBMTP_Get_Device_Certificate() → {int}

LIBMTP_Get_Device_Certificate

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
stringPtr

Source:

index.js, line 182

Returns:

Type: int

<inner> LIBMTP_Get_Deviceversion() → {string}

LIBMTP_Get_Deviceversion

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 127

Returns:

Type: string

<inner> LIBMTP_Get_Filelisting_With_Callback() → {LIBMTP_file_structPtr}

LIBMTP_Get_Filelisting_With_Callback

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
LIBMTP_progressfunc_t
voidPtr

Source:

index.js, line 200

Returns:

Type: LIBMTP_file_structPtr

<inner> LIBMTP_Get_Filetype_Description() → {string}

LIBMTP_Get_Filetype_Description

Parameters:

Type	Description
int

Source:

index.js, line 163

Returns:

Type: string

<inner> LIBMTP_Get_Friendlyname() → {string}

LIBMTP_Get_Friendlyname

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 95

Returns:

Type: string

<inner> LIBMTP_Get_Manufacturername() → {string}

LIBMTP_Get_Manufacturername

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 103

Returns:

Type: string

<inner> LIBMTP_Get_Modelname() → {string}

LIBMTP_Get_Modelname

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 111

Returns:

Type: string

<inner> LIBMTP_Get_Secure_Time() → {int}

LIBMTP_Get_Secure_Time Crashes Samsung Galaxy S5.

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
stringPtr

Source:

index.js, line 173

Returns:

Type: int

<inner> LIBMTP_Get_Serialnumber() → {string}

LIBMTP_Get_Serialnumber

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 119

Returns:

Type: string

<inner> LIBMTP_Get_Supported_Filetypes() → {int}

LIBMTP_Get_Supported_Filetypes

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
uint16PtrPtr
uint16Ptr

Source:

index.js, line 155

Returns:

Type: int

<inner> LIBMTP_Get_Syncpartner() → {string}

LIBMTP_Get_Syncpartner

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 135

Returns:

Type: string

<inner> LIBMTP_Get_Track_To_File_Descriptor() → {int}

LIBMTP_Get_Track_To_File_Descriptor

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr
uint32
int
LIBMTP_progressfunc_t
voidPtr

Source:

index.js, line 213

Returns:

Type: int

<inner> LIBMTP_Init() → {void}

LIBMTP_Init

Source:

index.js, line 38

Returns:

Type: void

<inner> LIBMTP_Open_Raw_Device() → {LIBMTP_mtpdevice_structPtr}

LIBMTP_Open_Raw_Device

Parameters:

Type	Description
LIBMTP_raw_device_structPtr

Source:

index.js, line 63

Returns:

Type: LIBMTP_mtpdevice_structPtr

<inner> LIBMTP_progressfunc_t(sent, total, data) → {int}

The callback type definition. Notice that a progress percentage ratio is easy to calculate by dividing sent by total.

Parameters:

Name	Type	Description
`sent`	uint64	the number of bytes sent so far
`total`	uint64	the total number of bytes to send
`data`	voidPtr	a user-defined dereferencable pointer

Source:

index.js, line 28

Returns:

if anything else than 0 is returned, the current transfer will be interrupted / cancelled.

Type: int

<inner> LIBMTP_Release_Device() → {void}

LIBMTP_Release_Device

Parameters:

Type	Description
LIBMTP_mtpdevice_structPtr

Source:

index.js, line 190

Returns:

Type: void

<inner> LIBMTP_Set_Debug() → {void}

LIBMTP_Set_Debug

Parameters:

Type	Description
int

Source:

index.js, line 46

Returns:

Type: void