FileListState getFileListState()

Description:

Current file list state of the speaker.

Return:

SpeakerDataTransmissionState getDataTransmissionState()

Description:

The data transmission state of the speaker.

Return:

void setVolume(@IntRange(from = MIN_VOLUME, to = MAX_VOLUME) int value,
                         @Nullable final CompletionCallback callback)

Description:

Sets the volume to play audio. The valid range is [0, 100]. 100 means loudest.

Input Parameters:

void setPlayMode(@NonNull SettingsDefinitions.PlayMode mode,
                           @Nullable final CompletionCallback callback)

Description:

Sets the play mode of the speaker to control the behavior after finishing playing a file.

Input Parameters:

void startTransmission(@NonNull AudioFileInfo info, @Nullable final TransmissionListener listener)

Description:

Starts to send a complete audio file to the aircraft, which can be played by the speaker. A transmission session can only be started when the transmission state is in IDLE. If the transmission is started successfully, the state will change to READY_TO_TRANSMIT. Then call paceData to send data to SDK. Call markEOF when all data has been sent to SDK. SDK will maintain a buffer to hold all the data and transmit it to the aircraft. For M2E Speaker, the audio file to transmit should fulfill the following configurations:
- The speaker only receives raw PCM(Pulse-code modulation) data of an audio file, if the audio file is compressed, PCM extraction is needed before the transmission.
- The audio channel is mono.
- The audio sample rate is 44,100 Hz.
- The PCM (Pulse-code modulation) sample depth is 16 bit per sample.
- The audio file is stored in the aircraft instead of the speaker.

Input Parameters:

boolean paceData(@NonNull @Size(MAX_INPUT_SIZE) byte[] data)

Description:

Sends raw PCM data of the audio file to SDK internal logic. For Mavic 2 Enterprise, the transmission rate is limited to 80kB/s by sdk. Therefore, SDK will cache the paced data to a local file when the rate of pacing data is over 80kB/s. The paced data will be appended to the local file. Call markEOF when all data of the data has been paced to SDK.

Input Parameters:

Return:

DJIError markEOF()

Description:

Marks EOF (end-of-file). It is used to inform SDK that all data of the file has been paced. SDK will continue to transmit data to the aircraft. The state will change to IDLE when all data is transmitted. After calling this method, paceData is invalid until a new transmission session starts. If no data is paced before calling this method, the transmission session will end immediately.

Return:

void cancelTransmission()

Description:

This will entirely stop the data transfer process and of course clean the transfer thread pool.

void play(int fileIndex, @Nullable final CompletionCallback callback)

Description:

Starts to play the audio file with the specific index.

Input Parameters:

void stop(@Nullable final CompletionCallback callback)

Description:

Stops the speaker from playing audio. The method is only valid when the playing state is PLAYING.

Input Parameters:

void rename(int index, String filename, final CommonCallbacks.CompletionCallback callback)

Description:

Renames the audio file with the specific index. If the operation is started successfully, FileListState will become RENAMING.

Input Parameters:

@Nullable
 List<AudioMediaFile> getFileListSnapshot()

Description:

Returns a copy of the current audio file list from the storage. Returns null if getFileListState is reset.

Return:

void refreshFileList(final CommonCallbacks.CompletionCallback callback)

Description:

Refresh the audio file list in the aircraft.
- If the current state is RESET, SDK will try to fetch the complete file list.
- If the current state is INCOMPLETE, SDK will only fetch the missing list of files.
- If the operation is started successfully, the FileListState will become SYNCING.
- When the file list is refreshed successfully, the FileListState will become UP_TO_DATE.

Input Parameters:

void delete(@NonNull List<Integer> fileIndices,
                      final CommonCallbacks.CompletionCallbackWithTwoParam<List<Integer>, DJIError> callback)

Description:

Deletes audio files in the aircraft. If the operation is started successfully, getFileListState will become DELETING. If there is error or "failedFiles" is not empty, getFileListState will become RESET.

Input Parameters:

void addFileListStateListener(FileListStateListener listener)

Description:

Start listen to the update of getFileListState.

Input Parameters:

void removeFileListStateListener(FileListStateListener listener)

Description:

Stop listen to the update of getFileListState.

Input Parameters:

void setStateCallback(@Nullable SpeakerState.Callback callback)

Description:

Sets the callback that updates speaker state.

Input Parameters:

enum PlayMode

Description:

The speaker's play mode. It determines the behavior of the speaker when it finishes playing a file.

Enum Members:

Class Members:

enum SpeakerPlayingState

Description:

The speaker's Playing State.

Enum Members:

Class Members:

enum SpeakerDataTransmissionState

Description:

Data transmission state of the speaker.

Enum Members:

Class Members:

void setComponentListener(ComponentListener listener)

Description:

Sets the listener for the DJI component.

Input Parameters:

int getIndex()

Description:

Returns the component index. Index is zero based. A component will have an index greater than zero when there are multiple components of the same type on the DJI product, and one of the components already has the index 0. For instance, M210 can have two gimbal mounted cameras, and will therefore have two gimbal components with indices 0 and 1, and two camera components with indices 0 and 1. For Matrice 600, there are printed numbers on the battery boxes. The Battery component instance with index 0 corresponds to battery compartment number 1. For Inspire 2 and M200 series, Battery with index 0 corresponds to the battery on the port (left hand) side of the aircraft. For M210, M210 RTK, M300 RTK and M350 RTK, Camera and Gimbal with index 0 corresponds to the camera and gimbal on the port (left hand) side of the aircraft. Lidar with index 0 corresponds to the lidar(Zenmuse L1) on the port (left hand) side of the aircraft.

Return:

boolean isConnected()

Description:

true if the component is connected.

Return:

void getSerialNumber(@NonNull CompletionCallbackWith<String> callback)

Description:

Gets the serial number of the component. Depending on the component, this serial number might not match the serial number found on the physical component.

Input Parameters:

void getFirmwareVersion(@NonNull CompletionCallbackWith<String> callback)

Description:

Returns the firmware version of the component. Each component will have a different firmware version, the combination of which will form the package firmware version getFirmwarePackageVersion found in BaseProduct.

Input Parameters: