/
SpeechSynthesisConnector.xml
937 lines (905 loc) · 50.4 KB
/
SpeechSynthesisConnector.xml
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
<Type Name="SpeechSynthesisConnector" FullName="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector">
<TypeSignature Language="C#" Value="public class SpeechSynthesisConnector : System.IO.Stream" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SpeechSynthesisConnector extends System.IO.Stream" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector" />
<TypeSignature Language="VB.NET" Value="Public Class SpeechSynthesisConnector
Inherits Stream" />
<TypeSignature Language="C++ CLI" Value="public ref class SpeechSynthesisConnector : System::IO::Stream" />
<TypeSignature Language="F#" Value="type SpeechSynthesisConnector = class
 inherit Stream" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IO.Stream</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
SpeechSynthesisConnector can be attached to an AudioVideoFlow, and provides a Stream interface to feed audio data to the flow.
</summary>
<remarks>
<para>The Stream can be given to a SpeechSynthesizer as an output destination, in order to synthesize text over the wire.</para>
<para>SpeechSynthesisConnector should be used only in conjuction with Microsoft.Speech.</para>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SpeechSynthesisConnector ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SpeechSynthesisConnector();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates a new instance of the SpeechSynthesisConnector class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AttachFlow">
<MemberSignature Language="C#" Value="public void AttachFlow (Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoFlow audioVideoFlow);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AttachFlow(class Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoFlow audioVideoFlow) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.AttachFlow(Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoFlow)" />
<MemberSignature Language="C++ CLI" Value="public:
 void AttachFlow(Microsoft::Rtc::Collaboration::AudioVideo::AudioVideoFlow ^ audioVideoFlow);" />
<MemberSignature Language="F#" Value="member this.AttachFlow : Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoFlow -> unit" Usage="speechSynthesisConnector.AttachFlow audioVideoFlow" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="audioVideoFlow" Type="Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoFlow" />
</Parameters>
<Docs>
<param name="audioVideoFlow">The AudioVideoFlow to use</param>
<summary>
Specifies which AudioVideoFlow will provide audio data for speech recognition.
Only one AudioVideoFlow may be bound at a time.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Thrown when an AudioVideoFlow is already attached or when an AudioVideoFlow is already attached to another SpeechSynthesisConnector.</exception>
<example>
<para />
<para>
The following example attaches and detaches a ToneController by the time AudioVideoFlow changes its state to Active and Terminated.
</para>
<para> C# Attaching and detaching an AudioVideoFlow.</para>
<code>
audioVideoFlow.StateChanged += delegate(object sender, MediaFlowStateChangedEventArgs args)
{
AudioVideoFlow avFlow = (AudioVideoFlow)sender;
if(avFlow.State == MediaFlowState.Active)
{
SpeechSynthesisConnector speechSynthesisConnector = new SpeechSynthesisConnector();
speechSynthesisConnector.AttachFlow(avFlow);
}
else if(avFlow.State == MediaFlowState.Terminated)
{
SpeechSynthesisConnector speechSynthesisConnector = new SpeechSynthesisConnector();
speechSynthesisConnector.AttachFlow(avFlow);
}
};
</code>
</example>
</Docs>
</Member>
<Member MemberName="AudioFormat">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.AudioVideo.AudioFormat AudioFormat { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.AudioVideo.AudioFormat AudioFormat" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.AudioFormat" />
<MemberSignature Language="VB.NET" Value="Public Property AudioFormat As AudioFormat" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::AudioVideo::AudioFormat AudioFormat { Microsoft::Rtc::Collaboration::AudioVideo::AudioFormat get(); void set(Microsoft::Rtc::Collaboration::AudioVideo::AudioFormat value); };" />
<MemberSignature Language="F#" Value="member this.AudioFormat : Microsoft.Rtc.Collaboration.AudioVideo.AudioFormat with get, set" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.AudioFormat" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.AudioVideo.AudioFormat</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the desired AudioFormat.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AudioVideoFlow">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoFlow AudioVideoFlow { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoFlow AudioVideoFlow" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.AudioVideoFlow" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AudioVideoFlow As AudioVideoFlow" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::AudioVideo::AudioVideoFlow ^ AudioVideoFlow { Microsoft::Rtc::Collaboration::AudioVideo::AudioVideoFlow ^ get(); };" />
<MemberSignature Language="F#" Value="member this.AudioVideoFlow : Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoFlow" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.AudioVideoFlow" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoFlow</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the attached AudioVideoFlow.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BeginRead">
<MemberSignature Language="C#" Value="public override IAsyncResult BeginRead (byte[] buffer, int offset, int count, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IAsyncResult BeginRead(unsigned int8[] buffer, int32 offset, int32 count, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function BeginRead (buffer As Byte(), offset As Integer, count As Integer, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="C++ CLI" Value="public:
 override IAsyncResult ^ BeginRead(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);" />
<MemberSignature Language="F#" Value="override this.BeginRead : byte[] * int * int * AsyncCallback * obj -> IAsyncResult" Usage="speechSynthesisConnector.BeginRead (buffer, offset, count, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="buffer">Not applicable.</param>
<param name="offset">Not applicable.</param>
<param name="count">Not applicable.</param>
<param name="callback">Not applicable.</param>
<param name="state">Not applicable.</param>
<summary>
Not supported.
</summary>
<returns>Not applicable.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when this method is called.</exception>
</Docs>
</Member>
<Member MemberName="BeginWrite">
<MemberSignature Language="C#" Value="public override IAsyncResult BeginWrite (byte[] buffer, int offset, int count, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IAsyncResult BeginWrite(unsigned int8[] buffer, int32 offset, int32 count, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function BeginWrite (buffer As Byte(), offset As Integer, count As Integer, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="C++ CLI" Value="public:
 override IAsyncResult ^ BeginWrite(cli::array <System::Byte> ^ buffer, int offset, int count, AsyncCallback ^ callback, System::Object ^ state);" />
<MemberSignature Language="F#" Value="override this.BeginWrite : byte[] * int * int * AsyncCallback * obj -> IAsyncResult" Usage="speechSynthesisConnector.BeginWrite (buffer, offset, count, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="buffer">Not applicable.</param>
<param name="offset">Not applicable.</param>
<param name="count">Not applicable.</param>
<param name="callback">Not applicable.</param>
<param name="state">Not applicable.</param>
<summary>
Not supported.
</summary>
<returns>Not applicable.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when this method is called.</exception>
</Docs>
</Member>
<Member MemberName="CanRead">
<MemberSignature Language="C#" Value="public override bool CanRead { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanRead" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.CanRead" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanRead As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanRead { bool get(); };" />
<MemberSignature Language="F#" Value="member this.CanRead : bool" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.CanRead" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets whether the current stream supports reading. This property always returns false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanSeek">
<MemberSignature Language="C#" Value="public override bool CanSeek { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanSeek" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.CanSeek" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanSeek As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanSeek { bool get(); };" />
<MemberSignature Language="F#" Value="member this.CanSeek : bool" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.CanSeek" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets whether the current stream supports seeking. This property always returns false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanTimeout">
<MemberSignature Language="C#" Value="public override bool CanTimeout { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.CanTimeout" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanTimeout As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanTimeout { bool get(); };" />
<MemberSignature Language="F#" Value="member this.CanTimeout : bool" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.CanTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets whether the current stream can time out. This property always returns false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanWrite">
<MemberSignature Language="C#" Value="public override bool CanWrite { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanWrite" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.CanWrite" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanWrite As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanWrite { bool get(); };" />
<MemberSignature Language="F#" Value="member this.CanWrite : bool" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.CanWrite" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets whether the current stream supports writing. This property always returns true.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DetachFlow">
<MemberSignature Language="C#" Value="public void DetachFlow ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DetachFlow() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.DetachFlow" />
<MemberSignature Language="VB.NET" Value="Public Sub DetachFlow ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void DetachFlow();" />
<MemberSignature Language="F#" Value="member this.DetachFlow : unit -> unit" Usage="speechSynthesisConnector.DetachFlow " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Detaches the current AudioVideoFlow, freeing the connector to use another.
</summary>
<remarks>
<para>Will NO-OP if no flow is attached.</para>
<para />
</remarks>
<example>
<para />
<para>
The following example attaches and detaches a SpeechSynthesisConnector by the time AudioVideoFlow changes its state to Active and Terminated.
</para>
<para> C# Attaching and detaching an AudioVideoFlow.</para>
<code>
audioVideoFlow.StateChanged += delegate(object sender, MediaFlowStateChangedEventArgs args)
{
AudioVideoFlow avFlow = (AudioVideoFlow)sender;
if(avFlow.State == MediaFlowState.Active)
{
SpeechSynthesisConnector speechSynthesisConnector = new SpeechSynthesisConnector();
speechSynthesisConnector.AttachFlow(avFlow);
}
else if(avFlow.State == MediaFlowState.Terminated)
{
if (avFlow.SpeechSynthesisConnector != null)
{
avFlow.SpeechSynthesisConnector.DetachFlow();
}
}
};
</code>
</example>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool explicitDispose);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool explicitDispose) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Dispose (explicitDispose As Boolean)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void Dispose(bool explicitDispose);" />
<MemberSignature Language="F#" Value="override this.Dispose : bool -> unit" Usage="speechSynthesisConnector.Dispose explicitDispose" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="explicitDispose" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="explicitDispose">true if the app called Dispose(), false if this is finalization</param>
<summary>
Dispose
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndRead">
<MemberSignature Language="C#" Value="public override int EndRead (IAsyncResult asyncResult);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 EndRead(class System.IAsyncResult asyncResult) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.EndRead(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function EndRead (asyncResult As IAsyncResult) As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 override int EndRead(IAsyncResult ^ asyncResult);" />
<MemberSignature Language="F#" Value="override this.EndRead : IAsyncResult -> int" Usage="speechSynthesisConnector.EndRead asyncResult" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="asyncResult">Not applicable.</param>
<summary>
Not supported.
</summary>
<returns>Not applicable.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when this method is called.</exception>
</Docs>
</Member>
<Member MemberName="EndWrite">
<MemberSignature Language="C#" Value="public override void EndWrite (IAsyncResult asyncResult);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void EndWrite(class System.IAsyncResult asyncResult) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.EndWrite(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub EndWrite (asyncResult As IAsyncResult)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void EndWrite(IAsyncResult ^ asyncResult);" />
<MemberSignature Language="F#" Value="override this.EndWrite : IAsyncResult -> unit" Usage="speechSynthesisConnector.EndWrite asyncResult" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncResult" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="asyncResult">Not applicable.</param>
<summary>
Not supported.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when this method is called.</exception>
</Docs>
</Member>
<Member MemberName="ExpectedAudioFormat">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.AudioVideo.AudioFormat ExpectedAudioFormat { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.AudioVideo.AudioFormat ExpectedAudioFormat" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.ExpectedAudioFormat" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExpectedAudioFormat As AudioFormat" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::AudioVideo::AudioFormat ExpectedAudioFormat { Microsoft::Rtc::Collaboration::AudioVideo::AudioFormat get(); };" />
<MemberSignature Language="F#" Value="member this.ExpectedAudioFormat : Microsoft.Rtc.Collaboration.AudioVideo.AudioFormat" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.ExpectedAudioFormat" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("ExpectedAudioFormat is obsolete, use AudioFormat property instead.")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.AudioVideo.AudioFormat</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the format in which SpeechSynthesisConnector expects audio data to be written to the stream.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="C#" Value="public override void Flush ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Flush() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Flush" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Flush ()" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Flush();" />
<MemberSignature Language="F#" Value="override this.Flush : unit -> unit" Usage="speechSynthesisConnector.Flush " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
</summary>
<remarks>
<para>This method is a NO-OP.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="IsActive">
<MemberSignature Language="C#" Value="public bool IsActive { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsActive" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.IsActive" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsActive As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsActive { bool get(); };" />
<MemberSignature Language="F#" Value="member this.IsActive : bool" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.IsActive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets whether the SpeechSynthesisConnector is currently started.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public override long Length { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Length" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Length" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Length As Long" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property long Length { long get(); };" />
<MemberSignature Language="F#" Value="member this.Length : int64" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Length" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Not supported. Gets the length of the stream in bytes.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when an attempt is made to get the length.</exception>
</Docs>
</Member>
<Member MemberName="Position">
<MemberSignature Language="C#" Value="public override long Position { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Position" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Position" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property Position As Long" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property long Position { long get(); void set(long value); };" />
<MemberSignature Language="F#" Value="member this.Position : int64 with get, set" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Position" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the position within the current stream. Setting this property is not supported.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ObjectDisposedException">Thrown when the stream has been disposed.</exception>
<exception cref="T:System.NotSupportedException">Thrown when an attempt is made to set the position in the stream.</exception>
</Docs>
</Member>
<Member MemberName="Read">
<MemberSignature Language="C#" Value="public override int Read (byte[] buffer, int offset, int count);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 Read(unsigned int8[] buffer, int32 offset, int32 count) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Read(System.Byte[],System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Read (buffer As Byte(), offset As Integer, count As Integer) As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 override int Read(cli::array <System::Byte> ^ buffer, int offset, int count);" />
<MemberSignature Language="F#" Value="override this.Read : byte[] * int * int -> int" Usage="speechSynthesisConnector.Read (buffer, offset, count)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<param name="buffer">Not applicable.</param>
<param name="offset">Not applicable.</param>
<param name="count">Not applicable.</param>
<summary>
Not supported. Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes.
</summary>
<returns>Not applicable.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when this method is called.</exception>
</Docs>
</Member>
<Member MemberName="ReadByte">
<MemberSignature Language="C#" Value="public override int ReadByte ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 ReadByte() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.ReadByte" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ReadByte () As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 override int ReadByte();" />
<MemberSignature Language="F#" Value="override this.ReadByte : unit -> int" Usage="speechSynthesisConnector.ReadByte " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Not supported.
</summary>
<returns>Not applicable.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when this method is called.</exception>
</Docs>
</Member>
<Member MemberName="ReadTimeout">
<MemberSignature Language="C#" Value="public override int ReadTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ReadTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.ReadTimeout" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property ReadTimeout As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property int ReadTimeout { int get(); void set(int value); };" />
<MemberSignature Language="F#" Value="member this.ReadTimeout : int with get, set" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.ReadTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Not supported. Gets or sets how long the stream will attempt to read before timing out.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when an attempt is made to get or set this property.</exception>
</Docs>
</Member>
<Member MemberName="Seek">
<MemberSignature Language="C#" Value="public override long Seek (long offset, System.IO.SeekOrigin origin);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int64 Seek(int64 offset, valuetype System.IO.SeekOrigin origin) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Seek(System.Int64,System.IO.SeekOrigin)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Seek (offset As Long, origin As SeekOrigin) As Long" />
<MemberSignature Language="C++ CLI" Value="public:
 override long Seek(long offset, System::IO::SeekOrigin origin);" />
<MemberSignature Language="F#" Value="override this.Seek : int64 * System.IO.SeekOrigin -> int64" Usage="speechSynthesisConnector.Seek (offset, origin)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="offset" Type="System.Int64" />
<Parameter Name="origin" Type="System.IO.SeekOrigin" />
</Parameters>
<Docs>
<param name="offset">Not supported.</param>
<param name="origin">Not supported.</param>
<summary>
Not supported. Sets the position within the current stream.
</summary>
<returns>Not applicable.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when this method is called.</exception>
</Docs>
</Member>
<Member MemberName="SetLength">
<MemberSignature Language="C#" Value="public override void SetLength (long value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void SetLength(int64 value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.SetLength(System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub SetLength (value As Long)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void SetLength(long value);" />
<MemberSignature Language="F#" Value="override this.SetLength : int64 -> unit" Usage="speechSynthesisConnector.SetLength value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int64" />
</Parameters>
<Docs>
<param name="value">value. Not supported</param>
<summary>
Not supported. Sets the length of the current stream.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when this method is called.</exception>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public void Start ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Start() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Start" />
<MemberSignature Language="VB.NET" Value="Public Sub Start ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void Start();" />
<MemberSignature Language="F#" Value="member this.Start : unit -> unit" Usage="speechSynthesisConnector.Start " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Prepares the connector to accept input from the SpeechSynthesizer and transmit it to the AudioVideoFlow.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Thrown when the SpeechSynthesisConnector is already started.</exception>
<example>
<para />
<para>
The following example starts the SpeechSynthesizerConnector.
</para>
<para> C# Starting a SpeechSynthesizerConnector.</para>
<code>
// connector needs to be set to Microsoft.Speech.SpeechSpeechSynthesizer
speechSynthesisConnector.AttachFlow(audioVideoFlow);
speechSynthesisConnector.Start();
speechSynthesisConnector.Stop();
</code>
</example>
</Docs>
</Member>
<Member MemberName="Stop">
<MemberSignature Language="C#" Value="public void Stop ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Stop" />
<MemberSignature Language="VB.NET" Value="Public Sub Stop ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void Stop();" />
<MemberSignature Language="F#" Value="member this.Stop : unit -> unit" Usage="speechSynthesisConnector.Stop " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Stops sending data to the AudioVideoFlow.
</summary>
<remarks>
<para>Will no-op if SpeechSynthesisConnector is already stopped, or is not attached to an AudioVideoFlow.</para>
<para />
</remarks>
<example>
<para />
<para>
The following example starts and stops the SpeechSynthesizerConnector.
</para>
<para> C# Starting and stopping a SpeechSynthesizerConnector.</para>
<code>
// connector needs to be set to Microsoft.Speech.SpeechSpeechSynthesizer
speechSynthesisConnector.AttachFlow(audioVideoFlow);
speechSynthesisConnector.Start();
speechSynthesisConnector.Stop();
</code>
</example>
</Docs>
</Member>
<Member MemberName="Stream">
<MemberSignature Language="C#" Value="public System.IO.Stream Stream { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IO.Stream Stream" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Stream" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Stream As Stream" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IO::Stream ^ Stream { System::IO::Stream ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Stream : System.IO.Stream" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Stream" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the stream corresponding to this connector, for use as a parameter to SpeechSynthesizer.SetOutputToAudioStream().
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (byte[] buffer, int offset, int count);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(unsigned int8[] buffer, int32 offset, int32 count) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.Write(System.Byte[],System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (buffer As Byte(), offset As Integer, count As Integer)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Write(cli::array <System::Byte> ^ buffer, int offset, int count);" />
<MemberSignature Language="F#" Value="override this.Write : byte[] * int * int -> unit" Usage="speechSynthesisConnector.Write (buffer, offset, count)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<param name="buffer">An array of bytes. This method copies count bytes from buffer to the current stream.</param>
<param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current stream.</param>
<param name="count">The number of bytes to be written to the current stream.</param>
<summary>
Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
Blocks until the data has been (almost) sent on the wire.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">Thrown when the sum of offset and count is larger than the buffer length.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when offset or count is negative.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown when the stream was already closed.</exception>
<exception cref="T:System.ArgumentNullException">Thrown when buffer is null.</exception>
<exception cref="T:System.InvalidOperationException">Thrown when the connector is not attached to a flow, or is not active, or has been suspended.</exception>
<exception cref="T:System.IO.EndOfStreamException">Thrown when the connector is stopped.</exception>
</Docs>
</Member>
<Member MemberName="WriteByte">
<MemberSignature Language="C#" Value="public override void WriteByte (byte value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void WriteByte(unsigned int8 value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.WriteByte(System.Byte)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub WriteByte (value As Byte)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void WriteByte(System::Byte value);" />
<MemberSignature Language="F#" Value="override this.WriteByte : byte -> unit" Usage="speechSynthesisConnector.WriteByte value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Byte" />
</Parameters>
<Docs>
<param name="value">Not applicable.</param>
<summary>
Not supported.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when this method is called.</exception>
</Docs>
</Member>
<Member MemberName="WriteTimeout">
<MemberSignature Language="C#" Value="public override int WriteTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 WriteTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.WriteTimeout" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property WriteTimeout As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property int WriteTimeout { int get(); void set(int value); };" />
<MemberSignature Language="F#" Value="member this.WriteTimeout : int with get, set" Usage="Microsoft.Rtc.Collaboration.AudioVideo.SpeechSynthesisConnector.WriteTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Not supported. Gets or sets how long the stream will attempt to write before timing out.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">Thrown when an attempt is made to get or set this property.</exception>
</Docs>
</Member>
</Members>
</Type>