AForge.Video.xml
50.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
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
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
<?xml version="1.0"?>
<doc>
<assembly>
<name>AForge.Video</name>
</assembly>
<members>
<member name="T:AForge.Video.AsyncVideoSource">
<summary>
Proxy video source for asynchronous processing of another nested video source.
</summary>
<remarks><para>The class represents a simple proxy, which wraps the specified <see cref="P:AForge.Video.AsyncVideoSource.NestedVideoSource"/>
with the aim of asynchronous processing of received video frames. The class intercepts <see cref="E:AForge.Video.AsyncVideoSource.NewFrame"/>
event from the nested video source and fires it to clients from its own thread, which is different from the thread
used by nested video source for video acquisition. This allows clients to perform processing of video frames
without blocking video acquisition thread, which continue to run and acquire next video frame while current is still
processed.</para>
<para>For example, let’s suppose that it takes 100 ms for the nested video source to acquire single frame, so the original
frame rate is 10 frames per second. Also let’s assume that we have an image processing routine, which also takes
100 ms to process a single frame. If the acquisition and processing are done sequentially, then resulting
frame rate will drop to 5 frames per second. However, if doing both in parallel, then there is a good chance to
keep resulting frame rate equal (or close) to the original frame rate.</para>
<para>The class provides a bonus side effect - easer debugging of image processing routines, which are put into
<see cref="E:AForge.Video.AsyncVideoSource.NewFrame"/> event handler. In many cases video source classes fire their <see cref="E:AForge.Video.IVideoSource.NewFrame"/>
event from a try/catch block, which makes it very hard to spot error made in user's code - the catch block simply
hides exception raised in user’s code. The <see cref="T:AForge.Video.AsyncVideoSource"/> does not have any try/catch blocks around
firing of <see cref="E:AForge.Video.AsyncVideoSource.NewFrame"/> event, so always user gets exception in the case it comes from his code. At the same time
nested video source is not affected by the user's exception, since it runs in different thread.</para>
<para>Sample usage:</para>
<code>
// usage of AsyncVideoSource is the same as usage of any
// other video source class, so code change is very little
// create nested video source, for example JPEGStream
JPEGStream stream = new JPEGStream( "some url" );
// create async video source
AsyncVideoSource asyncSource = new AsyncVideoSource( stream );
// set NewFrame event handler
asyncSource.NewFrame += new NewFrameEventHandler( video_NewFrame );
// start the video source
asyncSource.Start( );
// ...
private void video_NewFrame( object sender, NewFrameEventArgs eventArgs )
{
// get new frame
Bitmap bitmap = eventArgs.Frame;
// process the frame
}
</code>
</remarks>
</member>
<member name="T:AForge.Video.IVideoSource">
<summary>
Video source interface.
</summary>
<remarks>The interface describes common methods for different type of video sources.</remarks>
</member>
<member name="M:AForge.Video.IVideoSource.Start">
<summary>
Start video source.
</summary>
<remarks>Starts video source and return execution to caller. Video source
object creates background thread and notifies about new frames with the
help of <see cref="E:AForge.Video.IVideoSource.NewFrame"/> event.</remarks>
</member>
<member name="M:AForge.Video.IVideoSource.SignalToStop">
<summary>
Signal video source to stop its work.
</summary>
<remarks>Signals video source to stop its background thread, stop to
provide new frames and free resources.</remarks>
</member>
<member name="M:AForge.Video.IVideoSource.WaitForStop">
<summary>
Wait for video source has stopped.
</summary>
<remarks>Waits for video source stopping after it was signalled to stop using
<see cref="M:AForge.Video.IVideoSource.SignalToStop"/> method.</remarks>
</member>
<member name="M:AForge.Video.IVideoSource.Stop">
<summary>
Stop video source.
</summary>
<remarks>Stops video source aborting its thread.</remarks>
</member>
<member name="E:AForge.Video.IVideoSource.NewFrame">
<summary>
New frame event.
</summary>
<remarks><para>This event is used to notify clients about new available video frame.</para>
<para><note>Since video source may have multiple clients, each client is responsible for
making a copy (cloning) of the passed video frame, but video source is responsible for
disposing its own original copy after notifying of clients.</note></para>
</remarks>
</member>
<member name="E:AForge.Video.IVideoSource.VideoSourceError">
<summary>
Video source error event.
</summary>
<remarks>This event is used to notify clients about any type of errors occurred in
video source object, for example internal exceptions.</remarks>
</member>
<member name="E:AForge.Video.IVideoSource.PlayingFinished">
<summary>
Video playing finished event.
</summary>
<remarks><para>This event is used to notify clients that the video playing has finished.</para>
</remarks>
</member>
<member name="P:AForge.Video.IVideoSource.Source">
<summary>
Video source.
</summary>
<remarks>The meaning of the property depends on particular video source.
Depending on video source it may be a file name, URL or any other string
describing the video source.</remarks>
</member>
<member name="P:AForge.Video.IVideoSource.FramesReceived">
<summary>
Received frames count.
</summary>
<remarks>Number of frames the video source provided from the moment of the last
access to the property.
</remarks>
</member>
<member name="P:AForge.Video.IVideoSource.BytesReceived">
<summary>
Received bytes count.
</summary>
<remarks>Number of bytes the video source provided from the moment of the last
access to the property.
</remarks>
</member>
<member name="P:AForge.Video.IVideoSource.IsRunning">
<summary>
State of the video source.
</summary>
<remarks>Current state of video source object - running or not.</remarks>
</member>
<member name="M:AForge.Video.AsyncVideoSource.#ctor(AForge.Video.IVideoSource)">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.AsyncVideoSource"/> class.
</summary>
<param name="nestedVideoSource">Nested video source which is the target for asynchronous processing.</param>
</member>
<member name="M:AForge.Video.AsyncVideoSource.#ctor(AForge.Video.IVideoSource,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.AsyncVideoSource"/> class.
</summary>
<param name="nestedVideoSource">Nested video source which is the target for asynchronous processing.</param>
<param name="skipFramesIfBusy">Specifies if the object should skip frames from the nested video source
in the case if it is still busy processing the previous video frame.</param>
</member>
<member name="M:AForge.Video.AsyncVideoSource.Start">
<summary>
Start video source.
</summary>
<remarks><para>Starts the nested video source and returns execution to caller. This object creates
an extra thread which is used to fire <see cref="E:AForge.Video.AsyncVideoSource.NewFrame"/> events, so the image processing could be
done on another thread without blocking video acquisition thread.</para></remarks>
</member>
<member name="M:AForge.Video.AsyncVideoSource.SignalToStop">
<summary>
Signal video source to stop its work.
</summary>
<remarks><para>Signals video source to stop its background thread, stop to
provide new frames and free resources.</para></remarks>
</member>
<member name="M:AForge.Video.AsyncVideoSource.WaitForStop">
<summary>
Wait for video source has stopped.
</summary>
<remarks><para>Waits for video source stopping after it was signalled to stop using
<see cref="M:AForge.Video.AsyncVideoSource.SignalToStop"/> method.</para></remarks>
</member>
<member name="M:AForge.Video.AsyncVideoSource.Stop">
<summary>
Stop video source.
</summary>
<remarks><para>Stops nested video source by calling its <see cref="M:AForge.Video.IVideoSource.Stop"/> method.
See documentation of the particular video source for additional details.</para></remarks>
</member>
<member name="E:AForge.Video.AsyncVideoSource.NewFrame">
<summary>
New frame event.
</summary>
<remarks><para>Notifies clients about new available frame from video source.</para>
<para><note>This event is fired from a different thread other than the video acquisition thread created
by <see cref="P:AForge.Video.AsyncVideoSource.NestedVideoSource"/>. This allows nested video frame to continue acquisition of the next
video frame while clients perform processing of the current video frame.</note></para>
<para><note>Since video source may have multiple clients, each client is responsible for
making a copy (cloning) of the passed video frame, because the video source disposes its
own original copy after notifying of clients.</note></para>
</remarks>
</member>
<member name="E:AForge.Video.AsyncVideoSource.VideoSourceError">
<summary>
Video source error event.
</summary>
<remarks><para>This event is used to notify clients about any type of errors occurred in
video source object, for example internal exceptions.</para>
<para><note>Unlike <see cref="E:AForge.Video.AsyncVideoSource.NewFrame"/> event, this event is simply redirected to the corresponding
event of the <see cref="P:AForge.Video.AsyncVideoSource.NestedVideoSource"/>, so it is fired from the thread of the nested video source.</note></para>
</remarks>
</member>
<member name="E:AForge.Video.AsyncVideoSource.PlayingFinished">
<summary>
Video playing finished event.
</summary>
<remarks><para>This event is used to notify clients that the video playing has finished.</para>
<para><note>Unlike <see cref="E:AForge.Video.AsyncVideoSource.NewFrame"/> event, this event is simply redirected to the corresponding
event of the <see cref="P:AForge.Video.AsyncVideoSource.NestedVideoSource"/>, so it is fired from the thread of the nested video source.</note></para>
</remarks>
</member>
<member name="P:AForge.Video.AsyncVideoSource.NestedVideoSource">
<summary>
Nested video source which is the target for asynchronous processing.
</summary>
<remarks><para>The property is set through the class constructor.</para>
<para>All calls to this object are actually redirected to the nested video source. The only
exception is the <see cref="E:AForge.Video.AsyncVideoSource.NewFrame"/> event, which is handled differently. This object gets
<see cref="E:AForge.Video.IVideoSource.NewFrame"/> event from the nested class and then fires another
<see cref="E:AForge.Video.AsyncVideoSource.NewFrame"/> event, but from a different thread.</para>
</remarks>
</member>
<member name="P:AForge.Video.AsyncVideoSource.SkipFramesIfBusy">
<summary>
Specifies if the object should skip frames from the nested video source when it is busy.
</summary>
<remarks><para>Specifies if the object should skip frames from the nested video source
in the case if it is still busy processing the previous video frame in its own thread.</para>
<para>Default value is set to <see langword="false"/>.</para></remarks>
</member>
<member name="P:AForge.Video.AsyncVideoSource.Source">
<summary>
Video source string.
</summary>
<remarks><para>The property is redirected to the corresponding property of <see cref="P:AForge.Video.AsyncVideoSource.NestedVideoSource"/>,
so check its documentation to find what it means.</para></remarks>
</member>
<member name="P:AForge.Video.AsyncVideoSource.FramesReceived">
<summary>
Received frames count.
</summary>
<remarks><para>Number of frames the <see cref="P:AForge.Video.AsyncVideoSource.NestedVideoSource">nested video source</see> received from
the moment of the last access to the property.</para>
</remarks>
</member>
<member name="P:AForge.Video.AsyncVideoSource.BytesReceived">
<summary>
Received bytes count.
</summary>
<remarks><para>Number of bytes the <see cref="P:AForge.Video.AsyncVideoSource.NestedVideoSource">nested video source</see> received from
the moment of the last access to the property.</para></remarks>
</member>
<member name="P:AForge.Video.AsyncVideoSource.FramesProcessed">
<summary>
Processed frames count.
</summary>
<remarks><para>The property keeps the number of processed video frames since the last access to this property.
</para>
<para>The value of this property equals to <see cref="P:AForge.Video.AsyncVideoSource.FramesReceived"/> in most cases if the
<see cref="P:AForge.Video.AsyncVideoSource.SkipFramesIfBusy"/> property is set to <see langword="false"/> - every received frame gets processed
sooner or later. However, if the <see cref="P:AForge.Video.AsyncVideoSource.SkipFramesIfBusy"/> property is set to <see langword="true"/>,
then value of this property may be lower than the value of the <see cref="P:AForge.Video.AsyncVideoSource.FramesReceived"/> property, which
means that nested video source performs acquisition faster than client perform processing of the received frame
and some frame are skipped from processing.</para>
</remarks>
</member>
<member name="P:AForge.Video.AsyncVideoSource.IsRunning">
<summary>
State of the video source.
</summary>
<remarks><para>Current state of the video source object - running or not.</para></remarks>
</member>
<member name="T:AForge.Video.ScreenCaptureStream">
<summary>
Screen capture video source.
</summary>
<remarks><para>The video source constantly captures the desktop screen.</para>
<para>Sample usage:</para>
<code>
// get entire desktop area size
Rectangle screenArea = Rectangle.Empty;
foreach ( System.Windows.Forms.Screen screen in
System.Windows.Forms.Screen.AllScreens )
{
screenArea = Rectangle.Union( screenArea, screen.Bounds );
}
// create screen capture video source
ScreenCaptureStream stream = new ScreenCaptureStream( screenArea );
// set NewFrame event handler
stream.NewFrame += new NewFrameEventHandler( video_NewFrame );
// start the video source
stream.Start( );
// ...
// signal to stop
stream.SignalToStop( );
// ...
private void video_NewFrame( object sender, NewFrameEventArgs eventArgs )
{
// get new frame
Bitmap bitmap = eventArgs.Frame;
// process the frame
}
</code>
</remarks>
</member>
<member name="M:AForge.Video.ScreenCaptureStream.#ctor(System.Drawing.Rectangle)">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.ScreenCaptureStream"/> class.
</summary>
<param name="region">Screen's rectangle to capture (the rectangle may cover multiple displays).</param>
</member>
<member name="M:AForge.Video.ScreenCaptureStream.#ctor(System.Drawing.Rectangle,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.ScreenCaptureStream"/> class.
</summary>
<param name="region">Screen's rectangle to capture (the rectangle may cover multiple displays).</param>
<param name="frameInterval">Time interval between making screen shots, ms.</param>
</member>
<member name="M:AForge.Video.ScreenCaptureStream.Start">
<summary>
Start video source.
</summary>
<remarks>Starts video source and return execution to caller. Video source
object creates background thread and notifies about new frames with the
help of <see cref="E:AForge.Video.ScreenCaptureStream.NewFrame"/> event.</remarks>
<exception cref="T:System.ArgumentException">Video source is not specified.</exception>
</member>
<member name="M:AForge.Video.ScreenCaptureStream.SignalToStop">
<summary>
Signal video source to stop its work.
</summary>
<remarks>Signals video source to stop its background thread, stop to
provide new frames and free resources.</remarks>
</member>
<member name="M:AForge.Video.ScreenCaptureStream.WaitForStop">
<summary>
Wait for video source has stopped.
</summary>
<remarks>Waits for source stopping after it was signalled to stop using
<see cref="M:AForge.Video.ScreenCaptureStream.SignalToStop"/> method.</remarks>
</member>
<member name="M:AForge.Video.ScreenCaptureStream.Stop">
<summary>
Stop video source.
</summary>
<remarks><para>Stops video source aborting its thread.</para>
<para><note>Since the method aborts background thread, its usage is highly not preferred
and should be done only if there are no other options. The correct way of stopping camera
is <see cref="M:AForge.Video.ScreenCaptureStream.SignalToStop">signaling it stop</see> and then
<see cref="M:AForge.Video.ScreenCaptureStream.WaitForStop">waiting</see> for background thread's completion.</note></para>
</remarks>
</member>
<member name="M:AForge.Video.ScreenCaptureStream.Free">
<summary>
Free resource.
</summary>
</member>
<member name="E:AForge.Video.ScreenCaptureStream.NewFrame">
<summary>
New frame event.
</summary>
<remarks><para>Notifies clients about new available frame from video source.</para>
<para><note>Since video source may have multiple clients, each client is responsible for
making a copy (cloning) of the passed video frame, because the video source disposes its
own original copy after notifying of clients.</note></para>
</remarks>
</member>
<member name="E:AForge.Video.ScreenCaptureStream.VideoSourceError">
<summary>
Video source error event.
</summary>
<remarks>This event is used to notify clients about any type of errors occurred in
video source object, for example internal exceptions.</remarks>
</member>
<member name="E:AForge.Video.ScreenCaptureStream.PlayingFinished">
<summary>
Video playing finished event.
</summary>
<remarks><para>This event is used to notify clients that the video playing has finished.</para>
</remarks>
</member>
<member name="P:AForge.Video.ScreenCaptureStream.Source">
<summary>
Video source.
</summary>
</member>
<member name="P:AForge.Video.ScreenCaptureStream.Region">
<summary>
Gets or sets the screen capture region.
</summary>
<remarks><para>This property specifies which region (rectangle) of the screen to capture. It may cover multiple displays
if those are available in the system.</para>
<para><note>The property must be set before starting video source to have any effect.</note></para>
</remarks>
</member>
<member name="P:AForge.Video.ScreenCaptureStream.FrameInterval">
<summary>
Time interval between making screen shots, ms.
</summary>
<remarks><para>The property specifies time interval in milliseconds between consequent screen captures.
Expected frame rate of the stream should be approximately 1000/FrameInteval.</para>
<para>If the property is set to 0, then the stream will capture screen as fast as the system allows.</para>
<para>Default value is set to <b>100</b>.</para>
</remarks>
</member>
<member name="P:AForge.Video.ScreenCaptureStream.FramesReceived">
<summary>
Received frames count.
</summary>
<remarks>Number of frames the video source provided from the moment of the last
access to the property.
</remarks>
</member>
<member name="P:AForge.Video.ScreenCaptureStream.BytesReceived">
<summary>
Received bytes count.
</summary>
<remarks><para><note>The property is not implemented for this video source and always returns 0.</note></para>
</remarks>
</member>
<member name="P:AForge.Video.ScreenCaptureStream.IsRunning">
<summary>
State of the video source.
</summary>
<remarks>Current state of video source object - running or not.</remarks>
</member>
<member name="T:AForge.Video.MJPEGStream">
<summary>
MJPEG video source.
</summary>
<remarks><para>The video source downloads JPEG images from the specified URL, which represents
MJPEG stream.</para>
<para>Sample usage:</para>
<code>
// create MJPEG video source
MJPEGStream stream = new MJPEGStream( "some url" );
// set event handlers
stream.NewFrame += new NewFrameEventHandler( video_NewFrame );
// start the video source
stream.Start( );
// ...
</code>
<para><note>Some cameras produce HTTP header, which does not conform strictly to
standard, what leads to .NET exception. To avoid this exception the <b>useUnsafeHeaderParsing</b>
configuration option of <b>httpWebRequest</b> should be set, what may be done using application
configuration file.</note></para>
<code>
<configuration>
<system.net>
<settings>
<httpWebRequest useUnsafeHeaderParsing="true" />
</settings>
</system.net>
</configuration>
</code>
</remarks>
</member>
<member name="M:AForge.Video.MJPEGStream.#ctor">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.MJPEGStream"/> class.
</summary>
</member>
<member name="M:AForge.Video.MJPEGStream.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.MJPEGStream"/> class.
</summary>
<param name="source">URL, which provides MJPEG stream.</param>
</member>
<member name="M:AForge.Video.MJPEGStream.Start">
<summary>
Start video source.
</summary>
<remarks>Starts video source and return execution to caller. Video source
object creates background thread and notifies about new frames with the
help of <see cref="E:AForge.Video.MJPEGStream.NewFrame"/> event.</remarks>
<exception cref="T:System.ArgumentException">Video source is not specified.</exception>
</member>
<member name="M:AForge.Video.MJPEGStream.SignalToStop">
<summary>
Signal video source to stop its work.
</summary>
<remarks>Signals video source to stop its background thread, stop to
provide new frames and free resources.</remarks>
</member>
<member name="M:AForge.Video.MJPEGStream.WaitForStop">
<summary>
Wait for video source has stopped.
</summary>
<remarks>Waits for source stopping after it was signalled to stop using
<see cref="M:AForge.Video.MJPEGStream.SignalToStop"/> method.</remarks>
</member>
<member name="M:AForge.Video.MJPEGStream.Stop">
<summary>
Stop video source.
</summary>
<remarks><para>Stops video source aborting its thread.</para>
<para><note>Since the method aborts background thread, its usage is highly not preferred
and should be done only if there are no other options. The correct way of stopping camera
is <see cref="M:AForge.Video.MJPEGStream.SignalToStop">signaling it stop</see> and then
<see cref="M:AForge.Video.MJPEGStream.WaitForStop">waiting</see> for background thread's completion.</note></para>
</remarks>
</member>
<member name="M:AForge.Video.MJPEGStream.Free">
<summary>
Free resource.
</summary>
</member>
<member name="E:AForge.Video.MJPEGStream.NewFrame">
<summary>
New frame event.
</summary>
<remarks><para>Notifies clients about new available frame from video source.</para>
<para><note>Since video source may have multiple clients, each client is responsible for
making a copy (cloning) of the passed video frame, because the video source disposes its
own original copy after notifying of clients.</note></para>
</remarks>
</member>
<member name="E:AForge.Video.MJPEGStream.VideoSourceError">
<summary>
Video source error event.
</summary>
<remarks>This event is used to notify clients about any type of errors occurred in
video source object, for example internal exceptions.</remarks>
</member>
<member name="E:AForge.Video.MJPEGStream.PlayingFinished">
<summary>
Video playing finished event.
</summary>
<remarks><para>This event is used to notify clients that the video playing has finished.</para>
</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.SeparateConnectionGroup">
<summary>
Use or not separate connection group.
</summary>
<remarks>The property indicates to open web request in separate connection group.</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.Source">
<summary>
Video source.
</summary>
<remarks>URL, which provides MJPEG stream.</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.Login">
<summary>
Login value.
</summary>
<remarks>Login required to access video source.</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.Password">
<summary>
Password value.
</summary>
<remarks>Password required to access video source.</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.Proxy">
<summary>
Gets or sets proxy information for the request.
</summary>
<remarks><para>The local computer or application config file may specify that a default
proxy to be used. If the Proxy property is specified, then the proxy settings from the Proxy
property overridea the local computer or application config file and the instance will use
the proxy settings specified. If no proxy is specified in a config file
and the Proxy property is unspecified, the request uses the proxy settings
inherited from Internet Explorer on the local computer. If there are no proxy settings
in Internet Explorer, the request is sent directly to the server.
</para></remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.HttpUserAgent">
<summary>
User agent to specify in HTTP request header.
</summary>
<remarks><para>Some IP cameras check what is the requesting user agent and depending
on it they provide video in different formats or do not provide it at all. The property
sets the value of user agent string, which is sent to camera in request header.
</para>
<para>Default value is set to "Mozilla/5.0". If the value is set to <see langword="null"/>,
the user agent string is not sent in request header.</para>
</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.FramesReceived">
<summary>
Received frames count.
</summary>
<remarks>Number of frames the video source provided from the moment of the last
access to the property.
</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.BytesReceived">
<summary>
Received bytes count.
</summary>
<remarks>Number of bytes the video source provided from the moment of the last
access to the property.
</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.RequestTimeout">
<summary>
Request timeout value.
</summary>
<remarks>The property sets timeout value in milliseconds for web requests.
Default value is 10000 milliseconds.</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.IsRunning">
<summary>
State of the video source.
</summary>
<remarks>Current state of video source object - running or not.</remarks>
</member>
<member name="P:AForge.Video.MJPEGStream.ForceBasicAuthentication">
<summary>
Force using of basic authentication when connecting to the video source.
</summary>
<remarks><para>For some IP cameras (TrendNET IP cameras, for example) using standard .NET's authentication via credentials
does not seem to be working (seems like camera does not request for authentication, but expects corresponding headers to be
present on connection request). So this property allows to force basic authentication by adding required HTTP headers when
request is sent.</para>
<para>Default value is set to <see langword="false"/>.</para>
</remarks>
</member>
<member name="T:AForge.Video.VideoException">
<summary>
Video related exception.
</summary>
<remarks><para>The exception is thrown in the case of some video related issues, like
failure of initializing codec, compression, etc.</para></remarks>
</member>
<member name="M:AForge.Video.VideoException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.VideoException"/> class.
</summary>
<param name="message">Exception's message.</param>
</member>
<member name="T:AForge.Video.NewFrameEventHandler">
<summary>
Delegate for new frame event handler.
</summary>
<param name="sender">Sender object.</param>
<param name="eventArgs">Event arguments.</param>
</member>
<member name="T:AForge.Video.VideoSourceErrorEventHandler">
<summary>
Delegate for video source error event handler.
</summary>
<param name="sender">Sender object.</param>
<param name="eventArgs">Event arguments.</param>
</member>
<member name="T:AForge.Video.PlayingFinishedEventHandler">
<summary>
Delegate for playing finished event handler.
</summary>
<param name="sender">Sender object.</param>
<param name="reason">Reason of finishing video playing.</param>
</member>
<member name="T:AForge.Video.ReasonToFinishPlaying">
<summary>
Reason of finishing video playing.
</summary>
<remarks><para>When video source class fire the <see cref="E:AForge.Video.IVideoSource.PlayingFinished"/> event, they
need to specify reason of finishing video playing. For example, it may be end of stream reached.</para></remarks>
</member>
<member name="F:AForge.Video.ReasonToFinishPlaying.EndOfStreamReached">
<summary>
Video playing has finished because it end was reached.
</summary>
</member>
<member name="F:AForge.Video.ReasonToFinishPlaying.StoppedByUser">
<summary>
Video playing has finished because it was stopped by user.
</summary>
</member>
<member name="F:AForge.Video.ReasonToFinishPlaying.DeviceLost">
<summary>
Video playing has finished because the device was lost (unplugged).
</summary>
</member>
<member name="F:AForge.Video.ReasonToFinishPlaying.VideoSourceError">
<summary>
Video playing has finished because of some error happened the video source (camera, stream, file, etc.).
A error reporting event usually is fired to provide error information.
</summary>
</member>
<member name="T:AForge.Video.NewFrameEventArgs">
<summary>
Arguments for new frame event from video source.
</summary>
</member>
<member name="M:AForge.Video.NewFrameEventArgs.#ctor(System.Drawing.Bitmap)">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.NewFrameEventArgs"/> class.
</summary>
<param name="frame">New frame.</param>
</member>
<member name="P:AForge.Video.NewFrameEventArgs.Frame">
<summary>
New frame from video source.
</summary>
</member>
<member name="T:AForge.Video.VideoSourceErrorEventArgs">
<summary>
Arguments for video source error event from video source.
</summary>
</member>
<member name="M:AForge.Video.VideoSourceErrorEventArgs.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.VideoSourceErrorEventArgs"/> class.
</summary>
<param name="description">Error description.</param>
</member>
<member name="P:AForge.Video.VideoSourceErrorEventArgs.Description">
<summary>
Video source error description.
</summary>
</member>
<member name="T:AForge.Video.JPEGStream">
<summary>
JPEG video source.
</summary>
<remarks><para>The video source constantly downloads JPEG files from the specified URL.</para>
<para>Sample usage:</para>
<code>
// create JPEG video source
JPEGStream stream = new JPEGStream( "some url" );
// set NewFrame event handler
stream.NewFrame += new NewFrameEventHandler( video_NewFrame );
// start the video source
stream.Start( );
// ...
// signal to stop
stream.SignalToStop( );
// ...
private void video_NewFrame( object sender, NewFrameEventArgs eventArgs )
{
// get new frame
Bitmap bitmap = eventArgs.Frame;
// process the frame
}
</code>
<para><note>Some cameras produce HTTP header, which does not conform strictly to
standard, what leads to .NET exception. To avoid this exception the <b>useUnsafeHeaderParsing</b>
configuration option of <b>httpWebRequest</b> should be set, what may be done using application
configuration file.</note></para>
<code>
<configuration>
<system.net>
<settings>
<httpWebRequest useUnsafeHeaderParsing="true" />
</settings>
</system.net>
</configuration>
</code>
</remarks>
</member>
<member name="M:AForge.Video.JPEGStream.#ctor">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.JPEGStream"/> class.
</summary>
</member>
<member name="M:AForge.Video.JPEGStream.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:AForge.Video.JPEGStream"/> class.
</summary>
<param name="source">URL, which provides JPEG files.</param>
</member>
<member name="M:AForge.Video.JPEGStream.Start">
<summary>
Start video source.
</summary>
<remarks>Starts video source and return execution to caller. Video source
object creates background thread and notifies about new frames with the
help of <see cref="E:AForge.Video.JPEGStream.NewFrame"/> event.</remarks>
<exception cref="T:System.ArgumentException">Video source is not specified.</exception>
</member>
<member name="M:AForge.Video.JPEGStream.SignalToStop">
<summary>
Signal video source to stop its work.
</summary>
<remarks>Signals video source to stop its background thread, stop to
provide new frames and free resources.</remarks>
</member>
<member name="M:AForge.Video.JPEGStream.WaitForStop">
<summary>
Wait for video source has stopped.
</summary>
<remarks>Waits for source stopping after it was signalled to stop using
<see cref="M:AForge.Video.JPEGStream.SignalToStop"/> method.</remarks>
</member>
<member name="M:AForge.Video.JPEGStream.Stop">
<summary>
Stop video source.
</summary>
<remarks><para>Stops video source aborting its thread.</para>
<para><note>Since the method aborts background thread, its usage is highly not preferred
and should be done only if there are no other options. The correct way of stopping camera
is <see cref="M:AForge.Video.JPEGStream.SignalToStop">signaling it stop</see> and then
<see cref="M:AForge.Video.JPEGStream.WaitForStop">waiting</see> for background thread's completion.</note></para>
</remarks>
</member>
<member name="M:AForge.Video.JPEGStream.Free">
<summary>
Free resource.
</summary>
</member>
<member name="E:AForge.Video.JPEGStream.NewFrame">
<summary>
New frame event.
</summary>
<remarks><para>Notifies clients about new available frame from video source.</para>
<para><note>Since video source may have multiple clients, each client is responsible for
making a copy (cloning) of the passed video frame, because the video source disposes its
own original copy after notifying of clients.</note></para>
</remarks>
</member>
<member name="E:AForge.Video.JPEGStream.VideoSourceError">
<summary>
Video source error event.
</summary>
<remarks>This event is used to notify clients about any type of errors occurred in
video source object, for example internal exceptions.</remarks>
</member>
<member name="E:AForge.Video.JPEGStream.PlayingFinished">
<summary>
Video playing finished event.
</summary>
<remarks><para>This event is used to notify clients that the video playing has finished.</para>
</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.SeparateConnectionGroup">
<summary>
Use or not separate connection group.
</summary>
<remarks>The property indicates to open web request in separate connection group.</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.PreventCaching">
<summary>
Use or not caching.
</summary>
<remarks>If the property is set to <b>true</b>, then a fake random parameter will be added
to URL to prevent caching. It's required for clients, who are behind proxy server.</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.FrameInterval">
<summary>
Frame interval.
</summary>
<remarks>The property sets the interval in milliseconds betwen frames. If the property is
set to 100, then the desired frame rate will be 10 frames per second. Default value is 0 -
get new frames as fast as possible.</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.Source">
<summary>
Video source.
</summary>
<remarks>URL, which provides JPEG files.</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.Login">
<summary>
Login value.
</summary>
<remarks>Login required to access video source.</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.Password">
<summary>
Password value.
</summary>
<remarks>Password required to access video source.</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.Proxy">
<summary>
Gets or sets proxy information for the request.
</summary>
<remarks><para>The local computer or application config file may specify that a default
proxy to be used. If the Proxy property is specified, then the proxy settings from the Proxy
property overridea the local computer or application config file and the instance will use
the proxy settings specified. If no proxy is specified in a config file
and the Proxy property is unspecified, the request uses the proxy settings
inherited from Internet Explorer on the local computer. If there are no proxy settings
in Internet Explorer, the request is sent directly to the server.
</para></remarks>
</member>
<member name="P:AForge.Video.JPEGStream.FramesReceived">
<summary>
Received frames count.
</summary>
<remarks>Number of frames the video source provided from the moment of the last
access to the property.
</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.BytesReceived">
<summary>
Received bytes count.
</summary>
<remarks>Number of bytes the video source provided from the moment of the last
access to the property.
</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.RequestTimeout">
<summary>
Request timeout value.
</summary>
<remarks><para>The property sets timeout value in milliseconds for web requests.</para>
<para>Default value is set <b>10000</b> milliseconds.</para></remarks>
</member>
<member name="P:AForge.Video.JPEGStream.IsRunning">
<summary>
State of the video source.
</summary>
<remarks>Current state of video source object - running or not.</remarks>
</member>
<member name="P:AForge.Video.JPEGStream.ForceBasicAuthentication">
<summary>
Force using of basic authentication when connecting to the video source.
</summary>
<remarks><para>For some IP cameras (TrendNET IP cameras, for example) using standard .NET's authentication via credentials
does not seem to be working (seems like camera does not request for authentication, but expects corresponding headers to be
present on connection request). So this property allows to force basic authentication by adding required HTTP headers when
request is sent.</para>
<para>Default value is set to <see langword="false"/>.</para>
</remarks>
</member>
<member name="T:AForge.Video.ByteArrayUtils">
<summary>
Some internal utilities for handling arrays.
</summary>
</member>
<member name="M:AForge.Video.ByteArrayUtils.Compare(System.Byte[],System.Byte[],System.Int32)">
<summary>
Check if the array contains needle at specified position.
</summary>
<param name="array">Source array to check for needle.</param>
<param name="needle">Needle we are searching for.</param>
<param name="startIndex">Start index in source array.</param>
<returns>Returns <b>true</b> if the source array contains the needle at
the specified index. Otherwise it returns <b>false</b>.</returns>
</member>
<member name="M:AForge.Video.ByteArrayUtils.Find(System.Byte[],System.Byte[],System.Int32,System.Int32)">
<summary>
Find subarray in the source array.
</summary>
<param name="array">Source array to search for needle.</param>
<param name="needle">Needle we are searching for.</param>
<param name="startIndex">Start index in source array.</param>
<param name="sourceLength">Number of bytes in source array, where the needle is searched for.</param>
<returns>Returns starting position of the needle if it was found or <b>-1</b> otherwise.</returns>
</member>
</members>
</doc>