1.1. Revision record

Overview

SDK includes the following functional modules

1. Get host recommended playlist
2. Get local music on the host and scan the local scene folder
3. Voice synthesis and semantic interception are automatically processed, related to voice settings
4. Obtain the 485 data received by the host and the 485 data sent by the host
5. Host mode switch
6. Bilingual source machine supports partition settings

Integrated systems can be customized to meet individual needs

1.2. Interactive Chart

1.3. Public Access Configuration

1.3.1. Download demo

Baidu Netdisk Download Link: Link: https://pan.baidu.com/s/179xcJ6HirWoDVofAcsJN5A Password: 3vix
Path：JdRelease/jd_music_and_voice_open_sdk
Demo needs to be installed and run on the background music host, and the machine needs to be restarted after installation.

1.3.2. Import core package

Import two core packages within the demo: jdbase-release.aar and jdmusic-release-X.X.XX.aar into the project

repositories{
    flatDir{
        dirs'libs'
    }
}
dependencies {
    compile fileTree(include: ['*.jar'], dir: 'libs')
    compile(name: 'jdbase-release', ext: 'aar')
    compile(name: 'jdmusic-release-X.X.XX', ext: 'aar')
}

1.3.3. Add permission

Add the following permissions to AndroidManifest.xml

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

1.3.4. Initialize

public class App extends Application{
    @Override
    public void onCreate() {
        super.onCreate();
        JdPlayPresenter.getInstance().init(this);
    }
}

1.4. Based on the open SDK integration

1.4.1. Key class description

1.4.2. Voice synthesis entity class

TTS

public class TTS {
    //Do not operate
    public static final int TYPE_NONE = 0;
    //Enter recognition
    public static final int TYPE_ASR = 1;
    //Enter wake up
    public static final int TYPE_WAKE_UP = 2;
    //TTS content
    private String tts;
    //Whether to interrupt the current playback
    private boolean canInterrupt;
    //Text-to-Speech type
    private int ttsType;
}

JdRecommendMusicPresenter

Callback function

public interface IRecommendCallBack {
    void onQuerySceneMusic(List<JDMusicChannel> var1);
}

void onQuerySceneMusic(List<JDMusicChannel> var1)
* Parameter
* var1 Hosted music collection

Main methods

void querySceneMusic()
* Query the host's recommended music collection

JdPlayPresenter

Callback function

public interface IPlayCallBack {
    void onProgress(int var1, int var2);
    void onSongChange(EglSong var1);
    void onPlayStatus(int var1);
    void onListModeChange(String var1);
    void onPlaylist(List<JdSong> var1);
    void onPlaylistPosition(int var1);
}
public interface I485DataCallBack {
    void onReceiverData(String var1);
}

void onProgress(int var1, int var2)
* Parameter
* var1 Progress
* var2 Max_Progress

void onSongChange(EglSong var1)
* Parameter
* var1 Changed song

void onPlayStatus(int var1)
* Parameter
* var1 playback status

void onListModeChange(String var1)
* Parameter
* var1 changed mode

void onPlaylist(List<JdSong> var1)
* Parameter
* var1 song collection

void onPlaylistPosition(int var1)
* Parameter
* var1 plays the song at the position in the song collection

void onReceiverData(String var1)
* Parameter
* var1 Received data of 485

Main methods

void queryMediaInfo()
Query the current song status

void queryPlayList(final JdCallBack var1)
Get playlist
* Parameter
* var1 gets the callback for the success and failure of the playlist

void clearPlayList(final JdCallBack var1)
Clear playlist
* Parameter
* var1 Callbacks for success and failure to clear the playlist

void deletePlayListByPos(int var1, final JdCallBack var2)
Delete songs at the specified location in the playlist
* Parameter
* var1 Delete the playlist at the specified location
* var2 Delete the callback of the success and failure of the song at the specified location in the playlist

void editPlaylist(final String var1, final JdCallBack var2)
Edit playlist songs
* Parameter
* var1 Edit the playlist song to specify the location
* var2 Edit the callback of the success and failure of the playlist song

void refreshListAndPos(JdPlayList var1)
Refresh the playlist and playback position
* Parameter
* var1 playlist

void clearMediaData()
Clear data

void updatePlaylistPosition(EglSong var1)
Update playback position
* Parameter
* var1 songs

void togglePlay()
Playback status switch

void play()
* play

void pause()
* pause

void next()
* Next song

void prev()
* Previous song

void switchListMode()
* Switch playback mode

String queryListMode()
* Query playback mode

void seekTo(long var1)
Change the playback progress
* Parameter
* var1 progress value

void release()
Free up resources

void playLocalSceneMusic(int var1, int var2)
Play according to the location number
* Parameter
* var1 numbering position
* var2 song position

void playLocalSceneMusic(String var1, String var2)
Play md5 according to the file identification code
* Parameter
*var1 file identification code
* var2 song md5

void playSceneMusic(List<JDMusicChannel> var1, String var2)
Play the recommended list of scenes, specify the song
* Parameter
* var1 scene recommendation list collection
* var2 scene id

void playSceneMusic(JDMusicChannel var1)
Play the recommended song list
* Parameter
* var1 recommended song list

void playMusic(EglSong var1)
Play a single piece of music
* Parameter
* var1 songs

void playMusicByIndex(List<EglSong> var1, int var2)
Play the song in the specified location of the playlist
* Parameter
* var1 playlist
* var2 playlist specifies the location

void playOnlineMusic(BCategory var1)
Play online music
* Parameter
* var1 Play song type

void playSongByIndex(int var1)
Play the song at the specified location
* Parameter
* var1 specify the location

void playTTS (String var1, boolean var2) This method is outdated
Play TTS
* Parameter
* var1 play text
* Whether var2 interrupts the currently playing TTS

void playTTS (String var1) This method is outdated
Play TTS
* Parameter
* var1 play text

void playTTS(TTS var1)
Play TTS
* Parameter
* var1 plays TTS type data

void send485Data(String var1)
Send 485 control command
* Parameter
* var1 485 control command

void set485ReceiverListener(I485DataCallBack callBack)
Set 485 data to accept callbacks
* Parameter
* callBack I485DataCallBack callback interface

void enableSmartDeviceGrammar(boolean var1)
Disable local syntax
* Parameter
* Is var1 disabled?

void switchDeviceMode(String var1)
Switch mode interface
* Parameter
* var1 mode

void setChannelSync(String var1)
Set up a simultaneous broadcast partition
* Parameter
* var1 "1": simultaneous broadcast, "0": partition

void setChannel(String var1)
Switch partitions
* Parameter
* var1 "1": 1 partition, "2": 2 partitions

void getChannelSync()
Get whether the current status is simultaneous broadcast or partitioned
Result: "1": simultaneous broadcast, "0": partition

void getChannel()
Get the current partition
Result: "1":1 partition, "2":2 partition

void setChannelVolume(String var1, boolean var2)
Set partition volume
* Parameter
* var1 partition "1": 1 partition, "2":2 partition
* var2 volume range "0-10"

void getChannelOneVolume()
Get 1 partition volume
Result: Volume range "0-10"

void getChannelOneVolume()
Get 2 partition volume
Result: Volume range "0-10"

public interface IChannelVolumeCallBack {
    void onChannelVolume(String channel,String volume);
}
Volume callback


void setSpeed(String speed)
Set the speech speed of the TTS broadcast
* speed value is 0.5-2.0, 0.5 speech speed is the fastest, 2.0 speech speed is the slowest

void voiceSwitch(boolean open)
Voice wake-up switch
* open true / false indicates whether to turn on or off wake-up
If you need to obtain the initial state of the voice control wake-up switch, you can query the attribute value to obtain：
It can be obtained by integrating the jdsmart-common package call, [Click to download jdsmart-common] (http://upyun.aispeaker.com/externalDocFiles/jdsmart-common.aar )
String status=JdSystemProperty. getString("persist. sys. jd. voice. switch", "0");
Status 1 is open, 0 is closed


setVolume(String vol)
Control the volume
* vol volume, the value is 1-100

void shutUp()
Pause broadcast

void stopChat()
Actively end the conversation

void wakeUp(String wakeUpTip)
Actively wake up, the wake-up page will not pop up, and the screen host will be in a wake-up state, and voice control can be performed directly.
* wakeUpTip is passed in the broadcast text, and it will be broadcast first after being called, and it will be in the wake-up state.


void wakeUpWithUi(String wakeUpTip)
Actively wake up, the wake-up page pops up (here is the difference from wakeUp), and you can directly perform voice control.
* wakeUpTip is passed in the broadcast text, and it will be broadcast first after being called, and it will be in the wake-up state.

void voiceReply(String reply)
Select the wake-up reply method, the value passed in by reply is as follows
*"silent" silent
*"tone" tone
*"voiceReply" voice reply

void voiceWakeupWord(String word, String threshold)
Modify the wake-up word (updated in real time, no need to restart)
* word wake-up words are recommended to be 3-6 characters, and the wake-up rate is highest when the wake-up word is "Hello Little *".  When passing "", the default is "Hello Xiao Ke"
* threshold threshold range: "0.1-1.0", you can pass a null value.
* The lower the threshold, the more sensitive the wake-up is
* The threshold value defaults to 2MIC-- 0.18
*4MIC-- 0.25 (default 0.18 for X8)
* It is recommended to adjust 0.1-0.3 up and down the default value

void getDeviceMic(JdbaseCallback jdbaseCallback)
Get the MIC value of the device, indicating that it is a machine with a few meters (most of them are currently 2MIC and 4MIC), and use it with voiceWakeupWord

*Note: The above method is not applicable to some models*

JdLocalMusicPresenter

Callback function

public interface ILocalMusicCallBack {
    void onGetSdSongsSuccess(List<EglSong> var1);
    void onQueryLocalSceneMusic(List<LocalSceneMusic> var1);
}

void onGetSdSongsSuccess(List<EglSong> var1)
* Parameter
* var1 Sd song collection


void onQueryLocalSceneMusic(List<LocalSceneMusic> var1)
* Parameter
* var1 Collection of local scene songs

Main methods

void querySdCardSongs()
Query sdcard songs

void queryLocalSceneMusic()
Query local scene songs

JdVoicePresenter

Callback function

public interface IVoiceCallBack {
    boolean onAsrResult(String var1, VoiceExeBack var2);
    void onVoiceState(int var1);
    interface VoiceExeBack{
        @Deprecated
        void onSuccess(String var1);
        @Deprecated
        void onFail(String var1);
        void onSuccess(TTS var1);
        void onFail(TTS var1);
    }
}

boolean onAsrResult(String var1, VoiceExeBack var2)
* Parameter
* var1 identification content
* var2 intercepts the callback after the semantic processing is successful or fails (after the processing is complete, the onSuccess (TTS tts) or onFail (TTS tts) of VoiceExeBack returns the TTS that needs to be played for self-processing)
Return value
* True interception semantics are handled by yourself
* False does not intercept and leave it to the host for processing
Note that there are two cases where background music will handle semantics
1.  When onAsrResult returns false
2.  When onAsrResult returns true, the final callback of VoiceExeBack is onFail (TTS tts)

void onVoiceState(int var1)
* Parameter
* var1 voice_state status The callback status corresponds to the following：
    //Voice conversation starts
    public static final int VOICE_STATE_SESSION_START = 10001;
    //Recognize and start recording
    public static final int VOICE_STATE_ASR_START_SPEECH = 10003;
    //Recognize the end of the recording
    public static final int VOICE_STATE_ASR_END_SPEECH = 10004;
    //Start semantic recognition
    public static final int VOICE_STATE_ASR_RECOGNITION = 10005;
    // End of voice conversation
    public static final int VOICE_STATE_SESSION_END = 10008;
    //TTS playback starts
    public static final int VOICE_STATE_TTS_START = 10006;
    //TTS end of play
    public static final int VOICE_STATE_TTS_FINISH = 10007;

Main methods

void setIVoiceCallBack(IVoiceCallBack callBack)
Set up voice processing callback
* Parameter
* callBack callback method

Hot words added

When intercepting speech to obtain semantics, for some device names or scene names that are not easy to recognize, hot words can be set to prevent unrecognized speech control. For specific additions, you can check the JdVoiceFragment in the demo Note that when you have finished modifying the compilation and installing it on the background host, you need to restart the host.