class MediaTaskManager

sealed class MediaTaskManager

Declaration:

DJI.WindowsSDK

Description:

MediaTaskManager provides methods for MediaTask.

Class Members:

enum

MediaPhotoType

enum MediaPhotoType

enum MediaPhotoType

Declaration:

DJI.WindowsSDK

Description:

This flag indicate which photo type of this media file. Only valid when file type is JPEG, DNG See MediaFile .

Enum Members:

NORMAL	Sample photo file with default type.
HDR	Photo file taked by camera with High Dynamic Range(HDR) setting.
AEB	Photo file taked by camera with Automatic Exposure Bracketing(AEB) setting.
INTERVAL	Photo file taked by camera with time interval setting.
BURST	Photo file taked by camera with burst setting.
UNKNOWN	This enumerate use for system error, should not use by developer.

enum

MediaVideoType

enum MediaVideoType

enum MediaVideoType

Declaration:

DJI.WindowsSDK

Description:

This flag indicate which video type of this media file. Only valid when file type is MOV, MP4 See MediaFile .

Enum Members:

NORMAL	Sample video file with default type.
SLOW_MOTION	Video file taked by camera with slow motion setting.
FAST_MOTION	Video file taked by camera with fast motion setting.
TIME_LAPSE	Video file taked by camera with time lapse setting.
HDR	Video file taked by camera with High Dynamic Range(HDR) setting.
UNKNOWN	This enumerate use for system error, should not use by developer.

enum

MediaFileStarTag

enum MediaFileStarTag

enum MediaFileStarTag

Declaration:

DJI.WindowsSDK

Description:

This flag indicate whether this media file is tagged star/favorite/like. See MediaFile .

Enum Members:

NONE	This flag indicate this media file is not tagged star/favorite/like.
TAGGED	This flag indicate this media file is tagged star/favorite/like.
UNKNOWN	This enumerate use for system error, should not use by developer.

enum

MediaRequestType

enum MediaRequestType

enum MediaRequestType

Declaration:

DJI.WindowsSDK

Description:

This flag indicate type of file transfer request. See MediaFileDownloadRequest.

Enum Members:

ORIGIN	This flag indicate this request want to get origin file data.
THUMBNAIL	This flag indicate this request want to get thumbnail file data. Thumbnail is the smallest size picture of photo or video first frame.
SCREEN	This flag indicate this request want to get screen(preview) file data. Screen is the smaller size picture of photo or video first frame.
CLIP	This flag indicate this request want to get partial file data. Only valid when file is video.
STREAM	This flag indicate this request want to transfer with stream.
PANO	This flag indicate this request want to get origin panorama file data. Only valid when file is panorama.
PANOSCREENNAIL	This flag indicate this request want to get screen panorama file data. Only valid when file is panorama.
PANOTHUMBNAIL	This flag indicate this request want to get thumbnail panorama file data. Only valid when file is panorama.
UNKNOWN	This enumerate use for system error, should not use by developer.

enum

MediaFileListLocation

enum MediaFileListLocation

enum MediaFileListLocation

Declaration:

DJI.WindowsSDK

Description:

Where the media file locate, some device has multiple storage location.

Enum Members:

SD_CARD	The media file location at default SD Card.
INTERNAL_STORAGE	The media file location at Embedded Multi Media Card(EMMC).
EXTENDED_SD_CARD	The media file location at external SD Card.
UNKNOWN	This enumerate use for system error, should not use by developer.

struct

MediaFileListLocationMsg

struct MediaFileListLocationMsg

struct MediaFileListLocationMsg

Declaration:

DJI.WindowsSDK

Description:

Object for query stroage location.

Struct Members:

MediaFileListLocation location Enumerate for query stroage location. See MediaFileListLocation

enum

MediaTaskType

enum MediaTaskType

enum MediaTaskType

Declaration:

DJI.WindowsSDK

Description:

The media task type. using in MediaTaskRequest and MediaTaskResponse

Enum Members:

FILE_DATA	In `MediaTaskRequest` indicate transfer `MediaFileDownloadRequest` first. In `MediaTaskResponse` indicate this response from `MediaFileDownloadRequest`.
FILE_LIST	In `MediaTaskRequest` indicate transfer `MediaFileListRequest` first. In `MediaTaskResponse` indicate this response from `MediaFileListRequest`.
UNKNOWN	This enumerate use for system error, should not use by developer.

enum

MediaTaskDuplicate

enum MediaTaskDuplicate

enum MediaTaskDuplicate

Declaration:

DJI.WindowsSDK

Description:

The flag for control the effect to duplicate request waiting tasks when PushFront/PushBack and task finished

Enum Members:

NONE	When this task push in or successed, do nothing with other tasks.
ENQUEUE_WITH_CANCEL	When this task push in, cancel other tasks both executing and waiting.
DEQUEUE_WITH_COMPLETE	When this task successful complete, complete other tasks in waiting queue. It will make some task complete even not actually begin executing.
UNKNOWN	This enumerate use for system error, should not use by developer.

enum

MediaTaskDefer

enum MediaTaskDefer

enum MediaTaskDefer

Declaration:

DJI.WindowsSDK

Description:

The flag for control how to deal with this task, when DeferExecuteTask apply on it.

Enum Members:

BACK_TO_QUEUE	When DeferExecuteTask perform on this task, it will be save context and back to the front of waiting queue. The event you register on it will pause until it execute again, but not invoke any err code, so you will not receive the teardown event.
ABORT	When DeferExecuteTask perform on this task, it will be abort directly and invoke err code "kErrorMediaTaskAbort" and imediately receive the teardown event.
UNKNOWN	This enumerate use for system error, should not use by developer.

enum

MediaTaskPriority

enum MediaTaskPriority

enum MediaTaskPriority

Declaration:

DJI.WindowsSDK

Description:

The flag for control execute sequence. Final execute task will be decided by postion in waiting queue and priority. Manager will loop tasks from front to back to pick up the first highest priority tasks. If you want guarantee a task execute next, task should be pushfront with high priority.

Enum Members:

DEFAULT	Execute task with default priority, same mean as low.
MIDDLE	Execute task with middle priority.
HIGH	Execute task with high priority.
UNKNOWN	This enumerate use for system error, should not use by developer.

struct

MediaFile

struct MediaFile

struct MediaFile

Declaration:

DJI.WindowsSDK

Description:

MediaFile represent a file storage in SD-Card or EMMC.

Struct Members:

bool valid	This flag indicate whether the file is valid.
bool isManualGroupFile	This flag indicate whether the file is grouped by SDK. If flag is ture, you can read sub files in `subMediaFile`
int fileIndex	This indicates index of this file.
MediaFileType fileType	This indicates type of this file.
String fileName	This indicates name of this file.
Int64 fileSize	This indicates size of this file.
DateTime date	This indicates stroage date of this file.
MediaFileStarTag starTag	This indicates whether this file tagged star/favorite/like.
double duration	This indicates video duration of this file.
CameraOrientation orientation	This indicates video orientation of this file.
VideoFrameRate frameRate	This indicates video frame rate of this file.
VideoResolution resolution	This indicates video resolution of this file.
MediaVideoType videoType	This indicates video type of this file.
MediaPhotoType photoType	This indicates photo type of this file.
CameraPanoType panoType	This indicates panorama type of this file.
int videoSpeedRatio	This indicates video speed ratio of this file.
int panoCount	This indicates panorama include photo count of this file.
int guid	This indicates video global id of this file.
int fileGroupIndex	This indicates file group index of this file. File can be grouped by both camera and SDK. See `bool isManualGroupFile`
int subIndex	This indicates sub index of this file. Sub index will use in panorama file.
int segSubIndex	This indicates sub segment index of this file. Sub segment index will use for video cliped by storage system. Cause FAT32 system can only storage file less than 4GB, most 4K video will be separated by it.
int timeLapseInterval	This indicates time lapse shoot interval unit of this file. Each unit represent 100ms.
FileExifInfo EXIFInfo	This indicates Exchangeable image file format(EXIF) information of this file. See `FileExifInfo`.
PhotoRatio photoRatio	This indicates photo ratio of this file.

struct

MediaFileDownloadRequest

struct MediaFileDownloadRequest

struct MediaFileDownloadRequest

Declaration:

DJI.WindowsSDK

Description:

Request for download file data. It can be used in MediaTaskRequest

Struct Members:

int index	Download index of file, it can be obtained from media file. See `MediaFile`
int count	Download count represent how many files should be download from index. Mostly it should be 1 indicate only download index file itself. See `MediaFile`
Int64 offSet	Download offset represent download index file begin with which byte. Mostly it should be 0 indicate download from file begin. See `MediaFile`
int dataSize	Download data size represent how many bytes the index file should be download from offset. Mostly it should be -1 indicate download to file end. See `MediaFile`
MediaRequestType type	Download type of file. See `MediaRequestType`
int subIndex	Download sub index of file, it can be obtained from media file. Mostly it should be 0 indicate this file not contains sub file. See `MediaFile`
int segSubIndex	Download sub segment index of file, it can be obtained from media file. Mostly it should be 0 indicate this video not contains segment file. See `MediaFile`

struct

MediaFileListRequest

struct MediaFileListRequest

struct MediaFileListRequest

Declaration:

DJI.WindowsSDK

Description:

Request for download file list. It can be used in MediaTaskRequest

Struct Members:

int index	This indicates request files from which index. Only valid when `bool isAllList` set false.
int count	This indicates request files count. Only valid when `bool isAllList` set false.
MediaFileListLocation location	This indicates request files from which stroage. See `MediaFileListLocation`.
MediaRequestType subType	This indicates request files from which stroage. See `MediaFileListLocation`.
bool isAllList	This indicates request all files. Set ture will ignore `int index` and `int count`.

struct

MediaFileList

struct MediaFileList

struct MediaFileList

Declaration:

DJI.WindowsSDK

Description:

Response for download file list. See MediaFileListRequest.

Struct Members:

MediaFileListLocation location	This indicates where the files storage in.
bool hasInvalidFile	This indicates whether the files missed when transfer from hardware to SDK.

struct

MediaStarTagRequest

struct MediaStarTagRequest

struct MediaStarTagRequest

Declaration:

DJI.WindowsSDK

Description:

Request for taging file star/favorite/like in camera.

Struct Members:

MediaFileListLocation location	This indcates where the files locate.
MediaFileStarTag starTag	This indcates whether the files tag on or off.

struct

MediaDeletionRequest

struct MediaDeletionRequest

struct MediaDeletionRequest

Declaration:

DJI.WindowsSDK

Description:

Request for taging file star/favorite/like in camera.

Struct Members:

MediaFileListLocation location	This indcates where the files locate.
bool isDeleteAll	This indcates delete all files on storage.

struct

MediaBatchFileRequestResult

struct MediaBatchFileRequestResult

struct MediaBatchFileRequestResult

Declaration:

DJI.WindowsSDK

Description:

Response for taging file star/favorite/like or delete. See MediaStarTagRequest or MediaDeletionRequest

Struct Members:

bool allSucceeded

This indcates whether this action successed on every file.

struct

MediaTaskRequest

struct MediaTaskRequest

struct MediaTaskRequest

Declaration:

DJI.WindowsSDK

Description:

Request object of task. Use it to construct MediaTask

Struct Members:

MediaTaskType type	The flag control how to transfer request. See `MediaTaskType`
MediaTaskDuplicate duplicateType	The flag control how to deal with requests with duplicate information. See `MediaTaskDuplicate`
MediaTaskDefer deferType	The flag control how to apply defer action on this task. See `MediaTaskDefer`
MediaTaskPriority priority	The flag control execute sequence when add task in manager waiting queue. See `MediaTaskPriority`

struct

MediaTaskResponse

struct MediaTaskResponse

struct MediaTaskResponse

Declaration:

DJI.WindowsSDK

Description:

Response object of task execute event. All event decomposed from task response.

Struct Members:

MediaTaskType type	The flag indicate which type of request invoke this response. See `MediaTaskType`
MediaFileListRequest listReq	Response is invoked by this request. Only valid when type is `FILE_LIST` See `MediaFileListRequest`.
MediaFileDownloadRequest dataReq	Response is invoked by this request. Only valid when type is `FILE_DATA` See `MediaFileDownloadRequest`.
bool requestClear	Have all requests in this task already transfered.
int listLeft	How many `MediaFileListRequest` left in this task.
int dataLeft	How many `MediaFileDownloadRequest` left in this task.
MediaFileList fileList	File result from `MediaFileListRequest`. Only valid when type is `FILE_LIST` See `MediaFileList`.
Int64 bitSpeed	Speed result from `MediaFileDownloadRequest`. Only valid when type is `FILE_DATA`

struct

FileExifInfo

struct FileExifInfo

struct FileExifInfo

Declaration:

DJI.WindowsSDK

Description:

Exchangeable image file format(EXIF) information. Use in MediaFile.

Struct Members:

bool focalLength35mmFormatEnabled	Flag indicates having valid `int focalLength35mmFormat`.
bool lightSourceEnabled	Flag indicates having valid `int lightSource`.
bool meteringModeEnabled	Flag indicates having valid `int meteringMode`.
bool exposureCompensationEnabled	Flag indicates having valid `String exposureCompensationText`.
bool isoEnabled	Flag indicates having valid `int iso`.
bool exposureProgramEnabled	Flag indicates having valid `int exposureProgram`.
bool fNumberEnabled	Flag indicates having valid `String apertureText`.
bool exposureTimeEnabled	Flag indicates having valid `String shutterSpeedText`.
int exposureProgram	Int value of exposure program.
int iso	Int value of iso.
int meteringMode	Int value of metering mode.
int lightSource	Int value of light source.
int focalLength35mmFormat	Int value of focal length 35mm format.
String shutterSpeedText	Exposure time text with format like +3.5.
String apertureText	F number text with format like +3.5.
String exposureCompensationText	Exposure Compensation text with format like +3.5.

class

MediaTask

Construct

Methods

method

