liveserv_help.txt
33.9 KB
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
liveserv可以支持同时编码screen,window,camera,mic,movie ,集成本地rtmp服务器,支持共享时缺省推流到本地rtmp服务器,同时支持单独命令进行多路rmtp流推送和多路录制。
1. 客户端模拟
wsclient.exe,使用命令如下
connect <ws uri>
send <connection id> <message>
close <connection id> [<close code:default=1000>] [<close reason>]
show <connection id>
help: Display this help text
quit: Exit the program
connect ws://127.0.0.1:6080 这个端口可以在config.ini里[LiveServ] PORT=6080 配置
wssclient.exe 如果测试 secure websocket,使用wssclient.exe,命令与wsclient相同
connect wss://localhost.xuedianyun.com:6081 这个端口可以在config.ini里[LiveServ] PORT=6081 配置,如果为0,则不启动secure websocket服务
(1)获取liveserv的本地rtmp服务器端口
send 0 get_rtmp_port ;缺省返回值为1935,可以在liveserv.ini(应用程序名+ini)中配置 RTMP.Port=1935
(2) 媒体共享命令
send 0 mov_start //开始媒体共享,缺省本地推流地址为rtmp://127.0.0.1:1935/live/ms
send 0 mov_start rtmp://127.0.0.1:1935/live/mytest //开始媒体共享,把共享流推向rtmp://127.0.0.1:1935/live/mytest
send 0 mov_stop //停止媒体共享
send 0 mov_pause //暂停媒体共享,当前位置暂停
send 0 mov_pause 60 //暂停媒体共享,设置停止位置为60s,resume时,会从60s处继续
send 0 mov_resume //从暂停状态变成继续共享
send 0 mov_seek 120 //seek 到120秒
(2)屏幕共享命令(scr)
send 0 ss_start //开始屏幕共享,缺省本地推流地址为rtmp://127.0.0.1:1935/live/ss
send 0 ss_stop
send 0 ss_start rtmp://127.0.0.1:1935/live/mytest //开始屏幕共享,把共享流推向rtmp://127.0.0.1:1935/live/mytest
send 0 ss_stop
send 0 ss_start 100,100,400,200 //共享屏幕(100,100)位置,宽为400,高为200区域,缺省本地推流地址为rtmp://127.0.0.1:1935/live/ss
send 0 ss_stop
send 0 ss_start rtmp://127.0.0.1:1935/live/mytest 100,100,400,200 //共享屏幕(100,100)位置,宽为400,高为200区域,把共享流推向rtmp://127.0.0.1:1935/live/mytest
send 0 ss_stop
如果使用SmartStreamingSDK(配置方式为见后面config.ini说明里[ConfigInfo] use_smart_streaming_sdk=1),当推流地址不为rtmp://127.0.0.1:1935/live/ss时,自动添加一路推流到rtmp://127.0.0.1:1935/live/ss。
使用SmartStreamingSDK时,start_push,start_record里参数 video=scr 不起作用。使用SmartStreamingSDK做屏幕共享时,如果要推音频,需要先aud_start,再ss_start。如果要静音,设置send 0 set_mic_vol 0,取消静音,则send 0 set_mic_vol 100。
(3)文档共享(窗口共享)(doc)
;相应参数从ds_start.txt读取,ds_start是一个文本文件,第一行保存的是窗口标题,后面各行依次为x坐标,y坐标,宽度,高度
send 0 ds_start //开始文档共享(窗口共享),缺省本地推流地址为rtmp://127.0.0.1:1935/live/ds
send 0 ds_start rtmp://127.0.0.1:1935/live/mytest //开始文档共享,把共享流推向rtmp://127.0.0.1:1935/live/mytest
send 0 ds_stop
(3) 音频共享(mic)
;如果先运行了send 0 get_mic,会使用get_mic返回的第一个mic名测试;否则使用 "麦克风 (Conexant SmartAudio HD)"
send 0 aud_start //开始音频,缺省本地推流地址为rtmp://127.0.0.1:1935/live/as
send 0 aud_start /开始音频,把共享流推向rtmp://127.0.0.1:1935/live/mytest
send 0 aud_stop
send 0 get_mic //获取mic列表
(4)摄像头共享
send 0 get_cam
;如果先运行了send 0 get_cam,会使用get_cam返回的第一个摄像头名字,否则使用"Integrated Camera"
send 0 cam_start //开始摄像头共享,缺省本地推流地址为rtmp://127.0.0.1:1935/live/cs
send 0 cam_stop
send 0 cam_start rtmp://127.0.0.1:1935/live/mytest //开始摄像头共享,把共享流推向rtmp://127.0.0.1:1935/live/mytest
send 0 cam_stop
(5)录制
录制时,要进行相应的共享,才可能有流。如果要录制camra和mic,需要先audio_start,cam_start,然后start_record
或者先start_record,也要audio_start之后才有对应的audio,cam_start之后才有对应video。如果已经开始了相应的共享,start_record后不指定音视频源,则自动选择已经共享的源,
选择顺序为视频:屏幕共享,窗口共享,摄像头共享,媒体共享; 音频:音频共享,媒体共享;如果不需要音频,可以指定audio=non;不需要视频 video=non
send 0 start_record 0 video=cam audio=mic //视频为摄像头,音频为MIC (start_record后面的0为录制序号,如果不写,缺省为0)
send 0 start_record 1 video=scr audio=mic //视频为屏幕共享,音频为MIC(start_record后面的0为录制序号,如果不写,缺省为0
send 0 start_record 2 audio=non video=scr //视频为屏幕共享,无音频 (start_record 后面的0为推流序号,如果不写,缺省为0)
send 0 stop_record 0
send 0 stop_record 1
send 0 stop_record 2
send 0 stop_record -1 //停止所有录制
(6) 推流(向外部服务器推流)
向外部推流时,要进行相应的共享,才可能有流。如果要向外部推camra和mic,需要先audio_start,cam_start,然后start_push
或者先start_push,也要audio_start之后才有对应的audio,cam_start之后才有对应video。如果已经开始了相应的共享,start_push后不指定音视频源,则自动选择已经共享的源,
选择顺序为视频:屏幕共享,窗口共享,摄像头共享,媒体共享; 音频:音频共享,媒体共享;如果不需要音频,可以指定audio=non;不需要视频 video=non
send 0 start_push 0 audio=mic video=cam rtmp://myrtmpserver/live/mystream1 //视频为摄像头,音频为MIC (start_push 后面的0为推流序号,如果不写,缺省为0),
send 0 start_push 1 audio=mic video=scr rtmp://myrtmpserver/live/mystream2 //推第二路流,视频为屏幕共享,音频为MIC (start_push 后面的0为推流序号,如果不写,缺省为0)
send 0 start_push 2 audio=non video=scr rtmp://myrtmpserver/live/mystream3 //推第三路流,视频为屏幕共享,无音频 (start_push 后面的0为推流序号,如果不写,缺省为0)
send 0 stop_push 0 //停止第一路流
send 0 stop_push 1 //停止第二路流
send 0 stop_push 2 //停止第三路流
send 0 stop_push -1 //停止所有推流
(7)设置编码参数
send 0 set_videoparam cam=640;480;15;45;1000;2000 //设置摄像头共享的编码参数:数字,分号分隔: width;height;fps;keyframe-interval;bit-rate;max-bitrate 如果某一项保留原设置,该项不填写数字
例如,只修改分辨率:send 0 set_videoparam 640;480;;;;
send 0 set_videoparam scr=640;480;15;45;1000;2000 //设置屏幕共享的编码参数
send 0 set_videoparam doc=640;480;15;45;1000;2000 //设置文档共享的编码参数
send 0 set_videoparam mov=640;480;15;45;1000;2000 //设置媒体共享的编码参数
(8)获取编码参数
send 0 get_videoparam cam //获取摄像头共享编码参数,其他类型形式相同(scr,mov,doc)返回的参数格式如设置参数: cam=640;480;15;45;1000;2000 //w;h;fps;keyframe-interval;bit-rate;max-bitrate
(9)设置MIC音量
send 0 set_mic_vol 100 ;0为静音,100为原始音量大小,(0,100)音量减小(100,200]音量提升
(10)获取MIC音量
send 0 get_mic_vol
(11)系统剪贴板,文件相关(保留之前插件功能)
send 0 clipboard_query image //查询剪贴板里是否有图片
send 0 clipboard_get image //获取剪贴板里的图片,返回文件格式缺省为jpg
send 0 clipboard_get image jpg //获取剪贴板里的图片,返回文件格式jpg
send 0 clipboard_get image png //获取剪贴板里的图片,返回文件格式png
send 0 file_get filename //获取插件目录下的文件内容
send 0 file_set filename //设置插件目录下的文件内容
(12)屏幕录制/QAV命令(保留之前插件功能)
send 0 get_mic
send 0 rec_start 麦克风 (Conexant High Definition S
send 0 rec_start 0 ;通过get_mic获取的mic列表的顺序号(0开始)
send 0 rec_stop
send 0 rec_version
send 0 qav_login
send 0 qav_logout
send 0 qav_enter_room
send 0 qav_leave_room
send 0 qav_open_mic
send 0 qav_close_mic
send 0 qav_open_player
send 0 qav_close_player
send 0 qav_mute_audio
send 0 qav_unmute_audio
(13)获取版本信息(在config.ini的[ConfigInfo],version=项配置),与之前插件兼容
send 0 ss_version
send 0 mov_version
send 0 rec_version
(14)获取配置信息get_config(根据config.ini中配置项名称,直接访问)
send 0 get_config ConfigInfo.use_smart_streaming_sdk //是否使用SmartSDK
send 0 get_config ScrShare.width //获取屏幕共享宽度信息
(15)设置配置信息set_config(根据config.ini中配置项名称,直接访问)
send 0 set_config ConfigInfo.use_smart_streaming_sdk=1 //设置使用SmartSDK
send 0 get_config ScrShare.width=1920 //设置屏幕共享宽度为1920
(16)robotpen输入
参考liveassistant_web_demo "robot pen input"标签页: git@123.56.226.173:hubin/liveAssistant_web_demo.git
(17)AgoraNativeSDK 屏幕共享相关
参考liveassistant_web_demo “Agora screen share"标签页: git@123.56.226.173:hubin/liveAssistant_web_demo.git
2. 协议
详见libws\ws_data.h
typedef struct tagWSData_S
{
uint16_ws cmd;
uint8_ws byte_order; // 0: little endian, 1: bit endian
uint8_ws resv;
uint32_ws data_len;
uint8_ws *data;
}WSData_S;
即:客户端和服务器端发送的数据都有如下8字节数据头
+---------+------------+---------+-----------+-----------------+
| 2byte | 1byte | 1byte | 4byte | data_len byte |
+---------+------------+---------+-----------+-----------------+
| cmd | byte_order | resv | data_len | data |
+---------+------------+---------+-----------+-----------------+
cmd: 命令类型
byte_order:数据大小端, 0: little endian, 1: bit endian
resv:保留字节
data_len: 数据头后面的数据长度
命令类型定义:
客户端发送给liveserv的命令
+----------------------------+----+
| 命令 | 值 |
+----------------------------+----+
| WS_CMD_UNKNOWN | 0 |
+----------------------------+----+
| WS_CMD_MOV_START | 1 |
+----------------------------+----+
| WS_CMD_MOV_STOP | 2 |
+----------------------------+----+
| WS_CMD_MOV_PAUSE | 3 |
+----------------------------+----+
| WS_CMD_MOV_RESUME | 4 |
+----------------------------+----+
| WS_CMD_MOV_SEEK | 5 |
+----------------------------+----+
| WS_CMD_SS_START | 6 |
+----------------------------+----+
| WS_CMD_SS_STOP | 7 |
+----------------------------+----+
| WS_CMD_REC_START | 8 |
+----------------------------+----+
| WS_CMD_REC_STOP | 9 |
+----------------------------+----+
| WS_CMD_REC_PAUSE | 10 |
+----------------------------+----+
| WS_CMD_REC_RESUME | 11 |
+----------------------------+----+
| WS_CMD_REC_PUSH_AUDIO_DATA | 12 |
+----------------------------+----+
| WS_CMD_MOV_VERSION | 13 |
+----------------------------+----+
| WS_CMD_SS_VERSION | 14 |
+----------------------------+----+
| WS_CMD_REC_VERSION | 15 |
+----------------------------+----+
| WS_CMD_QAV_LOGIN | 16 |
+----------------------------+----+
| WS_CMD_QAV_LOGOUT | 17 |
+----------------------------+----+
| WS_CMD_QAV_ENTER_ROOM | 18 |
+----------------------------+----+
| WS_CMD_QAV_LEAVE_ROOM | 19 |
+----------------------------+----+
| WS_CMD_QAV_OPEN_MIC | 20 |
+----------------------------+----+
| WS_CMD_QAV_CLOSE_MIC | 21 |
+----------------------------+----+
| WS_CMD_QAV_OPEN_PLAYER | 22 |
+----------------------------+----+
| WS_CMD_QAV_CLOSE_PLAYER | 23 |
+----------------------------+----+
| WS_CMD_QAV_MUTE_AUDIO | 24 |
+----------------------------+----+
| WS_CMD_QAV_UNMUTE_AUDIO | 25 |
+----------------------------+----+
| WS_CMD_GET_MIC | 26 |
+----------------------------+----+
| WS_CMD_DS_START | 27 |
+----------------------------+----+
| WS_CMD_DS_STOP | 28 |
+----------------------------+----+
| WS_CMD_AUD_START | 29 |
+----------------------------+----+
| WS_CMD_AUD_STOP | 30 |
+----------------------------+----+
| WS_CMD_CONN_CLOSE | 31 |
+----------------------------+----+
| WS_CMD_PEN_START | 32 |
+----------------------------+----+
| WS_CMD_PEN_STOP | 33 |
+----------------------------+----+
| WS_CMD_PEN_VERSION | 34 |
+----------------------------+----+
| WS_CMD_QAV_DEVICE | 35 |
+----------------------------+----+
| WS_CMD_CBD_QUERY | 36 |
+----------------------------+----+
| WS_CMD_CBD_GET | 37 |
+----------------------------+----+
| WS_CMD_FILE_GET | 38 |
+----------------------------+----+
| WS_CMD_FILE_SET | 39 |
+----------------------------+----+
| WS_CMD_RESTART | 40 |
+----------------------------+----+
| WS_CMD_GET_CAM | 41 |
+----------------------------+----+
| WS_CMD_CAM_START | 42 |
+----------------------------+----+
| WS_CMD_CAM_STOP | 43 |
+----------------------------+----+
| WS_CMD_SWITCH_SCENE | 44 |
+----------------------------+----+
| WS_CMD_SHOW_UI | 45 |
+----------------------------+----+
| WS_CMD_SET_VIDEO_PARAM | 46 |
+----------------------------+----+
| WS_CMD_GET_VIDEO_PARAM | 47 |
+----------------------------+----+
| WS_CMD_START_RECORD | 48 |
+----------------------------+----+
| WS_CMD_STOP_RECORD | 49 |
+----------------------------+----+
| WS_CMD_START_PUSH | 50 |
+----------------------------+----+
| WS_CMD_STOP_PUSH | 51 |
+----------------------------+----+
| WS_CMD_GET_RTMP_PORT | 52 |
+----------------------------+----+
| WS_CMD_SET_MIC_VOL | 53 |
+----------------------------+----+
| WS_CMD_GET_MIC_VOL | 54 |
+----------------------------+----+
| WS_CMD_SET_CONFIG | 55 |
+----------------------------+----+
| WS_CMD_GET_CONFIG | 56 |
+----------------------------+----+
| WS_CMD_EXT_INPUT | 57 |
+----------------------------+----+
| WS_CMD_AGORA_ENTER_CHANNEL | 58 |
+----------------------------+----+
| WS_CMD_AGORA_LEAVE_CHANNEL | 59 |
+----------------------------+----+
| WS_CMD_AGORA_SS_START | 60 |
+----------------------------+----+
| WS_CMD_AGORA_SS_STOP | 61 |
+----------------------------+----+
| WS_CMD_AGORA_GET_MIC | 62 |
+----------------------------+----+
| WS_CMD_AGORA_AUD_START | 63 |
+----------------------------+----+
| WS_CMD_AGORA_AUD_STOP | 64 |
+----------------------------+----+
liveserv返回客户端的结果,状态
+-------------------------------+-----+
| 命令 | 值 |
+-------------------------------+-----+
| WS_RES_MOV_START_SUC | 0 |
+-------------------------------+-----+
| WS_RES_MOV_START_FAIL | 1 |
+-------------------------------+-----+
| WS_RES_MOV_STOP_SUC | 2 |
+-------------------------------+-----+
| WS_RES_MOV_STOP_FAIL | 3 |
+-------------------------------+-----+
| WS_RES_MOV_PAUSE_SUC | 4 |
+-------------------------------+-----+
| WS_RES_MOV_PAUSE_FAIL | 5 |
+-------------------------------+-----+
| WS_RES_MOV_RESUME_SUC | 6 |
+-------------------------------+-----+
| WS_RES_MOV_RESUME_FAIL | 7 |
+-------------------------------+-----+
| WS_RES_MOV_SEEK_SUC | 8 |
+-------------------------------+-----+
| WS_RES_MOV_SEEK_FAIL | 9 |
+-------------------------------+-----+
| WS_RES_MOV_PROPERTY | 10 |
+-------------------------------+-----+
| WS_RES_SS_START_SUC | 11 |
+-------------------------------+-----+
| WS_RES_SS_START_FAIL | 12 |
+-------------------------------+-----+
| WS_RES_SS_STOP_SUC | 13 |
+-------------------------------+-----+
| WS_RES_SS_STOP_FAIL | 14 |
+-------------------------------+-----+
| WS_RES_REC_START_SUC | 15 |
+-------------------------------+-----+
| WS_RES_REC_START_FAIL | 16 |
+-------------------------------+-----+
| WS_RES_REC_STOP_SUC | 17 |
+-------------------------------+-----+
| WS_RES_REC_STOP_FAIL | 18 |
+-------------------------------+-----+
| WS_RES_REC_PAUSE_SUC | 19 |
+-------------------------------+-----+
| WS_RES_REC_PAUSE_FAIL | 20 |
+-------------------------------+-----+
| WS_RES_REC_RESUME_SUC | 21 |
+-------------------------------+-----+
| WS_RES_REC_RESUME_FAIL | 22 |
+-------------------------------+-----+
| WS_RES_MOV_PLAY_FINISH | 23 |
+-------------------------------+-----+
| WS_RES_MOV_VERSION | 24 |
+-------------------------------+-----+
| WS_RES_SS_VERSION | 25 |
+-------------------------------+-----+
| WS_RES_REC_VERSION | 26 |
+-------------------------------+-----+
| WS_RES_MOV_SELECT_FILE_CANCEL | 27 |
+-------------------------------+-----+
| WS_RES_QAV_LOGIN_SUC | 28 |
+-------------------------------+-----+
| WS_RES_QAV_LOGIN_FAIL | 29 |
+-------------------------------+-----+
| WS_RES_QAV_LOGOUT_SUC | 30 |
+-------------------------------+-----+
| WS_RES_QAV_LOGOUT_FAIL | 31 |
+-------------------------------+-----+
| WS_RES_QAV_ENTERROOM_SUC | 32 |
+-------------------------------+-----+
| WS_RES_QAV_ENTERROOM_FAIL | 33 |
+-------------------------------+-----+
| WS_RES_QAV_LEAVEROOM_SUC | 34 |
+-------------------------------+-----+
| WS_RES_QAV_LEAVEROOM_FAIL | 35 |
+-------------------------------+-----+
| WS_RES_QAV_OPEN_MIC_SUC | 36 |
+-------------------------------+-----+
| WS_RES_QAV_OPEN_MIC_FAIL | 37 |
+-------------------------------+-----+
| WS_RES_QAV_OPEN_MIC_NODEV | 38 |
+-------------------------------+-----+
| WS_RES_QAV_CLOSE_MIC_SUC | 39 |
+-------------------------------+-----+
| WS_RES_QAV_CLOSE_MIC_FAIL | 40 |
+-------------------------------+-----+
| WS_RES_QAV_CLOSE_MIC_NODEV | 41 |
+-------------------------------+-----+
| WS_RES_QAV_OPEN_PLAYER_SUC | 42 |
+-------------------------------+-----+
| WS_RES_QAV_OPEN_PLAYER_FAIL | 43 |
+-------------------------------+-----+
| WS_RES_QAV_OPEN_PLAYER_NODEV | 44 |
+-------------------------------+-----+
| WS_RES_QAV_CLOSE_PLAYER_SUC | 45 |
+-------------------------------+-----+
| WS_RES_QAV_CLOSE_PLAYER_FAIL | 46 |
+-------------------------------+-----+
| WS_RES_QAV_CLOSE_PLAYER_NODEV | 47 |
+-------------------------------+-----+
| WS_RES_QAV_MUTE_AUDIO_SUC | 48 |
+-------------------------------+-----+
| WS_RES_QAV_MUTE_AUDIO_FAIL | 49 |
+-------------------------------+-----+
| WS_RES_QAV_UNMUTE_AUDIO_SUC | 50 |
+-------------------------------+-----+
| WS_RES_QAV_UNMUTE_AUDIO_FAIL | 51 |
+-------------------------------+-----+
| WS_RES_REC_SAVE_FILE_CANCEL | 52 |
+-------------------------------+-----+
| WS_RES_GET_MIC_SUC | 53 |
+-------------------------------+-----+
| WS_RES_GET_MIC_FAIL | 54 |
+-------------------------------+-----+
| WS_RES_DS_START_SUC | 55 |
+-------------------------------+-----+
| WS_RES_DS_START_FAIL | 56 |
+-------------------------------+-----+
| WS_RES_DS_STOP_SUC | 57 |
+-------------------------------+-----+
| WS_RES_DS_STOP_FAIL | 58 |
+-------------------------------+-----+
| WS_RES_AUD_START_SUC | 59 |
+-------------------------------+-----+
| WS_RES_AUD_START_FAIL | 60 |
+-------------------------------+-----+
| WS_RES_AUD_STOP_SUC | 61 |
+-------------------------------+-----+
| WS_RES_AUD_STOP_FAIL | 62 |
+-------------------------------+-----+
| WS_RES_AUD_DATA | 63 |
+-------------------------------+-----+
| WS_RES_SS_DATA | 64 |
+-------------------------------+-----+
| WS_RES_MOV_DATA | 65 |
+-------------------------------+-----+
| WS_RES_PEN_START_SUC | 66 |
+-------------------------------+-----+
| WS_RES_PEN_START_FAIL | 67 |
+-------------------------------+-----+
| WS_RES_PEN_STOP_SUC | 68 |
+-------------------------------+-----+
| WS_RES_PEN_STOP_FAIL | 69 |
+-------------------------------+-----+
| WS_RES_PEN_VERSION | 70 |
+-------------------------------+-----+
| "WS_RES_QAV_DEVICE_SUC | 71 |
+-------------------------------+-----+
| WS_RES_QAV_DEVICE_FAIL | 72 |
+-------------------------------+-----+
| WS_RES_CBD_QUERY_SUC | 73 |
+-------------------------------+-----+
| WS_RES_CBD_QUERY_FAIL | 74 |
+-------------------------------+-----+
| WS_RES_CBD_GET_SUC | 75 |
+-------------------------------+-----+
| WS_RES_CBD_GET_FAIL | 76 |
+-------------------------------+-----+
| WS_RES_FILE_GET_SUC | 77 |
+-------------------------------+-----+
| WS_RES_FILE_GET_FAIL | 78 |
+-------------------------------+-----+
| WS_RES_FILE_SET_SUC | 79 |
+-------------------------------+-----+
| WS_RES_FILE_SET_FAIL | 80 |
+-------------------------------+-----+
| WS_RES_RESTART_SUC | 81 |
+-------------------------------+-----+
| WS_RES_RESTART_FAIL | 82 |
+-------------------------------+-----+
| WS_RES_GET_CAM_SUC | 83 |
+-------------------------------+-----+
| WS_RES_GET_CAM_FAIL | 84 |
+-------------------------------+-----+
| WS_RES_CAM_START_SUC | 85 |
+-------------------------------+-----+
| WS_RES_CAM_START_FAIL | 86 |
+-------------------------------+-----+
| WS_RES_CAM_STOP_SUC | 87 |
+-------------------------------+-----+
| WS_RES_CAM_STOP_FAIL | 88 |
+-------------------------------+-----+
| WS_RES_SWITCH_SCENE_SUC | 89 |
+-------------------------------+-----+
| WS_RES_SWITCH_SCENE_FAIL | 90 |
+-------------------------------+-----+
| WS_RES_PUSH_STREAM_FAIL | 91 |
+-------------------------------+-----+
| WS_RES_SHOW_UI_SUC | 92 |
+-------------------------------+-----+
| WS_RES_SET_VIDEO_PARAM_SUC | 93 |
+-------------------------------+-----+
| WS_RES_SET_VIDEO_PARAM_FAIL | 94 |
+-------------------------------+-----+
| WS_RES_GET_VIDEO_PARAM_SUC | 95 |
+-------------------------------+-----+
| WS_RES_GET_VIDEO_PARAM_FAIL | 96 |
+-------------------------------+-----+
| WS_RES_START_RECORD_SUC | 97 |
+-------------------------------+-----+
| WS_RES_START_RECORD_FAIL | 98 |
+-------------------------------+-----+
| WS_RES_STOP_RECORD_SUC | 99 |
+-------------------------------+-----+
| WS_RES_STOP_RECORD_FAIL | 100 |
+-------------------------------+-----+
| WS_RES_START_PUSH_SUC | 101 |
+-------------------------------+-----+
| WS_RES_START_PUSH_FAIL | 102 |
+-------------------------------+-----+
| WS_RES_STOP_PUSH_SUC | 103 |
+-------------------------------+-----+
| WS_RES_STOP_PUSH_FAIL | 104 |
+-------------------------------+-----+
| WS_RES_GET_RTMP_PORT_SUC | 105 |
+-------------------------------+-----+
| WS_RES_GET_RTMP_PORT_FAIL | 106 |
+-------------------------------+-----+
| WS_RES_SET_MIC_VOL_SUC | 107 |
+-------------------------------+-----+
| WS_RES_SET_MIC_VOL_FAIL | 108 |
+-------------------------------+-----+
| WS_RES_GET_MIC_VOL_SUC | 109 |
+-------------------------------+-----+
| WS_RES_GET_MIC_VOL_FAIL | 110 |
+-------------------------------+-----+
| WS_RES_RTMP_CONNECTING | 111 |
+-------------------------------+-----+
| WS_RES_RTMP_CONNECT_SUC | 112 |
+-------------------------------+-----+
| WS_RES_RTMP_CONNECT_FAIL | 113 |
+-------------------------------+-----+
| WS_RES_RTMP_CONNECT_CLOSED | 114 |
+-------------------------------+-----+
| WS_RES_SET_CONFIG_SUC | 115 |
+-------------------------------+-----+
| WS_RES_SET_CONFIG_FAIL | 116 |
+-------------------------------+-----+
| WS_RES_GET_CONFIG_SUC | 117 |
+-------------------------------+-----+
| WS_RES_GET_CONFIG_FAIL | 118 |
+-------------------------------+-----+
| WS_RES_EXT_INPUT | 119 |
+-------------------------------+-----+
| WS_RES_AGORA_ENTER_CHANNEL | 120 |
+-------------------------------+-----+
| WS_RES_AGORA_LEAVE_CHANNEL | 121 |
+-------------------------------+-----+
| WS_RES_AGORA_GET_MIC | 122 |
+-------------------------------+-----+
| WS_RES_AGORA_SS_START | 123 |
+-------------------------------+-----+
| WS_RES_AGORA_SS_STOP | 124 |
+-------------------------------+-----+
数据头后面是data_len字节的数据,根据各个cmd不同,有不同的结构
(1)命令消息
看ws_data.h中WSCmd_E列举值
WS_CMD_MOV_START和WS_CMD_SS_START时data为rtmp的URI
WS_CMD_MOV_SEEK时data为seek的位置,4个字节int类型,单位秒
WS_CMD_REC_PUSH_AUDIO_DATA时data为音频PCM RAW数据
WS_CMD_REC_START时data为MIC名字,不传的话只录制speaker
WS_CMD_FILE_SET时data前256字节为文件名,后面data_len - 256 字节为文件内容
WS_CMD_FILE_GET时data为文件名
WS_CMD_KILL_PROCESS时,data前256字节为应用程序名(movserv.exe,ssserv.exe,recserv.exe)
(2)返回消息
看ws_data.h中WSResult_E列举值
a. WS_RES_MOV_PROPERTY时data为视频参数如下:
typedef struct tagMovProperty_S
{
int32_ws nWidth; //宽
int32_ws nHeight;//高
int32_ws nFrameRate;//帧率
int32_ws nDuration;// 时长
int32_ws nPos;//开始播放位置,秒
uint32_ws nFileSize;//文件大小低32位
int32_ws nFileNameLength;//sFileName字符串长度
uint32_ws nFileSizeHigh;//文件大小高32位
int8_ws sFileName[MOV_FILENAME_MAX_LENGTH + 1]; // 播放视频文件名,MOV_FILENAME_MAX_LENGTH=255
} MovProperty_S;
b. 其他没有data值,看比如WS_RES_MOV_START_SUC是指播放成功
c. WS_RES_CBD_GET_SUC时,data为返回的文件信息
typedef struct tagCBD_FIlE_S
{
int32_ws type; //文件类型,
int32_ws nlen; //文件长度
int8_ws filecontent[0]; // 文件内容,长度为nlen
} CBDContent_S;
d. 对ds_start和ss_start,
返回的结构为WSData_S后多了一个uint32_ws 的错误返回码。
错误返回值参见:tagSSRetCode_E。
enum tagSSRetCode_E
{
SS_RET_ERR_SUCCESS = 0,//没有错误
SS_RET_ERR_NULLPARAM, //传入的参数指针为空
SS_RET_ERR_NOPARAM, //没有指定输入参数
SS_RET_ERR_NO_MATCHED_WINDOW, //没有找到对应的窗口
SS_RET_ERR_CREATE_LIVEMGR, //创建LiveMgr失败
SS_RET_ERR_INIT_ENV, //初始环境错
SS_RET_ERR_INIT_CONTEXT, //初始换上下文失败
SS_RET_ERR_PARAM_REGION, // 参数区域错误
SS_RET_ERR_ADD_VIDEOSTREAM, //添加video stream失败
SS_RET_ERR_START_ENCODER, //启动encoder失败
SS_RET_ERR_START_OUTPUT, //开始输出失败
SS_RET_ERR_START_CAPTURE, //启动捕获失败
SS_RET_ERR_UNKNOWN //未知错误
};
对应于ret_code小于SS_RET_ERR_SUCCESS和大于SS_RET_ERR_UNKNOWN的都是未知错误
e.
WS_REC_FILE_GET_SUC时, data 前256字节为请求的文件名,后data_len - 256字节为文件内容
WS_RES_FILE_GET_FAIL, WS_RES_FILE_SET_SUC, WS_RES_FILE_SET_FAIL时,data为请求的文件名
f.对于返回的rtmp状态,WSData_S里data对应rtmp url.
WS_RES_RTMP_CONNECTING,
WS_RES_RTMP_CONNECT_SUC,
WS_RES_RTMP_CONNECT_FAIL,
WS_RES_RTMP_CONNECT_CLOSED,
g.WS_CMD_EXT_INPUT:
1.罗博智能笔输入命令
打开输入, data_len=1 data[0]=0
关闭输入,data_len=1 data[0]=1
旋转输入坐标90度,data_len=1 data[0]=2
2.磐度PH-1820-A USB命令
打开输入, data_len=1 data[0]=10
关闭输入,data_len=1 data[0]=11
WS_RES_EXT_INPUT,
1.罗博智能笔输入状态:
data
+---------+--------------------------+
| 1byte | var length |
+---------+--------------------------+
| type | content |
+---------+--------------------------+
type = 1
+---------+------------+
| 2byte | 2byte |
+---------+------------+
| width | height |
+---------+------------+
type = 2
+---------+------------+------------+
| 2byte | 2byte | 2byte |
+---------+------------+------------+
| presss | x | y |
+---------+------------+------------+
type = 3
+------------+
| 1byte |
+------------+
| status |
+------------+
status:
+---------+-----------------+
| 值 | 状态 |
+---------+-----------------+
| 0 | 设备未连接 |
+---------+-----------------+
| 1 | 设备打开成功 |
+---------+-----------------+
| 2 | 设备关闭 |
+---------+-----------------+
| 3 | 设备打开失败 |
+---------+-----------------+
| 4 | 蓝牙设备未连接 |
+---------+-----------------+
| 5 | 蓝牙待机 |
+---------+-----------------+
| 6 | 蓝牙扫描中 |
+---------+-----------------+
| 7 | 蓝牙连接中 |
+---------+-----------------+
| 8 | 蓝牙连接成功 |
+---------+-----------------+
| 9 | 蓝牙断开中 |
+---------+-----------------+
| 10 | 蓝牙重连中 |
+---------+-----------------+
2.磐度智写板状态
data
+---------+--------------------------+
| 1byte | var length |
+---------+--------------------------+
| type | content |
+---------+--------------------------+
type = 10 打开USB设备错误码(0为正常)
type = 11 关闭USB设备错误码(0为正常)
+------------+
| 4byte |
+------------+
| ret code |
+------------+
type = 14
+---------+------------+------------+
| 2byte | 2byte | 2byte |
+---------+------------+------------+
| presss | x | y |
+---------+------------+------------+
h. 声网屏幕共享相关命令
a).WS_CMD_AGORA_ENTER_CHANNEL 加入频道
data:字符串: appid=aaaa token=bbbb channel=cccc uid=dddd live=0/1 secrete=dddd encmode=aes-128-xts/aes-256-xts
对于不使用token的项目,appid ,channel为必须,如果uid不填,由系统分配uid
对于使用token的项目,appid,token,channel,uid为必须
live=可选项 1互动直播类型,live=0视频通话类型,缺省为视频通话类型
secrete= 加密密码,启用Agora内置加密功能。如果不填,则不启用
encmode= 加密方法,aes-128-xts或aes-256-xts,缺省为aes-128-xts
WS_RES_AGORA_ENTER_CHANNEL 返回加入频道结果
+----------+------------+----------------+-----------------------+
| 4byte | 4byte | 4byte | ChannelNameLen byte |
+----------+------------+----------------+-----------------------+
| ret_code | uUID | ChannelNameLen | channel name |
+----------+------------+----------------+-----------------------+
在收到WS_RES_AGORA_ENTER_CHANNEL命令,且ret_code为0时,才能进行后续操作(WS_CMD_AGORA_SS_START...)
a).WS_CMD_AGORA_LEAVE_CHANNEL 离开频道
b). WS_CMD_AGORA_SS_START 开始屏幕共享
data:字符串: rect=100,100,400,200 fps= //共享屏幕(100,100)位置,宽为400,高为200区域 fps缺省为15
WS_RES_AGORA_SS_START 返回开始屏幕共享结果
c).WS_CMD_AGORA_SS_START 停止屏幕共享
WS_RES_AGORA_SS_START 返回停止屏幕共享结果
d). WS_CMD_AGORA_GET_MIC 获取音频输入设备
WS_RES_AGORA_GET_MIC 返回音频输入设备
e).WS_CMD_AGORA_AUD_START 开始声音共享
data:可选字符串,音频设备名。如果系统只有一个输入设备,会忽略输入音频设备名。如果有多个,则会选择匹配,首先是全字符匹配,如果无匹配,则采用前缀匹配,如果仍然无匹配,则采用config.ini里,[Agora] input_audio_device=配置项
WS_RES_AGORA_AUD_START 返回声音共享结果
f).WS_CMD_AGORA_AUD_STOP 停止声音共享
WS_RES_AGORA_AUD_STOP 返回停止共享结果
config.ini说明
;livemgr服务配置项
[Service]
;服务名称
name=3mlive
;服务描述
desc=3mlive service
;服务管理的可执行文件名(与livemgr在同一目录,不带exe,由";"分隔)
modules=xuedianyun
[ConfigInfo]
;整数,版本号
version = 28
;是否通过websocket发送编码后的flv数据到flash(为保持与之前的版本兼容)
data_to_websocket = 0
;LOG_LEVEL_ERROR:0 LOG_LEVEL_WARNING:1 LOG_LEVEL_INFO:2 LOG_LEVEL_DEBUG:3
log_level = 2
;是否使用SmartSDK,确省不使用。
;如果使用,目前只对 屏幕共享(ss_start有效),并且在使用SmartSDK时,其他命令,如start_record,start_push的 scr 源就不起作用
use_smart_streaming_sdk = 0
;是否推送缺省的本地流,缺省值为不推送
push_default_local_stream = 0
;日志保留时间,缺省30天
log_keep_days = 30
[MovShare] ;媒体共享
maxrate = 1000 ;最大码率kps
framerate = 10 ;帧率fps,如果framerate=0,用原始视频的平均帧率
tune =zerolatency
x264opts =
preset = fast
profile = baseline
level = 3.1
width = 720; ;如果为0,用原始视频的宽度
height = 576; ;如果为0,用原始视频高度
;编码声道数
channels = 2
;采用率
sample_rate = 22050
;采用大小
sample_size = 16
;采用音频缓冲区大小(ms)
audio_buffer_size = 60
;音频编码码率(bps)
audio_bitrate = 64000
[ScrShare] ;全屏共享
maxrate = 1000 ;最大码率kps
framerate = 10
tune =zerolatency
x264opts =
preset = fast
profile = baseline
level = 3.1
width = 720 ;如果为0,用原始视频的宽度
height = 576 ;如果为0,用原始视频的高度
keep_aspect_ratio = 1; 是否保存宽高比,如果保持宽高比,可能在输出视频上下或左右加黑边
[RegShare] ;区域共享
maxrate = 1000 ;;最大码率kps
framerate = 10 ;帧率fps
tune =zerolatency
x264opts =
preset = fast
profile = baseline
level = 3.1
width = 720 ;如果为0,用原始视频的宽度
height = 576 ;如果为0,用原始视频的高度
keep_aspect_ratio = 1; 是否保存宽高比,如果保持宽高比,可能在输出视频上下或左右加黑边
[CamShare] ;摄像头共享
maxrate = 1000 ;;最大码率kps
framerate = 10 ;帧率fps
tune =zerolatency
x264opts =
preset = fast
profile = baseline
level = 3.1
width = 720 ;如果为0,用原始视频的宽度
height = 576 ;如果为0,用原始视频的高度
keep_aspect_ratio = 1; 是否保存宽高比,如果保持宽高比,可能在输出视频上下或左右加黑边
[RecServ]
;修改用ffmpeg写flv的本地录像的编码参数
param= -framerate 10 -i desktop -acodec libvo_aacenc -ar 22050 -vcodec libx264 -pix_fmt yuv420p -level 3.1 -preset fast
;1,使用 ffmpeg写flv;0,上层应用写flv;下面的与视频编码相关配置,对上层应用写flv模式起作用;
;目前自己写flv,只录制了 MIC和视频(ffmpeg录制了MIC和playback的混音加视频)
UseFF = 1
maxrate = 2000 ;;最大码率kps
framerate = 10 ;帧率fps
tune =zerolatency
x264opts =
preset = fast
profile = main
level = 5.1
width = 720 ;如果为0,用原始视频的宽度
height = 576 ;如果为0,用原始视频的高度
keep_aspect_ratio = 1; 是否保存宽高比,如果保持宽高比,可能在输出视频上下或左右加黑边
;编码声道数
channels = 2
;采用率
sample_rate = 22050
;采用大小
sample_size = 16
;采用音频缓冲区大小(ms)
audio_buffer_size = 60
;音频编码码率(bps)
audio_bitrate = 64000
;音频共享参数
[MicShare]
;音量,100为原始大小,0为静音
volume=100
;编码声道数
channels = 2
;采用率
sample_rate = 22050
;采用大小
sample_size = 16
;采用音频缓冲区大小(ms)
audio_buffer_size = 60
;音频编码码率(bps)
audio_bitrate = 64000
;是否检查音频共享设备名(如果是,则把音频共享名与系统音频共享名比较,
;如果有多余部分,则截掉,如“回音消除话筒 (Plantronics P610) (047f:c02f)”会截掉为“回音消除话筒 (Plantronics P610)”,以支持传入webrtc接口获取的设备名),
;如果没有匹配的,则检测[MicShare] input_device配置项,如果没有此项,则采用系统枚举的第一个设备名
check_replace_mic_name = 1
缺省的设备名
input_device=
[LiveServ]
;websocket监听端口,0为不监听
PORT=6080
;scure websocket监听端口,0为不监听
WSS_PORT=6081
[Security]
;flash 安全服务器端口,0为不监听
PORT=843
[Agora]
;缺省的音频输入设备
input_audio_device=