وب سرویس زیرنویس ویدیو
متد SubtitleUpload
از این متد جهت بارگزاری فایل زیرنویس استفاده فرمایید
آدرس متد
Method Urlhttps://stream.yoursite.xyz/api/v1/Video/SubtitleUpload
داده ها می بایست بصورت multipart/form-data به این متد Post شود
پارامتر های ورودی
نام پارامتر | نوع پارامتر | ضروری | توضیحات |
---|---|---|---|
videoId | String | بله | کد ویدیو |
title | String | بله | عنوان زیر نویس |
lang | String | بله | زبان زیر نویس مثال: fa,ar,en,... |
default | Boolean | بله | این فایل آیا زیرنویس پیشفرض ویدیو باشد یا خیر |
subtitleFile | file | بله | فایل زیر نویس که باید با پسوند vtt یا srt باشد |
مقدار بازگشتی
مقدار بازگشتی در response همان کد زیرنویس افزوده شده می باشد
{
"success" : true,
"response" : "1126",
"error": ""
}
متد SubtitleUpdate
از این متد جهت ویرایش و اصلاح زیرنویس استفاده فرمایید
آدرس متد
Method Urlhttps://stream.yoursite.xyz/api/v1/Video/SubtitleUpdate
پارامتر های ورودی
نام پارامتر | نوع پارامتر | ضروری | توضیحات |
---|---|---|---|
subtitleId | String | بله | کد زیرنویس |
title | String | بله | عنوان زیرنویس |
lang | String | بله | زبان زیر نویس - مثال: fa,en,ar,... |
default | Boolean | بله | پیشفرض باشد یا خیر |
مقدار بازگشتی
مقدار بازگشتی در response همان کد زیرنویس اصلاح شده می باشد
{
"success" : true,
"response" : "1126",
"error": ""
}
متد SubtitleDelete
از این متد جهت حذف زیرنویس استفاده فرمایید
آدرس متد
Method Urlhttps://stream.yoursite.xyz/api/v1/Video/SubtitleDelete/{id}
پارامتر های ورودی
نام پارامتر | نوع پارامتر | ضروری | توضیحات |
---|---|---|---|
id | long | بله | کد زیرنویس |
مقدار id را در انتهای url بفرستید
مثال: https://.../api/v1/video/SubtitleDelete/1126
مقدار بازگشتی
{
"success" : true,
"response" : "زیرنویس حذف شد",
"error": ""
}
متد SubtitleList
از این متد جهت دریافت لیست زیرنویس های یک ویدیو استفاده فرمایید
آدرس متد
Method Urlhttps://stream.yoursite.xyz/api/v1/Video/SubtitleList/{videoId}
پارامتر های ورودی
نام پارامتر | نوع پارامتر | ضروری | توضیحات |
---|---|---|---|
videoId | String | بله | کد ویدیو |
مقدار videoId را در انتهای url بفرستید
مثال: https://.../api/v1/video/SubtitleList/b8mpGIdRVEOcYBqLClUVdA
مقدار بازگشتی
[
{
"VideoSubtitle_ID": 10005,
"VideoSubtitle_CustomerVideo_Ref": 10085,
"VideoSubtitle_Label": "Persian (Farsi)",
"VideoSubtitle_Lang": "fa",
"VideoSubtitle_Vtt": "b8mpGIdRVEOcYBqLClUVdA/43b34d703a734225bd3de2e7dbb36a42.vtt",
"VideoSubtitle_Srt": "",
"VideoSubtitle_Default": true
},
{
"VideoSubtitle_ID": 10006,
"VideoSubtitle_CustomerVideo_Ref": 10085,
"VideoSubtitle_Label": "English",
"VideoSubtitle_Lang": "en",
"VideoSubtitle_Vtt": "b8mpGIdRVEOcYBqLClUVdA/31b2e06f8b114246883c31042a7015ce.vtt",
"VideoSubtitle_Srt": "",
"VideoSubtitle_Default": false
}
]
شرح مقادیر بازگشتی
نام پارامتر | نوع پارامتر | توضیحات |
---|---|---|
VideoSubtitle_ID | Long | کد زیرنویس. |
VideoSubtitle_CustomerVideo_Ref | Long | آیدی ویدیو |
VideoSubtitle_Label | String | عنوان زیرنویس |
VideoSubtitle_Lang | String | زبان زیرنویس |
VideoSubtitle_Vtt | String | فایل زیر نویس با پسوند vtt |
VideoSubtitle_Srt | String | فایل زیر نویس با پسوند srt که جهت تبدیل به vtt استفاده می شود |
VideoSubtitle_Default | Boolean | زیرنویس پیشفرض |
متد LangList
از این متد جهت دریافت لیست زبان های مورد نیاز برای زیرنویس ها استفاده فرمایید
آدرس متد
Method Urlhttps://stream.yoursite.xyz/api/v1/Video/LangList
پارامتر های ورودی
نام پارامتر | نوع پارامتر | ضروری | توضیحات |
---|---|---|---|
ندارد | ندارد | ندارد | پارامتر ورودی ندارد |
مقدار id را می توانید در انتهای url هم بفرستید
مثال: https://.../api/v1/video/langlist
مقدار بازگشتی
[
{
"Subtitle_ID": 1,
"Subtitle_Title": "Persian (Farsi)",
"Subtitle_Lang": "fa"
},
{
"Subtitle_ID": 2,
"Subtitle_Title": "English",
"Subtitle_Lang": "en"
},
{
"Subtitle_ID": 3,
"Subtitle_Title": "Afar",
"Subtitle_Lang": "aa"
},
.....
]
شرح مقادیر بازگشتی
نام پارامتر | نوع پارامتر | توضیحات |
---|---|---|
Subtitle_ID | Long | کد زبان. |
Subtitle_Title | String | عنوان زبان. |
Subtitle_Lang | String | زبان |