groundsdk 7.4.0 API/com.parrot.drone.groundsdk.device.peripheral.storage/UserStorage

UserStorage

interface UserStorage
Content copied to clipboard

User storage interface.

This is the common interface for user storage peripherals, which provides access to the drone physical storage state, file system information, as well as formatting and encryption operations.

See also

Types

Link copied to clipboard
enum FileSystemState
Content copied to clipboard
File system state of the user storage.
Link copied to clipboard
interface FormattingState
Content copied to clipboard
Progress state of the formatting process.
Link copied to clipboard
enum FormattingType
Content copied to clipboard
Type of formatting.
Link copied to clipboard
interface MediaInfo
Content copied to clipboard
Information about media.
Link copied to clipboard
enum PasswordUsage
Content copied to clipboard
Usage for decryption.
Link copied to clipboard
enum PhysicalState
Content copied to clipboard
Physical state of the user storage.
Link copied to clipboard
enum Type
Content copied to clipboard
Type of user storage.

Functions

Link copied to clipboard
abstract fun canFormat(): Boolean
Content copied to clipboard
Tells whether the media can be formatted.
Link copied to clipboard
abstract fun format(@NonNull type: UserStorage.FormattingType): Boolean
Content copied to clipboard
abstract fun format(@NonNull type: UserStorage.FormattingType, @NonNull name: String): Boolean
Content copied to clipboard
Requests a format of the media.
Link copied to clipboard
@Nullable
abstract fun formattingState(): UserStorage.FormattingState
Content copied to clipboard
Gets the progress state of the formatting process.
Link copied to clipboard
abstract fun formatWithEncryption(    @NonNull password: String,     @NonNull type: UserStorage.FormattingType,     @Nullable name: String): Boolean
Content copied to clipboard
Requests a format of the media with encryption.
Link copied to clipboard
abstract fun getAvailableSpace(): Long
Content copied to clipboard
Gets available free space on current media.
Link copied to clipboard
@NonNull
abstract fun getFileSystemState(): UserStorage.FileSystemState
Content copied to clipboard
Gets the current file system state of the user storage.
Link copied to clipboard
@Nullable
abstract fun getMediaInfo(): UserStorage.MediaInfo
Content copied to clipboard
Gets information on current media.
Link copied to clipboard
@NonNull
abstract fun getPhysicalState(): UserStorage.PhysicalState
Content copied to clipboard
Gets the current physical state of the user storage.
Link copied to clipboard
@Nullable
abstract fun getUuid(): String
Content copied to clipboard
Gets the UUID of user storage.
Link copied to clipboard
abstract fun hasCheckError(): Boolean
Content copied to clipboard
Tells whether media failed being checked without error.
Link copied to clipboard
abstract fun isEncrypted(): Boolean
Content copied to clipboard
Tells whether the media is encrypted.
Link copied to clipboard
abstract fun isEncryptionSupported(): Boolean
Content copied to clipboard
Tells whether the media can be encrypted.
Link copied to clipboard
abstract fun sendPassword(@NonNull password: String, @NonNull usage: UserStorage.PasswordUsage): Boolean
Content copied to clipboard
Sends a password in order to decrypt the media.
Link copied to clipboard
@NonNull
abstract fun supportedFormattingTypes(): EnumSet<UserStorage.FormattingType>
Content copied to clipboard
Retrieves the supported formatting types.

Inheritors

Link copied to clipboard
Link copied to clipboard