Справка по API REST Видео

Область применения: SharePoint Online | Office 365

Вы можете использовать API REST Видео для обнаружения и взаимодействия с видеороликами в службе Office 365 Видео в SharePoint Online. Вы можете получать информацию о видеороликах и каналах, отправлять новые видеоролики и получать информацию для их потоковой передачи.

Использование API REST Видео

Существует два типа объектов, с которыми взаимодействует API REST Видео: видеоролики и каналы.

Чтобы взаимодействовать с API REST Видео, вы отправляете HTTP-запросы, которые используют поддерживаемый метод: GET, POST, MERGE или DELETE.

Все запросы API Видео используют корневой URL-адрес, полученный от службы обнаружения, как описано в разделе "Операции с видеопорталом".

Имена ресурсов в URL-адресах и путях, а также параметры запросов нечувствительны к регистру. Однако присваиваемые значения, идентификаторы сущностей и другие кодированные значения base64 чувствительны к регистру.

API-интерфейсы Office 365 используют Microsoft Azure Active Directory (Azure AD) и OAuth для проверки подлинности запросов приложений. Чтобы получить доступ к API Видео в своем приложении, вам необходимо зарегистрировать его в Azure AD с помощью разрешений в соответствующей области. API REST Office 365 Видео поддерживает стандарты OData 4.0 и позволяет приложениям взаимодействовать с видеоданными Office 365 с использованием интерфейсов RESTful.

Разрешения разделены на три пользовательские группы:

  • Администраторы могут изменять настройки каналов и редактировать видеоролики.
  • Авторы могут создавать, читать, обновлять и удалять видеоролики (операции CRUD).
  • Зрители могут только просматривать видеоролики.

Владелец для каждого канала определяет, кто в организации попадает в каждую из этих групп. Кроме того, администратор клиента SharePoint может выполнить то же самое определение.

Примечание

Дополнительные сведения см. в статье Разработка на платформе Office 365.

Операции с видеопорталом

Вы можете получить корневой URL-адрес видеопортала, который будет использоваться во всех других операциях API REST Видео, и вы можете узнать, настроен и включен ли видеопортал.

Получение информации о видеопортале

С помощью службы обнаружения O365 получите корневой URL-адрес семейства веб-узлов SharePoint (RootSite), а затем вызовите VideoService.Discover с этого URL-адреса, чтобы получить URL-адрес видеопортала в SharePoint Online, который затем будет использоваться во всех последующих вызовах. Определите, установлен и включен ли видеопортал.

Примечание

Примечание. Чтобы получить доступ к службе обнаружения, вы должны войти в портал SharePoint для своей компании.

Как правило, конечный URL-адрес корневого семейства веб-узлов для SharePoint будет выглядеть примерно так (для вымышленной компании Contoso):

https://contoso.sharepoint.com/

Конечный URL-адрес видеопортала для той же компании, возвращаемый службой обнаружения, будет выглядеть примерно так:

https://contoso.sharepoint.com/portals/hub

GET {RootSite}/_api/VideoService.Discover

Примечание

Параметр RootSite - это строка, представляющая конечный URL-адрес корневого семейства веб-узлов для SharePoint, полученный из службы обнаружения.

Тип отклика

  • IsVideoPortalEnabled - возвращает True, если портал включен и настроен, False, если портал либо не включен, либо не настроен.
  • VideoPortalURL - конечный URL-адрес видеопортала, используемый во всех последующих вызовах.

Примечание

Мы предлагаем вам определить и использовать константу для этого URL-адреса, чтобы вы могли легко добавлять информацию о версии, когда она станет доступной.

Пример запроса

GET https://a830edad9050849nda1.sharepoint.com/_api/VideoService.Discover

Пример отклика

Код состояния: 200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/_api/$metadata#SP.ApiData.VideoServiceDiscoverers/@Element",
  "odata.type": "SP.Publishing.VideoServiceDiscoverer",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/_api/VideoService.Discover",
  "odata.editLink": "VideoService.Discover",
  "ChannelUrlTemplate": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_layouts/15/videochannel.aspx?channel={0}",
  "IsVideoPortalEnabled": true,
  "PlayerUrlTemplate": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_layouts/15/videoplayer.aspx?v={0}",
  "VideoPortalLayoutsUrl": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_layouts/15",
  "VideoPortalUrl": "https://a830edad9050849nda1.sharepoint.com/portals/hub"
}

Операции с каналами

Видеоролики хранятся в каналах. Вы можете получить список всех каналов, в которые пользователи могут отправлять видеоролики, и список всех каналов, которые пользователь может просматривать. Вы также можете получить информацию о конкретном канале, включая его идентификатор, цвет, название и список всех видеороликов, которые содержит канал.

Получение информации о каналах, которые пользователь может просматривать или использовать для отправки видеороликов

Получение списка каналов, в которые пользователь может отправлять видеоролики

Получите список каналов, в которые пользователь может отправлять видеоролики. Это каналы, для которых у него есть права владельца или редактора.

GET {VideoPortalURL}/_api/VideoService/CanEditChannels

Примечание

В этом и последующих вызовах VideoPortalURL - это строка, которая представляет собой URL-адрес конечной точки видеопортала, полученный из вызова VideoService.Discover.

Тип отклика

Возвращает список объектов Channel.

Примечание

Если у вашего видеопортала много каналов, на возврат значения этому API может потребоваться много времени.

Получение списка каналов, которые пользователь может просматривать

Получите список всех каналов, которые пользователь может просматривать. Это каналы, для которых у него есть права владельца, редактора или зрителя.

GET {VideoPortalURL}/_api/VideoService/Channels
Тип отклика

Возвращает список объектов Channel.

Пример запроса
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels
Пример отклика

Код состояния: 200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoChannels",
  "value": [
    {
      "odata.type": "SP.Publishing.VideoChannel",
      "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
      "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
      "Description": "",
      "Id": "1833f204-bb2a-4e93-b8dd-b236daeccae8",
      "ServerRelativeUrl": "/portals/Red-Channel",
      "TileHtmlColor": "#FF0000",
      "Title": "Red Channel",
      "YammerEnabled": true
    },
    {
      "odata.type": "SP.Publishing.VideoChannel",
      "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'c0949ba6-44fb-4db4-9d44-a395f7e9070f')",
      "odata.editLink": "VideoService/Channels(guid'c0949ba6-44fb-4db4-9d44-a395f7e9070f')",
      "Description": "",
      "Id": "c0949ba6-44fb-4db4-9d44-a395f7e9070f",
      "ServerRelativeUrl": "/portals/Blue-Channel",
      "TileHtmlColor": "#0072c6",
      "Title": "Blue Channel",
      "YammerEnabled": true
    },
    {
      "odata.type": "SP.Publishing.VideoChannel",
      "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'f92879ac-63bb-4247-a267-73e91cd2fe59')",
      "odata.editLink": "VideoService/Channels(guid'f92879ac-63bb-4247-a267-73e91cd2fe59')",
      "Description": "",
      "Id": "f92879ac-63bb-4247-a267-73e91cd2fe59",
      "ServerRelativeUrl": "/portals/community",
      "TileHtmlColor": "#2A8DD4",
      "Title": "Community",
      "YammerEnabled": true
    }
  ]
}

Получение информации о конкретном канале

Получение идентификатора, цвета и названия канала

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
Тип отклика

Возвращает следующую информацию о канале:

  • Id - идентификатор канала.
  • TileHtmlColor - цвет канала.
  • Title - название канала.
Пример запроса
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')
Пример отклика

Код состояния: 200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoChannels/@Element",
  "odata.type": "SP.Publishing.VideoChannel",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
  "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
  "Description": "",
  "Id": "1833f204-bb2a-4e93-b8dd-b236daeccae8",
  "ServerRelativeUrl": "/portals/Red-Channel",
  "TileHtmlColor": "#FF0000",
  "Title": "Red Channel",
  "YammerEnabled": true
}

Получение списка всех видеороликов на канале

Получает список всех видеороликов на указанном канале.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
Тип отклика

Возвращает список объектов Video.

Пример запроса
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos
Пример отклика

Код состояния: 200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoChannels/@Element",
  "odata.type": "SP.Publishing.VideoChannel",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
  "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
  "Description": "",
  "Id": "1833f204-bb2a-4e93-b8dd-b236daeccae8",
  "ServerRelativeUrl": "/portals/Red-Channel",
  "TileHtmlColor": "#FF0000",
  "Title": "Red Channel",
  "YammerEnabled": true
}

Получение списка самых последних воспроизводимых видеороликов на канале

Получает отсортированный список последних отправленных на канал видеороликов и отфильтровывает все видеоролики, которые еще не готовы к воспроизведению, за исключением тех, которые были загружены вами.

Будет возвращен отсортированный список всех видеороликов для канала, которые прошли транскодирование и готовы к воспроизведению (VideoProcessingStatus = 2), а также видеоролики, которые не готовы к воспроизведению, если они были загружены текущим пользователем.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/GetAllVideos
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
Тип отклика

Возвращает список объектов Video

Операции с видеороликами

Получайте информацию о конкретном видеоролике с канала, количество просмотров видео и данные о воспроизведении. Также отправляйте видеоролики на канал, обновляйте их и удаляйте с канала.

Получение информации о видеоролике

Получите информацию о конкретном видеоролике, включая дату его создания, название, продолжительность, URL-адрес миниатюры видеоролика и его статус обработки.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')

Параметры URL-адреса запроса

Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.

Тип отклика

Возвращает следующую информацию:

  • CreatedDate - дата, когда видеоролик был отправлен первоначально.
  • Title - название видеоролика.
  • VideoDurationInSeconds - длительность видеоролика в секундах.
  • ThumbnailURL - URL-адрес миниатюрного изображения видеоролика.
  • VideoProcessingStatus - статус обработки видеоролика. Может принимать следующие значения:
    • 0 - (по умолчанию) – видеоролик для воспроизведения еще не обработан.
    • 1 – видеоролик был выбран и обрабатывается.
    • 2 – видеоролик готов к воспроизведению.
    • 3 – в видеоролике возникла ошибка в процессе его отправки в службы мультимедиа Azure для обработки.
    • 4 – ошибка – общая ошибка. Невозможно обработать видеоролик для потоковой передачи.
    • 5 – ошибка – ошибка времени ожидания. Невозможно обработать видеоролик для потоковой передачи.
    • 6 – ошибка – неподдерживаемый формат. Тип видеофайла не поддерживается для потокового воспроизведения службами мультимедиа Azure.

Пример запроса

GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')

Пример отклика

Код состояния: 200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoItems/@Element",
  "odata.type": "SP.Publishing.VideoItem",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')",
  "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')",
  "ChannelID": "1833f204-bb2a-4e93-b8dd-b236daeccae8",
  "CreatedDate": "2015-07-08T05:05:06Z",
  "Description": "",
  "DisplayFormUrl": "https://a830edad9050849nda1.sharepoint.com/portals/Red-Channel/pVid/Forms/DispForm.aspx?ID=5",
  "FileName": "Divers - Future of Productivity.mp4",
  "OwnerName": "TEST_TEST_SPOProvHeartbeat_E3_15_4911090814_22,#i:0#.f|membership|admin@a830edad9050849nda1.onmicrosoft.com,#admin@a830edad9050849NDA1.onmicrosoft.com,#admin@a830edad9050849NDA1.onmicrosoft.com,#TEST_TEST_SPOProvHeartbeat_E3_15_4911090814_22,#https://a830edad9050849nda1-my.sharepoint.com:443/User%20Photos/Profile%20Pictures/admin_a830edad9050849nda1_onmicrosoft_com_MThumb.jpg,#,#",
  "ServerRelativeUrl": "/portals/Red-Channel/pVid/Divers - Future of Productivity.mp4",
  "ThumbnailUrl": "https://a830edad9050849nda1.sharepoint.com/portals/Red-Channel/pVid/Divers - Future of Productivity.mp4.PNG?VideoPreview=1",
  "Title": "Divers - Future of Productivity",
  "ID": "6b518eae-b0d9-4951-b6da-1e5f58a43daa",
  "Url": "https://a830edad9050849nda1.sharepoint.com/portals/Red-Channel/pVid/Divers - Future of Productivity.mp4",
  "VideoDurationInSeconds": 388,
  "VideoProcessingStatus": 2,
  "ViewCount": -1,
  "YammerObjectUrl": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_layouts/15/videoplayer.aspx?v=https%3A%2F%2Fa830edad9050849nda1%2Esharepoint%2Ecom%2Fportals%2FRed%2DChannel%2FpVid%2FDivers%20%2D%20Future%20of%20Productivity%2Emp4"
}

Получение количества просмотров видеоролика

Показатели просмотра возвращаются только тогда, когда вы извлекаете объект Video из конечных точек поиска, поскольку подсчет просмотров агрегируется поисковой аналитикой. Таким образом, свойство ViewCount будет иметь неточные значения, если оно не будет получено через поисковые конечные точки концентратора или канала.

Чтобы получить количество просмотров для одного видеоролика, запустите поисковый запрос, используя идентификатор видеоролика.

GET {VideoPortalURL}/_api/videoservice/Channels('{channelId}')/search/query('{videoId}')?$Select=ViewCount
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
Параметры запроса
Имя Тип Описание
_$Select=ViewCount string Количество просмотров, включаемое в ответ.
Тип отклика

Возвращает количество просмотров видеоролика.

Пример запроса
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')?$Select=ViewCount
Пример отклика
{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoItems/@Element&$select=ViewCount",
  "odata.type": "SP.Publishing.VideoItem",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')",
  "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')",
  "ViewCount": -1
}

Получение информации о воспроизведении видеоролика

Получение URL-адреса манифеста служб мультимедиа Azure для видеоролика

Этот вызов получает URL-адрес манифеста служб мультимедиа Azure для видеоролика. Вы можете передать этот манифест в плеер, у которого есть поддержка для работы с ресурсами служб мультимедиа Azure.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetPlaybackUrl('{streamingFormatType}')
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
streamingFormatType numeric Тип формата потокового видео.

Параметр streamingFormatType может принимать следующие значения:

  • 1 -- Smooth Streaming или MPEG-DASH.
  • 0 - Потоковая передача HLS.
Тип отклика

Возвращает URL-адрес манифеста для видеоролика.

Пример запроса
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')/GetPlaybackUrl(1)
Пример отклика

Код состояния: 200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#Edm.String",
  "value": "https://cdn-cvprbl201m01.streaming.mediaservices.windows.net/dc91ba77-e23b-4f2d-9a6b-1b4e96ed554a/9c9b55ed-24d3-45d5-b8dd-f262856a8812.ism/Manifest"
}

Получение маркера носителя для доступа к расшифровке видеоролика

Все видео O365 зашифрованы по алгоритму AES. Для воспроизведения видеороликов в формате Smooth Streaming или MPEG-DASH вам сначала нужно получить маркер носителя для доступа к расшифровке содержимого. Этот API возвращает маркер проверки подлинности, чтобы плеер мог расшифровывать содержимое.

Однако для потоковой передачи HLS вам не нужно отдельно получать маркер доступа к ключам, поскольку он уже является частью URL-адреса манифеста, который вы получаете, когда извлекаете формат HLS манифеста.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetStreamingKeyAccessToken
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
Тип отклика

Возвращает маркер проверки подлинности, чтобы плеер мог расшифровать содержимое.

Пример запроса
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')/GetStreamingKeyAccessToken
Пример отклика

Код состояния: 200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#Edm.String",
  "value": "Bearer=urn%3amicrosoft%3aazure%3amediaservices%3acontentkeyidentifier=589ae2f2-969e-43bb-bd04-8d5dad4cce4b&urn%3amicrosoft%3aazure%3amediaservices%3akeyacquisitionhostname=cvprbl201m01.keydelivery.mediaservices.windows.net&http%3a%2f%2fschemas.microsoft.com%2faccesscontrolservice%2f2010%2f07%2fclaims%2fidentityprovider=https%3a%2f%2fnimbuslkgglobacs.accesscontrol.windows.net&urn%3aServiceAccessible=service&Audience=urn%3aNimbus&ExpiresOn=1438217438&Issuer=https%3a%2f%2fnimbuslkgglobacs.accesscontrol.windows.net%2f&HMACSHA256=QHrVRPwi4z1ogCTC5VSbzB%2bS4ThTAaZMvIRCrPQSYno%3d"
}

Отправка видеороликов на канал

Создайте пустой видеообъект в качестве заполнителя для папки отправки видео.

После этого вы можете отправить один небольшой видеоролик в одном POST-вызове или более крупный по фрагментам в нескольких POST-вызовах.

Создание заполнителя для папки отправки видеоролика

Создает пустой видеообъект, который выступает в качестве заполнителя для папки отправки видеоролика.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
Текст запроса
{
    '__metadata': {
        'type': 'SP.Publishing.VideoItem'
    },
    'Description': '
    {
        *your description text here*
    }
    ',
    'Title': '
    {
        *your title of video here*
    }
    '
}
Имя Тип Описание
метаданные SP.Publishing.VideoItem Тип объекта, который вы обновляете
Описание string Описание видеоролика.
Название string Название видеоролика.
FileName string Имя файла видеоролика.
Тип отклика

VideoObject - объект, в который нужно отправить видеоролик. Используйте идентификатор, возвращаемый в качестве идентификатора видеоролика, чтобы начать отправку.

Отправка небольшого видеоролика в одной публикации

Загружает один видеоролик достаточно малого размера для передачи в одной публикации.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/SaveBinaryStream
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
Текст запроса

Бинарный поток файлов.

Тип отклика

Возвращает 200. Нет текста ответа.

Отправка крупного видеоролика по фрагментам

Используйте следующие вызовы, чтобы отправить видеоролик, слишком крупный для одного вызова POST, или отменить отправку по фрагментам.

Начало отправки в видеообъект, созданный ранее

Начинает отправку фрагментированного видеоролика.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/StartUpload(uploadId=guid'{yourGeneratedGuid}')
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
yourGeneratedGuid GUID GUID, который вы создаете для своего сеанса отправки.
Тип отклика

Возвращает 200. Нет текста ответа.

Отправка каждого фрагмента файла в видеообъект, созданный ранее

Продолжает отправлять следующий фрагмент файла. Повторяйте столько раз, сколько необходимо.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/ContinueUpload(uploadId=guid'{yourGeneratedGuid}',fileOffset='{offsetSize}')
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
yourGeneratedGuid GUID GUID, который вы создаете для своего сеанса отправки.
offsetSize целое число Значение уже отправленных байтов.

Примечание

Если вы отправили фрагменты по 8 МБ, смещение для первого фрагмента будет 0, а смещение для второго фрагмента будет 8*1024=8192.

Текст запроса

Бинарный поток файла этого фрагмента.

Тип отклика

Возвращает 200. Нет текста ответа.

Завершение отправки последнего фрагмента файла в видеообъект, созданный ранее

Завершает отправку фрагментированного видеоролика.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/FinishUpload(uploadId=guid'{yourGeneratedGuid}',fileOffset='{offsetSize}')
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
yourGeneratedGuid GUID GUID, который вы создаете для своего сеанса отправки.
offsetSize целое число Значение уже отправленных байтов.
Текст запроса

Бинарный поток файла последнего фрагмента.

Тип отклика

Возвращает 200. Нет текста ответа.

Отмена отправки

Отменяет отправку фрагментированного видеоролика.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/CancelUpload(uploadId=guid'{yourGeneratedGuid}')
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
yourGeneratedGuid GUID GUID, который вы создаете для своего сеанса отправки.
Тип отклика

Возвращает 200. Нет текста ответа.

Обновление метаданных видеоролика

Обновление метаданных для существующего видеоролика на канале

Измените название и описание видео.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
Заголовок запроса
Имя Тип Описание
X-HTTP-Method string MERGE - это значение свойства X-HTTP-Method.
Текст запроса
{'__metadata':{'type':'SP.Publishing.VideoItem'},'Description':'{ *your description text here* }', 'Title':'{ *your title of video here* }'}
Имя Тип Описание
метаданные SP.Publishing.VideoItem Тип видеообъекта.
Описание string Описание видеоролика.
Название string Название видеоролика.
Тип отклика

Возвращает 200. Нет текста ответа.

Удаление видеороликов с канала

Удаление существующего видеоролика с канала

 POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')
Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
Заголовок запроса
Имя Тип Описание
X-HTTP-Method string DELETE - это значение свойства X-HTTP-Method.
Тип отклика

Возвращает 200. Нет текста ответа.

Внедрение видеоролика на другую страницу

Получение кода, который позволяет внедрять видеоэлемент на другую веб-страницу, указывая значения параметров

Используя этот вызов, вы можете указать значения параметров, которые вы передаете, включая ширину и высоту внедренного окна, а также определить, будет ли воспроизводиться видеоролик автоматически при открытии страницы и отображаться определенная информация в видеоплеере, когда видео приостановлено. Информация включает в себя название видеоролика, его длительность, количество воспроизведений и название канала.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetVideoEmbedCode?width={width}&height={height}&autoplay={true/false}&showinfo={true/false}

Если вы не передадите значения для параметров, Office 365 выберет некоторые разумные значения по умолчанию, например 120 для ширины и 230 для высоты.

Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
width numeric Ширина внедренного видеоокна.
height numeric Высота внедренного видеоокна.
Autoplay true/false Будет ли внедренный видеоролик запускаться автоматически.
ShowInfo true/false Будут ли отображаться в плеере название видеоролика, его длительность, количество просмотров и имя канала, когда видеоролик приостановлен.
Тип отклика

Возвращает код внедрения.

Получение кода, который позволяет внедрять видеоэлемент на другую веб-страницу с использованием значений по умолчанию

Используя этот вызов, вы можете получить код внедрения, который определяет значения по умолчанию для внедренного видеоплеера.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/?$Select=Title,DefaultEmbedCode

Свойство DefaultEmbedCode не возвращается автоматически в объект Video. Чтобы получить DefaultEmbedCode, вам нужно использовать параметр $select.

Используя параметр $select, вы можете запросить видеоэлемент для возврата любых свойств видеоролика, включая заголовок и код внедрения по умолчанию, как показано на рисунке.

Параметры URL-адреса запроса
Обязательный параметр Тип Описание
channelId string Идентификатор канала.
videoId string Идентификатор видеоролика.
Тип отклика

Возвращает любые свойства по умолчанию, которые вы запрашиваете, с помощью $select, включая код внедрения по умолчанию.

Получение информации о видеоэлементе и кода внедрения по умолчанию с URL-адреса страницы плеера

Используя этот вызов, если вы знаете URL-адрес страницы плеера видеопортала O365 для видеоролика, вы можете получить идентификатор видеоролика, канала и другую информацию.

POST {VideoPortalURL}/_api/VideoService/GetVideoByURL?$Select=Title,Description,CreatedDate,DefaultEmbedCode,VideoDurationInSeconds,ID,VideoProcessingStatus

Используя параметр $select, вы можете запросить у видеоэлемента возврат любых свойств видеоролика, включая название и код внедрения по умолчанию, как показано выше.

Заголовок запроса

Accept=application/json;odata=verbose

Content-Type=application/json;odata=verbose

Текст запроса
{'videoFileRelativeUrl':'https://*root_SharePoint_site*/portals/hub/_layouts/15/PointPublishing.aspx?app=video&p=p&chid=b74774cb-faad-43a0-8de9-cb263e38d75d&vid=e5b66725-9f87-4813-9b50-b24fe80c9c20'}

Где videoFileRelativeURL является относительным или абсолютным URL-адресом страницы плеера видеопортала O365 для видеоролика.

Дальнейшие действия

Готовы ли вы приступить к созданию приложения или просто хотите узнать больше, мы можем вам помочь.

Или узнайте больше об использовании платформы Office 365 здесь: