DJI Windows SDK Documentation

class BeaconHandler

sealed class BeaconHandler
Declaration:DJI.WindowsSDK.Components
Description:

The class represents the beacon accessory mounted on the aircraft. It is a sub-component and managed by AccessoryHandler.

Class Members:
property
property ProductIndex
uint ProductIndex { get; }
Declaration:DJI.WindowsSDK.Components
Description:

The index of the product to which this component handler belongs. The default product index is 0.

property ComponentIndex
uint ComponentIndex { get; }
Declaration:DJI.WindowsSDK.Components
Description:

The index of the AccessoryHandler to which this component belongs to. The default product index is 0.

property SubComponentIndex
uint SubComponentIndex { get; }
Declaration:DJI.WindowsSDK.Components
Description:

The sub index of the component. It is unique for a type of components inside a product. It is useful when a product has multiple handlers of the same kind. If the product only has one handler of this kind, the index is 0.

method ~BeaconHandler
~BeaconHandler()
Declaration:DJI.WindowsSDK.Components
Description:

The destructor. It should not be called explicitly.

event ConnectionChanged
event BoolMsgChangedEventHandler ConnectionChanged
Declaration:DJI.WindowsSDK.Components
Description:

Subscribe the event to receive a component's connection change.

event IsBeaconOpenedChanged
event BoolMsgChangedEventHandler IsBeaconOpenedChanged
Declaration:DJI.WindowsSDK.Components
Description:

Subscribe the event to receive changes of the opening state of beacon.

event SerialNumberChanged
event StringMsgChangedEventHandler SerialNumberChanged
Declaration:DJI.WindowsSDK.Components
Description:

Subscribe the event to receive changes of the serial number of the component.

Methods
method
method GetConnectionAsync
async Task<ResultValue<BoolMsg?>> GetConnectionAsync()
Declaration:DJI.WindowsSDK.Components
Description:

Determines if a component is connected or not.

Return:
async Task<ResultValue<BoolMsg?>>A Task<ResultValue<Value_BoolMsg?>> object.
method GetIsBeaconOpenedAsync
async Task<ResultValue<BoolMsg?>> GetIsBeaconOpenedAsync()
Declaration:DJI.WindowsSDK.Components
Description:

Gets if the beacon is opened.

Return:
async Task<ResultValue<BoolMsg?>>A Task<ResultValue<Value_BoolMsg?>> object.
method GetSerialNumberAsync
async Task<ResultValue<StringMsg?>> GetSerialNumberAsync()
Declaration:DJI.WindowsSDK.Components
Description:

Gets the serial number of the component.

Return:
async Task<ResultValue<StringMsg?>>A Task<ResultValue<Value_StringMsg?>> object.
method SetIsBeaconOpenedAsync
async Task<SDKError> SetIsBeaconOpenedAsync(BoolMsg value)
Declaration:DJI.WindowsSDK.Components
Description:

Sets is the beacon opened.

Input Parameters:
BoolMsg valueA parameter object of type BoolMsg.
Return:
async Task<SDKError>A Task<SDKErrorCode> object.