DJI Mobile SDK Documentation

      class SpeakerState

      final class SpeakerState
      Package:dji.common.accessory
      Description:

      State of the speaker accessory.

      Class Members:
      Volume
      method
      method getVolume
      int getVolume()
      Package:dji.common.accessory
      Description:

      The volume of the speaker to play audio.

      Return:
      intAn int value.
      Playing State
      method
      method getPlayingState
      SettingsDefinitions.SpeakerPlayingState getPlayingState()
      Package:dji.common.accessory
      Description:

      Get the audio playing state.

      Return:
      SettingsDefinitions.SpeakerPlayingStateAn enum value of the SpeakerPlayingState.
      Playing Mode
      method
      method getPlayingMode
      SettingsDefinitions.PlayMode getPlayingMode()
      Package:dji.common.accessory
      Description:

      The playing mode of the speaker.

      Return:
      SettingsDefinitions.PlayModeAn enum value of the PlayMode.
      Playing Index
      method
      method getPlayingIndex
      int getPlayingIndex()
      Package:dji.common.accessory
      Description:

      The index of the audio media file being played. If the speaker is not playing any files, -1 will be returned.

      Return:
      intAn int value.
      Audio Storage Location
      method
      method getStorageLocation
      SettingsDefinitions.AudioStorageLocation getStorageLocation()
      Package:dji.common.accessory
      Description:

      The storage location of the file that is being played by the speaker.

      Return:
      SettingsDefinitions.AudioStorageLocationAn enum value of the AudioStorageLocation.
      State Updates
      interface
      interface Callback
      interface Callback
      Package:dji.common.accessory
      Description:

      This interface provides a callback to update the speaker's state.

      Interface Methods:

      Callback Method

      State
      method
      method onUpdate
      void onUpdate(SpeakerState state)
      Package:dji.common.accessory
      Description:

      Callback to update spotlight state.

      Input Parameters:
      SpeakerState stateThe spotlight's state.