DJI::OSDK::MopClient Class Reference

Class providing APIs & data structures for acting as a MOP client. More...

#include <dji_mop_client.hpp>

Inherits DJI::OSDK::MopPipelineManagerBase.

Public Member Functions

 MopClient (SlotType slot)
 
MopErrCode connect (PipelineID id, PipelineType type, MopPipeline *&p)
 Connect the target device by a pipelineid with properties of pipeline type. If success, a pipeline object will be created. More...
 
void connect (PipelineID id, PipelineType type, void(*cb)(MopErrCode errCode, MopPipeline *p, void *userData), void *userData)
 Connect the target device by a pipelineid with properties of pipeline type. If success, a pipeline object will be created. More...
 
MopErrCode disconnect (PipelineID id)
 Disonnect the target device by a pipelineid. More...
 
void disconnect (PipelineID id, void(*cb)(MopErrCode errCode, void *userData), void *userData)
 Disonnect the target device by a pipelineid. More...
 

Detailed Description

Class providing APIs & data structures for acting as a MOP client.

Member Function Documentation

◆ connect() [1/2]

MopErrCode DJI::OSDK::MopClient::connect ( PipelineID  id,
PipelineType  type,
MopPipeline *&  p 
)

Connect the target device by a pipelineid with properties of pipeline type. If success, a pipeline object will be created.

Supported Platforms : M300
Note
This is a blocking api
Parameters
idThe pipeline id which to be connected, ref to DJI::OSDK::MOP::PipelineID
typeThe pipeline type. It can be set to be RELIABLE or UBRELIABLE ref to the enum DJI::OSDK::MOP::PipelineType
pThe pointer of pipeline. If success, it will be pointed to be the target pipeline object.
Returns
ref to the enum DJI::OSDK::MOP::MopErrCode

◆ connect() [2/2]

void DJI::OSDK::MopClient::connect ( PipelineID  id,
PipelineType  type,
void(*)(MopErrCode errCode, MopPipeline *p, void *userData)  cb,
void *  userData 
)

Connect the target device by a pipelineid with properties of pipeline type. If success, a pipeline object will be created.

Supported Platforms : M300
Note
This is a non-blocking api.
Parameters
idThe pipeline id which to be connected, ref to DJI::OSDK::MOP::PipelineID
typeThe pipeline type. It can be set to be RELIABLE or UBRELIABLE ref to the enum DJI::OSDK::MOP::PipelineType
cbCallback function defined by user
  • errCode is the DJI::OSDK::MOP::MopErrCode error code
  • p The pointer of pipeline. If success, it will be pointed to be the target pipeline object.
  • userData the interface to pass userData in when the callback is called
userDatawhen UserCallBack is called, used in UserCallBack

◆ disconnect() [1/2]

MopErrCode DJI::OSDK::MopClient::disconnect ( PipelineID  id)

Disonnect the target device by a pipelineid.

Supported Platforms : M300
Note
This is a blocking api
Parameters
idThe pipeline id which to be connected, ref to DJI::OSDK::MOP::PipelineID
Returns
ref to the enum DJI::OSDK::MOP::MopErrCode

◆ disconnect() [2/2]

void DJI::OSDK::MopClient::disconnect ( PipelineID  id,
void(*)(MopErrCode errCode, void *userData)  cb,
void *  userData 
)

Disonnect the target device by a pipelineid.

Supported Platforms : M300
Note
This is a non-blocking api
Parameters
idThe pipeline id which to be connected, ref to the enum
cbCallback function defined by user
  • errCode is the DJI::OSDK::MOP::MopErrCode error code
  • userData the interface to pass userData in when the callback is called
userDatawhen UserCallBack is called, used in UserCallBack

The documentation for this class was generated from the following file: