DJI Mobile SDK Documentation

Mobile SDK

      Manager Classes
      DJISDKManager
      DJIKeyManager
      DJIFlyZoneManager
      DJIAppActivationManager
      DJIUserAccountManager
      DJIDataProtectionManager
      DJILDMManager
      DJIUTMISSManager
      DJIFlightHubManager
      DJIUASRemoteIDManager
      DJIUpgradeManager
      Base Classes
      DJIBaseProduct
      DJIBaseComponent
      Product Classes
      DJIAircraft
      DJIHandheld
      Component Classes
      DJIFlightController
      DJIBattery
      DJICamera
      DJIGimbal
      DJIAirLink
      DJIRemoteController
      DJIHandheldController
      DJIMobileRemoteController
      DJIPayload
      DJIPipeline
      DJIAccessoryAggregation
      DJIRTKBaseStation
      DJILidar
      Mission Classes
      DJIMissionControl
      DJIMissionAction
      DJIMissionTrigger
      DJIWaypointMissionOperator
      DJIWaypointV2MissionOperator
      DJIFollowMeMissionOperator
      DJIPanoramaMissionOperator
      DJIHotpointMissionOperator
      DJIIntelligentHotpointMissionOperator
      DJITapFlyMissionOperator
      DJIActiveTrackMissionOperator
      DJIMission
      Misc Classes
      DJIParamCapability
      NSError
      DJIDiagnostics
      DJIRemoteLogger

      class DJIPipeline

      @interface DJIPipeline : NSObject
      Header:DJIPipeline.h
      Inherits From:NSObject
      Description:

      Establishes a pipeline connected with Onboard device or Payload device to transmit data. Uses connect:pipelineType:withCompletion to create a pipeline. disconnect:withCompletion can be invoked to destroy the data transmission channel and disconnect from the Onboard device or Payload device.

      Class Members:
      ID
      property
      Id
      property Id
      @property (nonatomic, readonly) uint16_t Id
      Header:DJIPipeline.h
      Description:

      The identification number of the pipeline connected with the Payload or the Onboard device.

      Transmission Type
      property
      transmissionType
      property transmissionType
      @property (nonatomic, readonly) DJITransmissionControlType transmissionType
      Header:DJIPipeline.h
      Description:

      Transmission processing type.

      See Also:

      DJITransmissionControlType

      Device Type
      property
      deviceType
      property deviceType
      @property (nonatomic, readonly) DJIPipelineDeviceType deviceType
      Header:DJIPipeline.h
      Description:

      Device type connected.

      See Also:

      DJIPipelineDeviceType

      Write Data
      method
      writeData:error
      method writeData:error
      - (int32_t)writeData:(NSData *)data error:(NSError **)error
      Header:DJIPipeline.h
      Description:

      Data to be sent. 1 KB data size is recommended.

      Input Parameters:
      NSData * dataThe data needs to be sent.
      NSError ** errorA pointer to an error object. It is nullable if no further error information is expected. Tries to invoke disconnect:withCompletion and then disconnect:withCompletion to reconnect, if the connection is broken due to any exception.
      Return:
      int32_tSent data length.
      Read Data
      method
      readData:error
      method readData:error
      - (NSData *)readData:(uint32_t)readLength error:(NSError **)error
      Header:DJIPipeline.h
      Description:

      Read data from the pipeline.

      Input Parameters:
      uint32_t readLengthMaximum cache length to read
      NSError ** errorA pointer to an error object. It is nullable if no further error information is expected.
      Return:
      NSData *Read data length.
      enum DJITransmissionControlType
      typedef NS_ENUM(NSUInteger, DJITransmissionControlType)
      Header:DJIPipeline.h
      Description:

      Defines pipeline transmission control type.

      Enum Members:
      DJITransmissionControlTypeStableGuarantees delivery of data and that packets will be delivered in the order they were sent.
      DJITransmissionControlTypeUnreliableThis transmission control type does not provide guaranteed delivery and a datagram packet may become corrupt or lost in transit. Suitable for time-sensitive transmission.
      enum DJIPipelineDeviceType
      typedef NS_ENUM(NSUInteger, DJIPipelineDeviceType)
      Header:DJIPipeline.h
      Description:

      The enum is used to represent the pipeline device type.

      Enum Members:
      DJIPipelineDeviceTypeOnboardOnboard device. Please check the developer website: https://developer.dji.com/onboard-sdk/.
      DJIPipelineDeviceTypePayloadPayload device. Please check the developer website: https://developer.dji.com/payload-sdk/.
      DJIPipelineDeviceTypeUnknownUnknown.