Référence de l'API REST Vidéo

S'applique à : SharePoint Online | Office 365

Vous pouvez utiliser l'API REST Vidéo pour découvrir et interagir avec des vidéos du service Office 365 Vidéo dans SharePoint Online. Vous pouvez obtenir des informations sur les vidéos et les chaînes, télécharger de nouvelles vidéos et obtenir des informations pour diffuser des vidéos.

Utilisation de l'API REST Vidéo

L'API vidéo REST interagit avec deux types d'objets : les vidéos et les chaînes.

Pour interagir avec l'API vidéo REST, vous envoyez des requêtes HTTP qui utilisent une méthode prise en charge : GET, POST, MERGE ou DELETE.

Toutes les demandes d'API vidéo utilisent l'URL racine obtenue auprès du service de découverte, comme expliqué dans la rubrique « Opérations du portail vidéo ».

Les noms de ressources d'URL de chemin et les paramètres de requête sont insensibles à la casse. Toutefois, les valeurs que vous attribuez, les identifiants d'entité et les autres valeurs codées en base64 sont sensibles à la casse.

Les API Office 365 utilisent Microsoft Azure Active Directory (Azure AD) et OAuth pour authentifier les demandes d'application. Pour accéder à l'API vidéo depuis votre application, vous devez l'enregistrer dans Azure AD avec les autorisations appropriées. L'API vidéo REST Office 365 prend en charge les normes OData 4.0 et permet aux applications d'interagir avec les données vidéo sur Office 365 à l'aide d'interfaces RESTful.

Les autorisations sont définies selon trois groupes personnalisés :

  • Les administrateurs peuvent modifier les paramètres de chaîne et modifier les vidéos.
  • Les contributeurs peuvent créer, lire, mettre à jour et supprimer des vidéos (CRUD - create, read, update, delete en anglais).
  • Les spectateurs ne peuvent que visionner les vidéos.

Le propriétaire de la chaîne détermine pour chaque chaîne qui, dans l'organisation, appartient à chacun de ces groupes. En outre, l'administrateur de client SharePoint peut effectuer la même détermination.

Note

Pour plus d’informations, voir Développement sur la plateforme Office 365.

Opérations du portail vidéo

Vous pouvez obtenir l'URL racine du portail vidéo à utiliser dans toutes les autres opérations de l'API vidéo REST et vous pouvez déterminer si le portail vidéo est configuré et activé.

Obtenir des informations sur le portail vidéo

Utilisez le Service de découverte O365 pour obtenir l'URL racine de la collection de sites SharePoint (RootSite), puis appelez VideoService. Découvrez à partir de cette URL pour obtenir l'URL du portail vidéo dans SharePoint Online, que vous utiliserez ensuite dans tous les appels suivants. Déterminez si le portail vidéo est configuré et activé.

Note

Pour accéder au service de découverte, vous devez être connecté au portail SharePoint de votre entreprise.

En règle générale, l'URL du point de terminaison de la collection de sites racines pour SharePoint ressemble à ceci (pour la société fictive Contoso) :

https://contoso.sharepoint.com/

L'URL du point de terminaison du portail vidéo de la même société renvoyée par le service de découverte ressemblerait à ceci :

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

GET {RootSite}/_api/VideoService.Discover

Note

Le paramètre RootSite est une chaîne qui représente l'URL du point de terminaison de la collection de sites racines pour SharePoint, telle qu'elle est extraite du service de découverte.

Type de réponse

  • IsVideoPortalEnabled – Renvoie True si le portail est activé et configuré, False si le portail n'est pas activé ou n'est pas configuré.
  • VideoPortalURL – L'URL du point de terminaison du portail vidéo, utilisée dans tous les appels suivants.

Note

Nous vous suggérons de définir et d'utiliser une constante pour cette URL, afin que vous puissiez facilement ajouter des informations de version lorsque celles-ci seront disponibles.

Exemple de demande

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

Exemple de réponse

Code d’état : 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"
}

Opérations de chaîne

Les vidéos sont stockées dans des chaînes. Vous pouvez obtenir une liste de toutes les chaînes sur lesquelles les utilisateurs peuvent télécharger des vidéos, ainsi qu'une liste de toutes les chaînes qu'un utilisateur peut visualiser. Vous pouvez également obtenir des informations sur une chaîne en particulier, notamment l'identifiant d'une chaîne, la couleur d'une chaîne, le titre d'une chaîne et la liste de toutes les vidéos qu'elle contient.

Obtenir des informations sur les chaînes que l'utilisateur peut afficher ou sur lesquelles il peut télécharger

Obtenir la liste des chaînes sur lesquelles l'utilisateur peut télécharger des vidéos

Obtenez la liste des chaînes sur lesquelles un utilisateur peut télécharger des vidéos. Ce sont les chaînes pour lesquelles il a des autorisations Propriétaire ou Éditeur.

GET {VideoPortalURL}/_api/VideoService/CanEditChannels

Note

Dans cet appel et tous les suivants, VideoPortalURLVideoPortalURL est une chaîne qui représente l'URL du point de terminaison du portail vidéo, telle qu'elle est extraite de l'appel VideoService.Discover.

Type de réponse

Renvoie une liste d'objets Channel.

Note

Si votre portail vidéo comporte beaucoup de chaînes, cette API peut prendre beaucoup de temps à répondre.

Obtenir la liste des chaînes que l'utilisateur peut consulter

Obtenir la liste de toutes les chaînes qu'un utilisateur peut visionner. Ce sont les chaînes pour lesquelles il a des autorisations Propriétaire, Éditeur ou Spectateur.

GET {VideoPortalURL}/_api/VideoService/Channels
Type de réponse

Renvoie une liste d'objets Channel.

Exemple de demande
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels
Exemple de réponse

Code d’état : 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
    }
  ]
}

Obtenir des informations sur une chaîne particulière

Obtenir l'identifiant de la chaîne, la couleur de la chaîne et le titre de la chaîne

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
Type de réponse

Renvoie les informations suivantes sur une chaîne :

  • Id -- Identifiant de la chaîne.
  • TileHtmlColor -- Couleur de la chaîne.
  • Titre -- Titre de la chaîne.
Exemple de demande
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')
Exemple de réponse

Code d’état : 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
}

Obtenir une liste de toutes les vidéos sur une chaîne

Obtient la liste de toutes les vidéos sur la chaîne spécifiée.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
Type de réponse

Renvoie une liste d'objets vidéo.

Exemple de demande
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos
Exemple de réponse

Code d’état : 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
}

Obtenir la liste des vidéos les plus récentes sur une chaîne

Obtient une liste triée des dernières vidéos mises en ligne pour une chaîne et filtre toutes les vidéos qui ne sont pas encore prêtes à être lues, à l'exception de celles qui ont été téléchargées par vous.

Cela renvoie une liste triée de toutes les vidéos de la chaîne qui ont terminé le transcodage et sont prêtes à être lues (VideoProcessingStatus = 2), ainsi que des vidéos qui ne sont pas prêtes à être lues si elles ont été téléchargées par l'utilisateur actuellement connecté.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/GetAllVideos
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
Type de réponse

Renvoie une liste d'objets vidéo

Opérations vidéo

Obtenez des informations sur une vidéo particulière d'une chaîne, obtenez le nombre de fois que la vidéo a été visionnée et obtenez des informations de lecture. En outre, mettez en ligne des vidéos sur une chaîne, mettez à jour les vidéos sur une chaîne et supprimez des vidéos d'une chaîne.

Obtenir des informations sur une vidéo

Obtenez des informations sur une vidéo en particulier, y compris la date à laquelle elle a été créée, son titre, sa durée, l'URL de la vignette de la vidéo et son état de traitement.

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

Demander des paramètres d'URL

Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.

Type de réponse

Renvoie les informations suivantes :

  • CreatedDate - Date à laquelle la vidéo a été importée.
  • Titre -- Le titre de la vidéo.
  • VideoDurationInSeconds -- Durée de la vidéo, en secondes.
  • ThumbnailURL -- URL de l'image miniature de la vidéo.
  • VideoProcessingStatus -- Etat du traitement vidéo. Peut avoir les valeurs suivantes :
    • 0 -- (par défaut) -- La vidéo n'a pas encore été traitée pour la lecture.
    • 1 -- La vidéo a été prise en compte et est en cours de traitement.
    • 2 -- La vidéo est prête à être lue.
    • 3 -- La vidéo a rencontré une erreur pendant son transfert vers Azure Media Services pour traitement.
    • 4 -- Erreur -- Erreur générique -- Impossible de traiter la vidéo pour la diffusion.
    • 5 -- Erreur -- Erreur de délai d'attente -- Impossible de traiter la vidéo pour la diffusion.
    • 6 -- Erreur -- Format non pris en charge -- Le type de fichier vidéo n'est pas pris en charge pour la lecture en continu par Azure Media Services.

Exemple de demande

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

Exemple de réponse

Code d’état : 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"
}

Obtenir le nombre de fois qu'une vidéo a été visionnée

Les décomptes de visionnement sont renvoyés uniquement lorsque vous récupérez l'objet vidéo à partir des points de terminaison de la recherche, car les décomptes de vue sont agrégés par l'analytique de recherche. Ainsi, la propriété ViewCount aura des valeurs inexactes à moins d'être récupérée via les points de terminaison /Search du concentrateur ou d'une chaîne.

Pour obtenir le nombre de vues d'une seule vidéo, exécutez une requête de recherche à l'aide de l'identifiant de la vidéo.

GET {VideoPortalURL}/_api/videoservice/Channels('{channelId}')/search/query('{videoId}')?$Select=ViewCount
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
Paramètres de requête
Nom Type Description
_$Select=ViewCount chaîne Le nombre de vues à inclure dans la réponse.
Type de réponse

Renvoie le nombre de fois que la vidéo a été visionnée.

Exemple de demande
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
Exemple de réponse
{
  "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
}

Obtenir des informations sur une vidéo

Obtenir l'URL du manifeste Azure Media Services pour une vidéo

Cela obtient l'URL du manifeste Azure Media Services pour la vidéo. Vous pouvez envoyer ce manifeste à un lecteur prenant en charge la lecture des ressources Azure Media Services.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetPlaybackUrl('{streamingFormatType}')
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
streamingFormatType numeric Le type de format de diffusion de la vidéo.

Le paramètre streamingFormatType peut prendre les valeurs suivantes :

  • 1 -- Diffusion en continu lisse ou MPEG-DASH
  • 0 - Diffusion HLS
Type de réponse

Renvoie l'URL du manifeste pour la vidéo.

Exemple de demande
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)
Exemple de réponse

Code d’état : 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"
}

Obtenir le jeton du porteur pour accéder au décryptage de la vidéo

Toutes les vidéos O365 sont cryptées en AES. Pour lire des vidéos au format Diffusion en continu lisse ou MPEG-DASH, vous devez d'abord obtenir le jeton du porteur pour accéder au décryptage du contenu. Cette API renvoie le jeton d'authentification pour permettre au lecteur de décrypter le contenu.

Toutefois, pour la diffusion HLS, vous n'avez pas besoin de récupérer le jeton d'accès de clé séparément, car il fait déjà partie de l'URL du manifeste que vous obtenez lorsque vous récupérez le format HLS du manifeste.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetStreamingKeyAccessToken
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
Type de réponse

Renvoie le jeton d'authentification pour permettre au lecteur de décrypter le contenu.

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

Code d’état : 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"
}

Importer des vidéos sur une chaîne

Créez un objet vidéo vide qui servira d'espace réservé pour l'importation d'une vidéo.

Après cela, vous pouvez télécharger une seule petite vidéo dans un appel POST, ou une plus grande, en morceaux, dans plusieurs appels POST.

Créer un espace réservé pour l'endroit où vous allez télécharger la vidéo

Crée un objet vidéo vide qui sert d'espace réservé pour le téléchargement de la vidéo.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
Corps de la demande
{
    '__metadata': {
        'type': 'SP.Publishing.VideoItem'
    },
    'Description': '
    {
        *your description text here*
    }
    ',
    'Title': '
    {
        *your title of video here*
    }
    '
}
Nom Type Description
métadonnées SP.Publishing.VideoItem Le type d'objet que vous mettez à jour
Description chaîne La description de la vidéo.
Title chaîne Le titre de la vidéo.
FileName chaîne Le nom de fichier de la vidéo.
Type de réponse

VideoObject -- L'objet dans lequel télécharger la vidéo. Utilisez l'identifiant renvoyé comme identifiant de la vidéo pour commencer le téléchargement.

Télécharger une vidéo plus petite en une seule requête POST

Télécharge une seule vidéo assez petite pour être transmise en une seule requête POST.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/SaveBinaryStream
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
Corps de la demande

Le flux binaire du fichier.

Type de réponse

Renvoie 200. Pas de réponse.

Télécharger une vidéo plus grande en morceaux

Utilisez les appels suivants pour télécharger une vidéo trop volumineuse pour tenir dans un seul appel POST ou pour annuler un téléchargement groupé.

Commencez le téléchargement vers l'objet vidéo créé précédemment

Démarre le téléchargement de la vidéo segmentée.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/StartUpload(uploadId=guid'{yourGeneratedGuid}')
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
yourGeneratedGuid GUID Le GUID que vous générez pour votre session de téléchargement.
Type de réponse

Renvoie 200. Pas de réponse.

Télécharger chaque partie du fichier vers l'objet vidéo créé précédemment

Continue de télécharger le morceau suivant du fichier. Répétez cette action autant de fois que nécessaire.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/ContinueUpload(uploadId=guid'{yourGeneratedGuid}',fileOffset='{offsetSize}')
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
yourGeneratedGuid GUID Le GUID que vous générez pour votre session de téléchargement.
offsetSize entier La valeur des octets déjà téléchargés.

Note

Si vous chargiez des blocs de 8 Mo, le décalage pour le premier segment serait de 0 et le décalage pour le second morceau serait de 8*1024 = 8192.

Corps de la demande

Le flux binaire du fichier de ce segment.

Type de réponse

Renvoie 200. Pas de réponse.

Terminer le téléchargement du dernier segment du fichier vers l'objet vidéo créé précédemment

Termine le téléchargement de la vidéo segmentée.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/FinishUpload(uploadId=guid'{yourGeneratedGuid}',fileOffset='{offsetSize}')
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
yourGeneratedGuid GUID Le GUID que vous générez pour votre session de téléchargement.
offsetSize entier La valeur des octets déjà téléchargés.
Corps de la demande

Le flux binaire du fichier du dernier morceau.

Type de réponse

Renvoie 200. Pas de réponse.

Annuler le téléchargement

Annule le téléchargement de la vidéo segmentée.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/CancelUpload(uploadId=guid'{yourGeneratedGuid}')
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
yourGeneratedGuid GUID Le GUID que vous générez pour votre session de téléchargement.
Type de réponse

Renvoie 200. Pas de réponse.

Mettre à jour les métadonnées vidéo

Mettre à jour les métadonnées d'une vidéo existante sur une chaîne

Changer le titre et la description d'une vidéo.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
En-tête de demande
Nom Type Description
X-HTTP-Method chaîne MERGE est la valeur de la propriété X-HTTP-Method.
Corps de la demande
{'__metadata':{'type':'SP.Publishing.VideoItem'},'Description':'{ *your description text here* }', 'Title':'{ *your title of video here* }'}
Nom Type Description
métadonnées SP.Publishing.VideoItem Le type de l'objet vidéo.
Description chaîne La description de la vidéo.
Title chaîne Le titre de la vidéo.
Type de réponse

Renvoie 200. Pas de réponse.

Supprimer des vidéos d'une chaîne

Supprimer une vidéo existante d'une chaîne

 POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')
Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
En-tête de demande
Nom Type Description
X-HTTP-Method chaîne DELETE est la valeur de la propriété X-HTTP-Method.
Type de réponse

Renvoie 200. Pas de réponse.

Incorpore une vidéo dans une autre page

Obtenez un code qui vous permet d'incorporer un élément vidéo dans une autre page Web, en spécifiant des valeurs de paramètres

Cet appel vous permet de spécifier des valeurs pour les paramètres que vous passez, notamment la largeur et la hauteur de la fenêtre incorporée, si la vidéo est lue automatiquement à l'ouverture de la page et si certaines informations s'affichent dans le lecteur vidéo lorsque la vidéo est en pause. L'information comprend le titre de la vidéo, sa durée, le nombre de fois qu'elle a été lue. et le nom de la chaîne.

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

Si vous ne transmettez pas de valeurs pour les paramètres, Office 365 sélectionnera certaines valeurs par défaut, telles que 120 pour la largeur et 230 pour la hauteur.

Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
largeur numeric Largeur de la fenêtre vidéo intégrée.
height numeric La hauteur de la fenêtre vidéo intégrée.
Lecture automatique vrai/faux Si la vidéo intégrée va démarrer automatiquement.
ShowInfo vrai/faux Indique si le titre de la vidéo, la durée, le nombre de vues et le nom de la chaîne s'affichent dans le lecteur lorsque la vidéo est en pause.
Type de réponse

Renvoie le code d'intégration.

Obtenir un code qui vous permet d'intégrer un élément vidéo dans une autre page Web en utilisant les valeurs par défaut

En utilisant cet appel, vous pouvez obtenir un code d'intégration qui spécifie les valeurs par défaut pour le lecteur vidéo intégré.

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

La propriété « DefaultEmbedCode » n'est pas renvoyée automatiquement sur l'objet vidéo. Pour obtenir le « DefaultEmbedCode », vous devez utiliser l'option $select.

En utilisant l'option $select, vous pouvez demander à l'élément vidéo de renvoyer l'une des propriétés de la vidéo, y compris le titre et le code d'intégration par défaut, comme indiqué.

Demander des paramètres d'URL
Paramètre requis Type Description
channelId chaîne Identifiant de la chaîne.
videoId chaîne Identifiant de la vidéo.
Type de réponse

Renvoie toutes les propriétés par défaut que vous demandez en utilisant $select, y compris le code d'intégration par défaut.

Obtenez les informations sur l'élément vidéo et le code d'intégration par défaut à partir de l'URL de la page du lecteur

Avec cet appel, si vous connaissez l'URL de la page du lecteur du portail vidéo O365 pour une vidéo, vous pouvez obtenir l'identifiant de la vidéo, l'identifiant de la chaîne et d'autres informations sur la vidéo.

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

En utilisant l'option $select, vous pouvez demander à l'élément vidéo de renvoyer l'une des propriétés de la vidéo, y compris le titre et le code d'intégration par défaut, comme indiqué.

En-tête de demande

Accept=application/json;odata=verbose

Content-Type=application/json;odata=verbose

Corps de la demande
{'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 est l'URL relative ou absolue de la page du lecteur du portail vidéo O365 pour une vidéo.

Étapes suivantes

Que vous soyez prêt à commencer à construire une application ou que vous souhaitiez simplement en apprendre plus, nous avons ce qu'il vous faut.

Ou pour en savoir plus sur l'utilisation de la plateforme Office 365 :