Skip to content

Commit 9880fa6

Browse files
authored
Merge pull request #101053 from Juliako/patch-167
Update upload-index-videos.md
2 parents 204b755 + 5dc2925 commit 9880fa6

File tree

2 files changed

+47
-15
lines changed

2 files changed

+47
-15
lines changed

articles/media-services/video-indexer/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
href: connect-to-azure.md
4646
- name: Manage account connected to Azure
4747
href: manage-account-connected-to-azure.md
48-
- name: Use API to upload and index videos
48+
- name: Upload and index videos
4949
href: upload-index-videos.md
5050
- name: Examine Video Indexer output
5151
href: video-indexer-output-json-v2.md

articles/media-services/video-indexer/upload-index-videos.md

Lines changed: 46 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ manager: femila
99
ms.service: media-services
1010
ms.subservice: video-indexer
1111
ms.topic: article
12-
ms.date: 01/14/2020
12+
ms.date: 01/13/2020
1313
ms.author: juliako
1414
---
1515

@@ -21,9 +21,12 @@ When uploading videos with Video Indexer API, you have the following upload opti
2121
* send the video file as a byte array in the request body,
2222
* Use existing Azure Media Services asset by providing the [asset ID](https://docs.microsoft.com/azure/media-services/latest/assets-concept) (supported in paid accounts only).
2323

24-
The article shows how to use the [Upload video](https://api-portal.videoindexer.ai/docs/services/operations/operations/Upload-video?) API to upload and index your videos based on a URL. The code sample in the article includes the commented out code that shows how to upload the byte array. <br/>The article also discusses some of the parameters that you can set on the API to change the process and output of the API.
24+
Once your video has been uploaded, Video Indexer (optionally) encodes the video (discussed in the article). When creating a Video Indexer account, you can choose a free trial account (where you get a certain number of free indexing minutes) or a paid option (where you are not limited by the quota). With free trial, Video Indexer provides up to 600 minutes of free indexing to website users and up to 2400 minutes of free indexing to API users. With paid option, you create a Video Indexer account that is [connected to your Azure subscription and an Azure Media Services account](connect-to-azure.md). You pay for minutes indexed as well as the Media Account related charges.
2525

26-
Once your video has been uploaded, Video Indexer, optionally encodes the video (discussed in the article). When creating a Video Indexer account, you can choose a free trial account (where you get a certain number of free indexing minutes) or a paid option (where you are not limited by the quota). With free trial, Video Indexer provides up to 600 minutes of free indexing to website users and up to 2400 minutes of free indexing to API users. With paid option, you create a Video Indexer account that is [connected to your Azure subscription and an Azure Media Services account](connect-to-azure.md). You pay for minutes indexed as well as the Media Account related charges.
26+
The article shows how to upload and index your videos with these options:
27+
28+
* [The Video Indexer website](#website)
29+
* [The Video Indexer APIs](#apis)
2730

2831
## Uploading considerations and limitations
2932

@@ -36,22 +39,50 @@ Once your video has been uploaded, Video Indexer, optionally encodes the video (
3639
- The URL provided in the `videoURL` param needs to be encoded.
3740
- Indexing Media Services assets has the same limitation as indexing from URL.
3841
- Video Indexer has a max duration limit of 4 hours for a single file.
42+
- The URL needs to be accessible (for example a public URL).
43+
44+
If it is a private URL, the access token need to be provided in the request.
45+
- The URL has to point to a valid media file and not to a webpage, such as a link to `www.youtube.com` page.
3946
- You can upload up to 60 movies per minute.
4047

4148
> [!Tip]
4249
> It is recommended to use .NET framework version 4.6.2. or higher because older .NET frameworks do not default to TLS 1.2.
4350
>
4451
> If you must use older .NET frameworks, add one line into your code before making the REST API call: <br/> System.Net.ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls12;
4552
46-
## Configurations and params
53+
## Supported file formats for Video Indexer
54+
55+
See the [input container/file formats](../latest/media-encoder-standard-formats.md#input-containerfile-formats) article for a list of file formats that you can use with Video Indexer.
56+
57+
## <a id="website"/>Upload and index a video using the Video Indexer website
58+
59+
> [!NOTE]
60+
> A name of the video must be no greater than 80 characters.
61+
62+
1. Sign in on the [Video Indexer](https://www.videoindexer.ai/) website.
63+
2. To upload a video, press the **Upload** button or link.
64+
65+
![Upload](./media/video-indexer-get-started/video-indexer-upload.png)
66+
67+
Once your video has been uploaded, Video Indexer starts indexing and analyzing the video.
68+
69+
![Uploaded](./media/video-indexer-get-started/video-indexer-uploaded.png)
70+
71+
Once Video Indexer is done analyzing, you will get a notification with a link to your video and a short description of what was found in your video. For example: people, topics, OCRs.
72+
73+
## <a id="apis"/>Upload and index with API
74+
75+
Use the [Upload video](https://api-portal.videoindexer.ai/docs/services/operations/operations/Upload-video?) API to upload and index your videos based on a URL. The code sample that follows includes the commented out code that shows how to upload the byte array.
76+
77+
### Configurations and params
4778

4879
This section describes some of the optional parameters and when you would want to set them.
4980

50-
### externalID
81+
#### externalID
5182

5283
This parameter enables you to specify an ID that will be associated with the video. The ID can be applied to external "Video Content Management" (VCM) system integration. The videos that are located in the Video Indexer portal can be searched using the specified external ID.
5384

54-
### callbackUrl
85+
#### callbackUrl
5586

5687
A URL that is used to notify the customer (using a POST request) about the following events:
5788

@@ -75,12 +106,12 @@ A URL that is used to notify the customer (using a POST request) about the follo
75106
76107
- Example: https:\//test.com/notifyme?projectName=MyProject&id=1234abcd&faceid=12&knownPersonId=CCA84350-89B7-4262-861C-3CAC796542A5&personName=Inigo_Montoya
77108

78-
#### Notes
109+
##### Notes
79110

80111
- Video Indexer returns any existing parameters provided in the original URL.
81112
- The provided URL must be encoded.
82113

83-
### indexingPreset
114+
#### indexingPreset
84115

85116
Use this parameter if raw or external recordings contain background noise. This parameter is used to configure the indexing process. You can specify the following values:
86117

@@ -91,13 +122,13 @@ Use this parameter if raw or external recordings contain background noise. This
91122

92123
Price depends on the selected indexing option.
93124

94-
### priority
125+
#### priority
95126

96127
Videos are indexed by Video Indexer according to their priority. Use the **priority** parameter to specify the index priority. The following values are valid: **Low**, **Normal** (default), and **High**.
97128

98129
**Priority** parameter is only supported for paid accounts.
99130

100-
### streamingPreset
131+
#### streamingPreset
101132

102133
Once your video has been uploaded, Video Indexer, optionally encodes the video. Then, proceeds to indexing, and analyzing the video. When Video Indexer is done analyzing, you will get a notification with the video ID.
103134

@@ -107,17 +138,17 @@ In order to run the indexing and encoding jobs, the [Azure Media Services accoun
107138

108139
If you only want to index your video but not encode it, set `streamingPreset`to `NoStreaming`.
109140

110-
### videoUrl
141+
#### videoUrl
111142

112143
A URL of the video/audio file to be indexed. The URL must point at a media file (HTML pages are not supported). The file can be protected by an access token provided as part of the URI and the endpoint serving the file must be secured with TLS 1.2 or higher. The URL needs to be encoded.
113144

114145
If the `videoUrl` is not specified, the Video Indexer expects you to pass the file as a multipart/form body content.
115146

116-
## Code sample
147+
### Code sample
117148

118149
The following C# code snippet demonstrates the usage of all the Video Indexer APIs together.
119150

120-
### Instructions for running this code sample
151+
#### Instructions for running this code sample
121152

122153
After copying this code into your development platform you will need to provide two parameters: API Management authentication key and video URL.
123154

@@ -304,7 +335,8 @@ public class AccountContractSlim
304335
public string AccessToken { get; set; }
305336
}
306337
```
307-
## Common errors
338+
339+
### Common errors
308340

309341
The status codes listed in the following table may be returned by the Upload operation.
310342

0 commit comments

Comments
 (0)