@datafire/azure_mediaservices_streamingpoliciesandstreaminglocators

Client library for Azure Media Services

Installation and Usage

npm install --save @datafire/azure_mediaservices_streamingpoliciesandstreaminglocators

let azure_mediaservices_streamingpoliciesandstreaminglocators = require('@datafire/azure_mediaservices_streamingpoliciesandstreaminglocators').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

This Swagger was generated by the API Framework.

Actions

StreamingLocators_List

Lists the Streaming Locators in the account

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingLocators_List({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • api-version required string: The Version of the API to be used with the client request.
  • $filter string: Restricts the set of items returned.
  • $top integer: Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.
  • $orderby string: Specifies the key by which the result collection should be ordered.

Output

• output StreamingLocatorCollection

StreamingLocators_Delete

Deletes a Streaming Locator in the Media Services account

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingLocators_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "streamingLocatorName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • streamingLocatorName required string: The Streaming Locator name.
  • api-version required string: The Version of the API to be used with the client request.

Output

Output schema unknown

StreamingLocators_Get

Get the details of a Streaming Locator in the Media Services account

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingLocators_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "streamingLocatorName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • streamingLocatorName required string: The Streaming Locator name.
  • api-version required string: The Version of the API to be used with the client request.

Output

• output StreamingLocator

StreamingLocators_Create

Create a Streaming Locator in the Media Services account

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingLocators_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "streamingLocatorName": "",
  "parameters": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • streamingLocatorName required string: The Streaming Locator name.
  • parameters required StreamingLocator
  • api-version required string: The Version of the API to be used with the client request.

Output

• output StreamingLocator

StreamingLocators_ListContentKeys

List Content Keys used by this Streaming Locator

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingLocators_ListContentKeys({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "streamingLocatorName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • streamingLocatorName required string: The Streaming Locator name.
  • api-version required string: The Version of the API to be used with the client request.

Output

• output ListContentKeysResponse

StreamingLocators_ListPaths

List Paths supported by this Streaming Locator

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingLocators_ListPaths({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "streamingLocatorName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • streamingLocatorName required string: The Streaming Locator name.
  • api-version required string: The Version of the API to be used with the client request.

Output

• output ListPathsResponse

StreamingPolicies_List

Lists the Streaming Policies in the account

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingPolicies_List({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • api-version required string: The Version of the API to be used with the client request.
  • $filter string: Restricts the set of items returned.
  • $top integer: Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.
  • $orderby string: Specifies the key by which the result collection should be ordered.

Output

• output StreamingPolicyCollection

StreamingPolicies_Delete

Deletes a Streaming Policy in the Media Services account

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingPolicies_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "streamingPolicyName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • streamingPolicyName required string: The Streaming Policy name.
  • api-version required string: The Version of the API to be used with the client request.

Output

Output schema unknown

StreamingPolicies_Get

Get the details of a Streaming Policy in the Media Services account

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingPolicies_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "streamingPolicyName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • streamingPolicyName required string: The Streaming Policy name.
  • api-version required string: The Version of the API to be used with the client request.

Output

• output StreamingPolicy

StreamingPolicies_Create

Create a Streaming Policy in the Media Services account

azure_mediaservices_streamingpoliciesandstreaminglocators.StreamingPolicies_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "streamingPolicyName": "",
  "parameters": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • streamingPolicyName required string: The Streaming Policy name.
  • parameters required StreamingPolicy
  • api-version required string: The Version of the API to be used with the client request.

Output

• output StreamingPolicy

Definitions

ApiError

• ApiError object: The API error.
  • error ODataError

CbcsDrmConfiguration

• CbcsDrmConfiguration object: Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy
  • fairPlay StreamingPolicyFairPlayConfiguration
  • playReady StreamingPolicyPlayReadyConfiguration
  • widevine StreamingPolicyWidevineConfiguration

CencDrmConfiguration

• CencDrmConfiguration object: Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy
  • playReady StreamingPolicyPlayReadyConfiguration
  • widevine StreamingPolicyWidevineConfiguration

CommonEncryptionCbcs

• CommonEncryptionCbcs object: Class for CommonEncryptionCbcs encryption scheme
  • clearTracks array: Representing which tracks should not be encrypted
    • items TrackSelection
  • contentKeys StreamingPolicyContentKeys
  • drm CbcsDrmConfiguration
  • enabledProtocols EnabledProtocols

CommonEncryptionCenc

• CommonEncryptionCenc object: Class for envelope encryption scheme
  • clearTracks array: Representing which tracks should not be encrypted
    • items TrackSelection
  • contentKeys StreamingPolicyContentKeys
  • drm CencDrmConfiguration
  • enabledProtocols EnabledProtocols

DefaultKey

• DefaultKey object: Class to specify properties of default content key for each encryption scheme
  • label string: Label can be used to specify Content Key when creating a Streaming Locator
  • policyName string: Policy used by Default Key

EnabledProtocols

• EnabledProtocols object: Class to specify which protocols are enabled
  • dash required boolean: Enable DASH protocol or not
  • download required boolean: Enable Download protocol or not
  • hls required boolean: Enable HLS protocol or not
  • smoothStreaming required boolean: Enable SmoothStreaming protocol or not

EnvelopeEncryption

• EnvelopeEncryption object: Class for EnvelopeEncryption encryption scheme
  • clearTracks array: Representing which tracks should not be encrypted
    • items TrackSelection
  • contentKeys StreamingPolicyContentKeys
  • customKeyAcquisitionUrlTemplate string: Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.
  • enabledProtocols EnabledProtocols

ListContentKeysResponse

• ListContentKeysResponse object: Class of response for listContentKeys action
  • contentKeys array: ContentKeys used by current Streaming Locator
    • items StreamingLocatorContentKey

ListPathsResponse

• ListPathsResponse object: Class of response for listPaths action
  • downloadPaths array: Download Paths supported by current Streaming Locator
    • items string
  • streamingPaths array: Streaming Paths supported by current Streaming Locator
    • items StreamingPath

NoEncryption

• NoEncryption object: Class for NoEncryption scheme
  • enabledProtocols EnabledProtocols

ODataError

• ODataError object: Information about an error.
  • code string: A language-independent error name.
  • details array: The error details.
    • items ODataError
  • message string: The error message.
  • target string: The target of the error (for example, the name of the property in error).

StreamingLocator

• StreamingLocator object: A Streaming Locator resource
  • properties StreamingLocatorProperties
  • id string: Fully qualified resource ID for the resource.
  • name string: The name of the resource.
  • type string: The type of the resource.

StreamingLocatorCollection

• StreamingLocatorCollection object: A collection of StreamingLocator items.
  • @odata.nextLink string: A link to the next page of the collection (when the collection contains too many results to return in one response).
  • value array: A collection of StreamingLocator items.
    • items StreamingLocator

StreamingLocatorContentKey

• StreamingLocatorContentKey object: Class for content key in Streaming Locator
  • id required string: ID of Content Key
  • labelReferenceInStreamingPolicy string: Label of Content Key as specified in the Streaming Policy
  • policyName string: ContentKeyPolicy used by Content Key
  • tracks array: Tracks which use this Content Key
    • items TrackSelection
  • type string (values: CommonEncryptionCenc, CommonEncryptionCbcs, EnvelopeEncryption): Encryption type of Content Key
  • value string: Value of Content Key

StreamingLocatorProperties

• StreamingLocatorProperties object: Properties of the Streaming Locator.
  • alternativeMediaId string: Alternative Media ID of this Streaming Locator
  • assetName required string: Asset Name
  • contentKeys array: The ContentKeys used by this Streaming Locator.
    • items StreamingLocatorContentKey
  • created string: The creation time of the Streaming Locator.
  • defaultContentKeyPolicyName string: Name of the default ContentKeyPolicy used by this Streaming Locator.
  • endTime string: The end time of the Streaming Locator.
  • filters array: A list of asset or account filters which apply to this streaming locator
    • items string
  • startTime string: The start time of the Streaming Locator.
  • streamingLocatorId string: The StreamingLocatorId of the Streaming Locator.
  • streamingPolicyName required string: Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming'

StreamingPath

• StreamingPath object: Class of paths for streaming
  • encryptionScheme required string (values: NoEncryption, EnvelopeEncryption, CommonEncryptionCenc, CommonEncryptionCbcs): Encryption scheme
  • paths array: Streaming paths for each protocol and encryptionScheme pair
    • items string
  • streamingProtocol required string (values: Hls, Dash, SmoothStreaming, Download): Streaming protocol

StreamingPolicy

• StreamingPolicy object: A Streaming Policy resource
  • properties StreamingPolicyProperties
  • id string: Fully qualified resource ID for the resource.
  • name string: The name of the resource.
  • type string: The type of the resource.

StreamingPolicyCollection

• StreamingPolicyCollection object: A collection of StreamingPolicy items.
  • @odata.nextLink string: A link to the next page of the collection (when the collection contains too many results to return in one response).
  • value array: A collection of StreamingPolicy items.
    • items StreamingPolicy

StreamingPolicyContentKey

• StreamingPolicyContentKey object: Class to specify properties of content key
  • label string: Label can be used to specify Content Key when creating a Streaming Locator
  • policyName string: Policy used by Content Key
  • tracks array: Tracks which use this content key
    • items TrackSelection

StreamingPolicyContentKeys

• StreamingPolicyContentKeys object: Class to specify properties of all content keys in Streaming Policy
  • defaultKey DefaultKey
  • keyToTrackMappings array: Representing tracks needs separate content key
    • items StreamingPolicyContentKey

StreamingPolicyFairPlayConfiguration

• StreamingPolicyFairPlayConfiguration object: Class to specify configurations of FairPlay in Streaming Policy
  • allowPersistentLicense required boolean: All license to be persistent or not
  • customLicenseAcquisitionUrlTemplate string: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.

StreamingPolicyPlayReadyConfiguration

• StreamingPolicyPlayReadyConfiguration object: Class to specify configurations of PlayReady in Streaming Policy
  • customLicenseAcquisitionUrlTemplate string: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.
  • playReadyCustomAttributes string: Custom attributes for PlayReady

StreamingPolicyProperties

• StreamingPolicyProperties object: Class to specify properties of Streaming Policy
  • commonEncryptionCbcs CommonEncryptionCbcs
  • commonEncryptionCenc CommonEncryptionCenc
  • created string: Creation time of Streaming Policy
  • defaultContentKeyPolicyName string: Default ContentKey used by current Streaming Policy
  • envelopeEncryption EnvelopeEncryption
  • noEncryption NoEncryption

StreamingPolicyWidevineConfiguration

• StreamingPolicyWidevineConfiguration object: Class to specify configurations of Widevine in Streaming Policy
  • customLicenseAcquisitionUrlTemplate string: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested.

TrackPropertyCondition

• TrackPropertyCondition object: Class to specify one track property condition
  • operation required string (values: Unknown, Equal): Track property condition operation
  • property required string (values: Unknown, FourCC): Track property type
  • value string: Track property value

TrackSelection

• TrackSelection object: Class to select a track
  • trackSelections array: TrackSelections is a track property condition list which can specify track(s)
    • items TrackPropertyCondition