ایران لایو استریم

مستندات وب‌سرویس

ایران لایو استریم

مستندات وب‌سرویس

ایران لایو استریم

مستندات وب‌سرویس

وب سرویس ویدیوها

آخرین به روز رسانی: 14 بهمن 1400

متد Upload

از این متد جهت بارگزاری ویدیو استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Video/Upload

داده ها می بایست بصورت multipart/form-data به این متد Post شود

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
groupId String بله کد سرفصل یا دوره آموزشی(در صورت عدم ایجاد سرفصل)
title String بله عنوان ویدیو
wmPosition String مشروط در صورت ارسال لوگو جهت درج روی ویدیو الزامی می باشد و مقدار آن باید یکی از مقادیر زیر باشد
TopLeft
TopRight
BottomLeft
BottomRight
videoFile file بله فایل ویدیو با پسوند mp4
watermarkFile file دلخواه فایل لوگو در قالب تصویر PNG transparent
connectionId String دلخواه چنانچه نیاز به نمایش Progressbar دارید می توانید از SignalR استفاده نموده و آیدی کلاینت را ارسال نمایید تا سامانه میزان پیشرفت پردازش ویدیو رو به شما گزارش نماید

مقدار بازگشتی

مقدار بازگشتی در response کد ویدیوی شما می باشد

                                            
    {
        "success" : true,
        "response" : "b8mpGIdRVEOcYBqLClUVdA",
        "error": ""
    }

توجه: چنانچه ویدیویی در حال پردازش نداشته باشید بلافاصله پس از آپلود ویدیو پردازش آن آغاز می گردد در غیر اینصورت ویدیوی شما به صف پردازش منتقل شده و باید منتظر پردازش آن بمانید

متد Import

از این متد جهت بارگزاری ویدیو از آدرس اینترنتی استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Video/Import

داده ها می بایست بصورت multipart/form-data به این متد Post شود

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
groupId String بله کد سرفصل یا دوره آموزشی(در صورت عدم ایجاد سرفصل)
title String بله عنوان ویدیو
wmPosition String مشروط در صورت ارسال لوگو جهت درج روی ویدیو الزامی می باشد و مقدار آن باید یکی از مقادیر زیر باشد
TopLeft
TopRight
BottomLeft
BottomRight
videoUrl String بله مسیر اینترنتی فایل ویدیو
مثال:https://yoursite.com/video.mp4
watermarkFile file دلخواه فایل لوگو در قالب تصویر PNG transparent
connectionId String دلخواه چنانچه نیاز به نمایش Progressbar دارید می توانید از SignalR استفاده نموده و آیدی کلاینت را ارسال نمایید تا سامانه میزان پیشرفت پردازش ویدیو رو به شما گزارش نماید

مقدار بازگشتی

مقدار بازگشتی در response کد ویدیوی شما می باشد

                                            
    {
        "success" : true,
        "response" : "b8mpGIdRVEOcYBqLClUVdA",
        "error": ""
    }

متد Update

از این متد جهت ویرایش و اصلاح اطلاعات ویدیو استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Video/Update

داده ها می بایست بصورت multipart/form-data به این متد Post شود

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
videoId String بله کد ویدیو
title String بله عنوان ویدیو
description String بله شرح ویدیو
downloadable boolean بله ویدیو قابل دانلود باشد یا خیر
googleAnalytics string بله درصورت نیاز به رصد ویدیوها توسط گوگل آنالاینیکس می توانید Tracking ID وب سایت خود را در این فیلد بگذارید در غیر اینصورت رشته خالی ارسال شود
allowDomains boolean بله دامنه های مجاز به پخش ویدیو، مقدار پیشفرض آن می بایست "*" باشد. درصورت تعدد دامنه ها می بایست آنها را با ویرگول لاتین از هم جدا نمایید
allowIPs string بله آی پی های مجاز به تماشای ویدیو، مقدار پیشفرض آن می بایست "*" باشد. درصورت تعدد آی پی می بایست آنها را با ویرگول لاتین از هم جدا نمایید
directPlayEnable boolean بله پخش مستقیم ویدیو فعال باشد یا خیر
coverFile file دلخواه سامانه اتوماتیک برای ویدیو کاور تولید می کند ولی در صورتی که نیاز دارید کاور ویدیو تصویر دیگری باشد می توانید تصویر طراحی شده خود را آپلود نمایید

مقدار بازگشتی

مقدار بازگشتی در response همان کد ویدیوی اصلاح شده می باشد

                                            
    {
        "success" : true,
        "response" : "b8mpGIdRVEOcYBqLClUVdA",
        "error": ""
    }

متد Delete

از این متد جهت حذف ویدیو استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Video/Delete/{id}

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
id string بله کد ویدیو

مقدار id را در انتهای url بفرستید

مثال: https://.../api/v1/Video/delete/b8mpGIdRVEOcYBqLClUVdA

مقدار بازگشتی

                                            
    {
        "success" : true,
        "response" : "ویدیو حذف شد",
        "error": ""
    }

متد List

از این متد جهت دریافت لیست ویدیوهای یک سرفصل یا دوره آموزشی استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Video/List/{groupId}

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
groupId long بله کد سرفصل یا دوره آموزشی

مقدار groupId را در انتهای url بفرستید

مثال: https://.../api/v1/video/list/20016

مقدار بازگشتی

    
    [
        {
            "Video_ID": "DSePUvB4EiawBgXAOLxA",
            "Video_Group_ID": 20016,
            "Video_Title": "ویدیوی شماره 1",
            "Video_Cover": "https://stream.yoursite.xyz/Files/DSePUvB4EiawBgXAOLxA/thumbnail.jpg",
            "Video_Duration": 1627.0,
            "Video_Downloadable": false,
            "Video_Description": "",
            "Video_Status": 2,
            "Video_StatusName": "آماده",
            "Video_CreateDate": "2022-01-19T07:42:02.393",
            "Video_UpdateDate": "2022-01-29T17:58:37.113",
            "Video_View": 5,
            "Video_AllowDomains": "*",
            "Video_AllowIPs": "*",
            "Video_DirectPlayURL": "https://stream.yoursite.xyz/Video/Play/10083/vhznSUnPmk2v4YhkSjcBfg",
            "Video_DirectPlayEnable": true,
            "Video_EmbedScript": "<script id='DSePUvB4EiawBgXAOLxA' src='https://stream.yoursite.xyz/Video/Embed/DSePUvB4EiawBgXAOLxA'></script>",
            "Video_DownloadUrl": "",
            "Video_GoogleAnalytics": ""
        },
        {
            "Video_ID": "b8mpGIdRVEOcYBqLClUVdA",
            "Video_Group_ID": 20016,
            "Video_Title": "مدیریت منابع انسانی",
            "Video_Cover": "https://stream.yoursite.xyz/Files/b8mpGIdRVEOcYBqLClUVdA/thumbnail.jpg",
            "Video_Duration": 30.0,
            "Video_Downloadable": false,
            "Video_Description": "",
            "Video_Status": 2,
            "Video_StatusName": "آماده",
            "Video_CreateDate": "2022-01-19T10:57:31.193",
            "Video_UpdateDate": "2022-01-29T17:08:23.813",
            "Video_View": 4,
            "Video_AllowDomains": "*",
            "Video_AllowIPs": "*",
            "Video_DirectPlayURL": "https://stream.yoursite.xyz/Video/Play/10085/fibJUcv0Ddz5cisidA",
            "Video_DirectPlayEnable": false,
            "Video_EmbedScript": "<script id='b8mpGIdRVEOcYBqLClUVdA' src='https://stream.yoursite.xyz/Video/Embed/b8mpGIdRVEOcYBqLClUVdA'></script>",
            "Video_DownloadUrl": "",
            "Video_GoogleAnalytics": "UA-26674367-1"
        },
        {
            "Video_ID": "JZAkz7WUqOQssToF51yA",
            "Video_Group_ID": 20016,
            "Video_Title": "ویدیوی شماره 4",
            "Video_Cover": "https://stream.yoursite.xyz/Files/JZAkz7WUqOQssToF51yA/thumbnail.jpg",
            "Video_Duration": 19.0,
            "Video_Downloadable": false,
            "Video_Description": "",
            "Video_Status": 2,
            "Video_StatusName": "آماده",
            "Video_CreateDate": "2022-01-20T23:18:21.29",
            "Video_UpdateDate": "2022-01-23T08:58:11.067",
            "Video_View": 1,
            "Video_AllowDomains": "*",
            "Video_AllowIPs": "*",
            "Video_DirectPlayURL": "https://stream.yoursite.xyz/Video/Play/10086/jNdTYV33J0y0aofLAZRTg",
            "Video_DirectPlayEnable": false,
            "Video_EmbedScript": "<script id='JZAkz7WUqOQssToF51yA' src='https://stream.yoursite.xyz/Video/Embed/JZAkz7WUqOQssToF51yA'></script>",
            "Video_DownloadUrl": "",
            "Video_GoogleAnalytics": ""
        }
    ]

شرح مقادیر بازگشتی

نام پارامتر نوع پارامتر توضیحات
Video_ID String کد ویدیو.
Video_Group_ID long کد سرفصل یا دوره آموزشی.
Video_Title String عنوان ویدیو
Video_Cover String مسیر فایل کاور ویدیو
Video_Duration double زمان ویدیو به ثانیه
Video_Downloadable Boolean ویدیو فایل دانلود هست یا خیر.
Video_Description String شرح ویدیو
Video_Status Int کد وضعیت ویدیو
0 = در صف پردازش
1 = در حال پردازش
2 = آماده پخش
3 = دارای خطا
Video_StatusName String وضعیت ویدیو
Video_CreateDate String تاریخ و ساعت بارگزاری ویدیو
Video_UpdateDate String تاریخ و ساعت بروز رسانی ویدیو
Video_View Long تعداد بازدید ویدیو
Video_AllowDomains String دامنه های مجاز به پخش ویدیو
Video_AllowIPs String آی پی های مجاز به تماشای ویدیو
Video_DirectPlayURL String آدرس اینترنتی پخش مستقیم ویدیو
Video_DirectPlayEnable Boolean پخش مستقیم فعال باشد یا خیر
Video_EmbedScript String اسکریپت پخش ویدیو روی وب سایت ها
Video_DownloadUrl String آدرس دانلود
Video_GoogleAnalytics String کد ترکینگ گوگل آنالایتیکس

متد Get

از این متد جهت دریافت اطلاعات یک ویدیو استفاده فرمایید

آدرس متد

Method Urlhttps://stream.yoursite.xyz/api/v1/Video/Get/{id}

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
id String بله کد ویدیو

مقدار id را در انتهای url بفرستید

مثال: https://.../api/v1/video/get/DSePUvB4EiawBgXAOLxA

مقدار بازگشتی

    
    {
        "Video_ID": "DSePUvB4EiawBgXAOLxA",
        "Video_Group_ID": 20016,
        "Video_Title": "ویدیوی شماره 1",
        "Video_Cover": "https://stream.yoursite.xyz/Files/DSePUvB4EiawBgXAOLxA/thumbnail.jpg",
        "Video_Duration": 1627.0,
        "Video_Downloadable": false,
        "Video_Description": "",
        "Video_Status": 2,
        "Video_StatusName": "آماده",
        "Video_CreateDate": "2022-01-19T07:42:02.393",
        "Video_UpdateDate": "2022-01-29T17:58:37.113",
        "Video_View": 5,
        "Video_AllowDomains": "*",
        "Video_AllowIPs": "*",
        "Video_DirectPlayURL": "https://stream.yoursite.xyz/Video/Play/10083/vhznSUnPmk2v4YhkSjcBfg",
        "Video_DirectPlayEnable": true,
        "Video_EmbedScript": "<script id='DSePUvB4EiawBgXAOLxA' src='https://stream.yoursite.xyz/Video/Embed/DSePUvB4EiawBgXAOLxA'></script>",
        "Video_DownloadUrl": "",
        "Video_GoogleAnalytics": ""
    }

شرح مقادیر بازگشتی

مانند جدول مقادیر بازگشتی متد List