1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
|
/*
* Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.smartdevicelink.proxy;
import android.os.Build;
import com.smartdevicelink.proxy.rpc.AddCommand;
import com.smartdevicelink.proxy.rpc.AddSubMenu;
import com.smartdevicelink.proxy.rpc.Alert;
import com.smartdevicelink.proxy.rpc.ChangeRegistration;
import com.smartdevicelink.proxy.rpc.Choice;
import com.smartdevicelink.proxy.rpc.CreateInteractionChoiceSet;
import com.smartdevicelink.proxy.rpc.DeleteCommand;
import com.smartdevicelink.proxy.rpc.DeleteFile;
import com.smartdevicelink.proxy.rpc.DeleteInteractionChoiceSet;
import com.smartdevicelink.proxy.rpc.DeleteSubMenu;
import com.smartdevicelink.proxy.rpc.DeviceInfo;
import com.smartdevicelink.proxy.rpc.EndAudioPassThru;
import com.smartdevicelink.proxy.rpc.GetVehicleData;
import com.smartdevicelink.proxy.rpc.Image;
import com.smartdevicelink.proxy.rpc.ListFiles;
import com.smartdevicelink.proxy.rpc.MenuParams;
import com.smartdevicelink.proxy.rpc.PerformAudioPassThru;
import com.smartdevicelink.proxy.rpc.PerformInteraction;
import com.smartdevicelink.proxy.rpc.PutFile;
import com.smartdevicelink.proxy.rpc.RegisterAppInterface;
import com.smartdevicelink.proxy.rpc.ScrollableMessage;
import com.smartdevicelink.proxy.rpc.SdlMsgVersion;
import com.smartdevicelink.proxy.rpc.SetAppIcon;
import com.smartdevicelink.proxy.rpc.SetDisplayLayout;
import com.smartdevicelink.proxy.rpc.SetGlobalProperties;
import com.smartdevicelink.proxy.rpc.SetMediaClockTimer;
import com.smartdevicelink.proxy.rpc.Show;
import com.smartdevicelink.proxy.rpc.Slider;
import com.smartdevicelink.proxy.rpc.SoftButton;
import com.smartdevicelink.proxy.rpc.Speak;
import com.smartdevicelink.proxy.rpc.StartTime;
import com.smartdevicelink.proxy.rpc.SubscribeButton;
import com.smartdevicelink.proxy.rpc.SubscribeVehicleData;
import com.smartdevicelink.proxy.rpc.SystemRequest;
import com.smartdevicelink.proxy.rpc.TTSChunk;
import com.smartdevicelink.proxy.rpc.UnregisterAppInterface;
import com.smartdevicelink.proxy.rpc.UnsubscribeButton;
import com.smartdevicelink.proxy.rpc.UnsubscribeVehicleData;
import com.smartdevicelink.proxy.rpc.VrHelpItem;
import com.smartdevicelink.proxy.rpc.enums.AppHMIType;
import com.smartdevicelink.proxy.rpc.enums.AudioType;
import com.smartdevicelink.proxy.rpc.enums.BitsPerSample;
import com.smartdevicelink.proxy.rpc.enums.ButtonName;
import com.smartdevicelink.proxy.rpc.enums.FileType;
import com.smartdevicelink.proxy.rpc.enums.ImageType;
import com.smartdevicelink.proxy.rpc.enums.InteractionMode;
import com.smartdevicelink.proxy.rpc.enums.Language;
import com.smartdevicelink.proxy.rpc.enums.RequestType;
import com.smartdevicelink.proxy.rpc.enums.SamplingRate;
import com.smartdevicelink.proxy.rpc.enums.TextAlignment;
import com.smartdevicelink.proxy.rpc.enums.UpdateMode;
import java.util.Vector;
/**
* @deprecated Use RPC constructors directly instead
*/
@Deprecated
public class RPCRequestFactory {
public static final int SDL_MSG_MAJOR_VERSION = 1;
public static final int SDL_MSG_MINOR_VERSION = 0;
public static SystemRequest buildSystemRequest(
String data, Integer correlationID) {
if(data == null) return null;
SystemRequest msg = new SystemRequest();
msg.setRequestType(RequestType.PROPRIETARY);
msg.setCorrelationID(correlationID);
msg.setBulkData(data.getBytes());
return msg;
}
public static SystemRequest buildSystemRequestLegacy(
Vector<String> data, Integer correlationID) {
if(data == null) return null;
SystemRequest msg = new SystemRequest(true);
msg.setCorrelationID(correlationID);
msg.setLegacyData(data);
return msg;
}
public static AddCommand buildAddCommand(Integer commandID,
String menuText, Integer parentID, Integer position,
Vector<String> vrCommands, Image cmdIcon, Integer correlationID) {
AddCommand msg = new AddCommand();
msg.setCorrelationID(correlationID);
msg.setCmdID(commandID);
msg.setVrCommands(vrCommands);
if (cmdIcon != null) msg.setCmdIcon(cmdIcon);
if(menuText != null || parentID != null || position != null) {
MenuParams menuParams = new MenuParams();
menuParams.setMenuName(menuText);
menuParams.setPosition(position);
menuParams.setParentID(parentID);
msg.setMenuParams(menuParams);
}
return msg;
}
public static AddCommand buildAddCommand(Integer commandID,
String menuText, Integer parentID, Integer position,
Vector<String> vrCommands, String IconValue, ImageType IconType,
Integer correlationID) {
AddCommand msg = new AddCommand();
msg.setCorrelationID(correlationID);
msg.setCmdID(commandID);
if (vrCommands != null) msg.setVrCommands(vrCommands);
Image cmdIcon = null;
if (IconValue != null && IconType != null)
{
cmdIcon = new Image();
cmdIcon.setValue(IconValue);
cmdIcon.setImageType(IconType);
}
if (cmdIcon != null) msg.setCmdIcon(cmdIcon);
if(menuText != null || parentID != null || position != null) {
MenuParams menuParams = new MenuParams();
menuParams.setMenuName(menuText);
menuParams.setPosition(position);
menuParams.setParentID(parentID);
msg.setMenuParams(menuParams);
}
return msg;
}
public static AddCommand buildAddCommand(Integer commandID,
String menuText, Integer parentID, Integer position,
Vector<String> vrCommands, Integer correlationID) {
AddCommand msg = new AddCommand();
msg.setCorrelationID(correlationID);
msg.setCmdID(commandID);
msg.setVrCommands(vrCommands);
if(menuText != null || parentID != null || position != null) {
MenuParams menuParams = new MenuParams();
menuParams.setMenuName(menuText);
menuParams.setPosition(position);
menuParams.setParentID(parentID);
msg.setMenuParams(menuParams);
}
return msg;
}
public static AddCommand buildAddCommand(Integer commandID,
String menuText, Vector<String> vrCommands, Integer correlationID) {
AddCommand msg = buildAddCommand(commandID, menuText, null, null,
vrCommands, correlationID);
return msg;
}
public static AddCommand buildAddCommand(Integer commandID,
Vector<String> vrCommands, Integer correlationID) {
AddCommand msg = new AddCommand();
msg.setCorrelationID(correlationID);
msg.setCmdID(commandID);
msg.setVrCommands(vrCommands);
return msg;
}
public static AddSubMenu buildAddSubMenu(Integer menuID, String menuName,
Integer correlationID) {
AddSubMenu msg = buildAddSubMenu(menuID, menuName, null, correlationID);
return msg;
}
public static AddSubMenu buildAddSubMenu(Integer menuID, String menuName,
Integer position, Integer correlationID) {
AddSubMenu msg = new AddSubMenu();
msg.setCorrelationID(correlationID);
msg.setMenuName(menuName);
msg.setMenuID(menuID);
msg.setPosition(position);
return msg;
}
public static Alert buildAlert(String ttsText, Boolean playTone,
Vector<SoftButton> softButtons, Integer correlationID) {
Vector<TTSChunk> chunks = TTSChunkFactory
.createSimpleTTSChunks(ttsText);
Alert msg = buildAlert(chunks, null, null, null, playTone, null, softButtons,
correlationID);
return msg;
}
public static Alert buildAlert(String alertText1, String alertText2,
String alertText3, Integer duration, Vector<SoftButton> softButtons,
Integer correlationID) {
Alert msg = buildAlert((Vector<TTSChunk>) null, alertText1, alertText2,
alertText3, null, duration, softButtons, correlationID);
return msg;
}
public static Alert buildAlert(String ttsText, String alertText1,
String alertText2, String alertText3, Boolean playTone,
Integer duration, Vector<SoftButton> softButtons, Integer correlationID) {
Vector<TTSChunk> chunks = TTSChunkFactory
.createSimpleTTSChunks(ttsText);
Alert msg = buildAlert(chunks, alertText1, alertText2, alertText3,
playTone, duration, softButtons, correlationID);
return msg;
}
public static Alert buildAlert(Vector<TTSChunk> chunks, Boolean playTone,
Vector<SoftButton> softButtons, Integer correlationID) {
Alert msg = buildAlert(chunks, null, null, null, playTone, null, softButtons, correlationID);
return msg;
}
public static Alert buildAlert(Vector<TTSChunk> ttsChunks,
String alertText1, String alertText2, String alertText3,
Boolean playTone, Integer duration, Vector<SoftButton> softButtons,
Integer correlationID) {
Alert msg = new Alert();
msg.setCorrelationID(correlationID);
msg.setAlertText1(alertText1);
msg.setAlertText2(alertText2);
msg.setAlertText3(alertText3);
msg.setDuration(duration);
msg.setPlayTone(playTone);
msg.setTtsChunks(ttsChunks);
msg.setSoftButtons(softButtons);
return msg;
}
public static Alert buildAlert(String ttsText, Boolean playTone,
Integer correlationID) {
Vector<TTSChunk> chunks = TTSChunkFactory
.createSimpleTTSChunks(ttsText);
Alert msg = buildAlert(chunks, null, null, playTone, null,
correlationID);
return msg;
}
public static Alert buildAlert(String alertText1, String alertText2,
Integer duration, Integer correlationID) {
Alert msg = buildAlert((Vector<TTSChunk>) null, alertText1, alertText2,
null, duration, correlationID);
return msg;
}
public static Alert buildAlert(String ttsText, String alertText1,
String alertText2, Boolean playTone, Integer duration,
Integer correlationID) {
Vector<TTSChunk> chunks = TTSChunkFactory
.createSimpleTTSChunks(ttsText);
Alert msg = buildAlert(chunks, alertText1, alertText2, playTone,
duration, correlationID);
return msg;
}
public static Alert buildAlert(Vector<TTSChunk> chunks, Boolean playTone,
Integer correlationID) {
Alert msg = buildAlert(chunks, null, null, playTone, null,
correlationID);
return msg;
}
public static Alert buildAlert(Vector<TTSChunk> ttsChunks,
String alertText1, String alertText2, Boolean playTone,
Integer duration, Integer correlationID) {
Alert msg = new Alert();
msg.setCorrelationID(correlationID);
msg.setAlertText1(alertText1);
msg.setAlertText2(alertText2);
msg.setDuration(duration);
msg.setPlayTone(playTone);
msg.setTtsChunks(ttsChunks);
return msg;
}
public static CreateInteractionChoiceSet buildCreateInteractionChoiceSet(
Vector<Choice> choiceSet, Integer interactionChoiceSetID,
Integer correlationID) {
CreateInteractionChoiceSet msg = new CreateInteractionChoiceSet();
msg.setChoiceSet(choiceSet);
msg.setInteractionChoiceSetID(interactionChoiceSetID);
msg.setCorrelationID(correlationID);
return msg;
}
public static DeleteCommand buildDeleteCommand(Integer commandID,
Integer correlationID) {
DeleteCommand msg = new DeleteCommand();
msg.setCmdID(commandID);
msg.setCorrelationID(correlationID);
return msg;
}
public static DeleteFile buildDeleteFile(String sdlFileName,
Integer correlationID) {
DeleteFile deleteFile = new DeleteFile();
deleteFile.setCorrelationID(correlationID);
deleteFile.setSdlFileName(sdlFileName);
return deleteFile;
}
public static DeleteInteractionChoiceSet buildDeleteInteractionChoiceSet(
Integer interactionChoiceSetID, Integer correlationID) {
DeleteInteractionChoiceSet msg = new DeleteInteractionChoiceSet();
msg.setInteractionChoiceSetID(interactionChoiceSetID);
msg.setCorrelationID(correlationID);
return msg;
}
public static DeleteSubMenu buildDeleteSubMenu(Integer menuID,
Integer correlationID) {
DeleteSubMenu msg = new DeleteSubMenu();
msg.setCorrelationID(correlationID);
msg.setMenuID(menuID);
return msg;
}
public static ListFiles buildListFiles(Integer correlationID) {
ListFiles listFiles = new ListFiles();
listFiles.setCorrelationID(correlationID);
return listFiles;
}
public static PerformInteraction buildPerformInteraction(
Vector<TTSChunk> initChunks, String displayText,
Vector<Integer> interactionChoiceSetIDList,
Vector<TTSChunk> helpChunks, Vector<TTSChunk> timeoutChunks,
InteractionMode interactionMode, Integer timeout,
Vector<VrHelpItem> vrHelp, Integer correlationID) {
PerformInteraction msg = new PerformInteraction();
msg.setInitialPrompt(initChunks);
msg.setInitialText(displayText);
msg.setInteractionChoiceSetIDList(interactionChoiceSetIDList);
msg.setInteractionMode(interactionMode);
msg.setTimeout(timeout);
msg.setHelpPrompt(helpChunks);
msg.setTimeoutPrompt(timeoutChunks);
msg.setVrHelp(vrHelp);
msg.setCorrelationID(correlationID);
return msg;
}
public static PerformInteraction buildPerformInteraction(
String initPrompt, String displayText,
Vector<Integer> interactionChoiceSetIDList,
String helpPrompt, String timeoutPrompt,
InteractionMode interactionMode, Integer timeout, Vector<VrHelpItem> vrHelp,
Integer correlationID) {
Vector<TTSChunk> initChunks = TTSChunkFactory
.createSimpleTTSChunks(initPrompt);
Vector<TTSChunk> helpChunks = TTSChunkFactory
.createSimpleTTSChunks(helpPrompt);
Vector<TTSChunk> timeoutChunks = TTSChunkFactory
.createSimpleTTSChunks(timeoutPrompt);
return buildPerformInteraction(initChunks,
displayText, interactionChoiceSetIDList, helpChunks,
timeoutChunks, interactionMode, timeout, vrHelp, correlationID);
}
public static PerformInteraction buildPerformInteraction(
String initPrompt, String displayText,
Integer interactionChoiceSetID,
String helpPrompt, String timeoutPrompt,
InteractionMode interactionMode, Integer timeout, Vector<VrHelpItem> vrHelp,
Integer correlationID) {
Vector<Integer> interactionChoiceSetIDs = new Vector<Integer>();
interactionChoiceSetIDs.add(interactionChoiceSetID);
return buildPerformInteraction(
initPrompt, displayText, interactionChoiceSetIDs,
helpPrompt, timeoutPrompt, interactionMode,
timeout, vrHelp, correlationID);
}
public static PerformInteraction buildPerformInteraction(String initPrompt,
String displayText, Integer interactionChoiceSetID, Vector<VrHelpItem> vrHelp,
Integer correlationID) {
return buildPerformInteraction(initPrompt, displayText,
interactionChoiceSetID, null, null,
InteractionMode.BOTH, null, vrHelp, correlationID);
}
public static PerformInteraction buildPerformInteraction(
Vector<TTSChunk> initChunks, String displayText,
Vector<Integer> interactionChoiceSetIDList,
Vector<TTSChunk> helpChunks, Vector<TTSChunk> timeoutChunks,
InteractionMode interactionMode, Integer timeout,
Integer correlationID) {
PerformInteraction msg = new PerformInteraction();
msg.setInitialPrompt(initChunks);
msg.setInitialText(displayText);
msg.setInteractionChoiceSetIDList(interactionChoiceSetIDList);
msg.setInteractionMode(interactionMode);
msg.setTimeout(timeout);
msg.setHelpPrompt(helpChunks);
msg.setTimeoutPrompt(timeoutChunks);
msg.setCorrelationID(correlationID);
return msg;
}
public static PerformInteraction buildPerformInteraction(
String initPrompt, String displayText,
Vector<Integer> interactionChoiceSetIDList,
String helpPrompt, String timeoutPrompt,
InteractionMode interactionMode, Integer timeout,
Integer correlationID) {
Vector<TTSChunk> initChunks = TTSChunkFactory
.createSimpleTTSChunks(initPrompt);
Vector<TTSChunk> helpChunks = TTSChunkFactory
.createSimpleTTSChunks(helpPrompt);
Vector<TTSChunk> timeoutChunks = TTSChunkFactory
.createSimpleTTSChunks(timeoutPrompt);
return buildPerformInteraction(initChunks,
displayText, interactionChoiceSetIDList, helpChunks,
timeoutChunks, interactionMode, timeout, correlationID);
}
public static PerformInteraction buildPerformInteraction(
String initPrompt, String displayText,
Integer interactionChoiceSetID,
String helpPrompt, String timeoutPrompt,
InteractionMode interactionMode, Integer timeout,
Integer correlationID) {
Vector<Integer> interactionChoiceSetIDs = new Vector<Integer>();
interactionChoiceSetIDs.add(interactionChoiceSetID);
return buildPerformInteraction(
initPrompt, displayText, interactionChoiceSetIDs,
helpPrompt, timeoutPrompt, interactionMode,
timeout, correlationID);
}
public static PerformInteraction buildPerformInteraction(String initPrompt,
String displayText, Integer interactionChoiceSetID,
Integer correlationID) {
return buildPerformInteraction(initPrompt, displayText,
interactionChoiceSetID, null, null,
InteractionMode.BOTH, null, correlationID);
}
@Deprecated
public static PerformInteraction buildPerformInteraction(
Vector<TTSChunk> initChunks, String displayText,
Vector<Integer> interactionChoiceSetIDList,
Vector<TTSChunk> helpChunks, InteractionMode interactionMode,
Integer timeout, Integer correlationID) {
PerformInteraction msg = new PerformInteraction();
msg.setInitialPrompt(initChunks);
msg.setInitialText(displayText);
msg.setInteractionChoiceSetIDList(interactionChoiceSetIDList);
msg.setInteractionMode(interactionMode);
msg.setTimeout(timeout);
msg.setHelpPrompt(helpChunks);
msg.setCorrelationID(correlationID);
return msg;
}
@Deprecated
public static PerformInteraction buildPerformInteraction(String initPrompt,
String displayText, Vector<Integer> interactionChoiceSetIDList,
String helpPrompt, InteractionMode interactionMode,
Integer timeout, Integer correlationID) {
Vector<TTSChunk> initChunks = TTSChunkFactory
.createSimpleTTSChunks(initPrompt);
Vector<TTSChunk> helpChunks = TTSChunkFactory
.createSimpleTTSChunks(helpPrompt);
PerformInteraction msg = buildPerformInteraction(initChunks,
displayText, interactionChoiceSetIDList, helpChunks,
interactionMode, timeout, correlationID);
return msg;
}
public static PutFile buildPutFile(String sdlFileName, FileType fileType,
Boolean persistentFile, byte[] fileData, Integer correlationID) {
PutFile putFile = new PutFile();
putFile.setCorrelationID(correlationID);
putFile.setSdlFileName(sdlFileName);
putFile.setFileType(fileType);
putFile.setPersistentFile(persistentFile);
putFile.setBulkData(fileData);
putFile.setCRC(fileData);
return putFile;
}
@Deprecated
public static PutFile buildPutFile(String sdlFileName, Integer iOffset, Integer iLength) {
PutFile putFile = new PutFile();
putFile.setCorrelationID(10000);
putFile.setSdlFileName(sdlFileName);
putFile.setFileType(FileType.BINARY);
putFile.setSystemFile(true);
putFile.setOffset(iOffset);
putFile.setLength(iLength);
return putFile;
}
public static PutFile buildPutFile(String sdlFileName, Long iOffset, Long iLength) {
PutFile putFile = new PutFile();
putFile.setCorrelationID(10000);
putFile.setSdlFileName(sdlFileName);
putFile.setFileType(FileType.BINARY);
putFile.setSystemFile(true);
putFile.setOffset(iOffset);
putFile.setLength(iLength);
return putFile;
}
@Deprecated
public static PutFile buildPutFile(String syncFileName, Integer iOffset, Integer iLength, FileType fileType, Boolean bPersistentFile, Boolean bSystemFile) {
PutFile putFile = new PutFile();
putFile.setCorrelationID(10000);
putFile.setSdlFileName(syncFileName);
putFile.setFileType(fileType);
putFile.setPersistentFile(bPersistentFile);
putFile.setSystemFile(bSystemFile);
putFile.setOffset(iOffset);
putFile.setLength(iLength);
return putFile;
}
public static PutFile buildPutFile(String syncFileName, Long iOffset, Long iLength, FileType fileType, Boolean bPersistentFile, Boolean bSystemFile) {
PutFile putFile = new PutFile();
putFile.setCorrelationID(10000);
putFile.setSdlFileName(syncFileName);
putFile.setFileType(fileType);
putFile.setPersistentFile(bPersistentFile);
putFile.setSystemFile(bSystemFile);
putFile.setOffset(iOffset);
putFile.setLength(iLength);
return putFile;
}
@Deprecated
public static PutFile buildPutFile(String sdlFileName, Integer iOffset, Integer iLength, FileType fileType, Boolean bPersistentFile, Boolean bSystemFile, Integer iCorrelationID) {
PutFile putFile = new PutFile();
putFile.setCorrelationID(iCorrelationID);
putFile.setSdlFileName(sdlFileName);
putFile.setFileType(fileType);
putFile.setPersistentFile(bPersistentFile);
putFile.setSystemFile(bSystemFile);
putFile.setOffset(iOffset);
putFile.setLength(iLength);
return putFile;
}
public static PutFile buildPutFile(String sdlFileName, Long iOffset, Long iLength, FileType fileType, Boolean bPersistentFile, Boolean bSystemFile, Boolean isPayloadProtected, Integer iCorrelationID) {
PutFile putFile = new PutFile();
putFile.setCorrelationID(iCorrelationID);
putFile.setSdlFileName(sdlFileName);
putFile.setFileType(fileType);
putFile.setPersistentFile(bPersistentFile);
putFile.setSystemFile(bSystemFile);
putFile.setOffset(iOffset);
putFile.setLength(iLength);
putFile.setPayloadProtected(isPayloadProtected);
return putFile;
}
public static RegisterAppInterface buildRegisterAppInterface(String appName, String appID) {
return buildRegisterAppInterface(appName, false, appID);
}
public static RegisterAppInterface buildRegisterAppInterface(
String appName, Boolean isMediaApp, String appID) {
return buildRegisterAppInterface(null, appName, null, null, null, isMediaApp,
null, null, null, appID, null, null);
}
public static RegisterAppInterface buildRegisterAppInterface(
SdlMsgVersion sdlMsgVersion, String appName, Vector<TTSChunk> ttsName,
String ngnMediaScreenAppName, Vector<String> vrSynonyms, Boolean isMediaApp,
Language languageDesired, Language hmiDisplayLanguageDesired, Vector<AppHMIType> appType,
String appID, Integer correlationID, DeviceInfo deviceInfo) {
RegisterAppInterface msg = new RegisterAppInterface();
if (correlationID == null) {
correlationID = 1;
}
msg.setCorrelationID(correlationID);
if (sdlMsgVersion == null) {
sdlMsgVersion = new SdlMsgVersion();
sdlMsgVersion.setMajorVersion(Integer.valueOf(SDL_MSG_MAJOR_VERSION));
sdlMsgVersion.setMinorVersion(Integer.valueOf(SDL_MSG_MINOR_VERSION));
}
msg.setSdlMsgVersion(sdlMsgVersion);
msg.setDeviceInfo(deviceInfo);
msg.setAppName(appName);
msg.setTtsName(ttsName);
if (ngnMediaScreenAppName == null) {
ngnMediaScreenAppName = appName;
}
msg.setNgnMediaScreenAppName(ngnMediaScreenAppName);
if (vrSynonyms == null) {
vrSynonyms = new Vector<String>();
vrSynonyms.add(appName);
}
msg.setVrSynonyms(vrSynonyms);
msg.setIsMediaApplication(isMediaApp);
if (languageDesired == null) {
languageDesired = Language.EN_US;
}
msg.setLanguageDesired(languageDesired);
if (hmiDisplayLanguageDesired == null) {
hmiDisplayLanguageDesired = Language.EN_US;
}
msg.setHmiDisplayLanguageDesired(hmiDisplayLanguageDesired);
msg.setAppHMIType(appType);
msg.setAppID(appID);
return msg;
}
public static SetAppIcon buildSetAppIcon(String sdlFileName,
Integer correlationID) {
SetAppIcon setAppIcon = new SetAppIcon();
setAppIcon.setCorrelationID(correlationID);
setAppIcon.setSdlFileName(sdlFileName);
return setAppIcon;
}
public static SetGlobalProperties buildSetGlobalProperties(
String helpPrompt, String timeoutPrompt, Integer correlationID) {
return buildSetGlobalProperties(TTSChunkFactory
.createSimpleTTSChunks(helpPrompt), TTSChunkFactory
.createSimpleTTSChunks(timeoutPrompt), correlationID);
}
public static SetGlobalProperties buildSetGlobalProperties(
Vector<TTSChunk> helpChunks, Vector<TTSChunk> timeoutChunks,
Integer correlationID) {
SetGlobalProperties req = new SetGlobalProperties();
req.setCorrelationID(correlationID);
req.setHelpPrompt(helpChunks);
req.setTimeoutPrompt(timeoutChunks);
return req;
}
public static SetGlobalProperties buildSetGlobalProperties(
String helpPrompt, String timeoutPrompt, String vrHelpTitle,
Vector<VrHelpItem> vrHelp, Integer correlationID) {
return buildSetGlobalProperties(TTSChunkFactory
.createSimpleTTSChunks(helpPrompt), TTSChunkFactory
.createSimpleTTSChunks(timeoutPrompt), vrHelpTitle, vrHelp, correlationID);
}
public static SetGlobalProperties buildSetGlobalProperties(
Vector<TTSChunk> helpChunks, Vector<TTSChunk> timeoutChunks,
String vrHelpTitle, Vector<VrHelpItem> vrHelp,
Integer correlationID) {
SetGlobalProperties req = new SetGlobalProperties();
req.setCorrelationID(correlationID);
req.setHelpPrompt(helpChunks);
req.setTimeoutPrompt(timeoutChunks);
req.setVrHelpTitle(vrHelpTitle);
req.setVrHelp(vrHelp);
return req;
}
public static SetMediaClockTimer buildSetMediaClockTimer(Integer hours,
Integer minutes, Integer seconds, UpdateMode updateMode,
Integer correlationID) {
SetMediaClockTimer msg = new SetMediaClockTimer();
if (hours != null || minutes != null || seconds != null) {
StartTime startTime = new StartTime();
msg.setStartTime(startTime);
startTime.setHours(hours);
startTime.setMinutes(minutes);
startTime.setSeconds(seconds);
}
msg.setUpdateMode(updateMode);
msg.setCorrelationID(correlationID);
return msg;
}
@Deprecated
public static SetMediaClockTimer buildSetMediaClockTimer(
UpdateMode updateMode, Integer correlationID) {
Integer hours = null;
Integer minutes = null;
Integer seconds = null;
SetMediaClockTimer msg = buildSetMediaClockTimer(hours, minutes,
seconds, updateMode, correlationID);
return msg;
}
@SuppressWarnings("deprecation")
public static Show buildShow(String mainText1, String mainText2,
String mainText3, String mainText4,
String statusBar, String mediaClock, String mediaTrack,
Image graphic, Vector<SoftButton> softButtons, Vector <String> customPresets,
TextAlignment alignment, Integer correlationID) {
Show msg = new Show();
msg.setCorrelationID(correlationID);
msg.setMainField1(mainText1);
msg.setMainField2(mainText2);
msg.setStatusBar(statusBar);
msg.setMediaClock(mediaClock);
msg.setMediaTrack(mediaTrack);
msg.setAlignment(alignment);
msg.setMainField3(mainText3);
msg.setMainField4(mainText4);
msg.setGraphic(graphic);
msg.setSoftButtons(softButtons);
msg.setCustomPresets(customPresets);
return msg;
}
public static Show buildShow(String mainText1, String mainText2, String mainText3, String mainText4,
TextAlignment alignment, Integer correlationID) {
Show msg = buildShow(mainText1, mainText2, mainText3, mainText4, null, null, null, null, null, null, alignment,
correlationID);
return msg;
}
@SuppressWarnings("deprecation")
public static Show buildShow(String mainText1, String mainText2,
String statusBar, String mediaClock, String mediaTrack,
TextAlignment alignment, Integer correlationID) {
Show msg = new Show();
msg.setCorrelationID(correlationID);
msg.setMainField1(mainText1);
msg.setMainField2(mainText2);
msg.setStatusBar(statusBar);
msg.setMediaClock(mediaClock);
msg.setMediaTrack(mediaTrack);
msg.setAlignment(alignment);
return msg;
}
public static Show buildShow(String mainText1, String mainText2,
TextAlignment alignment, Integer correlationID) {
Show msg = buildShow(mainText1, mainText2, null, null, null, alignment,
correlationID);
return msg;
}
public static Speak buildSpeak(String ttsText, Integer correlationID) {
Speak msg = buildSpeak(TTSChunkFactory.createSimpleTTSChunks(ttsText),
correlationID);
return msg;
}
public static Speak buildSpeak(Vector<TTSChunk> ttsChunks,
Integer correlationID) {
Speak msg = new Speak();
msg.setCorrelationID(correlationID);
msg.setTtsChunks(ttsChunks);
return msg;
}
public static SubscribeButton buildSubscribeButton(ButtonName buttonName,
Integer correlationID) {
SubscribeButton msg = new SubscribeButton();
msg.setCorrelationID(correlationID);
msg.setButtonName(buttonName);
return msg;
}
public static UnregisterAppInterface buildUnregisterAppInterface(
Integer correlationID) {
UnregisterAppInterface msg = new UnregisterAppInterface();
msg.setCorrelationID(correlationID);
return msg;
}
public static UnsubscribeButton buildUnsubscribeButton(
ButtonName buttonName, Integer correlationID) {
UnsubscribeButton msg = new UnsubscribeButton();
msg.setCorrelationID(correlationID);
msg.setButtonName(buttonName);
return msg;
}
@SuppressWarnings("deprecation")
public static SubscribeVehicleData BuildSubscribeVehicleData(boolean gps, boolean speed, boolean rpm, boolean fuelLevel, boolean fuelLevel_State,
boolean instantFuelConsumption, boolean externalTemperature, boolean prndl, boolean tirePressure,
boolean odometer, boolean beltStatus, boolean bodyInformation, boolean deviceStatus,
boolean driverBraking, Integer correlationID)
{
SubscribeVehicleData msg = new SubscribeVehicleData();
msg.setGps(gps);
msg.setSpeed(speed);
msg.setRpm(rpm);
msg.setFuelLevel(fuelLevel);
msg.setFuelLevel_State(fuelLevel_State);
msg.setInstantFuelConsumption(instantFuelConsumption);
msg.setExternalTemperature(externalTemperature);
msg.setPrndl(prndl);
msg.setTirePressure(tirePressure);
msg.setOdometer(odometer);
msg.setBeltStatus(beltStatus);
msg.setBodyInformation(bodyInformation);
msg.setDeviceStatus(deviceStatus);
msg.setDriverBraking(driverBraking);
msg.setCorrelationID(correlationID);
return msg;
}
@SuppressWarnings("deprecation")
public static UnsubscribeVehicleData BuildUnsubscribeVehicleData(boolean gps, boolean speed, boolean rpm, boolean fuelLevel, boolean fuelLevel_State,
boolean instantFuelConsumption, boolean externalTemperature, boolean prndl, boolean tirePressure,
boolean odometer, boolean beltStatus, boolean bodyInformation, boolean deviceStatus,
boolean driverBraking, Integer correlationID)
{
UnsubscribeVehicleData msg = new UnsubscribeVehicleData();
msg.setGps(gps);
msg.setSpeed(speed);
msg.setRpm(rpm);
msg.setFuelLevel(fuelLevel);
msg.setFuelLevel_State(fuelLevel_State);
msg.setInstantFuelConsumption(instantFuelConsumption);
msg.setExternalTemperature(externalTemperature);
msg.setPrndl(prndl);
msg.setTirePressure(tirePressure);
msg.setOdometer(odometer);
msg.setBeltStatus(beltStatus);
msg.setBodyInformation(bodyInformation);
msg.setDeviceStatus(deviceStatus);
msg.setDriverBraking(driverBraking);
msg.setCorrelationID(correlationID);
return msg;
}
@SuppressWarnings("deprecation")
public static GetVehicleData BuildGetVehicleData(boolean gps, boolean speed, boolean rpm, boolean fuelLevel, boolean fuelLevel_State,
boolean instantFuelConsumption, boolean externalTemperature, boolean vin, boolean prndl, boolean tirePressure,
boolean odometer, boolean beltStatus, boolean bodyInformation, boolean deviceStatus,
boolean driverBraking, Integer correlationID)
{
GetVehicleData msg = new GetVehicleData();
msg.setGps(gps);
msg.setSpeed(speed);
msg.setRpm(rpm);
msg.setFuelLevel(fuelLevel);
msg.setFuelLevel_State(fuelLevel_State);
msg.setInstantFuelConsumption(instantFuelConsumption);
msg.setExternalTemperature(externalTemperature);
msg.setVin(vin);
msg.setPrndl(prndl);
msg.setTirePressure(tirePressure);
msg.setOdometer(odometer);
msg.setBeltStatus(beltStatus);
msg.setBodyInformation(bodyInformation);
msg.setDeviceStatus(deviceStatus);
msg.setDriverBraking(driverBraking);
msg.setCorrelationID(correlationID);
return msg;
}
public static ScrollableMessage BuildScrollableMessage(String scrollableMessageBody, Integer timeout, Vector<SoftButton> softButtons, Integer correlationID)
{
ScrollableMessage msg = new ScrollableMessage();
msg.setCorrelationID(correlationID);
msg.setScrollableMessageBody(scrollableMessageBody);
msg.setTimeout(timeout);
msg.setSoftButtons(softButtons);
return msg;
}
public static Slider BuildSlider(Integer numTicks, Integer position, String sliderHeader, Vector<String> sliderFooter, Integer timeout, Integer correlationID)
{
Slider msg = new Slider();
msg.setCorrelationID(correlationID);
msg.setNumTicks(numTicks);
msg.setPosition(position);
msg.setSliderHeader(sliderHeader);
msg.setSliderFooter(sliderFooter);
msg.setTimeout(timeout);
return msg;
}
public static ChangeRegistration BuildChangeRegistration(Language language, Language hmiDisplayLanguage, Integer correlationID)
{
ChangeRegistration msg = new ChangeRegistration();
msg.setCorrelationID(correlationID);
msg.setLanguage(language);
msg.setHmiDisplayLanguage(hmiDisplayLanguage);
return msg;
}
public static SetDisplayLayout BuildSetDisplayLayout(String displayLayout, Integer correlationID)
{
SetDisplayLayout msg = new SetDisplayLayout();
msg.setCorrelationID(correlationID);
msg.setDisplayLayout(displayLayout);
return msg;
}
public static PerformAudioPassThru BuildPerformAudioPassThru(String ttsText, String audioPassThruDisplayText1, String audioPassThruDisplayText2,
SamplingRate samplingRate, Integer maxDuration, BitsPerSample bitsPerSample,
AudioType audioType, Boolean muteAudio, Integer correlationID)
{
Vector<TTSChunk> chunks = TTSChunkFactory
.createSimpleTTSChunks(ttsText);
PerformAudioPassThru msg = BuildPerformAudioPassThru(chunks, audioPassThruDisplayText1, audioPassThruDisplayText2,
samplingRate, maxDuration, bitsPerSample,audioType, muteAudio, correlationID);
return msg;
}
public static PerformAudioPassThru BuildPerformAudioPassThru(Vector<TTSChunk> initialPrompt, String audioPassThruDisplayText1, String audioPassThruDisplayText2,
SamplingRate samplingRate, Integer maxDuration, BitsPerSample bitsPerSample,
AudioType audioType, Boolean muteAudio, Integer correlationID)
{
PerformAudioPassThru msg = new PerformAudioPassThru();
msg.setCorrelationID(correlationID);
msg.setInitialPrompt(initialPrompt);
msg.setAudioPassThruDisplayText1(audioPassThruDisplayText1);
msg.setAudioPassThruDisplayText2(audioPassThruDisplayText2);
msg.setSamplingRate(samplingRate);
msg.setMaxDuration(maxDuration);
msg.setBitsPerSample(bitsPerSample);
msg.setAudioType(audioType);
msg.setMuteAudio(muteAudio);
return msg;
}
public static EndAudioPassThru BuildEndAudioPassThru(Integer correlationID)
{
EndAudioPassThru msg = new EndAudioPassThru();
msg.setCorrelationID(correlationID);
return msg;
}
public static DeviceInfo BuildDeviceInfo(String carrierName)
{
DeviceInfo msg = new DeviceInfo();
msg.setHardware(android.os.Build.MODEL);
msg.setOs(DeviceInfo.DEVICE_OS);
msg.setOsVersion(Build.VERSION.RELEASE);
msg.setCarrier(carrierName);
return msg;
}
}
|