Activar / Desactivar o Programar videos

Este tema muestra cómo activar, desactivar o programar un video usando el CMS API.

Introducción

Hay varias razones por las que es posible que desee que un video no se pueda reproducir hasta algún tiempo después. Por ejemplo:

  • Todavía se está revisando
  • Es un tráiler de película que aún no se ha estrenado
  • Es parte de una campaña de marketing que no ha comenzado o ha terminado.
  • Es parte de una noticia aún no publicada.

Si aún no ha colocado el código de inserción del video en una página o aplicación pública, no se puede ver, por supuesto, pero hay formas en las que un video puede publicarse accidentalmente, la más obvia es que sus etiquetas u otras propiedades se ajustan a un dispositivo inteligente. lista de reproducción que se publica.

Hay dos formas de asegurarse de que no se pueda ver un video de Video Cloud:

  • Desactivarlo
  • Prográmalo para que se pueda reproducir en algún momento en el futuro

Ambos cambios se pueden implementar a través del módulo de Medios en Studio, pero aquí cubriremos cómo implementarlos usando el CMS API. Ambas acciones se realizan utilizando un solicitud de actualización de video.

Autenticación

Solicitudes al CMS API requieren un encabezado de autorización que contenga sus tokens de acceso. Para obtener detalles sobre cómo obtener credenciales de cliente y usarlas para recuperar tokens de acceso, consulte la Descripción general de Brightcove OAuth.

Puede crear credenciales de cliente utilizando el Páginas de administración de Studio o la API de OAuth

También puede utilizar el API de OAuth directamente para recuperar tokens de acceso, o si está utilizando el Cartero o Insomnio aplicación o realice sus solicitudes, consulte nuestros tutoriales sobre cómo configurarlos para obtener tokens de acceso:

La solicitud de actualización de video

Para actualizar un video, envíe un PATCH solicitud de

https://cms.api.brightcove.com/v1/accounts/account_id/videos/video_id

En general, el cuerpo de la solicitud solo debe contener los campos que desea actualizar, aunque también puede incluir otros con los valores actuales. Examinaremos los órganos de solicitud de activación / desactivación y programación en las secciones que siguen.

Activar / Desactivar un video

Un video se activa (visible) o inactivo (no visible) configurando su state. Por defecto, los videos son ACTIVE una vez que se ingieren (a menos que haya campos obligatorios que se omitieron cuando se creó el video o se cargaron mediante el módulo Cargar).

Entonces, para desactivar un video, solo necesita enviar el siguiente cuerpo de solicitud con la solicitud de actualización de video:

{
  "state": "INACTIVE"
}

Puede verificar que el video ahora está inactivo al marcar la state campo en la respuesta de la API

Respuesta de muestra 
{
  "id": "1698990613556232930",
  "account_id": "57838016001",
  "ad_keys": null,
  "clip_source_video_id": null,
  "complete": true,
  "created_at": "2021-05-06T06:48:31.963Z",
  "created_by": {
    "type": "unknown"
  },
  "cue_points": [
  ],
  "custom_fields": {
  },
  "delivery_type": "dynamic_origin",
  "description": "Updated at: 2021-05-07T22:37:46.492Z",
  "digital_master_id": null,
  "duration": 41259,
  "economics": "AD_SUPPORTED",
  "folder_id": null,
  "geo": null,
  "has_digital_master": true,
  "images": {
    "poster": {
      "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/1494916a-e8a7-45ac-882f-6e0aa3489846/main/1280x720/20s629ms/match/image.jpg",
      "sources": [
        {
          "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/1494916a-e8a7-45ac-882f-6e0aa3489846/main/1280x720/20s629ms/match/image.jpg",
          "height": 720,
          "width": 1280
        }
      ]
    },
    "thumbnail": {
      "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/1494916a-e8a7-45ac-882f-6e0aa3489846/main/160x90/20s629ms/match/image.jpg",
      "sources": [
        {
          "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/1494916a-e8a7-45ac-882f-6e0aa3489846/main/160x90/20s629ms/match/image.jpg",
          "height": 90,
          "width": 160
        }
      ]
    }
  },
  "link": null,
  "long_description": null,
  "name": "Great Horned Owl",
  "original_filename": "greathornedowl.mp4",
  "projection": null,
  "published_at": "2021-05-06T06:48:31.963Z",
  "reference_id": "greathornedowl.mp4_1620283704192",
  "schedule": null,
  "sharing": null,
  "state": "INACTIVE",
  "tags": [
    "bird",
    "air",
    "nature"
  ],
  "text_tracks": [
  ],
  "updated_at": "2021-05-16T22:54:09.168Z",
  "updated_by": {
    "type": "api_key",
    "email": "rcrooks@brightcove.com"
  },
  "offline_enabled": false,
  "playback_rights_id": "primary"
}

Para volver a activar el video, simplemente envíe otra solicitud de actualización de video con el cuerpo de la solicitud:

{
  "state": "ACTIVE"
}

Programar un video

La segunda forma de hacer que un video se pueda reproducir o no es usar el schedule objeto en la solicitud de actualización de video. El schedule object has two properties:

  • starts_at la fecha y hora ISO-8601 cuando el video se vuelve reproducible (requerido)
  • ends_at la fecha y hora ISO-8601 cuando el video ya no se puede reproducir (opcional)

Aquí hay un cuerpo de solicitud de muestra que hace que un video se pueda reproducir a las 6:00 a. m. (UTC) el 16 de mayo de 2021 y lo vuelve a no reproducir exactamente un año después:

{
  "schedule": {
		"starts_at": "2021-05-16T06:00:00.000Z",
		"ends_at": "2022-05-16T06:00:00.000Z"
	}
}
Respuesta de muestra 
{
  "id": "1698990613556232930",
  "account_id": "57838016001",
  "ad_keys": null,
  "clip_source_video_id": null,
  "complete": true,
  "created_at": "2021-05-06T06:48:31.963Z",
  "created_by": {
    "type": "unknown"
  },
  "cue_points": [
  ],
  "custom_fields": {
  },
  "delivery_type": "dynamic_origin",
  "description": "Updated at: 2021-05-07T22:37:46.492Z",
  "digital_master_id": null,
  "duration": 41259,
  "economics": "AD_SUPPORTED",
  "folder_id": null,
  "geo": null,
  "has_digital_master": true,
  "images": {
    "poster": {
      "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/1494916a-e8a7-45ac-882f-6e0aa3489846/main/1280x720/20s629ms/match/image.jpg",
      "sources": [
        {
          "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/1494916a-e8a7-45ac-882f-6e0aa3489846/main/1280x720/20s629ms/match/image.jpg",
          "height": 720,
          "width": 1280
        }
      ]
    },
    "thumbnail": {
      "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/1494916a-e8a7-45ac-882f-6e0aa3489846/main/160x90/20s629ms/match/image.jpg",
      "sources": [
        {
          "src": "https://cf-images.us-east-1.prod.boltdns.net/v1/jit/57838016001/1494916a-e8a7-45ac-882f-6e0aa3489846/main/160x90/20s629ms/match/image.jpg",
          "height": 90,
          "width": 160
        }
      ]
    }
  },
  "link": null,
  "long_description": null,
  "name": "Great Horned Owl",
  "original_filename": "greathornedowl.mp4",
  "projection": null,
  "published_at": "2021-05-06T06:48:31.963Z",
  "reference_id": "greathornedowl.mp4_1620283704192",
  "schedule": {
    "ends_at": "2022-05-16T06:00:00.000Z",
    "starts_at": "2021-05-16T06:00:00.000Z"
  },
  "sharing": null,
  "state": "ACTIVE",
  "tags": [
    "bird",
    "air",
    "nature"
  ],
  "text_tracks": [
  ],
  "updated_at": "2021-05-17T00:42:45.172Z",
  "updated_by": {
    "type": "api_key",
    "email": "rcrooks@brightcove.com"
  },
  "offline_enabled": false,
  "playback_rights_id": "primary"
}