PlayReadyLicense
PlayReadyLicense
PlayReadyLicense
PlayReadyLicense
Class
Definition
Represents the properties of a PlayReady license.
public : sealed class PlayReadyLicense : IPlayReadyLicense, IPlayReadyLicense2public sealed class PlayReadyLicense : IPlayReadyLicense, IPlayReadyLicense2Public NotInheritable Class PlayReadyLicense Implements IPlayReadyLicense, IPlayReadyLicense2// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
This class is used to query license metadata. It 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 PlayReadyLicense class.
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.
ExpiresInRealTime ExpiresInRealTime ExpiresInRealTime ExpiresInRealTime
Gets a value that indicates if the license can expire in the middle of playback or if only expires when attempting a fresh playback.
public : PlatForm::Boolean ExpiresInRealTime { get; }public bool ExpiresInRealTime { get; }Public ReadOnly Property ExpiresInRealTime As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the license can expire in the middle of playback; otherwise, false.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
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.
InMemoryOnly InMemoryOnly InMemoryOnly InMemoryOnly
Gets a value that indicates if the license is in-memory-only.
public : PlatForm::Boolean InMemoryOnly { get; }public bool InMemoryOnly { get; }Public ReadOnly Property InMemoryOnly As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the license is in-memory-only; otherwise, false.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
SecureStopId SecureStopId SecureStopId SecureStopId
Gets the unique identifier of the certificate for the service that handles the server-side of the SecureStop protocol.
public : PlatForm::Guid SecureStopId { get; }public Guid SecureStopId { get; }Public ReadOnly Property SecureStopId As Guid// You can use this property in JavaScript.
- Value
- PlatForm::Guid Guid Guid Guid
The unique identifier of the certificate for the service that handles the server-side of the SecureStop protocol.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
SecurityLevel SecurityLevel SecurityLevel SecurityLevel
Gets a value that indicates the security level of the license.
public : unsigned int SecurityLevel { get; }public uint SecurityLevel { get; }Public ReadOnly Property SecurityLevel As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
A value that indicates the security level of the license.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
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.
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 (PlayReadyLicense.ChainDepth - 1).