IPlayReadyLicense
IPlayReadyLicense
IPlayReadyLicense
IPlayReadyLicense
Interface
Definition
Contains information about a PlayReady license.
public : interface IPlayReadyLicensepublic interface IPlayReadyLicensePublic Interface IPlayReadyLicense// You can use this interface in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
This interface could represent a single license or an entire chain of licenses depending on how the license enumeration was performed.
Properties
ChainDepth ChainDepth ChainDepth ChainDepth
Gets the chain depth of the license chain represented by the current IPlayReadyLicense interface.
public : unsigned int ChainDepth { get; }public uint ChainDepth { get; }Public ReadOnly Property ChainDepth As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The chain depth of the license chain.
DomainAccountID DomainAccountID DomainAccountID DomainAccountID
Gets the domain account identifier to which this license is bound.
public : PlatForm::Guid DomainAccountID { get; }public Guid DomainAccountID { get; }Public ReadOnly Property DomainAccountID As Guid// You can use this property in JavaScript.
- Value
- PlatForm::Guid Guid Guid Guid
The domain account identifier. If the license is not domain bound, GUID_NULL is returned. This property value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.
ExpirationDate ExpirationDate ExpirationDate ExpirationDate
Gets the expiration date of the current license.
public : IReference<DateTime> ExpirationDate { get; }public Nullable<DateTimeOffset> ExpirationDate { get; }Public ReadOnly Property ExpirationDate As Nullable<DateTimeOffset>// You can use this property in JavaScript.
- Value
- IReference<DateTime> Nullable<DateTimeOffset> Nullable<DateTimeOffset> Nullable<DateTimeOffset>
The expiration date of the current license.
ExpireAfterFirstPlay ExpireAfterFirstPlay ExpireAfterFirstPlay ExpireAfterFirstPlay
Gets the amount of time, in seconds, before the current license expires after the media is first played.
public : unsigned int ExpireAfterFirstPlay { get; }public uint ExpireAfterFirstPlay { get; }Public ReadOnly Property ExpireAfterFirstPlay As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The time, in seconds, before the current license expires after the media is first played.
FullyEvaluated FullyEvaluated FullyEvaluated FullyEvaluated
Gets the state of the license.
public : PlatForm::Boolean FullyEvaluated { get; }public bool FullyEvaluated { get; }Public ReadOnly Property FullyEvaluated As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
Indicates whether this license chain is evaluated or whether this license chain may be unusable due to enumeration for all licenses (including those that are unusable) being performed. If true, the license chain is evaluated. If false, the license chain may be unusable.
UsableForPlay UsableForPlay UsableForPlay UsableForPlay
Gets whether this license is usable for playback.
public : PlatForm::Boolean UsableForPlay { get; }public bool UsableForPlay { get; }Public ReadOnly Property UsableForPlay As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
true if this license is usable for playback, otherwise false.
Remarks
Many factors influence the ability to use a license. This property makes a determination based on the state of the PlayReady system and does not factor into account various issues such as video driver support.
Methods
GetKIDAtChainDepth(UInt32) GetKIDAtChainDepth(UInt32) GetKIDAtChainDepth(UInt32) GetKIDAtChainDepth(UInt32)
Gets the key identifier (KID) of the license at the specified chain depth.
public : PlatForm::Guid GetKIDAtChainDepth(unsigned int chainDepth)public Guid GetKIDAtChainDepth(UInt32 chainDepth)Public Function GetKIDAtChainDepth(chainDepth As UInt32) As Guid// You can use this method in JavaScript.
- chainDepth
- unsigned int UInt32 UInt32 UInt32
The depth of the license in the chain for which to retrieve the KID. This value is a 0-based index.
The KID of the license. This return value is sensitive to the underlying platform's endianness. Carefully test your app on all platforms you intend to support to ensure that correct endianness is used on each platform.
Remarks
The chainDepth parameter must be between the value of 0 and (IPlayReadyLicense.ChainDepth - 1).