-
Notifications
You must be signed in to change notification settings - Fork 256
/
IVideosOperations.xml
1004 lines (1004 loc) · 81.4 KB
/
IVideosOperations.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
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
<Type Name="IVideosOperations" FullName="Microsoft.Azure.CognitiveServices.Search.VideoSearch.IVideosOperations">
<TypeSignature Language="C#" Value="public interface IVideosOperations" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IVideosOperations" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Search.VideoSearch.IVideosOperations" />
<TypeSignature Language="VB.NET" Value="Public Interface IVideosOperations" />
<TypeSignature Language="F#" Value="type IVideosOperations = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.VideoSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
VideosOperations operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="DetailsWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoDetails>> DetailsWithHttpMessagesAsync (string query, string acceptLanguage = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string countryCode = default, string id = default, System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoInsightModule?> modules = default, string market = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution? resolution = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch? safeSearch = default, string setLang = default, bool? textDecorations = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat? textFormat = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoDetails>> DetailsWithHttpMessagesAsync(string query, string acceptLanguage, string userAgent, string clientId, string clientIp, string location, string countryCode, string id, class System.Collections.Generic.IList`1<valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoInsightModule>> modules, string market, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution> resolution, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch> safeSearch, string setLang, valuetype System.Nullable`1<bool> textDecorations, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat> textFormat, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.VideoSearch.IVideosOperations.DetailsWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Collections.Generic.IList{System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoInsightModule}},System.String,System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution},System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch},System.String,System.Nullable{System.Boolean},System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function DetailsWithHttpMessagesAsync (query As String, Optional acceptLanguage As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional countryCode As String = Nothing, Optional id As String = Nothing, Optional modules As IList(Of Nullable(Of VideoInsightModule)) = Nothing, Optional market As String = Nothing, Optional resolution As Nullable(Of VideoResolution) = Nothing, Optional safeSearch As Nullable(Of SafeSearch) = Nothing, Optional setLang As String = Nothing, Optional textDecorations As Nullable(Of Boolean) = Nothing, Optional textFormat As Nullable(Of TextFormat) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of VideoDetails))" />
<MemberSignature Language="F#" Value="abstract member DetailsWithHttpMessagesAsync : string * string * string * string * string * string * string * string * System.Collections.Generic.IList<Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoInsightModule>> * string * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch> * string * Nullable<bool> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoDetails>>" Usage="iVideosOperations.DetailsWithHttpMessagesAsync (query, acceptLanguage, userAgent, clientId, clientIp, location, countryCode, id, modules, market, resolution, safeSearch, setLang, textDecorations, textFormat, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.VideoSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="query" Type="System.String" />
<Parameter Name="acceptLanguage" Type="System.String" />
<Parameter Name="userAgent" Type="System.String" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="clientIp" Type="System.String" />
<Parameter Name="location" Type="System.String" />
<Parameter Name="countryCode" Type="System.String" />
<Parameter Name="id" Type="System.String" />
<Parameter Name="modules" Type="System.Collections.Generic.IList<System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoInsightModule>>" />
<Parameter Name="market" Type="System.String" />
<Parameter Name="resolution" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution>" />
<Parameter Name="safeSearch" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch>" />
<Parameter Name="setLang" Type="System.String" />
<Parameter Name="textDecorations" Type="System.Nullable<System.Boolean>" />
<Parameter Name="textFormat" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat>" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="query">
The user's search query string. The query string cannot be empty.
The query string may contain [Bing Advanced
Operators](http://msdn.microsoft.com/library/ff795620.aspx). For
example, to limit videos to a specific domain, use the
[site:](http://msdn.microsoft.com/library/ff795613.aspx) operator.
Use this parameter only with the Video Search API. Do not specify
this parameter when calling the Trending Videos API.
</param>
<param name="acceptLanguage">
A comma-delimited list of one or more languages to use for user
interface strings. The list is in decreasing order of preference.
For additional information, including expected format, see
[RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
This header and the
[setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#setlang)
query parameter are mutually exclusive; do not specify both. If you
set this header, you must also specify the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#cc)
query parameter. To determine the market to return results for,
Bing uses the first supported language it finds from the list and
combines it with the cc parameter value. If the list does not
include a supported language, Bing finds the closest language and
market that supports the request or it uses an aggregated or
default market for the results. To determine the market that Bing
used, see the BingAPIs-Market header. Use this header and the cc
query parameter only if you specify multiple languages. Otherwise,
use the
[mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#mkt)
and
[setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#setlang)
query parameters. A user interface string is a string that's used
as a label in a user interface. There are few user interface
strings in the JSON response objects. Any links to Bing.com
properties in the response objects apply the specified language.
</param>
<param name="userAgent">
The user agent originating the request. Bing uses the user agent to
provide mobile users with an optimized experience. Although
optional, you are encouraged to always specify this header. The
user-agent should be the same string that any commonly used browser
sends. For information about user agents, see [RFC
2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
following are examples of user-agent strings. Windows Phone:
Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0;
IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla /
5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build /
GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0
Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS
6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile
/ 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
(Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko.
iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit /
537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari /
9537.53
</param>
<param name="clientId">
Bing uses this header to provide users with consistent behavior
across Bing API calls. Bing often flights new features and
improvements, and it uses the client ID as a key for assigning
traffic on different flights. If you do not use the same client ID
for a user across multiple requests, then Bing may assign the user
to multiple conflicting flights. Being assigned to multiple
conflicting flights can lead to an inconsistent user experience.
For example, if the second request has a different flight
assignment than the first, the experience may be unexpected. Also,
Bing can use the client ID to tailor web results to that client
ID’s search history, providing a richer experience for the user.
Bing also uses this header to help improve result rankings by
analyzing the activity generated by a client ID. The relevance
improvements help with better quality of results delivered by Bing
APIs and in turn enables higher click-through rates for the API
consumer. IMPORTANT: Although optional, you should consider this
header required. Persisting the client ID across multiple requests
for the same end user and device combination enables 1) the API
consumer to receive a consistent user experience, and 2) higher
click-through rates via better quality of results from the Bing
APIs. Each user that uses your application on the device must have
a unique, Bing generated client ID. If you do not include this
header in the request, Bing generates an ID and returns it in the
X-MSEdge-ClientID response header. The only time that you should
NOT include this header in a request is the first time the user
uses your app on that device. Use the client ID for each Bing API
request that your app makes for this user on the device. Persist
the client ID. To persist the ID in a browser app, use a persistent
HTTP cookie to ensure the ID is used across all sessions. Do not
use a session cookie. For other apps such as mobile apps, use the
device's persistent storage to persist the ID. The next time the
user uses your app on that device, get the client ID that you
persisted. Bing responses may or may not include this header. If
the response includes this header, capture the client ID and use it
for all subsequent Bing requests for the user on that device. If
you include the X-MSEdge-ClientID, you must not include cookies in
the request.
</param>
<param name="clientIp">
The IPv4 or IPv6 address of the client device. The IP address is
used to discover the user's location. Bing uses the location
information to determine safe search behavior. Although optional,
you are encouraged to always specify this header and the
X-Search-Location header. Do not obfuscate the address (for
example, by changing the last octet to 0). Obfuscating the address
results in the location not being anywhere near the device's actual
location, which may result in Bing serving erroneous results.
</param>
<param name="location">
A semicolon-delimited list of key/value pairs that describe the
client's geographical location. Bing uses the location information
to determine safe search behavior and to return relevant local
content. Specify the key/value pair as <key>:<value>.
The following are the keys that you use to specify the user's
location. lat (required): The latitude of the client's location, in
degrees. The latitude must be greater than or equal to -90.0 and
less than or equal to +90.0. Negative values indicate southern
latitudes and positive values indicate northern latitudes. long
(required): The longitude of the client's location, in degrees. The
longitude must be greater than or equal to -180.0 and less than or
equal to +180.0. Negative values indicate western longitudes and
positive values indicate eastern longitudes. re (required): The
radius, in meters, which specifies the horizontal accuracy of the
coordinates. Pass the value returned by the device's location
service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell
tower triangulation, and 18,000m for reverse IP lookup. ts
(optional): The UTC UNIX timestamp of when the client was at the
location. (The UNIX timestamp is the number of seconds since
January 1, 1970.) head (optional): The client's relative heading or
direction of travel. Specify the direction of travel as degrees
from 0 through 360, counting clockwise relative to true north.
Specify this key only if the sp key is nonzero. sp (optional): The
horizontal velocity (speed), in meters per second, that the client
device is traveling. alt (optional): The altitude of the client
device, in meters. are (optional): The radius, in meters, that
specifies the vertical accuracy of the coordinates. Specify this
key only if you specify the alt key. Although many of the keys are
optional, the more information that you provide, the more accurate
the location results are. Although optional, you are encouraged to
always specify the user's geographical location. Providing the
location is especially important if the client's IP address does
not accurately reflect the user's physical location (for example,
if the client uses VPN). For optimal results, you should include
this header and the X-MSEdge-ClientIP header, but at a minimum, you
should include this header.
</param>
<param name="countryCode">
A 2-character country code of the country where the results come
from. This API supports only the United States market. If you
specify this query parameter, it must be set to us. If you set this
parameter, you must also specify the Accept-Language header. Bing
uses the first supported language it finds from the languages list,
and combine that language with the country code that you specify to
determine the market to return results for. If the languages list
does not include a supported language, Bing finds the closest
language and market that supports the request, or it may use an
aggregated or default market for the results instead of a specified
one. You should use this query parameter and the Accept-Language
query parameter only if you specify multiple languages; otherwise,
you should use the mkt and setLang query parameters. This parameter
and the mkt query parameter are mutually exclusive—do not specify
both.
</param>
<param name="id">
An ID that uniquely identifies a video. The
[Video](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#video)
object's videoId field contains the ID that you set this parameter
to. You use this parameter to identify the video to get insights
of.
</param>
<param name="modules">
A comma-delimited list of insights to request. The following are
the possible case-insensitive values. All: Return all available
insights. RelatedVideos: Return a list of videos that are similar
to the video specified by the id query parameter. VideoResult:
Return the video that you're requesting insights of (this is the
video that you set the id query parameter to in your insights
request). If you specify an insight and there is no data for it,
the response object does not include the related field. For
example, if you specify RelatedVideos and none exist, the response
does not include the relatedVideos field. Although the user's query
term is not required, you should always include it because it helps
to improve relevance and the results.
</param>
<param name="market">
The market where the results come from. Typically, mkt is the
country where the user is making the request from. However, it
could be a different country if the user is not located in a
country where Bing delivers results. The market must be in the form
<language code>-<country code>. For example, en-US. The
string is case insensitive. For a list of possible market values,
see [Market
Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#market-codes).
NOTE: If known, you are encouraged to always specify the market.
Specifying the market helps Bing route the request and return an
appropriate and optimal response. If you specify a market that is
not listed in [Market
Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#market-codes),
Bing uses a best fit market code based on an internal mapping that
is subject to change. This parameter and the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#cc)
query parameter are mutually exclusive—do not specify both.
</param>
<param name="resolution">
Filter videos by the following resolutions: SD480p: Return videos
with a 480p or higher resolution. HD720p: Return videos with a 720p
or higher resolution. HD1080p: Return videos with a 1080p or higher
resolution. All: Do not filter by resolution.Specifying this value
is the same as not specifying the resolution parameter. Possible
values include: 'All', 'SD480p', 'HD720p', 'HD1080p'
</param>
<param name="safeSearch">
Filter videos for adult content. The following are the possible
filter values. Off: If the request is through the Video Search API,
the response includes adult videos and the thumbnail images of the
videos are clear (non-fuzzy). If the request is through the Web
Search API, the response includes adult videos but the thumbnail
images of the videos are pixelated (fuzzy). Moderate: If the
request is through the Video Search API, the response does not
include videos with adult content. If the request is through the
Web Search API, the response may include videos with adult content
but the thumbnail images of the videos are pixelated (fuzzy).
Strict: Does not return videos with adult content. The default is
Moderate. If the request comes from a market that Bing's adult
policy requires that safeSearch is set to Strict, Bing ignores the
safeSearch value and uses Strict. If you use the site: query
operator, there is the chance that the response may contain adult
content regardless of what the safeSearch query parameter is set
to. Use site: only if you are aware of the content on the site and
your scenario supports the possibility of adult content. Possible
values include: 'Off', 'Moderate', 'Strict'
</param>
<param name="setLang">
The language to use for user interface strings. Specify the
language using the ISO 639-1 2-letter language code. For example,
the language code for English is EN. The default is EN (English).
Although optional, you should always specify the language.
Typically, you set setLang to the same language specified by mkt
unless the user wants the user interface strings displayed in a
different language. This parameter and the
[Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#acceptlanguage)
header are mutually exclusive; do not specify both. A user
interface string is a string that's used as a label in a user
interface. There are few user interface strings in the JSON
response objects. Also, any links to Bing.com properties in the
response objects apply the specified language.
</param>
<param name="textDecorations">
A Boolean value that determines whether display strings contain
decoration markers such as hit highlighting characters. If true,
the strings may include markers. The default is false. To specify
whether to use Unicode characters or HTML tags as the markers, see
the
[textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#textformat)
query parameter. For information about hit highlighting, see [Hit
Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
</param>
<param name="textFormat">
The type of markers to use for text decorations (see the
textDecorations query parameter). Possible values are Raw—Use
Unicode characters to mark content that needs special formatting.
The Unicode characters are in the range E000 through E019. For
example, Bing uses E000 and E001 to mark the beginning and end of
query terms for hit highlighting. HTML—Use HTML tags to mark
content that needs special formatting. For example, use <b>
tags to highlight query terms in display strings. The default is
Raw. For display strings that contain escapable HTML characters
such as <, >, and &, if textFormat is set to HTML, Bing
escapes the characters as appropriate (for example, < is escaped
to &lt;). Possible values include: 'Raw', 'Html'
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
The Video Detail Search API lets you search on Bing and get back
insights about a video, such as related videos. This section
provides technical details about the query parameters and headers
that you use to request insights of videos and the JSON response
objects that contain them. For examples that show how to make
requests, see [Searching the Web for
Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.ErrorResponseException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
</Docs>
</Member>
<Member MemberName="SearchWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Videos>> SearchWithHttpMessagesAsync (string query, string acceptLanguage = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string countryCode = default, int? count = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Freshness? freshness = default, string id = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoLength? length = default, string market = default, int? offset = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoPricing? pricing = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution? resolution = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch? safeSearch = default, string setLang = default, bool? textDecorations = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat? textFormat = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Videos>> SearchWithHttpMessagesAsync(string query, string acceptLanguage, string userAgent, string clientId, string clientIp, string location, string countryCode, valuetype System.Nullable`1<int32> count, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Freshness> freshness, string id, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoLength> length, string market, valuetype System.Nullable`1<int32> offset, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoPricing> pricing, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution> resolution, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch> safeSearch, string setLang, valuetype System.Nullable`1<bool> textDecorations, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat> textFormat, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.VideoSearch.IVideosOperations.SearchWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Freshness},System.String,System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoLength},System.String,System.Nullable{System.Int32},System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoPricing},System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution},System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch},System.String,System.Nullable{System.Boolean},System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SearchWithHttpMessagesAsync (query As String, Optional acceptLanguage As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional countryCode As String = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional freshness As Nullable(Of Freshness) = Nothing, Optional id As String = Nothing, Optional length As Nullable(Of VideoLength) = Nothing, Optional market As String = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional pricing As Nullable(Of VideoPricing) = Nothing, Optional resolution As Nullable(Of VideoResolution) = Nothing, Optional safeSearch As Nullable(Of SafeSearch) = Nothing, Optional setLang As String = Nothing, Optional textDecorations As Nullable(Of Boolean) = Nothing, Optional textFormat As Nullable(Of TextFormat) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of Videos))" />
<MemberSignature Language="F#" Value="abstract member SearchWithHttpMessagesAsync : string * string * string * string * string * string * string * Nullable<int> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Freshness> * string * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoLength> * string * Nullable<int> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoPricing> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch> * string * Nullable<bool> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Videos>>" Usage="iVideosOperations.SearchWithHttpMessagesAsync (query, acceptLanguage, userAgent, clientId, clientIp, location, countryCode, count, freshness, id, length, market, offset, pricing, resolution, safeSearch, setLang, textDecorations, textFormat, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.VideoSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Videos>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="query" Type="System.String" />
<Parameter Name="acceptLanguage" Type="System.String" />
<Parameter Name="userAgent" Type="System.String" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="clientIp" Type="System.String" />
<Parameter Name="location" Type="System.String" />
<Parameter Name="countryCode" Type="System.String" />
<Parameter Name="count" Type="System.Nullable<System.Int32>" />
<Parameter Name="freshness" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Freshness>" />
<Parameter Name="id" Type="System.String" />
<Parameter Name="length" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoLength>" />
<Parameter Name="market" Type="System.String" />
<Parameter Name="offset" Type="System.Nullable<System.Int32>" />
<Parameter Name="pricing" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoPricing>" />
<Parameter Name="resolution" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution>" />
<Parameter Name="safeSearch" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch>" />
<Parameter Name="setLang" Type="System.String" />
<Parameter Name="textDecorations" Type="System.Nullable<System.Boolean>" />
<Parameter Name="textFormat" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat>" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="query">
The user's search query string. The query string cannot be empty.
The query string may contain [Bing Advanced
Operators](http://msdn.microsoft.com/library/ff795620.aspx). For
example, to limit videos to a specific domain, use the
[site:](http://msdn.microsoft.com/library/ff795613.aspx) operator.
Use this parameter only with the Video Search API. Do not specify
this parameter when calling the Trending Videos API.
</param>
<param name="acceptLanguage">
A comma-delimited list of one or more languages to use for user
interface strings. The list is in decreasing order of preference.
For additional information, including expected format, see
[RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
This header and the
[setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#setlang)
query parameter are mutually exclusive; do not specify both. If you
set this header, you must also specify the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#cc)
query parameter. To determine the market to return results for,
Bing uses the first supported language it finds from the list and
combines it with the cc parameter value. If the list does not
include a supported language, Bing finds the closest language and
market that supports the request or it uses an aggregated or
default market for the results. To determine the market that Bing
used, see the BingAPIs-Market header. Use this header and the cc
query parameter only if you specify multiple languages. Otherwise,
use the
[mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#mkt)
and
[setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#setlang)
query parameters. A user interface string is a string that's used
as a label in a user interface. There are few user interface
strings in the JSON response objects. Any links to Bing.com
properties in the response objects apply the specified language.
</param>
<param name="userAgent">
The user agent originating the request. Bing uses the user agent to
provide mobile users with an optimized experience. Although
optional, you are encouraged to always specify this header. The
user-agent should be the same string that any commonly used browser
sends. For information about user agents, see [RFC
2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
following are examples of user-agent strings. Windows Phone:
Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0;
IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla /
5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build /
GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0
Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS
6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile
/ 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
(Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko.
iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit /
537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari /
9537.53
</param>
<param name="clientId">
Bing uses this header to provide users with consistent behavior
across Bing API calls. Bing often flights new features and
improvements, and it uses the client ID as a key for assigning
traffic on different flights. If you do not use the same client ID
for a user across multiple requests, then Bing may assign the user
to multiple conflicting flights. Being assigned to multiple
conflicting flights can lead to an inconsistent user experience.
For example, if the second request has a different flight
assignment than the first, the experience may be unexpected. Also,
Bing can use the client ID to tailor web results to that client
ID’s search history, providing a richer experience for the user.
Bing also uses this header to help improve result rankings by
analyzing the activity generated by a client ID. The relevance
improvements help with better quality of results delivered by Bing
APIs and in turn enables higher click-through rates for the API
consumer. IMPORTANT: Although optional, you should consider this
header required. Persisting the client ID across multiple requests
for the same end user and device combination enables 1) the API
consumer to receive a consistent user experience, and 2) higher
click-through rates via better quality of results from the Bing
APIs. Each user that uses your application on the device must have
a unique, Bing generated client ID. If you do not include this
header in the request, Bing generates an ID and returns it in the
X-MSEdge-ClientID response header. The only time that you should
NOT include this header in a request is the first time the user
uses your app on that device. Use the client ID for each Bing API
request that your app makes for this user on the device. Persist
the client ID. To persist the ID in a browser app, use a persistent
HTTP cookie to ensure the ID is used across all sessions. Do not
use a session cookie. For other apps such as mobile apps, use the
device's persistent storage to persist the ID. The next time the
user uses your app on that device, get the client ID that you
persisted. Bing responses may or may not include this header. If
the response includes this header, capture the client ID and use it
for all subsequent Bing requests for the user on that device. If
you include the X-MSEdge-ClientID, you must not include cookies in
the request.
</param>
<param name="clientIp">
The IPv4 or IPv6 address of the client device. The IP address is
used to discover the user's location. Bing uses the location
information to determine safe search behavior. Although optional,
you are encouraged to always specify this header and the
X-Search-Location header. Do not obfuscate the address (for
example, by changing the last octet to 0). Obfuscating the address
results in the location not being anywhere near the device's actual
location, which may result in Bing serving erroneous results.
</param>
<param name="location">
A semicolon-delimited list of key/value pairs that describe the
client's geographical location. Bing uses the location information
to determine safe search behavior and to return relevant local
content. Specify the key/value pair as <key>:<value>.
The following are the keys that you use to specify the user's
location. lat (required): The latitude of the client's location, in
degrees. The latitude must be greater than or equal to -90.0 and
less than or equal to +90.0. Negative values indicate southern
latitudes and positive values indicate northern latitudes. long
(required): The longitude of the client's location, in degrees. The
longitude must be greater than or equal to -180.0 and less than or
equal to +180.0. Negative values indicate western longitudes and
positive values indicate eastern longitudes. re (required): The
radius, in meters, which specifies the horizontal accuracy of the
coordinates. Pass the value returned by the device's location
service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell
tower triangulation, and 18,000m for reverse IP lookup. ts
(optional): The UTC UNIX timestamp of when the client was at the
location. (The UNIX timestamp is the number of seconds since
January 1, 1970.) head (optional): The client's relative heading or
direction of travel. Specify the direction of travel as degrees
from 0 through 360, counting clockwise relative to true north.
Specify this key only if the sp key is nonzero. sp (optional): The
horizontal velocity (speed), in meters per second, that the client
device is traveling. alt (optional): The altitude of the client
device, in meters. are (optional): The radius, in meters, that
specifies the vertical accuracy of the coordinates. Specify this
key only if you specify the alt key. Although many of the keys are
optional, the more information that you provide, the more accurate
the location results are. Although optional, you are encouraged to
always specify the user's geographical location. Providing the
location is especially important if the client's IP address does
not accurately reflect the user's physical location (for example,
if the client uses VPN). For optimal results, you should include
this header and the X-MSEdge-ClientIP header, but at a minimum, you
should include this header.
</param>
<param name="countryCode">
A 2-character country code of the country where the results come
from. This API supports only the United States market. If you
specify this query parameter, it must be set to us. If you set this
parameter, you must also specify the Accept-Language header. Bing
uses the first supported language it finds from the languages list,
and combine that language with the country code that you specify to
determine the market to return results for. If the languages list
does not include a supported language, Bing finds the closest
language and market that supports the request, or it may use an
aggregated or default market for the results instead of a specified
one. You should use this query parameter and the Accept-Language
query parameter only if you specify multiple languages; otherwise,
you should use the mkt and setLang query parameters. This parameter
and the mkt query parameter are mutually exclusive—do not specify
both.
</param>
<param name="count">
The number of videos to return in the response. The actual number
delivered may be less than requested. The default is 35. The
maximum is 105. You may use this parameter along with the offset
parameter to page results. For example, if your user interface
presents 20 videos per page, set count to 20 and offset to 0 to get
the first page of results. For each subsequent page, increment
offset by 20 (for example, 0, 20, 40). Use this parameter only with
the Video Search API. Do not specify this parameter when calling
the Trending Videos API or the Web Search API.
</param>
<param name="freshness">
Filter videos by the date and time that Bing discovered the video.
The following are the possible filter values. Day: Return videos
discovered within the last 24 hours. Week: Return videos discovered
within the last 7 days. Month: Return videos discovered within the
last 30 days. Possible values include: 'Day', 'Week', 'Month'
</param>
<param name="id">
An ID that uniquely identifies a video. The
[Video](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#video)
object's videoId field contains the ID that you set this parameter
to. You use this parameter to ensure that the specified video is
the first video in the list of videos that Bing returns.
</param>
<param name="length">
Filter videos by the following lengths: Short: Return videos that
are less than 5 minutes. Medium: Return videos that are between 5
and 20 minutes, inclusive. Long: Return videos that are longer than
20 minutes. All: Do not filter by length.Specifying this value is
the same as not specifying the videoLength parameter. Possible
values include: 'All', 'Short', 'Medium', 'Long'
</param>
<param name="market">
The market where the results come from. Typically, mkt is the
country where the user is making the request from. However, it
could be a different country if the user is not located in a
country where Bing delivers results. The market must be in the form
<language code>-<country code>. For example, en-US. The
string is case insensitive. For a list of possible market values,
see [Market
Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#market-codes).
NOTE: If known, you are encouraged to always specify the market.
Specifying the market helps Bing route the request and return an
appropriate and optimal response. If you specify a market that is
not listed in [Market
Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#market-codes),
Bing uses a best fit market code based on an internal mapping that
is subject to change. This parameter and the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#cc)
query parameter are mutually exclusive—do not specify both.
</param>
<param name="offset">
The zero-based offset that indicates the number of videos to skip
before returning videos. The default is 0. The offset should be
less than
([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#videos-totalmatches)
- count). Use this parameter along with the count parameter to page
results. For example, if your user interface displays 20 videos per
page, set count to 20 and offset to 0 to get the first page of
results. For each subsequent page, increment offset by 20 (for
example, 0, 20, 40). It is possible for multiple pages to include
some overlap in results. To prevent duplicates, see
[nextOffset](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#videos-nextoffset).
Use this parameter only with the Video Search API.
</param>
<param name="pricing">
Filter videos by the following pricing options: Free: Return videos
that are free to view. Paid: Return videos that require a
subscription or payment to view. All: Do not filter by
pricing.Specifying this value is the same as not specifying the
pricing parameter. Possible values include: 'All', 'Free', 'Paid'
</param>
<param name="resolution">
Filter videos by the following resolutions: SD480p: Return videos
with a 480p or higher resolution. HD720p: Return videos with a 720p
or higher resolution. HD1080p: Return videos with a 1080p or higher
resolution. All: Do not filter by resolution.Specifying this value
is the same as not specifying the resolution parameter. Possible
values include: 'All', 'SD480p', 'HD720p', 'HD1080p'
</param>
<param name="safeSearch">
Filter videos for adult content. The following are the possible
filter values. Off: If the request is through the Video Search API,
the response includes adult videos and the thumbnail images of the
videos are clear (non-fuzzy). If the request is through the Web
Search API, the response includes adult videos but the thumbnail
images of the videos are pixelated (fuzzy). Moderate: If the
request is through the Video Search API, the response does not
include videos with adult content. If the request is through the
Web Search API, the response may include videos with adult content
but the thumbnail images of the videos are pixelated (fuzzy).
Strict: Does not return videos with adult content. The default is
Moderate. If the request comes from a market that Bing's adult
policy requires that safeSearch is set to Strict, Bing ignores the
safeSearch value and uses Strict. If you use the site: query
operator, there is the chance that the response may contain adult
content regardless of what the safeSearch query parameter is set
to. Use site: only if you are aware of the content on the site and
your scenario supports the possibility of adult content. Possible
values include: 'Off', 'Moderate', 'Strict'
</param>
<param name="setLang">
The language to use for user interface strings. Specify the
language using the ISO 639-1 2-letter language code. For example,
the language code for English is EN. The default is EN (English).
Although optional, you should always specify the language.
Typically, you set setLang to the same language specified by mkt
unless the user wants the user interface strings displayed in a
different language. This parameter and the
[Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#acceptlanguage)
header are mutually exclusive; do not specify both. A user
interface string is a string that's used as a label in a user
interface. There are few user interface strings in the JSON
response objects. Also, any links to Bing.com properties in the
response objects apply the specified language.
</param>
<param name="textDecorations">
A Boolean value that determines whether display strings contain
decoration markers such as hit highlighting characters. If true,
the strings may include markers. The default is false. To specify
whether to use Unicode characters or HTML tags as the markers, see
the
[textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#textformat)
query parameter. For information about hit highlighting, see [Hit
Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
</param>
<param name="textFormat">
The type of markers to use for text decorations (see the
textDecorations query parameter). Possible values are Raw—Use
Unicode characters to mark content that needs special formatting.
The Unicode characters are in the range E000 through E019. For
example, Bing uses E000 and E001 to mark the beginning and end of
query terms for hit highlighting. HTML—Use HTML tags to mark
content that needs special formatting. For example, use <b>
tags to highlight query terms in display strings. The default is
Raw. For display strings that contain escapable HTML characters
such as <, >, and &, if textFormat is set to HTML, Bing
escapes the characters as appropriate (for example, < is escaped
to &lt;). Possible values include: 'Raw', 'Html'
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
The Video Search API lets you send a search query to Bing and get
back a list of videos that are relevant to the search query. This
section provides technical details about the query parameters and
headers that you use to request videos and the JSON response
objects that contain them. For examples that show how to make
requests, see [Searching the Web for
Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.ErrorResponseException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
</Docs>
</Member>
<Member MemberName="TrendingWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TrendingVideos>> TrendingWithHttpMessagesAsync (string acceptLanguage = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string countryCode = default, string market = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch? safeSearch = default, string setLang = default, bool? textDecorations = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat? textFormat = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TrendingVideos>> TrendingWithHttpMessagesAsync(string acceptLanguage, string userAgent, string clientId, string clientIp, string location, string countryCode, string market, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch> safeSearch, string setLang, valuetype System.Nullable`1<bool> textDecorations, valuetype System.Nullable`1<valuetype Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat> textFormat, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.VideoSearch.IVideosOperations.TrendingWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch},System.String,System.Nullable{System.Boolean},System.Nullable{Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function TrendingWithHttpMessagesAsync (Optional acceptLanguage As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional countryCode As String = Nothing, Optional market As String = Nothing, Optional safeSearch As Nullable(Of SafeSearch) = Nothing, Optional setLang As String = Nothing, Optional textDecorations As Nullable(Of Boolean) = Nothing, Optional textFormat As Nullable(Of TextFormat) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of TrendingVideos))" />
<MemberSignature Language="F#" Value="abstract member TrendingWithHttpMessagesAsync : string * string * string * string * string * string * string * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch> * string * Nullable<bool> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TrendingVideos>>" Usage="iVideosOperations.TrendingWithHttpMessagesAsync (acceptLanguage, userAgent, clientId, clientIp, location, countryCode, market, safeSearch, setLang, textDecorations, textFormat, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.VideoSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TrendingVideos>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="acceptLanguage" Type="System.String" />
<Parameter Name="userAgent" Type="System.String" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="clientIp" Type="System.String" />
<Parameter Name="location" Type="System.String" />
<Parameter Name="countryCode" Type="System.String" />
<Parameter Name="market" Type="System.String" />
<Parameter Name="safeSearch" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch>" />
<Parameter Name="setLang" Type="System.String" />
<Parameter Name="textDecorations" Type="System.Nullable<System.Boolean>" />
<Parameter Name="textFormat" Type="System.Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat>" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="acceptLanguage">
A comma-delimited list of one or more languages to use for user
interface strings. The list is in decreasing order of preference.
For additional information, including expected format, see
[RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
This header and the
[setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#setlang)
query parameter are mutually exclusive; do not specify both. If you
set this header, you must also specify the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#cc)
query parameter. To determine the market to return results for,
Bing uses the first supported language it finds from the list and
combines it with the cc parameter value. If the list does not
include a supported language, Bing finds the closest language and
market that supports the request or it uses an aggregated or
default market for the results. To determine the market that Bing
used, see the BingAPIs-Market header. Use this header and the cc
query parameter only if you specify multiple languages. Otherwise,
use the
[mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#mkt)
and
[setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#setlang)
query parameters. A user interface string is a string that's used
as a label in a user interface. There are few user interface
strings in the JSON response objects. Any links to Bing.com
properties in the response objects apply the specified language.
</param>
<param name="userAgent">
The user agent originating the request. Bing uses the user agent to
provide mobile users with an optimized experience. Although
optional, you are encouraged to always specify this header. The
user-agent should be the same string that any commonly used browser
sends. For information about user agents, see [RFC
2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
following are examples of user-agent strings. Windows Phone:
Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0;
IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla /
5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build /
GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0
Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS
6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile
/ 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
(Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko.
iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit /
537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari /
9537.53
</param>
<param name="clientId">
Bing uses this header to provide users with consistent behavior
across Bing API calls. Bing often flights new features and
improvements, and it uses the client ID as a key for assigning
traffic on different flights. If you do not use the same client ID
for a user across multiple requests, then Bing may assign the user
to multiple conflicting flights. Being assigned to multiple
conflicting flights can lead to an inconsistent user experience.
For example, if the second request has a different flight
assignment than the first, the experience may be unexpected. Also,
Bing can use the client ID to tailor web results to that client
ID’s search history, providing a richer experience for the user.
Bing also uses this header to help improve result rankings by
analyzing the activity generated by a client ID. The relevance
improvements help with better quality of results delivered by Bing
APIs and in turn enables higher click-through rates for the API
consumer. IMPORTANT: Although optional, you should consider this
header required. Persisting the client ID across multiple requests
for the same end user and device combination enables 1) the API
consumer to receive a consistent user experience, and 2) higher
click-through rates via better quality of results from the Bing
APIs. Each user that uses your application on the device must have
a unique, Bing generated client ID. If you do not include this
header in the request, Bing generates an ID and returns it in the
X-MSEdge-ClientID response header. The only time that you should
NOT include this header in a request is the first time the user
uses your app on that device. Use the client ID for each Bing API
request that your app makes for this user on the device. Persist
the client ID. To persist the ID in a browser app, use a persistent
HTTP cookie to ensure the ID is used across all sessions. Do not
use a session cookie. For other apps such as mobile apps, use the
device's persistent storage to persist the ID. The next time the
user uses your app on that device, get the client ID that you
persisted. Bing responses may or may not include this header. If
the response includes this header, capture the client ID and use it
for all subsequent Bing requests for the user on that device. If
you include the X-MSEdge-ClientID, you must not include cookies in
the request.
</param>
<param name="clientIp">
The IPv4 or IPv6 address of the client device. The IP address is
used to discover the user's location. Bing uses the location
information to determine safe search behavior. Although optional,
you are encouraged to always specify this header and the
X-Search-Location header. Do not obfuscate the address (for
example, by changing the last octet to 0). Obfuscating the address
results in the location not being anywhere near the device's actual
location, which may result in Bing serving erroneous results.
</param>
<param name="location">
A semicolon-delimited list of key/value pairs that describe the
client's geographical location. Bing uses the location information
to determine safe search behavior and to return relevant local
content. Specify the key/value pair as <key>:<value>.
The following are the keys that you use to specify the user's
location. lat (required): The latitude of the client's location, in
degrees. The latitude must be greater than or equal to -90.0 and
less than or equal to +90.0. Negative values indicate southern
latitudes and positive values indicate northern latitudes. long
(required): The longitude of the client's location, in degrees. The
longitude must be greater than or equal to -180.0 and less than or
equal to +180.0. Negative values indicate western longitudes and
positive values indicate eastern longitudes. re (required): The
radius, in meters, which specifies the horizontal accuracy of the
coordinates. Pass the value returned by the device's location
service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell
tower triangulation, and 18,000m for reverse IP lookup. ts
(optional): The UTC UNIX timestamp of when the client was at the
location. (The UNIX timestamp is the number of seconds since
January 1, 1970.) head (optional): The client's relative heading or
direction of travel. Specify the direction of travel as degrees
from 0 through 360, counting clockwise relative to true north.
Specify this key only if the sp key is nonzero. sp (optional): The
horizontal velocity (speed), in meters per second, that the client
device is traveling. alt (optional): The altitude of the client
device, in meters. are (optional): The radius, in meters, that
specifies the vertical accuracy of the coordinates. Specify this
key only if you specify the alt key. Although many of the keys are
optional, the more information that you provide, the more accurate
the location results are. Although optional, you are encouraged to
always specify the user's geographical location. Providing the
location is especially important if the client's IP address does
not accurately reflect the user's physical location (for example,
if the client uses VPN). For optimal results, you should include
this header and the X-MSEdge-ClientIP header, but at a minimum, you
should include this header.
</param>
<param name="countryCode">
A 2-character country code of the country where the results come
from. This API supports only the United States market. If you
specify this query parameter, it must be set to us. If you set this
parameter, you must also specify the Accept-Language header. Bing
uses the first supported language it finds from the languages list,
and combine that language with the country code that you specify to
determine the market to return results for. If the languages list
does not include a supported language, Bing finds the closest
language and market that supports the request, or it may use an
aggregated or default market for the results instead of a specified
one. You should use this query parameter and the Accept-Language
query parameter only if you specify multiple languages; otherwise,
you should use the mkt and setLang query parameters. This parameter
and the mkt query parameter are mutually exclusive—do not specify
both.
</param>
<param name="market">
The market where the results come from. Typically, mkt is the
country where the user is making the request from. However, it
could be a different country if the user is not located in a
country where Bing delivers results. The market must be in the form
<language code>-<country code>. For example, en-US. The
string is case insensitive. For a list of possible market values,
see [Market
Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#market-codes).
NOTE: If known, you are encouraged to always specify the market.
Specifying the market helps Bing route the request and return an
appropriate and optimal response. If you specify a market that is
not listed in [Market
Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#market-codes),
Bing uses a best fit market code based on an internal mapping that
is subject to change. This parameter and the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#cc)
query parameter are mutually exclusive—do not specify both.
</param>
<param name="safeSearch">
Filter videos for adult content. The following are the possible
filter values. Off: If the request is through the Video Search API,
the response includes adult videos and the thumbnail images of the
videos are clear (non-fuzzy). If the request is through the Web
Search API, the response includes adult videos but the thumbnail
images of the videos are pixelated (fuzzy). Moderate: If the
request is through the Video Search API, the response does not
include videos with adult content. If the request is through the
Web Search API, the response may include videos with adult content
but the thumbnail images of the videos are pixelated (fuzzy).
Strict: Does not return videos with adult content. The default is
Moderate. If the request comes from a market that Bing's adult
policy requires that safeSearch is set to Strict, Bing ignores the
safeSearch value and uses Strict. If you use the site: query
operator, there is the chance that the response may contain adult
content regardless of what the safeSearch query parameter is set
to. Use site: only if you are aware of the content on the site and
your scenario supports the possibility of adult content. Possible
values include: 'Off', 'Moderate', 'Strict'
</param>
<param name="setLang">
The language to use for user interface strings. Specify the
language using the ISO 639-1 2-letter language code. For example,
the language code for English is EN. The default is EN (English).
Although optional, you should always specify the language.
Typically, you set setLang to the same language specified by mkt
unless the user wants the user interface strings displayed in a
different language. This parameter and the
[Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#acceptlanguage)
header are mutually exclusive; do not specify both. A user
interface string is a string that's used as a label in a user
interface. There are few user interface strings in the JSON
response objects. Also, any links to Bing.com properties in the
response objects apply the specified language.
</param>
<param name="textDecorations">
A Boolean value that determines whether display strings contain
decoration markers such as hit highlighting characters. If true,
the strings may include markers. The default is false. To specify
whether to use Unicode characters or HTML tags as the markers, see
the
[textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#textformat)
query parameter. For information about hit highlighting, see [Hit
Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
</param>
<param name="textFormat">
The type of markers to use for text decorations (see the
textDecorations query parameter). Possible values are Raw—Use
Unicode characters to mark content that needs special formatting.
The Unicode characters are in the range E000 through E019. For
example, Bing uses E000 and E001 to mark the beginning and end of
query terms for hit highlighting. HTML—Use HTML tags to mark
content that needs special formatting. For example, use <b>
tags to highlight query terms in display strings. The default is
Raw. For display strings that contain escapable HTML characters
such as <, >, and &, if textFormat is set to HTML, Bing
escapes the characters as appropriate (for example, < is escaped
to &lt;). Possible values include: 'Raw', 'Html'
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
The Video Trending Search API lets you search on Bing and get back
a list of videos that are trending based on search requests made by
others. The videos are broken out into different categories. For
example, Top Music Videos. For a list of markets that support
trending videos, see [Trending
Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/trending-videos).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.ErrorResponseException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>