本文介紹文字識別(ocr)類目下的RecognizeVideoCharacter視頻文字識別的語法及示例。
功能描述
視頻文字識別能力可以實現對輸入視頻的結構化處理,返回對應的文字內容、文字區域坐標及時間等信息。
特色優勢
支持多種視頻格式:支持AVI、MP4、H264編碼格式。
接入指引
1. 注冊阿里云賬號:打開阿里云官網,在阿里云官網右上角,單擊立即注冊,按照操作提示完成賬號注冊。
2. 開通能力:請確保您已開通文字識別服務,若未開通服務請立即開通。
3. 創建AccessKey:請確保您已創建AccessKey,如果您使用的是子賬號AccessKey,您需要給子賬號賦予AliyunVIAPIFullAccess權限,具體操作,請參見RAM授權。
4. 在線調試(可選):您可以通過OpenAPI Explorer在線調試能力,查看完整的調用示例代碼及SDK依賴信息,也可以下載完整的工程。
5. 開發接入步驟:
- 在SDK總覽中選擇您要接入使用的SDK語言。
- 在對應語言的SDK文檔中找到AI類目為文字識別(ocr)的SDK包進行安裝。
- 參考文檔中提供的示例代碼進行適當修改后調用。
6. 示例代碼:該能力常用語言查詢異步任務結果的示例代碼,請參見查詢異步任務結果示例代碼。
7. 客戶端直接調用:該能力常用的客戶端調用方式包括以下幾種。
輸入限制
- 視頻格式:AVI、MP4、H264。
- 視頻大小:小于20 MB。
- 視頻時長:小于60秒。
- 視頻幀率:不大于35幀。
- 視頻分辨率:大于20×20像素,小于4096×4096像素。
- URL地址中不能包含中文字符。
計費說明
關于視頻文字識別的計費方式及報價,請參見計費介紹。
調用步驟
該能力為異步能力,需分兩步進行調用。
第一步調用RecognizeVideoCharacter接口提交任務,請求成功后,得到一個任務ID。
第二步調用GetAsyncJobResult接口查詢結果,根據任務ID查詢任務執行狀態和結果。如果任務還在處理中,可稍等一段時間后再進行查詢。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | RecognizeVideoCharacter | 系統規定參數。取值:RecognizeVideoCharacter。 |
VideoURL | String | 是 | http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/RecognizeVideoCharacter/xxxx.mp4 | 視頻URL地址。推薦使用上海地域的OSS鏈接,對于文件在本地或者非上海地域OSS鏈接的情況,請參見文件URL處理。 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | D3F5BA69-79C4-46A4-B02B-58C4EEBC4C33 | 請求ID。 |
Data | Object | 返回的結果數據內容。 該數據需要在異步任務執行成功后,通過調用GetAsyncJobResult接口,對其Result字段進行JSON反序列化之后得到。 |
|
Width | Long | 1920 | 視頻寬度分辨率,單位像素。 |
Height | Long | 1080 | 視頻高度分辨率,單位像素。 |
Frames | Array of Frame | 視頻幀的集合,空信息的幀不展示。 |
|
Timestamp | Long | 6124533574 | 幀時間戳,單位毫秒。 |
Elements | Array of Element | 文字區域元素列表 |
|
Score | Float | 0.99 | 文字區域概率,概率值的范圍為[0.0,1.0]。 |
Text | String | 在桃花盛開的地方 | 文字內容。 |
TextRectangles | Array of TextRectangle | 文字區域位置信息。 |
|
Angle | Long | -90 | 文字區域角度,角度范圍[-180, 180]。 |
Left | Long | 213 | 文字區域左上角X坐標。 |
Top | Long | 98 | 文字區域左上角Y坐標。 |
Width | Long | 46 | 文字區域寬度,單位像素。 |
Height | Long | 213 | 文字區域高度,單位像素。 |
InputFile | String | oss://my-bucket/a/b/c.mp4 | 輸入視頻文件OSS地址。 |
Message | String | 該調用為異步調用,任務已提交成功,請以requestId的值作為jobId參數調用同類目下GetAsyncJobResult接口查詢任務執行狀態和結果。 | 提交異步任務后的提示信息。 |
查詢結果
該接口為異步接口,當前并未返回真實的請求結果,您需要通過返回的RequestId調用GetAsyncJobResult接口來獲取該接口的真實請求結果。詳情請參見GetAsyncJobResult。
SDK參考
阿里云視覺AI文字識別類目下的視頻文字識別能力推薦使用SDK調用,支持多種編程語言,調用時請選擇AI類目為文字識別(ocr)的SDK包,文件參數通過SDK調用可支持本地文件及任意URL,具體可參見SDK總覽。
示例代碼
該能力常用語言查詢異步任務結果的示例代碼,請參見查詢異步任務結果示例代碼。
示例
請求示例
http(s)://ocr.cn-shanghai.aliyuncs.com/?Action=RecognizeVideoCharacter //更多關于訪問域名(Endpoint)信息,請參見:http://bestwisewords.com/document_detail/143103.html
&VideoURL=http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/videoenhan/RecognizeVideoCharacter/xxxx.mp4
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RecognizeVideoCharacterResponse>
<RequestId>D3F5BA69-79C4-46A4-B02B-58C4EEBC4C33</RequestId>
<Message>該調用為異步調用,任務已提交成功,請以requestId的值作為jobId參數調用同類目下GetAsyncJobResult接口查詢任務執行狀態和結果。</Message>
</RecognizeVideoCharacterResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D3F5BA69-79C4-46A4-B02B-58C4EEBC4C33",
"Message" : "該調用為異步調用,任務已提交成功,請以requestId的值作為jobId參數調用同類目下GetAsyncJobResult接口查詢任務執行狀態和結果。"
}
返回示例補充說明
//查詢結果:請求示例
http(s)://ocr.cn-shanghai.aliyuncs.com/?Action=GetAsyncJobResult
&JobId=E75FE679-0303-4DD1-8252-1143B4FA8A27
&<公共請求參數>
//查詢結果:返回示例
{
"RequestId" : "43A0AEB6-45F4-4138-8E89-E1A5D63200E3",
"Data" : {
"Status" : "PROCESS_SUCCESS",
"JobId" : "186AC396-0EEC-46F1-AAA1-BF3585227427",
"Result" : "Result" :"{\"Width\" : 1920,\"Height\" : 1080,\"Frames\" :\"Timestamp\" : 6124533574,\"Elements\":\"Score\":0.99,\"Text\":\"在桃花盛開的地方\",\"TextRectangles\":\"Angle\":-90,\"Left\":213,\"Top\": 98,\"Width\" : 46,\"Height\" : 213,\"InputFile\" : \"oss://my-bucket/a/b/c.mp4\"}"
}
}
//Result反序列化
{
"Width" : 1920,
"Height" : 1080,
"Frames" : [ {
"Timestamp" : 6124533574,
"Elements" : [ {
"Score" : 0.99,
"Text" : "在桃花盛開的地方",
"TextRectangles" : [ {
"Angle" : -90,
"Left" : 213,
"Top" : 98,
"Width" : 46,
"Height" : 213
} ]
} ]
} ]
"InputFile" : "oss://my-bucket/a/b/c.mp4"
}
錯誤碼
關于視頻文字識別的錯誤碼,詳情請參見常見錯誤碼。
安全聲明
- 請確保上傳的圖片或文件來源符合相應的法律法規。
- 通過體驗調試上傳的臨時文件有效期為1小時,在24小時后會被系統自動清理刪除。