MediaTaskManager

method MediaTaskManager

MediaTaskManager(uint productId, uint cameraIndex)

Declaration:

DJI.WindowsSDK

Description:

Construct a task manager with MediaTaskRequest.

Input Parameters:

uint productId	Which product that manager should access. Mostly should be use 0.
uint cameraIndex	Which camera that manager should access. If hardware only have one camera, here should be use 0.

Field

property

Suspend

property Suspend

bool Suspend { get; set; }

Declaration:

DJI.WindowsSDK

Description:

Flag to control the waiting task queue. After executing task complete, manager will check this flag to decide should begin next task. Attention set this flag will not effect current executing task. If you want pause task completely(both queue and data transfer), You should set this flag "True" first and call "DeferEexecuteTask". See DeferExecuteTask.

Description:

ProductId passed by construct.

unknown

uint CameraIndex => cameraIndex

Declaration:

DJI.WindowsSDK

Description:

CameraIndex passed by construct.

Action

Methods

method

PushFront

method PushFront

void PushFront(MediaTask task)

Declaration:

DJI.WindowsSDK

Description:

Push a task to the front of the wait queue. This action will check task request parameter "duplicateType" to decide how to deal with the same infomation task. See MediaTaskRequest.

Input Parameters:

MediaTask task Task will action on. See MediaTask.

method

PushBack

method PushBack

void PushBack(MediaTask task)

Declaration:

DJI.WindowsSDK

Description:

Push a task to the back of the wait queue. This action will check task request parameter "duplicateType" to decide how to deal with the same infomation task. See MediaTaskRequest.

Input Parameters:

MediaTask task Task will action on. See MediaTask

method

DeferExecuteTask

method DeferExecuteTask

void DeferExecuteTask()

Declaration:

DJI.WindowsSDK

Description:

Discard or backward current executing task to wait queue. This action will check executing task request parameter "deferType" to decide how to deal with it.See MediaTaskRequest. If deferType is "BACK_TO_QUEUE" , this action will postpone executing task event invoke. Otherwise deferType is "ABORT", this action will complete current task with error code "kErrorMediaTaskAbort".

method

TrySync

method TrySync

async Task<SDKError> TrySync(MediaTask task)

Declaration:

DJI.WindowsSDK

Description:

Try to synchronize a task with duplicate request infomation. See MediaTaskRequest. If neither executing task nor waiting task have the duplicate request infomation, this action will return error code "kErrorMediaTaskSyncFailure". If this action successful attach to a eixst task, the parameter task's event will invoke simultaneously with eixst task.

Input Parameters:

MediaTask task Task will compare to those tasks already pushed. See MediaTask.

Return:

async Task<SDKError>

Action error code, 0 define as no error.

method

TaskCancel

method TaskCancel

async Task<SDKError>Cancel(MediaTask task)

Declaration:

DJI.WindowsSDK

Description:

Cancel task with duplicate request infomation, only effect executing and waiting tasks once in manager.

Input Parameters:

MediaTask task Task will compare to those tasks already pushed. See MediaTask.

Return:

async

Action error code, 0 define as no error.

method

TaskCancelAllTask

method TaskCancelAllTask

async Task<SDKError>CancelAllTask()

Declaration:

DJI.WindowsSDK

Description:

Cancel all task ever pushed in manager.

Return:

async

Action error code, 0 define as no error.

Windows SDK

class MediaTaskManager

Description:

Class Members:

enum MediaPhotoType

Description:

Enum Members:

enum MediaVideoType

Description:

Enum Members:

enum MediaFileStarTag

Description:

Enum Members:

enum MediaRequestType

Description:

Enum Members:

enum MediaFileListLocation

Description:

Enum Members:

struct MediaFileListLocationMsg

Description:

Struct Members:

enum MediaTaskType

Description:

Enum Members:

enum MediaTaskDuplicate

Description:

Enum Members:

enum MediaTaskDefer

Description:

Enum Members:

enum MediaTaskPriority

Description:

Enum Members:

struct MediaFile

Description:

Struct Members:

struct MediaFileDownloadRequest

Description:

Struct Members:

struct MediaFileListRequest

Description:

Struct Members:

struct MediaFileList

Description:

Struct Members:

struct MediaStarTagRequest

Description:

Struct Members:

struct MediaDeletionRequest

Description:

Struct Members:

struct MediaBatchFileRequestResult

Description:

Struct Members:

struct MediaTaskRequest

Description:

Struct Members:

struct MediaTaskResponse

Description:

Struct Members:

struct FileExifInfo

Description:

Struct Members:

Construct

method MediaTaskManager

Description:

Input Parameters:

Field

property Suspend

Description:

See Also:

unknown

Description:

unknown

Description:

Action

method PushFront

Description:

Input Parameters: