DRMManager - Referencia de la API de Adobe ActionScript® 3 (AS3 )

Paquete	flash.net.drm
Clase	public class DRMManager
Herencia	DRMManager EventDispatcher Object

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 10.1

DRMManager gestiona la recuperación y el almacenamiento de las licencias necesarias para poder visualizar contenido protegido con DRM. Con el método estático DRMManager.getDRMManager(), puede acceder al objeto DRMManager existente para realizar las siguientes tareas de gestión DRM:

Precargar licencias desde un servidor de derechos multimedia mediante un objeto DRMContentData.
Se puede consultar la caché local para buscar una licencia concreta con un objeto DRMContentData.
Restablecer todas las licencias (sólo AIR)

No se proporciona método alguno para enumerar todas las licencias de la caché local.

No crear una instancia de la clase DRMManager. Utilice el objeto estático DRMManager.getDRMManager() para acceder al objeto DRMManager existente.

Compatibilidad con perfil de AIR: esta característica se admite en todos los sistemas operativos de escritorio y en dispositivos de AIR para TV, pero no en dispositivos móviles. Puede comprobar la compatibilidad en tiempo de ejecución mediante la propiedad DRMManager.isSupported. Consulte Compatibilidad con perfil de AIR para obtener información sobre la compatibilidad de la API con varios perfiles.

Elementos de API relacionados

flash.net.NetStream
flash.net.drm.DRMVoucher
flash.net.drm.DRMContentData

Propiedades públicas

Ocultar propiedades públicas heredadas

Mostrar propiedades públicas heredadas

	Propiedad		Definido por
		constructor : Object Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.	Object
		isSupported : Boolean [estática] [solo lectura] La propiedad isSupported se establece en true si la clase DRMManager se admite en la plataforma actual; en caso contrario, se establece en false.	DRMManager
		networkIdleTimeout : Number [estática]	DRMManager

Métodos públicos

Ocultar métodos públicos heredados

Mostrar métodos públicos heredados

	Método		Definido por
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento.	EventDispatcher
		addToDeviceGroup(deviceGroup:DRMDeviceGroup, forceRefresh:Boolean = false):void Añade el dispositivo actualmente en ejecución a un grupo de dispositivos.	DRMManager
		authenticate(serverURL:String, domain:String, username:String, password:String):void Autentica a un usuario.	DRMManager
		dispatchEvent(event:Event):Boolean Distribuye un evento en el flujo del evento.	EventDispatcher
		getDRMManager():DRMManager [estática] Devuelve una instancia del objeto simple DRMManager.	DRMManager
		hasEventListener(type:String):Boolean Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica si un objeto tiene definida una propiedad especificada.	Object
		isPrototypeOf(theClass:Object):Boolean Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.	Object
		loadPreviewVoucher(contentData:DRMContentData):void Obtiene una licencia de previsualización del servidor de licencias. La puede utilizar para permitir que un usuario verifique si puede reproducir contenido en un equipo determinado.	DRMManager
		loadVoucher(contentData:DRMContentData, setting:String):void Carga una licencia desde un servidor de derechos multimedia o desde la caché de licencias local.	DRMManager
		propertyIsEnumerable(name:String):Boolean Indica si existe la propiedad especificada y si es enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Elimina un detector del objeto EventDispatcher.	EventDispatcher
		removeFromDeviceGroup(deviceGroup:DRMDeviceGroup):void Elimina el dispositivo actualmente en ejecución de un grupo de dispositivos.	DRMManager
		resetDRMVouchers():void En aplicaciones de AIR, esta acción elimina todos los datos de licencias de gestión de derechos digitales (DRM) guardados en la caché local.	DRMManager
		returnVoucher(inServerURL:String, immediateCommit:Boolean, licenseID:String, policyID:String):void Devuelve al servidor de licencias todas las licencias que se ajustan a los criterios especificados.	DRMManager
		setAuthenticationToken(serverUrl:String, domain:String, token:ByteArray):void Define el símbolo de autenticación que se utiliza en la comunicación con el servidor y dominio especificados.	DRMManager
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.	Object
		storeVoucher(voucher:ByteArray):void	DRMManager
		toLocaleString():String Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.	Object
		toString():String Devuelve la representación de cadena del objeto especificado.	Object
		valueOf():Object Devuelve el valor simple del objeto especificado.	Object
		willTrigger(type:String):Boolean Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto.	EventDispatcher

Eventos

Haga clic para obtener más información sobre los eventos

Ocultar eventos heredados

Mostrar eventos heredados

	Resumen	Definido por
activate	[evento broadcast] Se distribuye cuando Flash Player o AIR pasan a estar activos.	EventDispatcher
authenticationComplete	DRMManager distribuye un objeto DRMAuthenticationCompleteEvent cuando el usuario se autentica en el servidor de derechos multimedia tras una llamada al método authenticate().	DRMManager
authenticationError	DRMManager distribuye un objeto DRMAuthenticationErrorEvent cuando el usuario no se autentica en el servidor de derechos multimedia una vez llamado el método authenticate().	DRMManager
deactivate	[evento broadcast] Se distribuye cuando Flash Player o de AIR pasan a estar inactivos.	EventDispatcher
drmError	DRMManager distribuye un objeto DRMErrorEvent si no se puede obtener una licencia solicitada al servidor de derechos multimedia.	DRMManager
drmStatus	DRMManager distribuye un objeto DRMStatusEvent cuando se obtiene una licencia solicitada al servidor de derechos multimedia.	DRMManager

Información sobre propiedades

isSupported

propiedad

isSupported:Boolean [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10.1, AIR 2

La propiedad isSupported se establece en true si la clase DRMManager se admite en la plataforma actual; en caso contrario, se establece en false.

Implementación
public static function get isSupported():Boolean

networkIdleTimeout

propiedad

networkIdleTimeout:Number

Implementación
public static function get networkIdleTimeout():Number
public static function set networkIdleTimeout(value:Number):void

Información sobre métodos

addToDeviceGroup

()

método

public function addToDeviceGroup(deviceGroup:DRMDeviceGroup, forceRefresh:Boolean = false):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 3.0, Flash Player 11.9

Añade el dispositivo actualmente en ejecución a un grupo de dispositivos.

Parámetros

	`deviceGroup:DRMDeviceGroup`

	`forceRefresh:Boolean` (default = `false`)

authenticate

()

método

public function authenticate(serverURL:String, domain:String, username:String, password:String):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 10.1

Autentica a un usuario.

Detecta los eventos authenticationComplete y authenticationError para determinar el resultado del intento de autenticación. Si hay varias llamadas a authenticate(), se ponen en cola. El objeto AuthenticationCompleteEvent distribuido por el evento authenticationComplete contiene un símbolo de autenticación que la aplicación puede guardar.

Se puede utilizar un símbolo de autenticación guardado, o uno descargado por otros medios, para establecer una sesión autenticada con el servidor de derechos multimedia en el futuro. Para establecer una sesión mediante un símbolo, llame al método setAuthenticationToken() de DRMManager. Las propiedades del símbolo, como la fecha de vencimiento, están determinadas por la configuración del servidor que lo genera.

Importante (sólo AIR): el método authenticate() no funciona correctamente si una conexión a Internet del usuario se realiza a través de un servidor proxy que requiera autenticación. Aunque dichos usuarios no pueden precargar una licencia DRM que requiera autenticación, la aplicación sí puede obtener la licencia iniciando la reproducción y utilizando el método setAuthenticationCredentials() de NetStream para conectar al usuario tanto al servidor proxy como al de derechos multimedia. Una vez obtenida la licencia, el usuario puede ver el contenido sin conexión (siempre y cuando la licencia contemple la reproducción sin conexión).

Parámetros

	`serverURL:String` — La dirección URL de un servidor de derechos multimedia que puede proveer licencias para ver contenido protegido

	`domain:String` — Un dominio del servidor (no un nombre de dominio de red o de Internet)

	`username:String` — Nombre de usuario

	`password:String` — Contraseña de usuario

Elementos de API relacionados

flash.net.NetStream.setAuthenticationCredentials()
setAuthenticationToken()

getDRMManager

()

método

public static function getDRMManager():DRMManager

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 10.1

Devuelve una instancia del objeto simple DRMManager.

Existe una instancia de DRMManager por cada dominio de seguridad.

Valor devuelto

DRMManager

Elementos de API relacionados

flash.system.SecurityDomain

loadPreviewVoucher

()

método

public function loadPreviewVoucher(contentData:DRMContentData):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 2, Flash Player 10.1

Obtiene una licencia de previsualización del servidor de licencias. La puede utilizar para permitir que un usuario verifique si puede reproducir contenido en un equipo determinado. Esta funcionalidad permite a los usuarios verificar que pueden reproducir contenido en su equipo antes de comprar y descargar el contenido. Resulta útil cuando el equipo del usuario no tiene las capacidades de protección de salida necesarias o un software requerido para reproducir contenido.

Al igual que el método loadVoucher(), este método es una llamada asíncrona y emite un evento DRMStatusEvent o DRMErrorEvent en caso de error.

Parámetros

contentData:DRMContentData

loadVoucher

()

método

public function loadVoucher(contentData:DRMContentData, setting:String):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 10.1

Carga una licencia desde un servidor de derechos multimedia o desde la caché de licencias local.

La licencia se carga según el parámetro setting:

LoadVoucherSetting.FORCE_REFRESH: la licencia siempre se descarga del servidor de derechos multimedia.
LoadVoucherSetting.LOCAL_ONLY: la licencia se carga desde la caché local.
LoadVoucherSetting.ALLOW_SERVER: la licencia se carga desde la caché local, si es posible; en caso contrario, se descarga desde el servidor.

La clase LoadVoucherSetting define constantes de cadena para utilizarlas como valores del parámetro setting.

Cuando se carga correctamente la licencia, DRMManager distribuye un evento de estado DRM. La aplicación puede iniciar la reproducción tan pronto como se haya cargado la licencia. La licencia cargada está disponible en la propiedad voucher del objeto DRMStatusEvent distribuido. Puede utilizar este objeto de licencia para mostrar información relacionada con derechos multimedia al usuario.

Si no es posible cargar una licencia desde el servidor de derechos multimedia, se distribuye un evento de error DRM. La propiedad errorID del objeto DRMErrorEvent distribuido indica el motivo del error. Algunas causas habituales de error son conectarse al servidor de derechos multimedia cuando el usuario está desconectado e intentar cargar una licencia cuando el usuario aún no se ha conectado. La aplicación puede reaccionar ante estos errores y tomar las medidas oportunas. Por ejemplo, si se necesitan credenciales de autenticación para descargar una licencia, se puede pedir al usuario que introduzca sus datos de nombre de usuario y contraseña, llamar al método authenticate() de DRMManager e intentar cargar la licencia de nuevo.

Si no es posible obtener una licencia desde la caché local y se utiliza el parámetro localOnly, no se distribuye ningún evento DRMErrorEvent. En su lugar, se distribuye un evento de estado DRM. La propiedad detail de este objeto DRMStatusEvent sigue siendo DRM.voucherObtained, pero la propiedad voucher es null.

Parámetros

	`contentData:DRMContentData` — El objeto DRMContentData de un archivo multimedia protegido con DRM

	`setting:String` — Determina si la licencia se recupera de la caché local o del servidor de derechos multimedia

removeFromDeviceGroup

()

método

public function removeFromDeviceGroup(deviceGroup:DRMDeviceGroup):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 3.0, Flash Player 11.9

Elimina el dispositivo actualmente en ejecución de un grupo de dispositivos.

Parámetros

deviceGroup:DRMDeviceGroup

resetDRMVouchers

()

método

public function resetDRMVouchers():void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 11.8

En aplicaciones de AIR, esta acción elimina todos los datos de licencias de gestión de derechos digitales (DRM) guardados en la caché local. Para aplicaciones basadas en navegador, esto solo está disponible durante errores 3322, 3346, 3323, 3326, y se comporta como el panel de configuración Reproducción de contenido protegido.

La aplicación debe descargar de nuevo las licencias necesarias para que el usuario pueda acceder a contenido codificado. Llamar a esta función equivale a llamar a Netstream.resetDRMVouchers().

Emite

IOError — No es posible eliminar los datos de las licencias.

Elementos de API relacionados

flash.net.NetStream.resetDRMVouchers()

returnVoucher

()

método

public function returnVoucher(inServerURL:String, immediateCommit:Boolean, licenseID:String, policyID:String):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 11.8, AIR 3.8

Devuelve al servidor de licencias todas las licencias que se ajustan a los criterios especificados. Cuando se devuelve una licencia, se quita del almacenamiento en disco y de la memoria. Esto no interrumpirá objetos NetStream ni AVStream que estén utilizando las licencias devueltas para la reproducción de vídeo, pero se prohibirá la reproducción futura. DRMManager comunicará DRMReturnVoucherCompleteEvent si la operación se realiza correctamente, o DRMReturnVoucherErrorEvent en caso de error. Emitirá un error ArgumentError si inServerURL tiene valor null o si tanto la identificación de licencia como la de política son null.

Parámetros

	`inServerURL:String` — Las direcciones URL del servidor de licencias de las que se descargaron las licencias devueltas.

	`immediateCommit:Boolean` — Reservado. El único valor admitido es true.

	`licenseID:String` — (Opcional) Se devolverán licencias que tengan esta identificación de licencia. Si el valor es null, se utilizará el identificador de política en su lugar.

	`policyID:String` — (Opcional) Se devolverán licencias que tengan esta identificación de política. Si el valor es null, se utilizará el identificador de licencia en su lugar. Si tanto el identificador de licencia como el de política tienen valor no null, solo se devolverá una licencia que corresponda tanto al identificador de licencia como al de política.

setAuthenticationToken

()

método

public function setAuthenticationToken(serverUrl:String, domain:String, token:ByteArray):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 10.1

Define el símbolo de autenticación que se utiliza en la comunicación con el servidor y dominio especificados.

Los símbolos de autenticación están disponibles en la propiedad token del objeto DRMAuthenticationCompleteEvent distribuido cuando se llama correctamente al método authenticate(). El símbolo se guarda automáticamente en la memoria caché de la sesión, pero se puede utilizar el método setAuthenticationToken() para gestionar los símbolos directamente.

Al definir un símbolo, se sobrescriben los símbolos existentes guardados en la caché para dicho servidor y dominio. Establezca el parámetro token en null para borrar los símbolos guardados en la caché.

Parámetros

	`serverUrl:String` — La dirección URL del servidor de derechos multimedia

	`domain:String` — DRMContentData

	`token:ByteArray` — El símbolo de autenticación

storeVoucher

()

método

public function storeVoucher(voucher:ByteArray):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 11.0, AIR 3.0

Parámetros

voucher:ByteArray

Información sobre eventos

authenticationComplete

Evento

Tipo de objeto de evento: flash.events.DRMAuthenticationCompleteEvent
propiedad DRMAuthenticationCompleteEvent.type = flash.events.DRMAuthenticationCompleteEvent.AUTHENTICATION_COMPLETE

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 10.1

DRMManager distribuye un objeto DRMAuthenticationCompleteEvent cuando el usuario se autentica en el servidor de derechos multimedia tras una llamada al método authenticate().

La constante de cadena que se utiliza para evento de finalización de autenticación en el parámetro type cuando se añaden o se eliminan detectores de eventos.

authenticationError

Evento

Tipo de objeto de evento: flash.events.DRMAuthenticationErrorEvent
propiedad DRMAuthenticationErrorEvent.type = flash.events.DRMAuthenticationErrorEvent.AUTHENTICATION_ERROR

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 10.1

DRMManager distribuye un objeto DRMAuthenticationErrorEvent cuando el usuario no se autentica en el servidor de derechos multimedia una vez llamado el método authenticate().

La constante de cadena que se utiliza para el evento de autenticación de errores en el parámetro type al añadir y eliminar detectores de eventos.

drmError

Evento

Tipo de objeto de evento: flash.events.DRMErrorEvent
propiedad DRMErrorEvent.type = flash.events.DRMErrorEvent.DRM_ERROR

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 10.1

DRMManager distribuye un objeto DRMErrorEvent si no se puede obtener una licencia solicitada al servidor de derechos multimedia.

Nota: cuando falla el intento de carga de una licencia desde la caché de licencias local (con localOnly como parámetro source), NO se distribuye ningún objeto DRMErrorEvent. En su lugar, se distribuye un objeto DRMStatusEvent con una propiedad voucher establecida como null.

La constante DRMErrorEvent.DRM_ERROR define el valor de la propiedad type de un objeto de evento drmError.

Este evento tiene las propiedades siguientes:

Propiedad	Valor
`bubbles`	`false`
`cancelable`	`false`; no hay ningún comportamiento predeterminado que cancelar.
`errorID`	Se ha asignado un código de error numérico al problema.
`subErrorID`	Código de error que indica más información detallada sobre el problema subyacente.
`target`	Objeto NetStream.

drmStatus

Evento

Tipo de objeto de evento: flash.events.DRMStatusEvent
propiedad DRMStatusEvent.type = flash.events.DRMStatusEvent.DRM_STATUS

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

AIR 1.5, Flash Player 10.1

DRMManager distribuye un objeto DRMStatusEvent cuando se obtiene una licencia solicitada al servidor de derechos multimedia.

La constante DRMStatusEvent.DRM_STATUS define el valor de la propiedad type de un objeto de evento drmStatus.

Este evento tiene las propiedades siguientes:

Propiedad	Valor
`bubbles`	`false`
`cancelable`	`false`; no hay ningún comportamiento predeterminado que cancelar.
`detail`	Cadena que explica el contexto del evento de estado.
`isAnonymous`	Indica si el contenido protegido con cifrado DRM está disponible sin necesidad de que el usuario proporcione sus credenciales de autenticación.
`isAvailableOffline`	Indica si el contenido protegido con cifrado DRM está disponible sin conexión.
`offlineLeasePeriod`	Número de días restantes para poder ver el contenido sin conexión.
`normativas`	Objeto personalizado del evento de estado de DRM.
`target`	Objeto NetStream.
`voucherEndDate`	Fecha absoluta de vencimiento de la licencia a partir de la cual los usuarios no pueden seguir viendo el contenido
`contentData`	DRMContentData para el contenido
`voucher`	Objeto DRMVoucher para el contenido.
`isLocal`	Indica si el contenido está guardado en el sistema de archivos locales

Avisos legales | Política de privacidad en línea

DRMManager - AS3

Paquetesx

Elementos del lenguaje

Apéndices

Paquete flash.net.drm

isSupported

networkIdleTimeout

addToDeviceGroup

authenticate

getDRMManager

loadPreviewVoucher

loadVoucher

removeFromDeviceGroup

resetDRMVouchers

returnVoucher

setAuthenticationToken

storeVoucher

authenticationComplete

authenticationError

drmError

drmStatus