Referencia de la API de REST para vídeos

Se aplica a: SharePoint Online | Office 365

Puede usar la API de REST para vídeos para descubrir e interactuar con vídeos en el servicio de Office 365 Video en SharePoint Online. Puede obtener información sobre vídeos y canales, subir vídeos nuevos y conseguir información para transmitir vídeos.

Usar la API de REST para vídeos

Hay dos tipos de objetos con los que interactúa la API de REST para vídeos: vídeos y canales.

Para interactuar con la API de REST para vídeos, envíe solicitudes HTTP que utilicen un método compatible: GET, POST, MERGE o DELETE.

Todas las solicitudes de la API de vídeo usan la URL raíz obtenida del Servicio de detección, como se explica en la sección "Operaciones del Portal de Vídeo".

Los nombres de los recursos de el URL de la ruta de acceso y los parámetros de consulta no distinguen entre mayúsculas y minúsculas. Sin embargo, los valores que asigne usted, los id. de entidad y otros valores codificados en base64 sí distinguen entre mayúsculas y minúsculas.

Las API de Office 365 usan Microsoft Azure Active Directory (Azure AD) y OAuth para autenticar solicitudes de aplicaciones. Para acceder a la API de vídeo desde su aplicación, deberá registrarla en Azure AD con permisos en el ámbito apropiado. La API de REST de Office 365 Video admite los estándares OData 4.0 y permite que las aplicaciones interactúen con datos de vídeo en Office 365 mediante el uso de interfaces RESTful.

Los permisos tienen tres grupos de ámbito personalizados:

  • Los administradores pueden cambiar la configuración del canal y editar vídeos.
  • Los colaboradores pueden crear, leer, actualizar y eliminar (CRUD) vídeos.
  • Los espectadores solo pueden ver vídeos.

El propietario del canal determina para cada canal quién de la organización pertenece a cada uno de estos grupos. Además, el administrador de inquilinos de SharePoint puede tomar la misma determinación.

Nota

Para más información, consulte Desarrollar en la plataforma de Office 365.

Operaciones del portal de vídeo

Puede obtener la URL raíz del portal de vídeo para utilizarla en todas las demás operaciones de la API de REST para vídeos, y puede detectar si el portal de vídeo está configurado y habilitado.

Obtener información sobre el portal de vídeo

Utilice el Servicio de detección O365 para obtener la URL raíz de la Colección de Sitios de SharePoint (Sitio raíz) y luego llame a VideoService.Discover desde esa URL para obtener la URL del portal de vídeo en SharePoint Online, que más tarde utilizará en todas las llamadas posteriores. Determine si el portal de vídeo está configurado y habilitado.

Nota

Para acceder al servicio de detección, debe iniciar sesión en el portal de SharePoint de su compañía.

Por lo general, la URL del punto de conexión de la colección de sitios raíz para SharePoint tendría un aspecto como este (para la compañía ficticia Contoso):

https://contoso.sharepoint.com/

La URL del punto de conexión para el portal de vídeo de la misma compañía devuelta por el servicio de detección tendría entonces un aspecto parecido a este:

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

GET {RootSite}/_api/VideoService.Discover

Nota

El parámetro RootSite es una cadena que representa la URL del punto de conexión de la colección de sitios raíz para SharePoint, según es recuperada por el servicio de detección.

Tipo de respuesta

  • IsVideoPortalEnabled devuelve True (Verdadero) si el portal está habilitado y configurado, y False (Falso) si el portal no está habilitado o no está configurado.
  • VideoPortalURL es la URL del punto de conexión del portal de vídeo, y se usa en todas las llamadas posteriores.

Nota

Sugerimos que defina y use una constante para esa URL, de forma que pueda agregar fácilmente la información del control de versiones cuando esté disponible.

Solicitud de muestra

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

Respuesta de muestra

Código de estado: 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"
}

Operaciones del canal

Los vídeos se almacenan en canales. Puede obtener una lista de todos los canales a los que los usuarios pueden subir vídeos y una lista de todos los canales que puede ver un usuario. También puede obtener información sobre un canal en particular, incluido el identificador, el color y el título de un canal y una lista de todos los vídeos que contiene.

Obtener información sobre los canales que el usuario puede ver o a los que puede cargar vídeos

Obtener una lista de canales a los que el usuario puede cargar vídeos

Obtenga la lista de canales a los que un usuario puede cargar vídeos. Estos son los canales para los que tienen permisos de Propietario o Editor.

GET {VideoPortalURL}/_api/VideoService/CanEditChannels

Nota

En esta y todas las llamadas posteriores, VideoPortalURL es una cadena que representa la URL del punto de conexión del portal de vídeo, tal y como se recuperó de la llamada a VideoService.Discover.

Tipo de respuesta

Devuelve una lista de objetos de canal.

Nota

Si su portal de vídeo tiene muchos canales, esta API puede tardar mucho tiempo en responder.

Obtener una lista de canales que el usuario puede ver

Obtenga la lista de todos los canales que un usuario puede ver. Estos son los canales para los que tienen permisos de Propietario, Editor o Espectador.

GET {VideoPortalURL}/_api/VideoService/Channels
Tipo de respuesta

Devuelve una lista de objetos de canal.

Solicitud de muestra
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels
Respuesta de muestra

Código de estado: 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
    }
  ]
}

Obtener información sobre un canal en particular

Obtener el id., el color y el título del canal

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El id. del canal.
Tipo de respuesta

Devuelve la siguiente información sobre un canal:

  • Id: el identificador del canal.
  • TileHtmlColor: el color del canal.
  • Title: el título del canal.
Solicitud de muestra
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')
Respuesta de muestra

Código de estado: 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
}

Obtener una lista de todos los vídeos de un canal

Obtiene la lista de todos los vídeos del canal especificado.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El id. del canal.
Tipo de respuesta

Devuelve una lista de objetos de vídeo.

Solicitud de muestra
GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos
Respuesta de muestra

Código de estado: 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
}

Obtener una lista de los vídeos reproducibles más recientes de un canal

Obtiene una lista ordenada de los vídeos subidos más recientemente de un canal y filtra todos los vídeos que aún no están listos para reproducirse, excepto los subidos por usted.

Esto devolverá una lista ordenada de todos los vídeos del canal que hayan completado la transcodificación y estén listos para reproducirse (VideoProcessingStatus = 2), junto con los vídeos que no estén listos para reproducirse, si fueron subidos por el usuario actualmente conectado.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/GetAllVideos
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El id. del canal.
Tipo de respuesta

Devuelve una lista de objetos de vídeo

Operaciones de vídeo

Obtenga información sobre un vídeo concreto de un canal, la cantidad de veces que se ha visualizado el vídeo e información sobre la reproducción. Además, suba vídeos a un canal y actualice y elimine los vídeos de un canal.

Obtener información sobre un vídeo

Obtenga información sobre un vídeo en particular, incluida la fecha de creación, su título, su duración, la URL de la miniatura del vídeo y su estado de procesamiento.

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

Solicitar parámetros de la URL

Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.

Tipo de respuesta

Devuelve la siguiente información:

  • CreatedDate: la fecha en la que se cargó el vídeo originalmente.
  • Title: el título del vídeo.
  • VideoDurationInSeconds: la duración del vídeo, en segundos.
  • ThumbnailURL: la URL de la imagen en miniatura del vídeo.
  • VideoProcessingStatus: el estado del procesamiento de vídeo. Puede tomar los siguientes valores:
    • 0 -- (predeterminado): el vídeo aún no se ha procesado para su reproducción.
    • 1: el vídeo ha sido seleccionado y está siendo procesado.
    • 2: el vídeo está listo para reproducirse.
    • 3: el vídeo detectó un error mientras se subía a Azure Media Services para su procesamiento.
    • 4 -- Error -- Error genérico: no se puede procesar el vídeo para su transmisión.
    • 5 -- Error -- Error de tiempo de espera: no se puede procesar el vídeo para la transmisión.
    • 6 -- Error -- Formato no compatible -- Azure Media Services no admite el tipo de archivo de vídeo para la reproducción en streaming.

Solicitud de muestra

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

Respuesta de muestra

Código de estado: 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"
}

Obtener un recuento de cuántas veces se ha visto un vídeo

Los recuentos de visualizaciones se devuelven solo cuando se recupera el objeto de vídeo de los extremos de búsqueda, ya que tales recuentos se agregan mediante análisis de la búsqueda. Por tanto, la propiedad ViewCount tendrá valores inexactos a menos que se recupere a través de /Buscar los puntos de conexión del concentrador o de un canal.

Para obtener el recuento de visualizaciones de un solo vídeo, ejecute una consulta de búsqueda usando el id. de dicho vídeo.

GET {VideoPortalURL}/_api/videoservice/Channels('{channelId}')/search/query('{videoId}')?$Select=ViewCount
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
Parámetros de consulta
Nombre Tipo Descripción
_$Select=ViewCount cadena El recuento de visualizaciones a incluir en la respuesta.
Tipo de respuesta

Devuelve el número de veces que se ha visto el vídeo.

Solicitud de muestra
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
Respuesta de muestra
{
  "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
}

Obtener información sobre cómo reproducir un vídeo

Obtener la URL del manifiesto de Azure Media Services para un vídeo

Obtiene la URL del manifiesto de Azure Media Services para el vídeo. Puede introducir este manifiesto en un reproductor que tenga soporte para reproducir activos de Azure Media Services.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetPlaybackUrl('{streamingFormatType}')
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
streamingFormatType numérico El tipo de formato de transmisión por secuencias del vídeo.

El parámetro streamingFormatType puede tomar los siguientes valores:

  • 1: Smooth Streaming o MPEG-DASH
  • 0: HLS Streaming
Tipo de respuesta

Devuelve la URL del manifiesto para el vídeo.

Solicitud de muestra
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)
Respuesta de muestra

Código de estado: 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"
}

Conseguir el token de portador para obtener acceso para descifrar el vídeo

Todos los vídeos de O365 están cifrados con AES. Para reproducir vídeos en el formato Smooth Streaming o MPEG-DASH, primero necesita obtener el token del portador para obtener acceso para descifrar el contenido. Esta API devuelve el token de autenticación para permitir que el reproductor descifre el contenido.

Sin embargo, para la transmisión por secuencias HLS, no necesita recuperar el token de acceso clave por separado, porque este ya forma parte de la URL del manifiesto que obtiene cuando recupera el formato HLS del manifiesto.

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetStreamingKeyAccessToken
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
Tipo de respuesta

Devuelve el token de autenticación para permitir que el reproductor descifre el contenido.

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

Código de estado: 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"
}

Subir vídeos a un canal

Cree un objeto de vídeo vacío para que actúe como marcador de posición donde va a subir un vídeo.

Después de hacerlo, puede subir un solo vídeo pequeño en una llamada POST, o uno más grande, en fragmentos, en varias llamadas POST.

Crear un marcador de posición para donde va a cargar el vídeo

Crea un objeto de vídeo vacío que actúa como un marcador de posición para donde va a cargar el vídeo.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El id. del canal.
Cuerpo de la solicitud
{
    '__metadata': {
        'type': 'SP.Publishing.VideoItem'
    },
    'Description': '
    {
        *your description text here*
    }
    ',
    'Title': '
    {
        *your title of video here*
    }
    '
}
Nombre Tipo Descripción
metadata SP.Publishing.VideoItem El tipo de objeto que está actualizando
Description cadena La descripción del vídeo.
Title cadena El título del vídeo.
FileName cadena El nombre de archivo del vídeo.
Tipo de respuesta

VideoObject: el objeto en el que cargar el vídeo. Use el id. devuelto como identificador del vídeo para empezar a cargarlo.

Cargar un vídeo más pequeño en una sola publicación

Carga un solo vídeo lo bastante pequeño para poder transmitirlo en una sola publicación.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/SaveBinaryStream
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
Cuerpo de la solicitud

La transmisión en secuencias binarias del archivo.

Tipo de respuesta

Devuelve 200. Sin cuerpo de respuesta.

Suba un vídeo más grande en fragmentos

Utilice las siguientes llamadas para cargar un vídeo demasiado grande como para caber en una sola llamada POST, o para cancelar una carga fragmentada.

Iniciar la carga del objeto de vídeo creado anteriormente

Inicia la carga del vídeo fragmentado.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/StartUpload(uploadId=guid'{yourGeneratedGuid}')
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
yourGeneratedGuid GUID El GUID que genera para su sesión de carga.
Tipo de respuesta

Devuelve 200. Sin cuerpo de respuesta.

Cargar cada fragmento del archivo al objeto de vídeo creado anteriormente

Continúa cargando el siguiente fragmento del archivo. Repítalo tantas veces como sea necesario.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/ContinueUpload(uploadId=guid'{yourGeneratedGuid}',fileOffset='{offsetSize}')
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
yourGeneratedGuid GUID El GUID que genera para su sesión de subida.
offsetSize entero El valor de los bytes ya cargados.

Nota

Si estuviera cargando fragmentos de 8 MB, el desplazamiento del primer fragmento sería 0, y el del segundo sería 8 × 1024 = 8192.

Cuerpo de la solicitud

La transmisión en secuencias binarias del archivo de este fragmento.

Tipo de respuesta

Devuelve 200. Sin cuerpo de respuesta.

Finalizar la carga del último fragmento del archivo al objeto de vídeo creado anteriormente

Finaliza la carga del vídeo fragmentado.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/FinishUpload(uploadId=guid'{yourGeneratedGuid}',fileOffset='{offsetSize}')
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
yourGeneratedGuid GUID El GUID que genera para su sesión de subida.
offsetSize entero El valor de los bytes ya cargados.
Cuerpo de la solicitud

La transmisión en secuencias binarias del archivo del último fragmento.

Tipo de respuesta

Devuelve 200. Sin cuerpo de respuesta.

Cancelar la carga

Cancela la carga del vídeo fragmentado.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/CancelUpload(uploadId=guid'{yourGeneratedGuid}')
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
yourGeneratedGuid GUID El GUID que genera para su sesión de carga.
Tipo de respuesta

Devuelve 200. Sin cuerpo de respuesta.

Actualizar los metadatos del vídeo

Actualizar los metadatos de un vídeo existente en un canal

Cambie el título y la descripción de un vídeo.

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
Encabezado de la solicitud
Nombre Tipo Descripción
X-HTTP-Method cadena MERGE es el valor de la propiedad X-HTTP-Method.
Cuerpo de la solicitud
{'__metadata':{'type':'SP.Publishing.VideoItem'},'Description':'{ *your description text here* }', 'Title':'{ *your title of video here* }'}
Nombre Tipo Descripción
metadata SP.Publishing.VideoItem El tipo del objeto de vídeo.
Descripción cadena La descripción del vídeo.
Title cadena El título del vídeo.
Tipo de respuesta

Devuelve 200. Sin cuerpo de respuesta.

Eliminar vídeos de un canal

Eliminar un vídeo existente de un canal

 POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')
Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
Encabezado de la solicitud
Nombre Tipo Descripción
X-HTTP-Method cadena DELETE es el valor de la propiedad X-HTTP-Method.
Tipo de respuesta

Devuelve 200. Sin cuerpo de respuesta.

Insertar un vídeo en otra página

Obtener un código que le permita insertar un elemento de vídeo en otra página web, especificando los valores de los parámetros

Con esta llamada, puede especificar valores para los parámetros que transmita, incluidos el ancho y el alto de la ventana insertada, si el vídeo se reproduce automáticamente al abrir la página o si se muestra cierta información en el reproductor de vídeo cuando el vídeo está en pausa. La información incluye el título del vídeo, su duración, un recuento de cuántas veces se ha reproducido y el nombre del canal.

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

Si no transmite valores para los parámetros, Office 365 seleccionará algunos valores predeterminados razonables, como 120 de ancho y 230 de alto.

Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
width numérico El ancho de la ventana de vídeo insertada.
height numérico El alto de la ventana de vídeo insertada.
Autoplay verdadero/falso El vídeo insertado se iniciará automáticamente.
ShowInfo verdadero/falso Si el título del vídeo, su duración, el recuento de visualizaciones y el nombre del canal se muestran en el reproductor cuando el vídeo está en pausa.
Tipo de respuesta

Devuelve el código para insertar.

Obtener un código que le permita insertar un elemento de vídeo en otra página web utilizando valores predeterminados

Con esta llamada, puede obtener un código para insertar que especifique los valores predeterminados para el reproductor de vídeo insertado.

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

La propiedad "DefaultEmbedCode" no se devuelve automáticamente en el objeto de Vídeo. Para obtener el "DefaultEmbedCode", debe usar la opción $select.

Al usar la opción $select, puede solicitar que el elemento de vídeo devuelva cualquiera de las propiedades del vídeo, incluido el título y el código de inserción predeterminado, como se muestra.

Solicitar parámetros de la URL
Parámetro obligatorio Tipo Descripción
channelId cadena El identificador del canal.
videoId cadena El id. del vídeo.
Tipo de respuesta

Devuelve las propiedades predeterminadas que solicite utilizando $select, incluido el código para insertar predeterminado.

Obtener la información del elemento de vídeo y el código para insertar predeterminado de la URL de la página del reproductor

Con esta llamada, si conoce la URL de la página del reproductor del portal de O365 Video para un vídeo, puede obtener el identificador del vídeo, el identificador del canal y otra información sobre el vídeo.

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

Al usar la opción $select, puede solicitar que el elemento de vídeo devuelva cualquiera de las propiedades del vídeo, incluido el título y el código de inserción predeterminado, como se muestra.

Encabezado de la solicitud

Accept=application/json;odata=verbose

Content-Type=application/json;odata=verbose

Cuerpo de la solicitud
{'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'}

Donde videoFileRelativeURL es la URL relativa o absoluta de la página del reproductor del portal de O365 Video para un vídeo.

Pasos siguientes

Tanto si ya está listo para empezar a compilar una aplicación como si solo quiere obtener más información, tenemos todo lo que necesita.

O bien, obtenga más información sobre cómo usar la plataforma de Office 365: