diff --git a/lib/services/mediaServicesManagement/README.md b/lib/services/mediaServicesManagement/README.md index a341ba1297..f9c4ea6070 100644 --- a/lib/services/mediaServicesManagement/README.md +++ b/lib/services/mediaServicesManagement/README.md @@ -3,22 +3,23 @@ uid: azure-arm-mediaservices summary: *content --- -# Microsoft Azure SDK for Node.js - AzureMediaServices +**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.** +## Microsoft Azure SDK for Node.js - AzureMediaServices This project provides a Node.js package for accessing Azure. Right now it supports: - **Node.js version 6.x.x or higher** -## Features +### Features -## How to Install +### How to Install ```bash npm install azure-arm-mediaservices ``` -## How to use +### How to use -### Authentication, client creation and list accountFilters as an example. +#### Authentication, client creation and list accountFilters as an example. ```javascript const msRestAzure = require("ms-rest-azure"); @@ -37,6 +38,6 @@ msRestAzure.interactiveLogin().then((creds) => { console.dir(err, {depth: null, colors: true}); }); -## Related projects +### Related projects - [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) diff --git a/lib/services/mediaServicesManagement/lib/models/aacAudio.js b/lib/services/mediaServicesManagement/lib/models/aacAudio.js index e57aa9748d..d88eb2377d 100644 --- a/lib/services/mediaServicesManagement/lib/models/aacAudio.js +++ b/lib/services/mediaServicesManagement/lib/models/aacAudio.js @@ -20,7 +20,7 @@ const models = require('./index'); class AacAudio extends models['Audio'] { /** * Create a AacAudio. - * @member {string} [profile] The encoding profile to be used when encoding + * @property {string} [profile] The encoding profile to be used when encoding * audio with AAC. Possible values include: 'AacLc', 'HeAacV1', 'HeAacV2' */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/accountFilter.js b/lib/services/mediaServicesManagement/lib/models/accountFilter.js index 282b206653..978b747e81 100644 --- a/lib/services/mediaServicesManagement/lib/models/accountFilter.js +++ b/lib/services/mediaServicesManagement/lib/models/accountFilter.js @@ -20,22 +20,22 @@ const models = require('./index'); class AccountFilter extends models['ProxyResource'] { /** * Create a AccountFilter. - * @member {object} [presentationTimeRange] The presentation time range. - * @member {number} [presentationTimeRange.startTimestamp] The absolute start + * @property {object} [presentationTimeRange] The presentation time range. + * @property {number} [presentationTimeRange.startTimestamp] The absolute + * start time boundary. + * @property {number} [presentationTimeRange.endTimestamp] The absolute end * time boundary. - * @member {number} [presentationTimeRange.endTimestamp] The absolute end - * time boundary. - * @member {number} [presentationTimeRange.presentationWindowDuration] The + * @property {number} [presentationTimeRange.presentationWindowDuration] The * relative to end sliding window. - * @member {number} [presentationTimeRange.liveBackoffDuration] The relative - * to end right edge. - * @member {number} [presentationTimeRange.timescale] The time scale of time - * stamps. - * @member {boolean} [presentationTimeRange.forceEndTimestamp] The indicator - * of forcing exsiting of end time stamp. - * @member {object} [firstQuality] The first quality. - * @member {number} [firstQuality.bitrate] The first quality bitrate. - * @member {array} [tracks] The tracks selection conditions. + * @property {number} [presentationTimeRange.liveBackoffDuration] The + * relative to end right edge. + * @property {number} [presentationTimeRange.timescale] The time scale of + * time stamps. + * @property {boolean} [presentationTimeRange.forceEndTimestamp] The + * indicator of forcing exsiting of end time stamp. + * @property {object} [firstQuality] The first quality. + * @property {number} [firstQuality.bitrate] The first quality bitrate. + * @property {array} [tracks] The tracks selection conditions. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/accountFilterCollection.js b/lib/services/mediaServicesManagement/lib/models/accountFilterCollection.js index 210b556327..15fca0febf 100644 --- a/lib/services/mediaServicesManagement/lib/models/accountFilterCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/accountFilterCollection.js @@ -16,8 +16,9 @@ class AccountFilterCollection extends Array { /** * Create a AccountFilterCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/akamaiAccessControl.js b/lib/services/mediaServicesManagement/lib/models/akamaiAccessControl.js index db629466fb..d0627f0587 100644 --- a/lib/services/mediaServicesManagement/lib/models/akamaiAccessControl.js +++ b/lib/services/mediaServicesManagement/lib/models/akamaiAccessControl.js @@ -17,7 +17,7 @@ class AkamaiAccessControl { /** * Create a AkamaiAccessControl. - * @member {array} [akamaiSignatureHeaderAuthenticationKeyList] + * @property {array} [akamaiSignatureHeaderAuthenticationKeyList] * authentication key list */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/akamaiSignatureHeaderAuthenticationKey.js b/lib/services/mediaServicesManagement/lib/models/akamaiSignatureHeaderAuthenticationKey.js index 2bd9ed32f6..612d09514d 100644 --- a/lib/services/mediaServicesManagement/lib/models/akamaiSignatureHeaderAuthenticationKey.js +++ b/lib/services/mediaServicesManagement/lib/models/akamaiSignatureHeaderAuthenticationKey.js @@ -17,9 +17,10 @@ class AkamaiSignatureHeaderAuthenticationKey { /** * Create a AkamaiSignatureHeaderAuthenticationKey. - * @member {string} [identifier] identifier of the key - * @member {string} [base64Key] authentication key - * @member {date} [expiration] The expiration time of the authentication key. + * @property {string} [identifier] identifier of the key + * @property {string} [base64Key] authentication key + * @property {date} [expiration] The expiration time of the authentication + * key. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/apiError.js b/lib/services/mediaServicesManagement/lib/models/apiError.js index c46090683e..bdeae0df60 100644 --- a/lib/services/mediaServicesManagement/lib/models/apiError.js +++ b/lib/services/mediaServicesManagement/lib/models/apiError.js @@ -17,12 +17,12 @@ class ApiError { /** * Create a ApiError. - * @member {object} [error] ApiError. The error properties. - * @member {string} [error.code] A language-independent error name. - * @member {string} [error.message] The error message. - * @member {string} [error.target] The target of the error (for example, the - * name of the property in error). - * @member {array} [error.details] The error details. + * @property {object} [error] ApiError. The error properties. + * @property {string} [error.code] A language-independent error name. + * @property {string} [error.message] The error message. + * @property {string} [error.target] The target of the error (for example, + * the name of the property in error). + * @property {array} [error.details] The error details. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/asset.js b/lib/services/mediaServicesManagement/lib/models/asset.js index 63876ee283..fc28152f5b 100644 --- a/lib/services/mediaServicesManagement/lib/models/asset.js +++ b/lib/services/mediaServicesManagement/lib/models/asset.js @@ -20,14 +20,14 @@ const models = require('./index'); class Asset extends models['ProxyResource'] { /** * Create a Asset. - * @member {uuid} [assetId] The Asset ID. - * @member {date} [created] The creation date of the Asset. - * @member {date} [lastModified] The last modified date of the Asset. - * @member {string} [alternateId] The alternate ID of the Asset. - * @member {string} [description] The Asset description. - * @member {string} [container] The name of the asset blob container. - * @member {string} [storageAccountName] The name of the storage account. - * @member {string} [storageEncryptionFormat] The Asset encryption format. + * @property {uuid} [assetId] The Asset ID. + * @property {date} [created] The creation date of the Asset. + * @property {date} [lastModified] The last modified date of the Asset. + * @property {string} [alternateId] The alternate ID of the Asset. + * @property {string} [description] The Asset description. + * @property {string} [container] The name of the asset blob container. + * @property {string} [storageAccountName] The name of the storage account. + * @property {string} [storageEncryptionFormat] The Asset encryption format. * One of None or MediaStorageEncryption. Possible values include: 'None', * 'MediaStorageClientEncryption' */ diff --git a/lib/services/mediaServicesManagement/lib/models/assetCollection.js b/lib/services/mediaServicesManagement/lib/models/assetCollection.js index 56bd4090df..8269570a53 100644 --- a/lib/services/mediaServicesManagement/lib/models/assetCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/assetCollection.js @@ -16,8 +16,9 @@ class AssetCollection extends Array { /** * Create a AssetCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/assetContainerSas.js b/lib/services/mediaServicesManagement/lib/models/assetContainerSas.js index db96730aa1..39cb7bec76 100644 --- a/lib/services/mediaServicesManagement/lib/models/assetContainerSas.js +++ b/lib/services/mediaServicesManagement/lib/models/assetContainerSas.js @@ -17,7 +17,7 @@ class AssetContainerSas { /** * Create a AssetContainerSas. - * @member {array} [assetContainerSasUrls] The list of Asset container SAS + * @property {array} [assetContainerSasUrls] The list of Asset container SAS * URLs. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/assetFileEncryptionMetadata.js b/lib/services/mediaServicesManagement/lib/models/assetFileEncryptionMetadata.js index 127d6e784c..7bfda41866 100644 --- a/lib/services/mediaServicesManagement/lib/models/assetFileEncryptionMetadata.js +++ b/lib/services/mediaServicesManagement/lib/models/assetFileEncryptionMetadata.js @@ -17,10 +17,10 @@ class AssetFileEncryptionMetadata { /** * Create a AssetFileEncryptionMetadata. - * @member {string} [initializationVector] The Asset File initialization + * @property {string} [initializationVector] The Asset File initialization * vector. - * @member {string} [assetFileName] The Asset File name. - * @member {uuid} assetFileId The Asset File Id. + * @property {string} [assetFileName] The Asset File name. + * @property {uuid} assetFileId The Asset File Id. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/assetFilter.js b/lib/services/mediaServicesManagement/lib/models/assetFilter.js index 456a6c18f8..a7d6484fe0 100644 --- a/lib/services/mediaServicesManagement/lib/models/assetFilter.js +++ b/lib/services/mediaServicesManagement/lib/models/assetFilter.js @@ -20,22 +20,22 @@ const models = require('./index'); class AssetFilter extends models['ProxyResource'] { /** * Create a AssetFilter. - * @member {object} [presentationTimeRange] The presentation time range. - * @member {number} [presentationTimeRange.startTimestamp] The absolute start + * @property {object} [presentationTimeRange] The presentation time range. + * @property {number} [presentationTimeRange.startTimestamp] The absolute + * start time boundary. + * @property {number} [presentationTimeRange.endTimestamp] The absolute end * time boundary. - * @member {number} [presentationTimeRange.endTimestamp] The absolute end - * time boundary. - * @member {number} [presentationTimeRange.presentationWindowDuration] The + * @property {number} [presentationTimeRange.presentationWindowDuration] The * relative to end sliding window. - * @member {number} [presentationTimeRange.liveBackoffDuration] The relative - * to end right edge. - * @member {number} [presentationTimeRange.timescale] The time scale of time - * stamps. - * @member {boolean} [presentationTimeRange.forceEndTimestamp] The indicator - * of forcing exsiting of end time stamp. - * @member {object} [firstQuality] The first quality. - * @member {number} [firstQuality.bitrate] The first quality bitrate. - * @member {array} [tracks] The tracks selection conditions. + * @property {number} [presentationTimeRange.liveBackoffDuration] The + * relative to end right edge. + * @property {number} [presentationTimeRange.timescale] The time scale of + * time stamps. + * @property {boolean} [presentationTimeRange.forceEndTimestamp] The + * indicator of forcing exsiting of end time stamp. + * @property {object} [firstQuality] The first quality. + * @property {number} [firstQuality.bitrate] The first quality bitrate. + * @property {array} [tracks] The tracks selection conditions. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/assetFilterCollection.js b/lib/services/mediaServicesManagement/lib/models/assetFilterCollection.js index 3f3f0ec041..91f106c8fd 100644 --- a/lib/services/mediaServicesManagement/lib/models/assetFilterCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/assetFilterCollection.js @@ -16,8 +16,9 @@ class AssetFilterCollection extends Array { /** * Create a AssetFilterCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/assetStreamingLocator.js b/lib/services/mediaServicesManagement/lib/models/assetStreamingLocator.js index df4bd4ee21..01625fea94 100644 --- a/lib/services/mediaServicesManagement/lib/models/assetStreamingLocator.js +++ b/lib/services/mediaServicesManagement/lib/models/assetStreamingLocator.js @@ -17,16 +17,16 @@ class AssetStreamingLocator { /** * Create a AssetStreamingLocator. - * @member {string} [name] Streaming Locator name. - * @member {string} [assetName] Asset Name. - * @member {date} [created] The creation time of the Streaming Locator. - * @member {date} [startTime] The start time of the Streaming Locator. - * @member {date} [endTime] The end time of the Streaming Locator. - * @member {uuid} [streamingLocatorId] StreamingLocatorId of the Streaming + * @property {string} [name] Streaming Locator name. + * @property {string} [assetName] Asset Name. + * @property {date} [created] The creation time of the Streaming Locator. + * @property {date} [startTime] The start time of the Streaming Locator. + * @property {date} [endTime] The end time of the Streaming Locator. + * @property {uuid} [streamingLocatorId] StreamingLocatorId of the Streaming * Locator. - * @member {string} [streamingPolicyName] Name of the Streaming Policy used + * @property {string} [streamingPolicyName] Name of the Streaming Policy used * by this Streaming Locator. - * @member {string} [defaultContentKeyPolicyName] Name of the default + * @property {string} [defaultContentKeyPolicyName] Name of the default * ContentKeyPolicy used by this Streaming Locator. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/audio.js b/lib/services/mediaServicesManagement/lib/models/audio.js index 78d73fa2dc..e192850efd 100644 --- a/lib/services/mediaServicesManagement/lib/models/audio.js +++ b/lib/services/mediaServicesManagement/lib/models/audio.js @@ -20,11 +20,11 @@ const models = require('./index'); class Audio extends models['Codec'] { /** * Create a Audio. - * @member {number} [channels] The number of channels in the audio. - * @member {number} [samplingRate] The sampling rate to use for encoding in + * @property {number} [channels] The number of channels in the audio. + * @property {number} [samplingRate] The sampling rate to use for encoding in * hertz. - * @member {number} [bitrate] The bitrate, in bits per second, of the output - * encoded audio. + * @property {number} [bitrate] The bitrate, in bits per second, of the + * output encoded audio. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/audioAnalyzerPreset.js b/lib/services/mediaServicesManagement/lib/models/audioAnalyzerPreset.js index af9c404eb7..e7f3b1f80f 100644 --- a/lib/services/mediaServicesManagement/lib/models/audioAnalyzerPreset.js +++ b/lib/services/mediaServicesManagement/lib/models/audioAnalyzerPreset.js @@ -22,9 +22,9 @@ const models = require('./index'); class AudioAnalyzerPreset extends models['Preset'] { /** * Create a AudioAnalyzerPreset. - * @member {string} [audioLanguage] The language for the audio payload in the - * input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). The - * list of supported languages are, 'en-US', 'en-GB', 'es-ES', 'es-MX', + * @property {string} [audioLanguage] The language for the audio payload in + * the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). + * The list of supported languages are, 'en-US', 'en-GB', 'es-ES', 'es-MX', * 'fr-FR', 'it-IT', 'ja-JP', 'pt-BR', 'zh-CN', 'de-DE', 'ar-EG', 'ru-RU', * 'hi-IN'. If not specified, automatic language detection would be employed. * This feature currently supports English, Chinese, French, German, Italian, diff --git a/lib/services/mediaServicesManagement/lib/models/builtInStandardEncoderPreset.js b/lib/services/mediaServicesManagement/lib/models/builtInStandardEncoderPreset.js index 3b0aee1b41..51354d73ca 100644 --- a/lib/services/mediaServicesManagement/lib/models/builtInStandardEncoderPreset.js +++ b/lib/services/mediaServicesManagement/lib/models/builtInStandardEncoderPreset.js @@ -21,7 +21,7 @@ const models = require('./index'); class BuiltInStandardEncoderPreset extends models['Preset'] { /** * Create a BuiltInStandardEncoderPreset. - * @member {string} presetName The built-in preset to be used for encoding + * @property {string} presetName The built-in preset to be used for encoding * videos. Possible values include: 'H264SingleBitrateSD', * 'H264SingleBitrate720p', 'H264SingleBitrate1080p', 'AdaptiveStreaming', * 'AACGoodQualityAudio', 'H264MultipleBitrate1080p', diff --git a/lib/services/mediaServicesManagement/lib/models/cbcsDrmConfiguration.js b/lib/services/mediaServicesManagement/lib/models/cbcsDrmConfiguration.js index fd53711b80..32817c69d0 100644 --- a/lib/services/mediaServicesManagement/lib/models/cbcsDrmConfiguration.js +++ b/lib/services/mediaServicesManagement/lib/models/cbcsDrmConfiguration.js @@ -18,20 +18,20 @@ class CbcsDrmConfiguration { /** * Create a CbcsDrmConfiguration. - * @member {object} [fairPlay] FairPlay configurations - * @member {string} [fairPlay.customLicenseAcquisitionUrlTemplate] The + * @property {object} [fairPlay] FairPlay configurations + * @property {string} [fairPlay.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. - * @member {boolean} [fairPlay.allowPersistentLicense] All license to be + * @property {boolean} [fairPlay.allowPersistentLicense] All license to be * persistent or not - * @member {object} [playReady] PlayReady configurations - * @member {string} [playReady.customLicenseAcquisitionUrlTemplate] The + * @property {object} [playReady] PlayReady configurations + * @property {string} [playReady.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. - * @member {string} [playReady.playReadyCustomAttributes] Custom attributes + * @property {string} [playReady.playReadyCustomAttributes] Custom attributes * for PlayReady - * @member {object} [widevine] Widevine configurations - * @member {string} [widevine.customLicenseAcquisitionUrlTemplate] The + * @property {object} [widevine] Widevine configurations + * @property {string} [widevine.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. */ diff --git a/lib/services/mediaServicesManagement/lib/models/cencDrmConfiguration.js b/lib/services/mediaServicesManagement/lib/models/cencDrmConfiguration.js index 71e8e992a5..16adddcf21 100644 --- a/lib/services/mediaServicesManagement/lib/models/cencDrmConfiguration.js +++ b/lib/services/mediaServicesManagement/lib/models/cencDrmConfiguration.js @@ -18,14 +18,14 @@ class CencDrmConfiguration { /** * Create a CencDrmConfiguration. - * @member {object} [playReady] PlayReady configurations - * @member {string} [playReady.customLicenseAcquisitionUrlTemplate] The + * @property {object} [playReady] PlayReady configurations + * @property {string} [playReady.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. - * @member {string} [playReady.playReadyCustomAttributes] Custom attributes + * @property {string} [playReady.playReadyCustomAttributes] Custom attributes * for PlayReady - * @member {object} [widevine] Widevine configurations - * @member {string} [widevine.customLicenseAcquisitionUrlTemplate] The + * @property {object} [widevine] Widevine configurations + * @property {string} [widevine.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. */ diff --git a/lib/services/mediaServicesManagement/lib/models/checkNameAvailabilityInput.js b/lib/services/mediaServicesManagement/lib/models/checkNameAvailabilityInput.js index 9db8c9a74b..7bc675ca1e 100644 --- a/lib/services/mediaServicesManagement/lib/models/checkNameAvailabilityInput.js +++ b/lib/services/mediaServicesManagement/lib/models/checkNameAvailabilityInput.js @@ -17,8 +17,8 @@ class CheckNameAvailabilityInput { /** * Create a CheckNameAvailabilityInput. - * @member {string} [name] The account name. - * @member {string} [type] The account type. For a Media Services account, + * @property {string} [name] The account name. + * @property {string} [type] The account type. For a Media Services account, * this should be 'MediaServices'. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/codec.js b/lib/services/mediaServicesManagement/lib/models/codec.js index eb34d76eb7..9e29bf8ab7 100644 --- a/lib/services/mediaServicesManagement/lib/models/codec.js +++ b/lib/services/mediaServicesManagement/lib/models/codec.js @@ -17,9 +17,9 @@ class Codec { /** * Create a Codec. - * @member {string} [label] An optional label for the codec. The label can be - * used to control muxing behavior. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} [label] An optional label for the codec. The label can + * be used to control muxing behavior. + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/commonEncryptionCbcs.js b/lib/services/mediaServicesManagement/lib/models/commonEncryptionCbcs.js index 5699c74024..9a79c3f8e7 100644 --- a/lib/services/mediaServicesManagement/lib/models/commonEncryptionCbcs.js +++ b/lib/services/mediaServicesManagement/lib/models/commonEncryptionCbcs.js @@ -17,40 +17,41 @@ class CommonEncryptionCbcs { /** * Create a CommonEncryptionCbcs. - * @member {object} [enabledProtocols] Representing supported protocols - * @member {boolean} [enabledProtocols.download] Enable Download protocol or - * not - * @member {boolean} [enabledProtocols.dash] Enable DASH protocol or not - * @member {boolean} [enabledProtocols.hls] Enable HLS protocol or not - * @member {boolean} [enabledProtocols.smoothStreaming] Enable + * @property {object} [enabledProtocols] Representing supported protocols + * @property {boolean} [enabledProtocols.download] Enable Download protocol + * or not + * @property {boolean} [enabledProtocols.dash] Enable DASH protocol or not + * @property {boolean} [enabledProtocols.hls] Enable HLS protocol or not + * @property {boolean} [enabledProtocols.smoothStreaming] Enable * SmoothStreaming protocol or not - * @member {array} [clearTracks] Representing which tracks should not be + * @property {array} [clearTracks] Representing which tracks should not be * encrypted - * @member {object} [contentKeys] Representing default content key for each + * @property {object} [contentKeys] Representing default content key for each * encryption scheme and separate content keys for specific tracks - * @member {object} [contentKeys.defaultKey] Default content key for an + * @property {object} [contentKeys.defaultKey] Default content key for an * encryption scheme - * @member {string} [contentKeys.defaultKey.label] Label can be used to + * @property {string} [contentKeys.defaultKey.label] Label can be used to * specify Content Key when creating a Streaming Locator - * @member {string} [contentKeys.defaultKey.policyName] Policy used by + * @property {string} [contentKeys.defaultKey.policyName] Policy used by * Default Key - * @member {array} [contentKeys.keyToTrackMappings] Representing tracks needs - * separate content key - * @member {object} [drm] Configuration of DRMs for current encryption scheme - * @member {object} [drm.fairPlay] FairPlay configurations - * @member {string} [drm.fairPlay.customLicenseAcquisitionUrlTemplate] The + * @property {array} [contentKeys.keyToTrackMappings] Representing tracks + * needs separate content key + * @property {object} [drm] Configuration of DRMs for current encryption + * scheme + * @property {object} [drm.fairPlay] FairPlay configurations + * @property {string} [drm.fairPlay.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. - * @member {boolean} [drm.fairPlay.allowPersistentLicense] All license to be - * persistent or not - * @member {object} [drm.playReady] PlayReady configurations - * @member {string} [drm.playReady.customLicenseAcquisitionUrlTemplate] The + * @property {boolean} [drm.fairPlay.allowPersistentLicense] All license to + * be persistent or not + * @property {object} [drm.playReady] PlayReady configurations + * @property {string} [drm.playReady.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. - * @member {string} [drm.playReady.playReadyCustomAttributes] Custom + * @property {string} [drm.playReady.playReadyCustomAttributes] Custom * attributes for PlayReady - * @member {object} [drm.widevine] Widevine configurations - * @member {string} [drm.widevine.customLicenseAcquisitionUrlTemplate] The + * @property {object} [drm.widevine] Widevine configurations + * @property {string} [drm.widevine.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. */ diff --git a/lib/services/mediaServicesManagement/lib/models/commonEncryptionCenc.js b/lib/services/mediaServicesManagement/lib/models/commonEncryptionCenc.js index 8b95457158..e97dd61a95 100644 --- a/lib/services/mediaServicesManagement/lib/models/commonEncryptionCenc.js +++ b/lib/services/mediaServicesManagement/lib/models/commonEncryptionCenc.js @@ -17,35 +17,35 @@ class CommonEncryptionCenc { /** * Create a CommonEncryptionCenc. - * @member {object} [enabledProtocols] Representing supported protocols - * @member {boolean} [enabledProtocols.download] Enable Download protocol or - * not - * @member {boolean} [enabledProtocols.dash] Enable DASH protocol or not - * @member {boolean} [enabledProtocols.hls] Enable HLS protocol or not - * @member {boolean} [enabledProtocols.smoothStreaming] Enable + * @property {object} [enabledProtocols] Representing supported protocols + * @property {boolean} [enabledProtocols.download] Enable Download protocol + * or not + * @property {boolean} [enabledProtocols.dash] Enable DASH protocol or not + * @property {boolean} [enabledProtocols.hls] Enable HLS protocol or not + * @property {boolean} [enabledProtocols.smoothStreaming] Enable * SmoothStreaming protocol or not - * @member {array} [clearTracks] Representing which tracks should not be + * @property {array} [clearTracks] Representing which tracks should not be * encrypted - * @member {object} [contentKeys] Representing default content key for each + * @property {object} [contentKeys] Representing default content key for each * encryption scheme and separate content keys for specific tracks - * @member {object} [contentKeys.defaultKey] Default content key for an + * @property {object} [contentKeys.defaultKey] Default content key for an * encryption scheme - * @member {string} [contentKeys.defaultKey.label] Label can be used to + * @property {string} [contentKeys.defaultKey.label] Label can be used to * specify Content Key when creating a Streaming Locator - * @member {string} [contentKeys.defaultKey.policyName] Policy used by + * @property {string} [contentKeys.defaultKey.policyName] Policy used by * Default Key - * @member {array} [contentKeys.keyToTrackMappings] Representing tracks needs - * separate content key - * @member {object} [drm] Configuration of DRMs for CommonEncryptionCenc + * @property {array} [contentKeys.keyToTrackMappings] Representing tracks + * needs separate content key + * @property {object} [drm] Configuration of DRMs for CommonEncryptionCenc * encryption scheme - * @member {object} [drm.playReady] PlayReady configurations - * @member {string} [drm.playReady.customLicenseAcquisitionUrlTemplate] The + * @property {object} [drm.playReady] PlayReady configurations + * @property {string} [drm.playReady.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. - * @member {string} [drm.playReady.playReadyCustomAttributes] Custom + * @property {string} [drm.playReady.playReadyCustomAttributes] Custom * attributes for PlayReady - * @member {object} [drm.widevine] Widevine configurations - * @member {string} [drm.widevine.customLicenseAcquisitionUrlTemplate] The + * @property {object} [drm.widevine] Widevine configurations + * @property {string} [drm.widevine.customLicenseAcquisitionUrlTemplate] The * template for a customer service to deliver keys to end users. Not needed * when using Azure Media Services for issuing keys. */ diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicy.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicy.js index 96cbab4094..bd52756efb 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicy.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicy.js @@ -20,11 +20,11 @@ const models = require('./index'); class ContentKeyPolicy extends models['ProxyResource'] { /** * Create a ContentKeyPolicy. - * @member {uuid} [policyId] The legacy Policy ID. - * @member {date} [created] The creation date of the Policy - * @member {date} [lastModified] The last modified date of the Policy - * @member {string} [description] A description for the Policy. - * @member {array} options The Key Policy options. + * @property {uuid} [policyId] The legacy Policy ID. + * @property {date} [created] The creation date of the Policy + * @property {date} [lastModified] The last modified date of the Policy + * @property {string} [description] A description for the Policy. + * @property {array} options The Key Policy options. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyCollection.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyCollection.js index 7c1462a17a..9c3a17c1f8 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyCollection.js @@ -16,8 +16,9 @@ class ContentKeyPolicyCollection extends Array { /** * Create a ContentKeyPolicyCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyConfiguration.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyConfiguration.js index a6795547fc..cbe2a7c624 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyConfiguration.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyConfiguration.js @@ -18,7 +18,7 @@ class ContentKeyPolicyConfiguration { /** * Create a ContentKeyPolicyConfiguration. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyFairPlayConfiguration.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyFairPlayConfiguration.js index 6b38bb138f..50adb4fb5c 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyFairPlayConfiguration.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyFairPlayConfiguration.js @@ -20,17 +20,17 @@ const models = require('./index'); class ContentKeyPolicyFairPlayConfiguration extends models['ContentKeyPolicyConfiguration'] { /** * Create a ContentKeyPolicyFairPlayConfiguration. - * @member {buffer} ask The key that must be used as FairPlay Application + * @property {buffer} ask The key that must be used as FairPlay Application * Secret key. - * @member {string} fairPlayPfxPassword The password encrypting FairPlay + * @property {string} fairPlayPfxPassword The password encrypting FairPlay * certificate in PKCS 12 (pfx) format. - * @member {string} fairPlayPfx The Base64 representation of FairPlay + * @property {string} fairPlayPfx The Base64 representation of FairPlay * certificate in PKCS 12 (pfx) format (including private key). - * @member {string} rentalAndLeaseKeyType The rental and lease key type. + * @property {string} rentalAndLeaseKeyType The rental and lease key type. * Possible values include: 'Unknown', 'Undefined', 'PersistentUnlimited', * 'PersistentLimited' - * @member {number} rentalDuration The rental duration. Must be greater than - * or equal to 0. + * @property {number} rentalDuration The rental duration. Must be greater + * than or equal to 0. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyOption.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyOption.js index 87f967d262..d5c0ae83aa 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyOption.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyOption.js @@ -17,13 +17,13 @@ class ContentKeyPolicyOption { /** * Create a ContentKeyPolicyOption. - * @member {uuid} [policyOptionId] The legacy Policy Option ID. - * @member {string} [name] The Policy Option description. - * @member {object} configuration The key delivery configuration. - * @member {string} [configuration.odatatype] Polymorphic Discriminator - * @member {object} restriction The requirements that must be met to deliver - * keys with this configuration - * @member {string} [restriction.odatatype] Polymorphic Discriminator + * @property {uuid} [policyOptionId] The legacy Policy Option ID. + * @property {string} [name] The Policy Option description. + * @property {object} configuration The key delivery configuration. + * @property {string} [configuration.odatatype] Polymorphic Discriminator + * @property {object} restriction The requirements that must be met to + * deliver keys with this configuration + * @property {string} [restriction.odatatype] Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyConfiguration.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyConfiguration.js index 541e7330c3..e5a7db01a7 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyConfiguration.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyConfiguration.js @@ -20,8 +20,8 @@ const models = require('./index'); class ContentKeyPolicyPlayReadyConfiguration extends models['ContentKeyPolicyConfiguration'] { /** * Create a ContentKeyPolicyPlayReadyConfiguration. - * @member {array} licenses The PlayReady licenses. - * @member {string} [responseCustomData] The custom response data. + * @property {array} licenses The PlayReady licenses. + * @property {string} [responseCustomData] The custom response data. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier.js index e97980c219..8d590e49a7 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier.js @@ -21,7 +21,7 @@ const models = require('./index'); class ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier extends models['ContentKeyPolicyPlayReadyContentKeyLocation'] { /** * Create a ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier. - * @member {uuid} keyId The content key ID. + * @property {uuid} keyId The content key ID. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyContentKeyLocation.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyContentKeyLocation.js index b26fd3bdff..205c5edcdc 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyContentKeyLocation.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyContentKeyLocation.js @@ -18,7 +18,7 @@ class ContentKeyPolicyPlayReadyContentKeyLocation { /** * Create a ContentKeyPolicyPlayReadyContentKeyLocation. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction.js index c8d09bc139..40526c45a7 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction.js @@ -18,9 +18,9 @@ class ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction { /** * Create a ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction. - * @member {boolean} bestEffort Indicates whether this restriction is + * @property {boolean} bestEffort Indicates whether this restriction is * enforced on a Best Effort basis. - * @member {number} configurationData Configures the restriction control + * @property {number} configurationData Configures the restriction control * bits. Must be between 0 and 3 inclusive. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyLicense.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyLicense.js index 52d3eb2f8c..5729380925 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyLicense.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyLicense.js @@ -17,63 +17,64 @@ class ContentKeyPolicyPlayReadyLicense { /** * Create a ContentKeyPolicyPlayReadyLicense. - * @member {boolean} allowTestDevices A flag indicating whether test devices - * can use the license. - * @member {date} [beginDate] The begin date of license - * @member {date} [expirationDate] The expiration date of license. - * @member {moment.duration} [relativeBeginDate] The relative begin date of + * @property {boolean} allowTestDevices A flag indicating whether test + * devices can use the license. + * @property {date} [beginDate] The begin date of license + * @property {date} [expirationDate] The expiration date of license. + * @property {moment.duration} [relativeBeginDate] The relative begin date of * license. - * @member {moment.duration} [relativeExpirationDate] The relative expiration - * date of license. - * @member {moment.duration} [gracePeriod] The grace period of license. - * @member {object} [playRight] The license PlayRight - * @member {moment.duration} [playRight.firstPlayExpiration] The amount of + * @property {moment.duration} [relativeExpirationDate] The relative + * expiration date of license. + * @property {moment.duration} [gracePeriod] The grace period of license. + * @property {object} [playRight] The license PlayRight + * @property {moment.duration} [playRight.firstPlayExpiration] The amount of * time that the license is valid after the license is first used to play * content. - * @member {number} [playRight.scmsRestriction] Configures the Serial Copy + * @property {number} [playRight.scmsRestriction] Configures the Serial Copy * Management System (SCMS) in the license. Must be between 0 and 3 * inclusive. - * @member {number} [playRight.agcAndColorStripeRestriction] Configures + * @property {number} [playRight.agcAndColorStripeRestriction] Configures * Automatic Gain Control (AGC) and Color Stripe in the license. Must be * between 0 and 3 inclusive. - * @member {object} [playRight.explicitAnalogTelevisionOutputRestriction] + * @property {object} [playRight.explicitAnalogTelevisionOutputRestriction] * Configures the Explicit Analog Television Output Restriction in the * license. Configuration data must be between 0 and 3 inclusive. - * @member {boolean} + * @property {boolean} * [playRight.explicitAnalogTelevisionOutputRestriction.bestEffort] Indicates * whether this restriction is enforced on a Best Effort basis. - * @member {number} + * @property {number} * [playRight.explicitAnalogTelevisionOutputRestriction.configurationData] * Configures the restriction control bits. Must be between 0 and 3 * inclusive. - * @member {boolean} [playRight.digitalVideoOnlyContentRestriction] Enables + * @property {boolean} [playRight.digitalVideoOnlyContentRestriction] Enables * the Image Constraint For Analog Component Video Restriction in the * license. - * @member {boolean} + * @property {boolean} * [playRight.imageConstraintForAnalogComponentVideoRestriction] Enables the * Image Constraint For Analog Component Video Restriction in the license. - * @member {boolean} + * @property {boolean} * [playRight.imageConstraintForAnalogComputerMonitorRestriction] Enables the * Image Constraint For Analog Component Video Restriction in the license. - * @member {string} [playRight.allowPassingVideoContentToUnknownOutput] + * @property {string} [playRight.allowPassingVideoContentToUnknownOutput] * Configures Unknown output handling settings of the license. Possible * values include: 'Unknown', 'NotAllowed', 'Allowed', * 'AllowedWithVideoConstriction' - * @member {number} [playRight.uncompressedDigitalVideoOpl] Specifies the + * @property {number} [playRight.uncompressedDigitalVideoOpl] Specifies the * output protection level for uncompressed digital video. - * @member {number} [playRight.compressedDigitalVideoOpl] Specifies the + * @property {number} [playRight.compressedDigitalVideoOpl] Specifies the * output protection level for compressed digital video. - * @member {number} [playRight.analogVideoOpl] Specifies the output + * @property {number} [playRight.analogVideoOpl] Specifies the output * protection level for compressed digital audio. - * @member {number} [playRight.compressedDigitalAudioOpl] Specifies the + * @property {number} [playRight.compressedDigitalAudioOpl] Specifies the * output protection level for compressed digital audio. - * @member {number} [playRight.uncompressedDigitalAudioOpl] Specifies the + * @property {number} [playRight.uncompressedDigitalAudioOpl] Specifies the * output protection level for uncompressed digital audio. - * @member {string} licenseType The license type. Possible values include: + * @property {string} licenseType The license type. Possible values include: * 'Unknown', 'NonPersistent', 'Persistent' - * @member {object} contentKeyLocation The content key location. - * @member {string} [contentKeyLocation.odatatype] Polymorphic Discriminator - * @member {string} contentType The PlayReady content type. Possible values + * @property {object} contentKeyLocation The content key location. + * @property {string} [contentKeyLocation.odatatype] Polymorphic + * Discriminator + * @property {string} contentType The PlayReady content type. Possible values * include: 'Unknown', 'Unspecified', 'UltraVioletDownload', * 'UltraVioletStreaming' */ diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyPlayRight.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyPlayRight.js index 218ccc99c8..bf368aec78 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyPlayRight.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyPlayReadyPlayRight.js @@ -17,41 +17,41 @@ class ContentKeyPolicyPlayReadyPlayRight { /** * Create a ContentKeyPolicyPlayReadyPlayRight. - * @member {moment.duration} [firstPlayExpiration] The amount of time that + * @property {moment.duration} [firstPlayExpiration] The amount of time that * the license is valid after the license is first used to play content. - * @member {number} [scmsRestriction] Configures the Serial Copy Management + * @property {number} [scmsRestriction] Configures the Serial Copy Management * System (SCMS) in the license. Must be between 0 and 3 inclusive. - * @member {number} [agcAndColorStripeRestriction] Configures Automatic Gain - * Control (AGC) and Color Stripe in the license. Must be between 0 and 3 - * inclusive. - * @member {object} [explicitAnalogTelevisionOutputRestriction] Configures + * @property {number} [agcAndColorStripeRestriction] Configures Automatic + * Gain Control (AGC) and Color Stripe in the license. Must be between 0 and + * 3 inclusive. + * @property {object} [explicitAnalogTelevisionOutputRestriction] Configures * the Explicit Analog Television Output Restriction in the license. * Configuration data must be between 0 and 3 inclusive. - * @member {boolean} [explicitAnalogTelevisionOutputRestriction.bestEffort] + * @property {boolean} [explicitAnalogTelevisionOutputRestriction.bestEffort] * Indicates whether this restriction is enforced on a Best Effort basis. - * @member {number} + * @property {number} * [explicitAnalogTelevisionOutputRestriction.configurationData] Configures * the restriction control bits. Must be between 0 and 3 inclusive. - * @member {boolean} digitalVideoOnlyContentRestriction Enables the Image + * @property {boolean} digitalVideoOnlyContentRestriction Enables the Image * Constraint For Analog Component Video Restriction in the license. - * @member {boolean} imageConstraintForAnalogComponentVideoRestriction + * @property {boolean} imageConstraintForAnalogComponentVideoRestriction * Enables the Image Constraint For Analog Component Video Restriction in the * license. - * @member {boolean} imageConstraintForAnalogComputerMonitorRestriction + * @property {boolean} imageConstraintForAnalogComputerMonitorRestriction * Enables the Image Constraint For Analog Component Video Restriction in the * license. - * @member {string} allowPassingVideoContentToUnknownOutput Configures + * @property {string} allowPassingVideoContentToUnknownOutput Configures * Unknown output handling settings of the license. Possible values include: * 'Unknown', 'NotAllowed', 'Allowed', 'AllowedWithVideoConstriction' - * @member {number} [uncompressedDigitalVideoOpl] Specifies the output + * @property {number} [uncompressedDigitalVideoOpl] Specifies the output * protection level for uncompressed digital video. - * @member {number} [compressedDigitalVideoOpl] Specifies the output + * @property {number} [compressedDigitalVideoOpl] Specifies the output * protection level for compressed digital video. - * @member {number} [analogVideoOpl] Specifies the output protection level + * @property {number} [analogVideoOpl] Specifies the output protection level * for compressed digital audio. - * @member {number} [compressedDigitalAudioOpl] Specifies the output + * @property {number} [compressedDigitalAudioOpl] Specifies the output * protection level for compressed digital audio. - * @member {number} [uncompressedDigitalAudioOpl] Specifies the output + * @property {number} [uncompressedDigitalAudioOpl] Specifies the output * protection level for uncompressed digital audio. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyProperties.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyProperties.js index e02821c4a1..9f2c1b47bf 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyProperties.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyProperties.js @@ -17,11 +17,11 @@ class ContentKeyPolicyProperties { /** * Create a ContentKeyPolicyProperties. - * @member {uuid} [policyId] The legacy Policy ID. - * @member {date} [created] The creation date of the Policy - * @member {date} [lastModified] The last modified date of the Policy - * @member {string} [description] A description for the Policy. - * @member {array} options The Key Policy options. + * @property {uuid} [policyId] The legacy Policy ID. + * @property {date} [created] The creation date of the Policy + * @property {date} [lastModified] The last modified date of the Policy + * @property {string} [description] A description for the Policy. + * @property {array} options The Key Policy options. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRestriction.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRestriction.js index 0a7a89409e..e924a935af 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRestriction.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRestriction.js @@ -18,7 +18,7 @@ class ContentKeyPolicyRestriction { /** * Create a ContentKeyPolicyRestriction. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRestrictionTokenKey.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRestrictionTokenKey.js index ae6c1f97a5..c00d4ac97c 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRestrictionTokenKey.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRestrictionTokenKey.js @@ -18,7 +18,7 @@ class ContentKeyPolicyRestrictionTokenKey { /** * Create a ContentKeyPolicyRestrictionTokenKey. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRsaTokenKey.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRsaTokenKey.js index 66041bc0ce..6ae76bc77d 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRsaTokenKey.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyRsaTokenKey.js @@ -20,8 +20,8 @@ const models = require('./index'); class ContentKeyPolicyRsaTokenKey extends models['ContentKeyPolicyRestrictionTokenKey'] { /** * Create a ContentKeyPolicyRsaTokenKey. - * @member {buffer} exponent The RSA Parameter exponent - * @member {buffer} modulus The RSA Parameter modulus + * @property {buffer} exponent The RSA Parameter exponent + * @property {buffer} modulus The RSA Parameter modulus */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicySymmetricTokenKey.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicySymmetricTokenKey.js index f560c151c9..9d99997c1f 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicySymmetricTokenKey.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicySymmetricTokenKey.js @@ -20,7 +20,7 @@ const models = require('./index'); class ContentKeyPolicySymmetricTokenKey extends models['ContentKeyPolicyRestrictionTokenKey'] { /** * Create a ContentKeyPolicySymmetricTokenKey. - * @member {buffer} keyValue The key value of the key + * @property {buffer} keyValue The key value of the key */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyTokenClaim.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyTokenClaim.js index 06dc7b8bb7..7b9a88b08d 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyTokenClaim.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyTokenClaim.js @@ -17,8 +17,8 @@ class ContentKeyPolicyTokenClaim { /** * Create a ContentKeyPolicyTokenClaim. - * @member {string} [claimType] Token claim type. - * @member {string} [claimValue] Token claim value. + * @property {string} [claimType] Token claim type. + * @property {string} [claimValue] Token claim value. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyTokenRestriction.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyTokenRestriction.js index df42bbf034..b6caec096c 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyTokenRestriction.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyTokenRestriction.js @@ -21,17 +21,17 @@ const models = require('./index'); class ContentKeyPolicyTokenRestriction extends models['ContentKeyPolicyRestriction'] { /** * Create a ContentKeyPolicyTokenRestriction. - * @member {string} issuer The token issuer. - * @member {string} audience The audience for the token. - * @member {object} primaryVerificationKey The primary verification key. - * @member {string} [primaryVerificationKey.odatatype] Polymorphic + * @property {string} issuer The token issuer. + * @property {string} audience The audience for the token. + * @property {object} primaryVerificationKey The primary verification key. + * @property {string} [primaryVerificationKey.odatatype] Polymorphic * Discriminator - * @member {array} [alternateVerificationKeys] A list of alternative + * @property {array} [alternateVerificationKeys] A list of alternative * verification keys. - * @member {array} [requiredClaims] A list of required token claims. - * @member {string} restrictionTokenType The type of token. Possible values + * @property {array} [requiredClaims] A list of required token claims. + * @property {string} restrictionTokenType The type of token. Possible values * include: 'Unknown', 'Swt', 'Jwt' - * @member {string} [openIdConnectDiscoveryDocument] The OpenID connect + * @property {string} [openIdConnectDiscoveryDocument] The OpenID connect * discovery document. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyWidevineConfiguration.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyWidevineConfiguration.js index b6fba54d50..7b779d114a 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyWidevineConfiguration.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyWidevineConfiguration.js @@ -20,7 +20,7 @@ const models = require('./index'); class ContentKeyPolicyWidevineConfiguration extends models['ContentKeyPolicyConfiguration'] { /** * Create a ContentKeyPolicyWidevineConfiguration. - * @member {string} widevineTemplate The Widevine template. + * @property {string} widevineTemplate The Widevine template. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyX509CertificateTokenKey.js b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyX509CertificateTokenKey.js index 925123c1c7..2723f3e379 100644 --- a/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyX509CertificateTokenKey.js +++ b/lib/services/mediaServicesManagement/lib/models/contentKeyPolicyX509CertificateTokenKey.js @@ -20,7 +20,7 @@ const models = require('./index'); class ContentKeyPolicyX509CertificateTokenKey extends models['ContentKeyPolicyRestrictionTokenKey'] { /** * Create a ContentKeyPolicyX509CertificateTokenKey. - * @member {buffer} rawBody The raw data field of a certificate in PKCS 12 + * @property {buffer} rawBody The raw data field of a certificate in PKCS 12 * format (X509Certificate2 in .NET) */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/crossSiteAccessPolicies.js b/lib/services/mediaServicesManagement/lib/models/crossSiteAccessPolicies.js index 3d65f6c570..b6f479a2a1 100644 --- a/lib/services/mediaServicesManagement/lib/models/crossSiteAccessPolicies.js +++ b/lib/services/mediaServicesManagement/lib/models/crossSiteAccessPolicies.js @@ -17,9 +17,9 @@ class CrossSiteAccessPolicies { /** * Create a CrossSiteAccessPolicies. - * @member {string} [clientAccessPolicy] The content of + * @property {string} [clientAccessPolicy] The content of * clientaccesspolicy.xml used by Silverlight. - * @member {string} [crossDomainPolicy] The content of crossdomain.xml used + * @property {string} [crossDomainPolicy] The content of crossdomain.xml used * by Silverlight. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/defaultKey.js b/lib/services/mediaServicesManagement/lib/models/defaultKey.js index 49d0e8072f..23f1771865 100644 --- a/lib/services/mediaServicesManagement/lib/models/defaultKey.js +++ b/lib/services/mediaServicesManagement/lib/models/defaultKey.js @@ -18,9 +18,9 @@ class DefaultKey { /** * Create a DefaultKey. - * @member {string} [label] Label can be used to specify Content Key when + * @property {string} [label] Label can be used to specify Content Key when * creating a Streaming Locator - * @member {string} [policyName] Policy used by Default Key + * @property {string} [policyName] Policy used by Default Key */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/deinterlace.js b/lib/services/mediaServicesManagement/lib/models/deinterlace.js index 2aaf2112e3..bd1ee32ab0 100644 --- a/lib/services/mediaServicesManagement/lib/models/deinterlace.js +++ b/lib/services/mediaServicesManagement/lib/models/deinterlace.js @@ -17,9 +17,10 @@ class Deinterlace { /** * Create a Deinterlace. - * @member {string} [parity] The field parity for de-interlacing, defaults to - * Auto. Possible values include: 'Auto', 'TopFieldFirst', 'BottomFieldFirst' - * @member {string} [mode] The deinterlacing mode. Defaults to + * @property {string} [parity] The field parity for de-interlacing, defaults + * to Auto. Possible values include: 'Auto', 'TopFieldFirst', + * 'BottomFieldFirst' + * @property {string} [mode] The deinterlacing mode. Defaults to * AutoPixelAdaptive. Possible values include: 'Off', 'AutoPixelAdaptive' */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/enabledProtocols.js b/lib/services/mediaServicesManagement/lib/models/enabledProtocols.js index 0b90fdd76d..c944662907 100644 --- a/lib/services/mediaServicesManagement/lib/models/enabledProtocols.js +++ b/lib/services/mediaServicesManagement/lib/models/enabledProtocols.js @@ -17,10 +17,10 @@ class EnabledProtocols { /** * Create a EnabledProtocols. - * @member {boolean} download Enable Download protocol or not - * @member {boolean} dash Enable DASH protocol or not - * @member {boolean} hls Enable HLS protocol or not - * @member {boolean} smoothStreaming Enable SmoothStreaming protocol or not + * @property {boolean} download Enable Download protocol or not + * @property {boolean} dash Enable DASH protocol or not + * @property {boolean} hls Enable HLS protocol or not + * @property {boolean} smoothStreaming Enable SmoothStreaming protocol or not */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/entityNameAvailabilityCheckOutput.js b/lib/services/mediaServicesManagement/lib/models/entityNameAvailabilityCheckOutput.js index d8c8e769fa..e2b97e6fb4 100644 --- a/lib/services/mediaServicesManagement/lib/models/entityNameAvailabilityCheckOutput.js +++ b/lib/services/mediaServicesManagement/lib/models/entityNameAvailabilityCheckOutput.js @@ -17,10 +17,10 @@ class EntityNameAvailabilityCheckOutput { /** * Create a EntityNameAvailabilityCheckOutput. - * @member {boolean} nameAvailable Specifies if the name is available. - * @member {string} [reason] Specifies the reason if the name is not + * @property {boolean} nameAvailable Specifies if the name is available. + * @property {string} [reason] Specifies the reason if the name is not * available. - * @member {string} [message] Specifies the detailed reason if the name is + * @property {string} [message] Specifies the detailed reason if the name is * not available. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/envelopeEncryption.js b/lib/services/mediaServicesManagement/lib/models/envelopeEncryption.js index 2e32c524b2..92c3d6dfcf 100644 --- a/lib/services/mediaServicesManagement/lib/models/envelopeEncryption.js +++ b/lib/services/mediaServicesManagement/lib/models/envelopeEncryption.js @@ -17,26 +17,26 @@ class EnvelopeEncryption { /** * Create a EnvelopeEncryption. - * @member {object} [enabledProtocols] Representing supported protocols - * @member {boolean} [enabledProtocols.download] Enable Download protocol or - * not - * @member {boolean} [enabledProtocols.dash] Enable DASH protocol or not - * @member {boolean} [enabledProtocols.hls] Enable HLS protocol or not - * @member {boolean} [enabledProtocols.smoothStreaming] Enable + * @property {object} [enabledProtocols] Representing supported protocols + * @property {boolean} [enabledProtocols.download] Enable Download protocol + * or not + * @property {boolean} [enabledProtocols.dash] Enable DASH protocol or not + * @property {boolean} [enabledProtocols.hls] Enable HLS protocol or not + * @property {boolean} [enabledProtocols.smoothStreaming] Enable * SmoothStreaming protocol or not - * @member {array} [clearTracks] Representing which tracks should not be + * @property {array} [clearTracks] Representing which tracks should not be * encrypted - * @member {object} [contentKeys] Representing default content key for each + * @property {object} [contentKeys] Representing default content key for each * encryption scheme and separate content keys for specific tracks - * @member {object} [contentKeys.defaultKey] Default content key for an + * @property {object} [contentKeys.defaultKey] Default content key for an * encryption scheme - * @member {string} [contentKeys.defaultKey.label] Label can be used to + * @property {string} [contentKeys.defaultKey.label] Label can be used to * specify Content Key when creating a Streaming Locator - * @member {string} [contentKeys.defaultKey.policyName] Policy used by + * @property {string} [contentKeys.defaultKey.policyName] Policy used by * Default Key - * @member {array} [contentKeys.keyToTrackMappings] Representing tracks needs - * separate content key - * @member {string} [customKeyAcquisitionUrlTemplate] + * @property {array} [contentKeys.keyToTrackMappings] Representing tracks + * needs separate content key + * @property {string} [customKeyAcquisitionUrlTemplate] * KeyAcquistionUrlTemplate is used to point to user specified service to * delivery content keys */ diff --git a/lib/services/mediaServicesManagement/lib/models/filterTrackPropertyCondition.js b/lib/services/mediaServicesManagement/lib/models/filterTrackPropertyCondition.js index a4292b858f..96a15c7c7f 100644 --- a/lib/services/mediaServicesManagement/lib/models/filterTrackPropertyCondition.js +++ b/lib/services/mediaServicesManagement/lib/models/filterTrackPropertyCondition.js @@ -17,10 +17,10 @@ class FilterTrackPropertyCondition { /** * Create a FilterTrackPropertyCondition. - * @member {string} property The track property type. Possible values + * @property {string} property The track property type. Possible values * include: 'Unknown', 'Type', 'Name', 'Language', 'FourCC', 'Bitrate' - * @member {string} value The track proprty value. - * @member {string} operation The track property condition operation. + * @property {string} value The track proprty value. + * @property {string} operation The track property condition operation. * Possible values include: 'Equal', 'NotEqual' */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/filterTrackSelection.js b/lib/services/mediaServicesManagement/lib/models/filterTrackSelection.js index dbf25b4c31..f26e2aa481 100644 --- a/lib/services/mediaServicesManagement/lib/models/filterTrackSelection.js +++ b/lib/services/mediaServicesManagement/lib/models/filterTrackSelection.js @@ -18,7 +18,7 @@ class FilterTrackSelection { /** * Create a FilterTrackSelection. - * @member {array} trackSelections The track selections. + * @property {array} trackSelections The track selections. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/filters.js b/lib/services/mediaServicesManagement/lib/models/filters.js index 3851a50e6b..67fef67b37 100644 --- a/lib/services/mediaServicesManagement/lib/models/filters.js +++ b/lib/services/mediaServicesManagement/lib/models/filters.js @@ -18,31 +18,31 @@ class Filters { /** * Create a Filters. - * @member {object} [deinterlace] The de-interlacing settings. - * @member {string} [deinterlace.parity] The field parity for de-interlacing, - * defaults to Auto. Possible values include: 'Auto', 'TopFieldFirst', - * 'BottomFieldFirst' - * @member {string} [deinterlace.mode] The deinterlacing mode. Defaults to + * @property {object} [deinterlace] The de-interlacing settings. + * @property {string} [deinterlace.parity] The field parity for + * de-interlacing, defaults to Auto. Possible values include: 'Auto', + * 'TopFieldFirst', 'BottomFieldFirst' + * @property {string} [deinterlace.mode] The deinterlacing mode. Defaults to * AutoPixelAdaptive. Possible values include: 'Off', 'AutoPixelAdaptive' - * @member {string} [rotation] The rotation, if any, to be applied to the + * @property {string} [rotation] The rotation, if any, to be applied to the * input video, before it is encoded. Default is Auto. Possible values * include: 'Auto', 'None', 'Rotate0', 'Rotate90', 'Rotate180', 'Rotate270' - * @member {object} [crop] The parameters for the rectangular window with + * @property {object} [crop] The parameters for the rectangular window with * which to crop the input video. - * @member {string} [crop.left] The number of pixels from the left-margin. + * @property {string} [crop.left] The number of pixels from the left-margin. * This can be absolute pixel value (e.g 100), or relative to the size of the * video (For example, 50%). - * @member {string} [crop.top] The number of pixels from the top-margin. This - * can be absolute pixel value (e.g 100), or relative to the size of the + * @property {string} [crop.top] The number of pixels from the top-margin. + * This can be absolute pixel value (e.g 100), or relative to the size of the * video (For example, 50%). - * @member {string} [crop.width] The width of the rectangular region in + * @property {string} [crop.width] The width of the rectangular region in * pixels. This can be absolute pixel value (e.g 100), or relative to the * size of the video (For example, 50%). - * @member {string} [crop.height] The height of the rectangular region in + * @property {string} [crop.height] The height of the rectangular region in * pixels. This can be absolute pixel value (e.g 100), or relative to the * size of the video (For example, 50%). - * @member {array} [overlays] The properties of overlays to be applied to the - * input video. These could be audio, image or video overlays. + * @property {array} [overlays] The properties of overlays to be applied to + * the input video. These could be audio, image or video overlays. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/firstQuality.js b/lib/services/mediaServicesManagement/lib/models/firstQuality.js index e70ed2d75d..6ac3345f74 100644 --- a/lib/services/mediaServicesManagement/lib/models/firstQuality.js +++ b/lib/services/mediaServicesManagement/lib/models/firstQuality.js @@ -17,7 +17,7 @@ class FirstQuality { /** * Create a FirstQuality. - * @member {number} bitrate The first quality bitrate. + * @property {number} bitrate The first quality bitrate. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/format.js b/lib/services/mediaServicesManagement/lib/models/format.js index 89eba64669..9b056cdd95 100644 --- a/lib/services/mediaServicesManagement/lib/models/format.js +++ b/lib/services/mediaServicesManagement/lib/models/format.js @@ -17,7 +17,7 @@ class Format { /** * Create a Format. - * @member {string} [filenamePattern] The pattern of the file names for the + * @property {string} [filenamePattern] The pattern of the file names for the * generated output files. The following macros are supported in the file * name: {Basename} - The base name of the input video {Extension} - The * appropriate extension for this format. {Label} - The label assigned to the @@ -25,7 +25,7 @@ class Format { * thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to * thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted * macros will be collapsed and removed from the filename. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/h264Layer.js b/lib/services/mediaServicesManagement/lib/models/h264Layer.js index 55e52f30b2..db8e63114e 100644 --- a/lib/services/mediaServicesManagement/lib/models/h264Layer.js +++ b/lib/services/mediaServicesManagement/lib/models/h264Layer.js @@ -21,22 +21,22 @@ const models = require('./index'); class H264Layer extends models['VideoLayer'] { /** * Create a H264Layer. - * @member {string} [profile] Which profile of the H.264 standard should be + * @property {string} [profile] Which profile of the H.264 standard should be * used when encoding this layer. Default is Auto. Possible values include: * 'Auto', 'Baseline', 'Main', 'High', 'High422', 'High444' - * @member {string} [level] Which level of the H.264 standard should be used - * when encoding this layer. The value can be Auto, or a number that matches - * the H.264 profile. If not specified, the default is Auto, which lets the - * encoder choose the Level that is appropriate for this layer. - * @member {moment.duration} [bufferWindow] The VBV buffer window length. The - * value should be in ISO 8601 format. The value should be in the range + * @property {string} [level] Which level of the H.264 standard should be + * used when encoding this layer. The value can be Auto, or a number that + * matches the H.264 profile. If not specified, the default is Auto, which + * lets the encoder choose the Level that is appropriate for this layer. + * @property {moment.duration} [bufferWindow] The VBV buffer window length. + * The value should be in ISO 8601 format. The value should be in the range * [0.1-100] seconds. The default is 5 seconds (for example, PT5S). - * @member {number} [referenceFrames] The number of reference frames to be + * @property {number} [referenceFrames] The number of reference frames to be * used when encoding this layer. If not specified, the encoder determines an * appropriate number based on the encoder complexity setting. - * @member {string} [entropyMode] The entropy mode to be used for this layer. - * If not specified, the encoder chooses the mode that is appropriate for the - * profile and level. Possible values include: 'Cabac', 'Cavlc' + * @property {string} [entropyMode] The entropy mode to be used for this + * layer. If not specified, the encoder chooses the mode that is appropriate + * for the profile and level. Possible values include: 'Cabac', 'Cavlc' */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/h264Video.js b/lib/services/mediaServicesManagement/lib/models/h264Video.js index 0dd96c8e97..de80b8ca64 100644 --- a/lib/services/mediaServicesManagement/lib/models/h264Video.js +++ b/lib/services/mediaServicesManagement/lib/models/h264Video.js @@ -20,14 +20,14 @@ const models = require('./index'); class H264Video extends models['Video'] { /** * Create a H264Video. - * @member {boolean} [sceneChangeDetection] Whether or not the encoder should - * insert key frames at scene changes. If not specified, the default is - * false. This flag should be set to true only when the encoder is being + * @property {boolean} [sceneChangeDetection] Whether or not the encoder + * should insert key frames at scene changes. If not specified, the default + * is false. This flag should be set to true only when the encoder is being * configured to produce a single output video. - * @member {string} [complexity] Tells the encoder how to choose its encoding - * settings. The default value is Balanced. Possible values include: 'Speed', - * 'Balanced', 'Quality' - * @member {array} [layers] The collection of output H.264 layers to be + * @property {string} [complexity] Tells the encoder how to choose its + * encoding settings. The default value is Balanced. Possible values include: + * 'Speed', 'Balanced', 'Quality' + * @property {array} [layers] The collection of output H.264 layers to be * produced by the encoder. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/hls.js b/lib/services/mediaServicesManagement/lib/models/hls.js index 8db190b274..9866f7fac7 100644 --- a/lib/services/mediaServicesManagement/lib/models/hls.js +++ b/lib/services/mediaServicesManagement/lib/models/hls.js @@ -17,8 +17,8 @@ class Hls { /** * Create a Hls. - * @member {number} [fragmentsPerTsSegment] The amount of fragments per HTTP - * Live Streaming (HLS) segment. + * @property {number} [fragmentsPerTsSegment] The amount of fragments per + * HTTP Live Streaming (HLS) segment. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/iPAccessControl.js b/lib/services/mediaServicesManagement/lib/models/iPAccessControl.js index f727f4ab2d..60a8ea534e 100644 --- a/lib/services/mediaServicesManagement/lib/models/iPAccessControl.js +++ b/lib/services/mediaServicesManagement/lib/models/iPAccessControl.js @@ -17,7 +17,7 @@ class IPAccessControl { /** * Create a IPAccessControl. - * @member {array} [allow] The IP allow list. + * @property {array} [allow] The IP allow list. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/iPRange.js b/lib/services/mediaServicesManagement/lib/models/iPRange.js index 1d04c7242a..ab94f0d7cb 100644 --- a/lib/services/mediaServicesManagement/lib/models/iPRange.js +++ b/lib/services/mediaServicesManagement/lib/models/iPRange.js @@ -17,9 +17,9 @@ class IPRange { /** * Create a IPRange. - * @member {string} [name] The friendly name for the IP address range. - * @member {string} [address] The IP address. - * @member {number} [subnetPrefixLength] The subnet mask prefix length (see + * @property {string} [name] The friendly name for the IP address range. + * @property {string} [address] The IP address. + * @property {number} [subnetPrefixLength] The subnet mask prefix length (see * CIDR notation). */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/image.js b/lib/services/mediaServicesManagement/lib/models/image.js index c1bd9dbbb1..6ba5b8f87f 100644 --- a/lib/services/mediaServicesManagement/lib/models/image.js +++ b/lib/services/mediaServicesManagement/lib/models/image.js @@ -21,20 +21,20 @@ const models = require('./index'); class Image extends models['Video'] { /** * Create a Image. - * @member {string} [start] The position in the input video from where to + * @property {string} [start] The position in the input video from where to * start generating thumbnails. The value can be in absolute timestamp (ISO * 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), * or a relative value (For example, 1%). Also supports a macro {Best}, which * tells the encoder to select the best thumbnail from the first few seconds * of the video. - * @member {string} [step] The intervals at which thumbnails are generated. + * @property {string} [step] The intervals at which thumbnails are generated. * The value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image * every 5 seconds), or a frame count (For example, 30 for every 30 frames), * or a relative value (For example, 1%). - * @member {string} [range] The position in the input video at which to stop - * generating thumbnails. The value can be in absolute timestamp (ISO 8601, - * e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For - * example, 300 to stop at the 300th frame), or a relative value (For + * @property {string} [range] The position in the input video at which to + * stop generating thumbnails. The value can be in absolute timestamp (ISO + * 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count + * (For example, 300 to stop at the 300th frame), or a relative value (For * example, 100%). */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/index.d.ts b/lib/services/mediaServicesManagement/lib/models/index.d.ts index eeb96c7098..eec1089316 100644 --- a/lib/services/mediaServicesManagement/lib/models/index.d.ts +++ b/lib/services/mediaServicesManagement/lib/models/index.d.ts @@ -1,3208 +1,2713 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the PresentationTimeRange class. - * @constructor - * The presentation time range, this is asset related and not recommended for - * Account Filter. - * - * @member {number} startTimestamp The absolute start time boundary. - * @member {number} endTimestamp The absolute end time boundary. - * @member {number} presentationWindowDuration The relative to end sliding - * window. - * @member {number} liveBackoffDuration The relative to end right edge. - * @member {number} timescale The time scale of time stamps. - * @member {boolean} forceEndTimestamp The indicator of forcing exsiting of end - * time stamp. + * The presentation time range, this is asset related and not recommended for Account Filter. */ export interface PresentationTimeRange { + /** + * The absolute start time boundary. + */ startTimestamp: number; + /** + * The absolute end time boundary. + */ endTimestamp: number; + /** + * The relative to end sliding window. + */ presentationWindowDuration: number; + /** + * The relative to end right edge. + */ liveBackoffDuration: number; + /** + * The time scale of time stamps. + */ timescale: number; + /** + * The indicator of forcing exsiting of end time stamp. + */ forceEndTimestamp: boolean; } /** - * @class - * Initializes a new instance of the FilterTrackPropertyCondition class. - * @constructor * The class to specify one track property condition. - * - * @member {string} property The track property type. Possible values include: - * 'Unknown', 'Type', 'Name', 'Language', 'FourCC', 'Bitrate' - * @member {string} value The track proprty value. - * @member {string} operation The track property condition operation. Possible - * values include: 'Equal', 'NotEqual' */ export interface FilterTrackPropertyCondition { + /** + * The track property type. Possible values include: 'Unknown', 'Type', 'Name', 'Language', + * 'FourCC', 'Bitrate' + */ property: string; + /** + * The track proprty value. + */ value: string; + /** + * The track property condition operation. Possible values include: 'Equal', 'NotEqual' + */ operation: string; } /** - * @class - * Initializes a new instance of the FirstQuality class. - * @constructor * Filter First Quality - * - * @member {number} bitrate The first quality bitrate. */ export interface FirstQuality { + /** + * The first quality bitrate. + */ bitrate: number; } /** - * @class - * Initializes a new instance of the FilterTrackSelection class. - * @constructor - * Representing a list of FilterTrackPropertyConditions to select a track. The - * filters are combined using a logical AND operation. - * - * @member {array} trackSelections The track selections. + * Representing a list of FilterTrackPropertyConditions to select a track. The filters are + * combined using a logical AND operation. */ export interface FilterTrackSelection { + /** + * The track selections. + */ trackSelections: FilterTrackPropertyCondition[]; } /** - * @class - * Initializes a new instance of the Resource class. - * @constructor * The core properties of ARM resources. - * - * @member {string} [id] Fully qualified resource ID for the resource. - * @member {string} [name] The name of the resource. - * @member {string} [type] The type of the resource. */ export interface Resource extends BaseResource { + /** + * Fully qualified resource ID for the resource. + */ readonly id?: string; + /** + * The name of the resource. + */ readonly name?: string; + /** + * The type of the resource. + */ readonly type?: string; } /** - * @class - * Initializes a new instance of the ProxyResource class. - * @constructor * The resource model definition for a ARM proxy resource. - * */ export interface ProxyResource extends Resource { } /** - * @class - * Initializes a new instance of the AccountFilter class. - * @constructor * An Account Filter. - * - * @member {object} [presentationTimeRange] The presentation time range. - * @member {number} [presentationTimeRange.startTimestamp] The absolute start - * time boundary. - * @member {number} [presentationTimeRange.endTimestamp] The absolute end time - * boundary. - * @member {number} [presentationTimeRange.presentationWindowDuration] The - * relative to end sliding window. - * @member {number} [presentationTimeRange.liveBackoffDuration] The relative to - * end right edge. - * @member {number} [presentationTimeRange.timescale] The time scale of time - * stamps. - * @member {boolean} [presentationTimeRange.forceEndTimestamp] The indicator of - * forcing exsiting of end time stamp. - * @member {object} [firstQuality] The first quality. - * @member {number} [firstQuality.bitrate] The first quality bitrate. - * @member {array} [tracks] The tracks selection conditions. */ export interface AccountFilter extends ProxyResource { + /** + * The presentation time range. + */ presentationTimeRange?: PresentationTimeRange; + /** + * The first quality. + */ firstQuality?: FirstQuality; + /** + * The tracks selection conditions. + */ tracks?: FilterTrackSelection[]; } /** - * @class - * Initializes a new instance of the ODataError class. - * @constructor * Information about an error. - * - * @member {string} [code] A language-independent error name. - * @member {string} [message] The error message. - * @member {string} [target] The target of the error (for example, the name of - * the property in error). - * @member {array} [details] The error details. */ export interface ODataError { + /** + * A language-independent error name. + */ code?: string; + /** + * The error message. + */ message?: string; + /** + * The target of the error (for example, the name of the property in error). + */ target?: string; + /** + * The error details. + */ details?: ODataError[]; } /** - * @class - * Initializes a new instance of the ApiError class. - * @constructor * The API error. - * - * @member {object} [error] ApiError. The error properties. - * @member {string} [error.code] A language-independent error name. - * @member {string} [error.message] The error message. - * @member {string} [error.target] The target of the error (for example, the - * name of the property in error). - * @member {array} [error.details] The error details. */ export interface ApiError { + /** + * @summary ApiError + * @description The error properties. + */ error?: ODataError; } /** - * @class - * Initializes a new instance of the TrackedResource class. - * @constructor * The resource model definition for a ARM tracked resource. - * - * @member {object} [tags] Resource tags. - * @member {string} [location] The Azure Region of the resource. */ export interface TrackedResource extends Resource { + /** + * Resource tags. + */ tags?: { [propertyName: string]: string }; + /** + * The Azure Region of the resource. + */ location?: string; } /** - * @class - * Initializes a new instance of the Provider class. - * @constructor * A resource provider. - * - * @member {string} providerName The provider name. */ export interface Provider { + /** + * The provider name. + */ providerName: string; } /** - * @class - * Initializes a new instance of the OperationDisplay class. - * @constructor * Operation details. - * - * @member {string} [provider] The service provider. - * @member {string} [resource] Resource on which the operation is performed. - * @member {string} [operation] The operation type. - * @member {string} [description] The operation description. */ export interface OperationDisplay { + /** + * The service provider. + */ provider?: string; + /** + * Resource on which the operation is performed. + */ resource?: string; + /** + * The operation type. + */ operation?: string; + /** + * The operation description. + */ description?: string; } /** - * @class - * Initializes a new instance of the MetricDimension class. - * @constructor * A metric dimension. - * - * @member {string} [name] The metric dimension name. - * @member {string} [displayName] The display name for the dimension. - * @member {boolean} [toBeExportedForShoebox] Whether to export metric to - * shoebox. */ export interface MetricDimension { + /** + * The metric dimension name. + */ readonly name?: string; + /** + * The display name for the dimension. + */ readonly displayName?: string; + /** + * Whether to export metric to shoebox. + */ readonly toBeExportedForShoebox?: boolean; } /** - * @class - * Initializes a new instance of the Metric class. - * @constructor * A metric emitted by service. - * - * @member {string} [name] The metric name. - * @member {string} [displayName] The metric display name. - * @member {string} [displayDescription] The metric display description. - * @member {string} [unit] The metric unit. Possible values include: 'Bytes', - * 'Count', 'Milliseconds' - * @member {string} [aggregationType] The metric aggregation type. Possible - * values include: 'Average', 'Count', 'Total' - * @member {array} [dimensions] The metric dimensions. */ export interface Metric { + /** + * The metric name. + */ readonly name?: string; + /** + * The metric display name. + */ readonly displayName?: string; + /** + * The metric display description. + */ readonly displayDescription?: string; + /** + * The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds' + */ readonly unit?: string; + /** + * The metric aggregation type. Possible values include: 'Average', 'Count', 'Total' + */ readonly aggregationType?: string; + /** + * The metric dimensions. + */ readonly dimensions?: MetricDimension[]; } /** - * @class - * Initializes a new instance of the ServiceSpecification class. - * @constructor * The service metric specifications. - * - * @member {array} [metricSpecifications] List of metric specifications. */ export interface ServiceSpecification { + /** + * List of metric specifications. + */ readonly metricSpecifications?: Metric[]; } /** - * @class - * Initializes a new instance of the MetricProperties class. - * @constructor * Metric properties. - * - * @member {object} [serviceSpecification] The service specifications. - * @member {array} [serviceSpecification.metricSpecifications] List of metric - * specifications. */ export interface MetricProperties { + /** + * The service specifications. + */ readonly serviceSpecification?: ServiceSpecification; } /** - * @class - * Initializes a new instance of the Operation class. - * @constructor * An operation. - * - * @member {string} name The operation name. - * @member {object} [display] The operation display name. - * @member {string} [display.provider] The service provider. - * @member {string} [display.resource] Resource on which the operation is - * performed. - * @member {string} [display.operation] The operation type. - * @member {string} [display.description] The operation description. - * @member {string} [origin] Origin of the operation. - * @member {object} [properties] Operation properties format. - * @member {object} [properties.serviceSpecification] The service - * specifications. - * @member {array} [properties.serviceSpecification.metricSpecifications] List - * of metric specifications. */ export interface Operation { + /** + * The operation name. + */ name: string; + /** + * The operation display name. + */ display?: OperationDisplay; + /** + * Origin of the operation. + */ origin?: string; + /** + * Operation properties format. + */ properties?: MetricProperties; } -/** - * @class - * Initializes a new instance of the Location class. - * @constructor - * @member {string} name - */ export interface Location { name: string; } /** - * @class - * Initializes a new instance of the EntityNameAvailabilityCheckOutput class. - * @constructor * The response from the check name availability request. - * - * @member {boolean} nameAvailable Specifies if the name is available. - * @member {string} [reason] Specifies the reason if the name is not available. - * @member {string} [message] Specifies the detailed reason if the name is not - * available. - */ +*/ export interface EntityNameAvailabilityCheckOutput { + /** + * Specifies if the name is available. + */ nameAvailable: boolean; + /** + * Specifies the reason if the name is not available. + */ reason?: string; + /** + * Specifies the detailed reason if the name is not available. + */ message?: string; } /** - * @class - * Initializes a new instance of the StorageAccount class. - * @constructor * The storage account details. - * - * @member {string} [id] The ID of the storage account resource. Media Services - * relies on tables and queues as well as blobs, so the primary storage account - * must be a Standard Storage account (either Microsoft.ClassicStorage or - * Microsoft.Storage). Blob only storage accounts can be added as secondary - * storage accounts. - * @member {string} type The type of the storage account. Possible values - * include: 'Primary', 'Secondary' - */ +*/ export interface StorageAccount { + /** + * The ID of the storage account resource. Media Services relies on tables and queues as well as + * blobs, so the primary storage account must be a Standard Storage account (either + * Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as + * secondary storage accounts. + */ id?: string; + /** + * The type of the storage account. Possible values include: 'Primary', 'Secondary' + */ type: string; } /** - * @class - * Initializes a new instance of the SyncStorageKeysInput class. - * @constructor * The input to the sync storage keys request. - * - * @member {string} [id] The ID of the storage account resource. - */ +*/ export interface SyncStorageKeysInput { + /** + * The ID of the storage account resource. + */ id?: string; } /** - * @class - * Initializes a new instance of the MediaService class. - * @constructor * A Media Services account. - * - * @member {uuid} [mediaServiceId] The Media Services account ID. - * @member {array} [storageAccounts] The storage accounts for this resource. - */ +*/ export interface MediaService extends TrackedResource { + /** + * The Media Services account ID. + */ readonly mediaServiceId?: string; + /** + * The storage accounts for this resource. + */ storageAccounts?: StorageAccount[]; } /** - * @class - * Initializes a new instance of the SubscriptionMediaService class. - * @constructor * A Media Services account. - * - * @member {uuid} [mediaServiceId] The Media Services account ID. - * @member {array} [storageAccounts] The storage accounts for this resource. - */ +*/ export interface SubscriptionMediaService extends TrackedResource { + /** + * The Media Services account ID. + */ readonly mediaServiceId?: string; + /** + * The storage accounts for this resource. + */ storageAccounts?: StorageAccount[]; } /** - * @class - * Initializes a new instance of the CheckNameAvailabilityInput class. - * @constructor * The input to the check name availability request. - * - * @member {string} [name] The account name. - * @member {string} [type] The account type. For a Media Services account, this - * should be 'MediaServices'. - */ +*/ export interface CheckNameAvailabilityInput { + /** + * The account name. + */ name?: string; + /** + * The account type. For a Media Services account, this should be 'MediaServices'. + */ type?: string; } /** - * @class - * Initializes a new instance of the AssetContainerSas class. - * @constructor * The Asset Storage container SAS URLs. - * - * @member {array} [assetContainerSasUrls] The list of Asset container SAS - * URLs. - */ +*/ export interface AssetContainerSas { + /** + * The list of Asset container SAS URLs. + */ assetContainerSasUrls?: string[]; } /** - * @class - * Initializes a new instance of the AssetFileEncryptionMetadata class. - * @constructor * The Asset File Storage encryption metadata. - * - * @member {string} [initializationVector] The Asset File initialization - * vector. - * @member {string} [assetFileName] The Asset File name. - * @member {uuid} assetFileId The Asset File Id. - */ +*/ export interface AssetFileEncryptionMetadata { + /** + * The Asset File initialization vector. + */ initializationVector?: string; + /** + * The Asset File name. + */ assetFileName?: string; + /** + * The Asset File Id. + */ assetFileId: string; } /** - * @class - * Initializes a new instance of the StorageEncryptedAssetDecryptionData class. - * @constructor * Data needed to decrypt asset files encrypted with legacy storage encryption. - * - * @member {buffer} [key] The Asset File storage encryption key. - * @member {array} [assetFileEncryptionMetadata] Asset File encryption - * metadata. - */ +*/ export interface StorageEncryptedAssetDecryptionData { + /** + * The Asset File storage encryption key. + */ key?: Buffer; + /** + * Asset File encryption metadata. + */ assetFileEncryptionMetadata?: AssetFileEncryptionMetadata[]; } /** - * @class - * Initializes a new instance of the AssetStreamingLocator class. - * @constructor * Properties of the Streaming Locator. - * - * @member {string} [name] Streaming Locator name. - * @member {string} [assetName] Asset Name. - * @member {date} [created] The creation time of the Streaming Locator. - * @member {date} [startTime] The start time of the Streaming Locator. - * @member {date} [endTime] The end time of the Streaming Locator. - * @member {uuid} [streamingLocatorId] StreamingLocatorId of the Streaming - * Locator. - * @member {string} [streamingPolicyName] Name of the Streaming Policy used by - * this Streaming Locator. - * @member {string} [defaultContentKeyPolicyName] Name of the default - * ContentKeyPolicy used by this Streaming Locator. - */ +*/ export interface AssetStreamingLocator { + /** + * Streaming Locator name. + */ readonly name?: string; + /** + * Asset Name. + */ readonly assetName?: string; + /** + * The creation time of the Streaming Locator. + */ readonly created?: Date; + /** + * The start time of the Streaming Locator. + */ readonly startTime?: Date; + /** + * The end time of the Streaming Locator. + */ readonly endTime?: Date; + /** + * StreamingLocatorId of the Streaming Locator. + */ readonly streamingLocatorId?: string; + /** + * Name of the Streaming Policy used by this Streaming Locator. + */ readonly streamingPolicyName?: string; + /** + * Name of the default ContentKeyPolicy used by this Streaming Locator. + */ readonly defaultContentKeyPolicyName?: string; } /** - * @class - * Initializes a new instance of the ListStreamingLocatorsResponse class. - * @constructor * The Streaming Locators associated with this Asset. - * - * @member {array} [streamingLocators] The list of Streaming Locators. - */ +*/ export interface ListStreamingLocatorsResponse { + /** + * The list of Streaming Locators. + */ readonly streamingLocators?: AssetStreamingLocator[]; } /** - * @class - * Initializes a new instance of the Asset class. - * @constructor * An Asset. - * - * @member {uuid} [assetId] The Asset ID. - * @member {date} [created] The creation date of the Asset. - * @member {date} [lastModified] The last modified date of the Asset. - * @member {string} [alternateId] The alternate ID of the Asset. - * @member {string} [description] The Asset description. - * @member {string} [container] The name of the asset blob container. - * @member {string} [storageAccountName] The name of the storage account. - * @member {string} [storageEncryptionFormat] The Asset encryption format. One - * of None or MediaStorageEncryption. Possible values include: 'None', - * 'MediaStorageClientEncryption' - */ +*/ export interface Asset extends ProxyResource { + /** + * The Asset ID. + */ readonly assetId?: string; + /** + * The creation date of the Asset. + */ readonly created?: Date; + /** + * The last modified date of the Asset. + */ readonly lastModified?: Date; + /** + * The alternate ID of the Asset. + */ alternateId?: string; + /** + * The Asset description. + */ description?: string; + /** + * The name of the asset blob container. + */ container?: string; + /** + * The name of the storage account. + */ storageAccountName?: string; + /** + * The Asset encryption format. One of None or MediaStorageEncryption. Possible values include: + * 'None', 'MediaStorageClientEncryption' + */ readonly storageEncryptionFormat?: string; } /** - * @class - * Initializes a new instance of the AssetFilter class. - * @constructor * An Asset Filter. - * - * @member {object} [presentationTimeRange] The presentation time range. - * @member {number} [presentationTimeRange.startTimestamp] The absolute start - * time boundary. - * @member {number} [presentationTimeRange.endTimestamp] The absolute end time - * boundary. - * @member {number} [presentationTimeRange.presentationWindowDuration] The - * relative to end sliding window. - * @member {number} [presentationTimeRange.liveBackoffDuration] The relative to - * end right edge. - * @member {number} [presentationTimeRange.timescale] The time scale of time - * stamps. - * @member {boolean} [presentationTimeRange.forceEndTimestamp] The indicator of - * forcing exsiting of end time stamp. - * @member {object} [firstQuality] The first quality. - * @member {number} [firstQuality.bitrate] The first quality bitrate. - * @member {array} [tracks] The tracks selection conditions. - */ +*/ export interface AssetFilter extends ProxyResource { + /** + * The presentation time range. + */ presentationTimeRange?: PresentationTimeRange; + /** + * The first quality. + */ firstQuality?: FirstQuality; + /** + * The tracks selection conditions. + */ tracks?: FilterTrackSelection[]; } /** - * @class - * Initializes a new instance of the ListContainerSasInput class. - * @constructor * The parameters to the list SAS request. - * - * @member {string} [permissions] The permissions to set on the SAS URL. - * Possible values include: 'Read', 'ReadWrite', 'ReadWriteDelete' - * @member {date} [expiryTime] The SAS URL expiration time. This must be less - * than 24 hours from the current time. - */ +*/ export interface ListContainerSasInput { + /** + * The permissions to set on the SAS URL. Possible values include: 'Read', 'ReadWrite', + * 'ReadWriteDelete' + */ permissions?: string; + /** + * The SAS URL expiration time. This must be less than 24 hours from the current time. + */ expiryTime?: Date; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction class. - * @constructor - * Configures the Explicit Analog Television Output Restriction control bits. - * For further details see the PlayReady Compliance Rules. - * - * @member {boolean} bestEffort Indicates whether this restriction is enforced - * on a Best Effort basis. - * @member {number} configurationData Configures the restriction control bits. - * Must be between 0 and 3 inclusive. - */ + * Configures the Explicit Analog Television Output Restriction control bits. For further details + * see the PlayReady Compliance Rules. +*/ export interface ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction { + /** + * Indicates whether this restriction is enforced on a Best Effort basis. + */ bestEffort: boolean; + /** + * Configures the restriction control bits. Must be between 0 and 3 inclusive. + */ configurationData: number; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyPlayReadyContentKeyLocation class. - * @constructor - * Base class for content key ID location. A derived class must be used to - * represent the location. - * - * @member {string} odatatype Polymorphic Discriminator - */ + * Base class for content key ID location. A derived class must be used to represent the location. +*/ export interface ContentKeyPolicyPlayReadyContentKeyLocation { + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader class. - * @constructor * Specifies that the content key ID is in the PlayReady header. - * - */ -export interface ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader extends ContentKeyPolicyPlayReadyContentKeyLocation { +*/ +export interface ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader extends +ContentKeyPolicyPlayReadyContentKeyLocation { } /** - * @class - * Initializes a new instance of the ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier class. - * @constructor - * Specifies that the content key ID is specified in the PlayReady - * configuration. - * - * @member {uuid} keyId The content key ID. - */ -export interface ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier extends ContentKeyPolicyPlayReadyContentKeyLocation { + * Specifies that the content key ID is specified in the PlayReady configuration. +*/ +export interface ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier extends +ContentKeyPolicyPlayReadyContentKeyLocation { + /** + * The content key ID. + */ keyId: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyPlayReadyPlayRight class. - * @constructor * Configures the Play Right in the PlayReady license. - * - * @member {moment.duration} [firstPlayExpiration] The amount of time that the - * license is valid after the license is first used to play content. - * @member {number} [scmsRestriction] Configures the Serial Copy Management - * System (SCMS) in the license. Must be between 0 and 3 inclusive. - * @member {number} [agcAndColorStripeRestriction] Configures Automatic Gain - * Control (AGC) and Color Stripe in the license. Must be between 0 and 3 - * inclusive. - * @member {object} [explicitAnalogTelevisionOutputRestriction] Configures the - * Explicit Analog Television Output Restriction in the license. Configuration - * data must be between 0 and 3 inclusive. - * @member {boolean} [explicitAnalogTelevisionOutputRestriction.bestEffort] - * Indicates whether this restriction is enforced on a Best Effort basis. - * @member {number} - * [explicitAnalogTelevisionOutputRestriction.configurationData] Configures the - * restriction control bits. Must be between 0 and 3 inclusive. - * @member {boolean} digitalVideoOnlyContentRestriction Enables the Image - * Constraint For Analog Component Video Restriction in the license. - * @member {boolean} imageConstraintForAnalogComponentVideoRestriction Enables - * the Image Constraint For Analog Component Video Restriction in the license. - * @member {boolean} imageConstraintForAnalogComputerMonitorRestriction Enables - * the Image Constraint For Analog Component Video Restriction in the license. - * @member {string} allowPassingVideoContentToUnknownOutput Configures Unknown - * output handling settings of the license. Possible values include: 'Unknown', - * 'NotAllowed', 'Allowed', 'AllowedWithVideoConstriction' - * @member {number} [uncompressedDigitalVideoOpl] Specifies the output - * protection level for uncompressed digital video. - * @member {number} [compressedDigitalVideoOpl] Specifies the output protection - * level for compressed digital video. - * @member {number} [analogVideoOpl] Specifies the output protection level for - * compressed digital audio. - * @member {number} [compressedDigitalAudioOpl] Specifies the output protection - * level for compressed digital audio. - * @member {number} [uncompressedDigitalAudioOpl] Specifies the output - * protection level for uncompressed digital audio. - */ +*/ export interface ContentKeyPolicyPlayReadyPlayRight { + /** + * The amount of time that the license is valid after the license is first used to play content. + */ firstPlayExpiration?: moment.Duration; + /** + * Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 + * inclusive. + */ scmsRestriction?: number; + /** + * Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and + * 3 inclusive. + */ agcAndColorStripeRestriction?: number; - explicitAnalogTelevisionOutputRestriction?: ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction; + /** + * Configures the Explicit Analog Television Output Restriction in the license. Configuration + * data must be between 0 and 3 inclusive. + */ + explicitAnalogTelevisionOutputRestriction?: + ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction; + /** + * Enables the Image Constraint For Analog Component Video Restriction in the license. + */ digitalVideoOnlyContentRestriction: boolean; + /** + * Enables the Image Constraint For Analog Component Video Restriction in the license. + */ imageConstraintForAnalogComponentVideoRestriction: boolean; + /** + * Enables the Image Constraint For Analog Component Video Restriction in the license. + */ imageConstraintForAnalogComputerMonitorRestriction: boolean; + /** + * Configures Unknown output handling settings of the license. Possible values include: + * 'Unknown', 'NotAllowed', 'Allowed', 'AllowedWithVideoConstriction' + */ allowPassingVideoContentToUnknownOutput: string; + /** + * Specifies the output protection level for uncompressed digital video. + */ uncompressedDigitalVideoOpl?: number; + /** + * Specifies the output protection level for compressed digital video. + */ compressedDigitalVideoOpl?: number; + /** + * Specifies the output protection level for compressed digital audio. + */ analogVideoOpl?: number; + /** + * Specifies the output protection level for compressed digital audio. + */ compressedDigitalAudioOpl?: number; + /** + * Specifies the output protection level for uncompressed digital audio. + */ uncompressedDigitalAudioOpl?: number; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyTokenClaim class. - * @constructor * Represents a token claim. - * - * @member {string} [claimType] Token claim type. - * @member {string} [claimValue] Token claim value. - */ +*/ export interface ContentKeyPolicyTokenClaim { + /** + * Token claim type. + */ claimType?: string; + /** + * Token claim value. + */ claimValue?: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyPlayReadyLicense class. - * @constructor * The PlayReady license - * - * @member {boolean} allowTestDevices A flag indicating whether test devices - * can use the license. - * @member {date} [beginDate] The begin date of license - * @member {date} [expirationDate] The expiration date of license. - * @member {moment.duration} [relativeBeginDate] The relative begin date of - * license. - * @member {moment.duration} [relativeExpirationDate] The relative expiration - * date of license. - * @member {moment.duration} [gracePeriod] The grace period of license. - * @member {object} [playRight] The license PlayRight - * @member {moment.duration} [playRight.firstPlayExpiration] The amount of time - * that the license is valid after the license is first used to play content. - * @member {number} [playRight.scmsRestriction] Configures the Serial Copy - * Management System (SCMS) in the license. Must be between 0 and 3 inclusive. - * @member {number} [playRight.agcAndColorStripeRestriction] Configures - * Automatic Gain Control (AGC) and Color Stripe in the license. Must be - * between 0 and 3 inclusive. - * @member {object} [playRight.explicitAnalogTelevisionOutputRestriction] - * Configures the Explicit Analog Television Output Restriction in the license. - * Configuration data must be between 0 and 3 inclusive. - * @member {boolean} - * [playRight.explicitAnalogTelevisionOutputRestriction.bestEffort] Indicates - * whether this restriction is enforced on a Best Effort basis. - * @member {number} - * [playRight.explicitAnalogTelevisionOutputRestriction.configurationData] - * Configures the restriction control bits. Must be between 0 and 3 inclusive. - * @member {boolean} [playRight.digitalVideoOnlyContentRestriction] Enables the - * Image Constraint For Analog Component Video Restriction in the license. - * @member {boolean} - * [playRight.imageConstraintForAnalogComponentVideoRestriction] Enables the - * Image Constraint For Analog Component Video Restriction in the license. - * @member {boolean} - * [playRight.imageConstraintForAnalogComputerMonitorRestriction] Enables the - * Image Constraint For Analog Component Video Restriction in the license. - * @member {string} [playRight.allowPassingVideoContentToUnknownOutput] - * Configures Unknown output handling settings of the license. Possible values - * include: 'Unknown', 'NotAllowed', 'Allowed', 'AllowedWithVideoConstriction' - * @member {number} [playRight.uncompressedDigitalVideoOpl] Specifies the - * output protection level for uncompressed digital video. - * @member {number} [playRight.compressedDigitalVideoOpl] Specifies the output - * protection level for compressed digital video. - * @member {number} [playRight.analogVideoOpl] Specifies the output protection - * level for compressed digital audio. - * @member {number} [playRight.compressedDigitalAudioOpl] Specifies the output - * protection level for compressed digital audio. - * @member {number} [playRight.uncompressedDigitalAudioOpl] Specifies the - * output protection level for uncompressed digital audio. - * @member {string} licenseType The license type. Possible values include: - * 'Unknown', 'NonPersistent', 'Persistent' - * @member {object} contentKeyLocation The content key location. - * @member {string} [contentKeyLocation.odatatype] Polymorphic Discriminator - * @member {string} contentType The PlayReady content type. Possible values - * include: 'Unknown', 'Unspecified', 'UltraVioletDownload', - * 'UltraVioletStreaming' - */ +*/ export interface ContentKeyPolicyPlayReadyLicense { + /** + * A flag indicating whether test devices can use the license. + */ allowTestDevices: boolean; + /** + * The begin date of license + */ beginDate?: Date; + /** + * The expiration date of license. + */ expirationDate?: Date; + /** + * The relative begin date of license. + */ relativeBeginDate?: moment.Duration; + /** + * The relative expiration date of license. + */ relativeExpirationDate?: moment.Duration; + /** + * The grace period of license. + */ gracePeriod?: moment.Duration; + /** + * The license PlayRight + */ playRight?: ContentKeyPolicyPlayReadyPlayRight; + /** + * The license type. Possible values include: 'Unknown', 'NonPersistent', 'Persistent' + */ licenseType: string; + /** + * The content key location. + */ contentKeyLocation: ContentKeyPolicyPlayReadyContentKeyLocation; + /** + * The PlayReady content type. Possible values include: 'Unknown', 'Unspecified', + * 'UltraVioletDownload', 'UltraVioletStreaming' + */ contentType: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyRestriction class. - * @constructor - * Base class for Content Key Policy restrictions. A derived class must be used - * to create a restriction. - * - * @member {string} odatatype Polymorphic Discriminator - */ + * Base class for Content Key Policy restrictions. A derived class must be used to create a + * restriction. +*/ export interface ContentKeyPolicyRestriction { + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyOpenRestriction class. - * @constructor - * Represents an open restriction. License or key will be delivered on every - * request. - * - */ + * Represents an open restriction. License or key will be delivered on every request. +*/ export interface ContentKeyPolicyOpenRestriction extends ContentKeyPolicyRestriction { } /** - * @class - * Initializes a new instance of the ContentKeyPolicyUnknownRestriction class. - * @constructor - * Represents a ContentKeyPolicyRestriction that is unavailable in the current - * API version. - * - */ + * Represents a ContentKeyPolicyRestriction that is unavailable in the current API version. +*/ export interface ContentKeyPolicyUnknownRestriction extends ContentKeyPolicyRestriction { } /** - * @class - * Initializes a new instance of the ContentKeyPolicyConfiguration class. - * @constructor - * Base class for Content Key Policy configuration. A derived class must be - * used to create a configuration. - * - * @member {string} odatatype Polymorphic Discriminator - */ + * Base class for Content Key Policy configuration. A derived class must be used to create a + * configuration. +*/ export interface ContentKeyPolicyConfiguration { + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyRestrictionTokenKey class. - * @constructor - * Base class for Content Key Policy key for token validation. A derived class - * must be used to create a token key. - * - * @member {string} odatatype Polymorphic Discriminator - */ + * Base class for Content Key Policy key for token validation. A derived class must be used to + * create a token key. +*/ export interface ContentKeyPolicyRestrictionTokenKey { + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicySymmetricTokenKey class. - * @constructor * Specifies a symmetric key for token validation. - * - * @member {buffer} keyValue The key value of the key - */ +*/ export interface ContentKeyPolicySymmetricTokenKey extends ContentKeyPolicyRestrictionTokenKey { + /** + * The key value of the key + */ keyValue: Buffer; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyRsaTokenKey class. - * @constructor * Specifies a RSA key for token validation - * - * @member {buffer} exponent The RSA Parameter exponent - * @member {buffer} modulus The RSA Parameter modulus - */ +*/ export interface ContentKeyPolicyRsaTokenKey extends ContentKeyPolicyRestrictionTokenKey { + /** + * The RSA Parameter exponent + */ exponent: Buffer; + /** + * The RSA Parameter modulus + */ modulus: Buffer; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyX509CertificateTokenKey class. - * @constructor * Specifies a certificate for token validation. - * - * @member {buffer} rawBody The raw data field of a certificate in PKCS 12 - * format (X509Certificate2 in .NET) - */ -export interface ContentKeyPolicyX509CertificateTokenKey extends ContentKeyPolicyRestrictionTokenKey { +*/ +export interface ContentKeyPolicyX509CertificateTokenKey extends +ContentKeyPolicyRestrictionTokenKey { + /** + * The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET) + */ rawBody: Buffer; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyTokenRestriction class. - * @constructor - * Represents a token restriction. Provided token must match these requirements - * for successful license or key delivery. - * - * @member {string} issuer The token issuer. - * @member {string} audience The audience for the token. - * @member {object} primaryVerificationKey The primary verification key. - * @member {string} [primaryVerificationKey.odatatype] Polymorphic - * Discriminator - * @member {array} [alternateVerificationKeys] A list of alternative - * verification keys. - * @member {array} [requiredClaims] A list of required token claims. - * @member {string} restrictionTokenType The type of token. Possible values - * include: 'Unknown', 'Swt', 'Jwt' - * @member {string} [openIdConnectDiscoveryDocument] The OpenID connect - * discovery document. - */ + * Represents a token restriction. Provided token must match these requirements for successful + * license or key delivery. +*/ export interface ContentKeyPolicyTokenRestriction extends ContentKeyPolicyRestriction { + /** + * The token issuer. + */ issuer: string; + /** + * The audience for the token. + */ audience: string; + /** + * The primary verification key. + */ primaryVerificationKey: ContentKeyPolicyRestrictionTokenKey; + /** + * A list of alternative verification keys. + */ alternateVerificationKeys?: ContentKeyPolicyRestrictionTokenKey[]; + /** + * A list of required token claims. + */ requiredClaims?: ContentKeyPolicyTokenClaim[]; + /** + * The type of token. Possible values include: 'Unknown', 'Swt', 'Jwt' + */ restrictionTokenType: string; + /** + * The OpenID connect discovery document. + */ openIdConnectDiscoveryDocument?: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyClearKeyConfiguration class. - * @constructor * Represents a configuration for non-DRM keys. - * - */ +*/ export interface ContentKeyPolicyClearKeyConfiguration extends ContentKeyPolicyConfiguration { } /** - * @class - * Initializes a new instance of the ContentKeyPolicyUnknownConfiguration class. - * @constructor - * Represents a ContentKeyPolicyConfiguration that is unavailable in the - * current API version. - * - */ + * Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version. +*/ export interface ContentKeyPolicyUnknownConfiguration extends ContentKeyPolicyConfiguration { } /** - * @class - * Initializes a new instance of the ContentKeyPolicyWidevineConfiguration class. - * @constructor * Specifies a configuration for Widevine licenses. - * - * @member {string} widevineTemplate The Widevine template. - */ +*/ export interface ContentKeyPolicyWidevineConfiguration extends ContentKeyPolicyConfiguration { + /** + * The Widevine template. + */ widevineTemplate: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyPlayReadyConfiguration class. - * @constructor * Specifies a configuration for PlayReady licenses. - * - * @member {array} licenses The PlayReady licenses. - * @member {string} [responseCustomData] The custom response data. - */ +*/ export interface ContentKeyPolicyPlayReadyConfiguration extends ContentKeyPolicyConfiguration { + /** + * The PlayReady licenses. + */ licenses: ContentKeyPolicyPlayReadyLicense[]; + /** + * The custom response data. + */ responseCustomData?: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyFairPlayConfiguration class. - * @constructor * Specifies a configuration for FairPlay licenses. - * - * @member {buffer} ask The key that must be used as FairPlay Application - * Secret key. - * @member {string} fairPlayPfxPassword The password encrypting FairPlay - * certificate in PKCS 12 (pfx) format. - * @member {string} fairPlayPfx The Base64 representation of FairPlay - * certificate in PKCS 12 (pfx) format (including private key). - * @member {string} rentalAndLeaseKeyType The rental and lease key type. - * Possible values include: 'Unknown', 'Undefined', 'PersistentUnlimited', - * 'PersistentLimited' - * @member {number} rentalDuration The rental duration. Must be greater than or - * equal to 0. - */ +*/ export interface ContentKeyPolicyFairPlayConfiguration extends ContentKeyPolicyConfiguration { + /** + * The key that must be used as FairPlay Application Secret key. + */ ask: Buffer; + /** + * The password encrypting FairPlay certificate in PKCS 12 (pfx) format. + */ fairPlayPfxPassword: string; + /** + * The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private + * key). + */ fairPlayPfx: string; + /** + * The rental and lease key type. Possible values include: 'Unknown', 'Undefined', + * 'PersistentUnlimited', 'PersistentLimited' + */ rentalAndLeaseKeyType: string; + /** + * The rental duration. Must be greater than or equal to 0. + */ rentalDuration: number; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyOption class. - * @constructor * Represents a policy option. - * - * @member {uuid} [policyOptionId] The legacy Policy Option ID. - * @member {string} [name] The Policy Option description. - * @member {object} configuration The key delivery configuration. - * @member {string} [configuration.odatatype] Polymorphic Discriminator - * @member {object} restriction The requirements that must be met to deliver - * keys with this configuration - * @member {string} [restriction.odatatype] Polymorphic Discriminator - */ +*/ export interface ContentKeyPolicyOption { + /** + * The legacy Policy Option ID. + */ readonly policyOptionId?: string; + /** + * The Policy Option description. + */ name?: string; + /** + * The key delivery configuration. + */ configuration: ContentKeyPolicyConfiguration; + /** + * The requirements that must be met to deliver keys with this configuration + */ restriction: ContentKeyPolicyRestriction; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyProperties class. - * @constructor * The properties of the Content Key Policy. - * - * @member {uuid} [policyId] The legacy Policy ID. - * @member {date} [created] The creation date of the Policy - * @member {date} [lastModified] The last modified date of the Policy - * @member {string} [description] A description for the Policy. - * @member {array} options The Key Policy options. - */ +*/ export interface ContentKeyPolicyProperties { + /** + * The legacy Policy ID. + */ readonly policyId?: string; + /** + * The creation date of the Policy + */ readonly created?: Date; + /** + * The last modified date of the Policy + */ readonly lastModified?: Date; + /** + * A description for the Policy. + */ description?: string; + /** + * The Key Policy options. + */ options: ContentKeyPolicyOption[]; } /** - * @class - * Initializes a new instance of the ContentKeyPolicy class. - * @constructor * A Content Key Policy resource. - * - * @member {uuid} [policyId] The legacy Policy ID. - * @member {date} [created] The creation date of the Policy - * @member {date} [lastModified] The last modified date of the Policy - * @member {string} [description] A description for the Policy. - * @member {array} options The Key Policy options. - */ +*/ export interface ContentKeyPolicy extends ProxyResource { + /** + * The legacy Policy ID. + */ readonly policyId?: string; + /** + * The creation date of the Policy + */ readonly created?: Date; + /** + * The last modified date of the Policy + */ readonly lastModified?: Date; + /** + * A description for the Policy. + */ description?: string; + /** + * The Key Policy options. + */ options: ContentKeyPolicyOption[]; } /** - * @class - * Initializes a new instance of the Preset class. - * @constructor - * Base type for all Presets, which define the recipe or instructions on how - * the input media files should be processed. - * - * @member {string} odatatype Polymorphic Discriminator - */ + * Base type for all Presets, which define the recipe or instructions on how the input media files + * should be processed. +*/ export interface Preset { + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the Codec class. - * @constructor * Describes the basic properties of all codecs. - * - * @member {string} [label] An optional label for the codec. The label can be - * used to control muxing behavior. - * @member {string} odatatype Polymorphic Discriminator - */ +*/ export interface Codec { + /** + * An optional label for the codec. The label can be used to control muxing behavior. + */ label?: string; + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the Audio class. - * @constructor * Defines the common properties for all audio codecs. - * - * @member {number} [channels] The number of channels in the audio. - * @member {number} [samplingRate] The sampling rate to use for encoding in - * hertz. - * @member {number} [bitrate] The bitrate, in bits per second, of the output - * encoded audio. - */ +*/ export interface Audio extends Codec { + /** + * The number of channels in the audio. + */ channels?: number; + /** + * The sampling rate to use for encoding in hertz. + */ samplingRate?: number; + /** + * The bitrate, in bits per second, of the output encoded audio. + */ bitrate?: number; } /** - * @class - * Initializes a new instance of the AacAudio class. - * @constructor * Describes Advanced Audio Codec (AAC) audio encoding settings. - * - * @member {string} [profile] The encoding profile to be used when encoding - * audio with AAC. Possible values include: 'AacLc', 'HeAacV1', 'HeAacV2' - */ +*/ export interface AacAudio extends Audio { + /** + * The encoding profile to be used when encoding audio with AAC. Possible values include: + * 'AacLc', 'HeAacV1', 'HeAacV2' + */ profile?: string; } /** - * @class - * Initializes a new instance of the AudioAnalyzerPreset class. - * @constructor - * The Audio Analyzer preset applies a pre-defined set of AI-based analysis - * operations, including speech transcription. Currently, the preset supports - * processing of content with a single audio track. - * - * @member {string} [audioLanguage] The language for the audio payload in the - * input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). The - * list of supported languages are, 'en-US', 'en-GB', 'es-ES', 'es-MX', - * 'fr-FR', 'it-IT', 'ja-JP', 'pt-BR', 'zh-CN', 'de-DE', 'ar-EG', 'ru-RU', - * 'hi-IN'. If not specified, automatic language detection would be employed. - * This feature currently supports English, Chinese, French, German, Italian, - * Japanese, Spanish, Russian, and Portuguese. The automatic detection works - * best with audio recordings with clearly discernable speech. If automatic - * detection fails to find the language, transcription would fallback to - * English. - */ + * The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including + * speech transcription. Currently, the preset supports processing of content with a single audio + * track. +*/ export interface AudioAnalyzerPreset extends Preset { + /** + * The language for the audio payload in the input using the BCP-47 format of 'language + * tag-region' (e.g: 'en-US'). The list of supported languages are, 'en-US', 'en-GB', 'es-ES', + * 'es-MX', 'fr-FR', 'it-IT', 'ja-JP', 'pt-BR', 'zh-CN', 'de-DE', 'ar-EG', 'ru-RU', 'hi-IN'. If + * not specified, automatic language detection would be employed. This feature currently supports + * English, Chinese, French, German, Italian, Japanese, Spanish, Russian, and Portuguese. The + * automatic detection works best with audio recordings with clearly discernable speech. If + * automatic detection fails to find the language, transcription would fallback to English. + */ audioLanguage?: string; } /** - * @class - * Initializes a new instance of the Overlay class. - * @constructor * Base type for all overlays - image, audio or video. - * - * @member {string} [inputLabel] The label of the job input which is to be used - * as an overlay. The Input must specify exactly one file. You can specify an - * image file in JPG or PNG formats, or an audio file (such as a WAV, MP3, WMA - * or M4A file), or a video file. See https://aka.ms/mesformats for the - * complete list of supported audio and video file formats. - * @member {moment.duration} [start] The start position, with reference to the - * input video, at which the overlay starts. The value should be in ISO 8601 - * format. For example, PT05S to start the overlay at 5 seconds in to the input - * video. If not specified the overlay starts from the beginning of the input - * video. - * @member {moment.duration} [end] The position in the input video at which the - * overlay ends. The value should be in ISO 8601 duration format. For example, - * PT30S to end the overlay at 30 seconds in to the input video. If not - * specified the overlay will be applied until the end of the input video if - * inputLoop is true. Else, if inputLoop is false, then overlay will last as - * long as the duration of the overlay media. - * @member {moment.duration} [fadeInDuration] The duration over which the - * overlay fades in onto the input video. The value should be in ISO 8601 - * duration format. If not specified the default behavior is to have no fade in - * (same as PT0S). - * @member {moment.duration} [fadeOutDuration] The duration over which the - * overlay fades out of the input video. The value should be in ISO 8601 - * duration format. If not specified the default behavior is to have no fade - * out (same as PT0S). - * @member {number} [audioGainLevel] The gain level of audio in the overlay. - * The value should be in the range [0, 1.0]. The default is 1.0. - * @member {string} odatatype Polymorphic Discriminator - */ +*/ export interface Overlay { + /** + * The label of the job input which is to be used as an overlay. The Input must specify exactly + * one file. You can specify an image file in JPG or PNG formats, or an audio file (such as a + * WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete + * list of supported audio and video file formats. + */ inputLabel?: string; + /** + * The start position, with reference to the input video, at which the overlay starts. The value + * should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds in to the + * input video. If not specified the overlay starts from the beginning of the input video. + */ start?: moment.Duration; + /** + * The position in the input video at which the overlay ends. The value should be in ISO 8601 + * duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If + * not specified the overlay will be applied until the end of the input video if inputLoop is + * true. Else, if inputLoop is false, then overlay will last as long as the duration of the + * overlay media. + */ end?: moment.Duration; + /** + * The duration over which the overlay fades in onto the input video. The value should be in ISO + * 8601 duration format. If not specified the default behavior is to have no fade in (same as + * PT0S). + */ fadeInDuration?: moment.Duration; + /** + * The duration over which the overlay fades out of the input video. The value should be in ISO + * 8601 duration format. If not specified the default behavior is to have no fade out (same as + * PT0S). + */ fadeOutDuration?: moment.Duration; + /** + * The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default + * is 1.0. + */ audioGainLevel?: number; + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the AudioOverlay class. - * @constructor * Describes the properties of an audio overlay. - * - */ +*/ export interface AudioOverlay extends Overlay { } /** - * @class - * Initializes a new instance of the CopyVideo class. - * @constructor - * A codec flag, which tells the encoder to copy the input video bitstream - * without re-encoding. - * - */ + * A codec flag, which tells the encoder to copy the input video bitstream without re-encoding. +*/ export interface CopyVideo extends Codec { } /** - * @class - * Initializes a new instance of the Video class. - * @constructor * Describes the basic properties for encoding the input video. - * - * @member {moment.duration} [keyFrameInterval] The distance between two key - * frames, thereby defining a group of pictures (GOP). The value should be a - * non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. - * The default is 2 seconds (PT2S). - * @member {string} [stretchMode] The resizing mode - how the input video will - * be resized to fit the desired output resolution(s). Default is AutoSize. - * Possible values include: 'None', 'AutoSize', 'AutoFit' - */ +*/ export interface Video extends Codec { + /** + * The distance between two key frames, thereby defining a group of pictures (GOP). The value + * should be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 format. The + * default is 2 seconds (PT2S). + */ keyFrameInterval?: moment.Duration; + /** + * The resizing mode - how the input video will be resized to fit the desired output + * resolution(s). Default is AutoSize. Possible values include: 'None', 'AutoSize', 'AutoFit' + */ stretchMode?: string; } /** - * @class - * Initializes a new instance of the Image class. - * @constructor - * Describes the basic properties for generating thumbnails from the input - * video - * - * @member {string} [start] The position in the input video from where to start - * generating thumbnails. The value can be in absolute timestamp (ISO 8601, - * e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a - * relative value (For example, 1%). Also supports a macro {Best}, which tells - * the encoder to select the best thumbnail from the first few seconds of the - * video. - * @member {string} [step] The intervals at which thumbnails are generated. The - * value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every - * 5 seconds), or a frame count (For example, 30 for every 30 frames), or a - * relative value (For example, 1%). - * @member {string} [range] The position in the input video at which to stop - * generating thumbnails. The value can be in absolute timestamp (ISO 8601, - * e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For - * example, 300 to stop at the 300th frame), or a relative value (For example, - * 100%). - */ + * Describes the basic properties for generating thumbnails from the input video +*/ export interface Image extends Video { + /** + * The position in the input video from where to start generating thumbnails. The value can be in + * absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th + * frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the + * encoder to select the best thumbnail from the first few seconds of the video. + */ start?: string; + /** + * The intervals at which thumbnails are generated. The value can be in absolute timestamp (ISO + * 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every + * 30 frames), or a relative value (For example, 1%). + */ step?: string; + /** + * The position in the input video at which to stop generating thumbnails. The value can be in + * absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame + * count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%). + */ range?: string; } /** - * @class - * Initializes a new instance of the Format class. - * @constructor * Base class for output. - * - * @member {string} [filenamePattern] The pattern of the file names for the - * generated output files. The following macros are supported in the file name: - * {Basename} - The base name of the input video {Extension} - The appropriate - * extension for this format. {Label} - The label assigned to the codec/layer. - * {Index} - A unique index for thumbnails. Only applicable to thumbnails. - * {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - - * The type of the audio/video codec. Any unsubstituted macros will be - * collapsed and removed from the filename. - * @member {string} odatatype Polymorphic Discriminator - */ +*/ export interface Format { + /** + * The pattern of the file names for the generated output files. The following macros are + * supported in the file name: {Basename} - The base name of the input video {Extension} - The + * appropriate extension for this format. {Label} - The label assigned to the codec/layer. + * {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The + * audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video + * codec. Any unsubstituted macros will be collapsed and removed from the filename. + */ filenamePattern?: string; + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the ImageFormat class. - * @constructor * Describes the properties for an output image file. - * - */ +*/ export interface ImageFormat extends Format { } /** - * @class - * Initializes a new instance of the JpgFormat class. - * @constructor * Describes the settings for producing JPEG thumbnails. - * - */ +*/ export interface JpgFormat extends ImageFormat { } /** - * @class - * Initializes a new instance of the PngFormat class. - * @constructor * Describes the settings for producing PNG thumbnails. - * - */ +*/ export interface PngFormat extends ImageFormat { } /** - * @class - * Initializes a new instance of the CopyAudio class. - * @constructor * A codec flag, which tells the encoder to copy the input audio bitstream. - * - */ +*/ export interface CopyAudio extends Codec { } /** - * @class - * Initializes a new instance of the Deinterlace class. - * @constructor * Describes the de-interlacing settings. - * - * @member {string} [parity] The field parity for de-interlacing, defaults to - * Auto. Possible values include: 'Auto', 'TopFieldFirst', 'BottomFieldFirst' - * @member {string} [mode] The deinterlacing mode. Defaults to - * AutoPixelAdaptive. Possible values include: 'Off', 'AutoPixelAdaptive' - */ +*/ export interface Deinterlace { + /** + * The field parity for de-interlacing, defaults to Auto. Possible values include: 'Auto', + * 'TopFieldFirst', 'BottomFieldFirst' + */ parity?: string; + /** + * The deinterlacing mode. Defaults to AutoPixelAdaptive. Possible values include: 'Off', + * 'AutoPixelAdaptive' + */ mode?: string; } /** - * @class - * Initializes a new instance of the Rectangle class. - * @constructor - * Describes the properties of a rectangular window applied to the input media - * before processing it. - * - * @member {string} [left] The number of pixels from the left-margin. This can - * be absolute pixel value (e.g 100), or relative to the size of the video (For - * example, 50%). - * @member {string} [top] The number of pixels from the top-margin. This can be - * absolute pixel value (e.g 100), or relative to the size of the video (For - * example, 50%). - * @member {string} [width] The width of the rectangular region in pixels. This - * can be absolute pixel value (e.g 100), or relative to the size of the video - * (For example, 50%). - * @member {string} [height] The height of the rectangular region in pixels. - * This can be absolute pixel value (e.g 100), or relative to the size of the - * video (For example, 50%). - */ + * Describes the properties of a rectangular window applied to the input media before processing + * it. +*/ export interface Rectangle { + /** + * The number of pixels from the left-margin. This can be absolute pixel value (e.g 100), or + * relative to the size of the video (For example, 50%). + */ left?: string; + /** + * The number of pixels from the top-margin. This can be absolute pixel value (e.g 100), or + * relative to the size of the video (For example, 50%). + */ top?: string; + /** + * The width of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or + * relative to the size of the video (For example, 50%). + */ width?: string; + /** + * The height of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or + * relative to the size of the video (For example, 50%). + */ height?: string; } /** - * @class - * Initializes a new instance of the Filters class. - * @constructor - * Describes all the filtering operations, such as de-interlacing, rotation - * etc. that are to be applied to the input media before encoding. - * - * @member {object} [deinterlace] The de-interlacing settings. - * @member {string} [deinterlace.parity] The field parity for de-interlacing, - * defaults to Auto. Possible values include: 'Auto', 'TopFieldFirst', - * 'BottomFieldFirst' - * @member {string} [deinterlace.mode] The deinterlacing mode. Defaults to - * AutoPixelAdaptive. Possible values include: 'Off', 'AutoPixelAdaptive' - * @member {string} [rotation] The rotation, if any, to be applied to the input - * video, before it is encoded. Default is Auto. Possible values include: - * 'Auto', 'None', 'Rotate0', 'Rotate90', 'Rotate180', 'Rotate270' - * @member {object} [crop] The parameters for the rectangular window with which - * to crop the input video. - * @member {string} [crop.left] The number of pixels from the left-margin. This - * can be absolute pixel value (e.g 100), or relative to the size of the video - * (For example, 50%). - * @member {string} [crop.top] The number of pixels from the top-margin. This - * can be absolute pixel value (e.g 100), or relative to the size of the video - * (For example, 50%). - * @member {string} [crop.width] The width of the rectangular region in pixels. - * This can be absolute pixel value (e.g 100), or relative to the size of the - * video (For example, 50%). - * @member {string} [crop.height] The height of the rectangular region in - * pixels. This can be absolute pixel value (e.g 100), or relative to the size - * of the video (For example, 50%). - * @member {array} [overlays] The properties of overlays to be applied to the - * input video. These could be audio, image or video overlays. - */ + * Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be + * applied to the input media before encoding. +*/ export interface Filters { + /** + * The de-interlacing settings. + */ deinterlace?: Deinterlace; + /** + * The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto. + * Possible values include: 'Auto', 'None', 'Rotate0', 'Rotate90', 'Rotate180', 'Rotate270' + */ rotation?: string; + /** + * The parameters for the rectangular window with which to crop the input video. + */ crop?: Rectangle; + /** + * The properties of overlays to be applied to the input video. These could be audio, image or + * video overlays. + */ overlays?: Overlay[]; } /** - * @class - * Initializes a new instance of the Layer class. - * @constructor - * The encoder can be configured to produce video and/or images (thumbnails) at - * different resolutions, by specifying a layer for each desired resolution. A - * layer represents the properties for the video or image at a resolution. - * - * @member {string} [width] The width of the output video for this layer. The - * value can be absolute (in pixels) or relative (in percentage). For example - * 50% means the output video has half as many pixels in width as the input. - * @member {string} [height] The height of the output video for this layer. The - * value can be absolute (in pixels) or relative (in percentage). For example - * 50% means the output video has half as many pixels in height as the input. - * @member {string} [label] The alphanumeric label for this layer, which can be - * used in multiplexing different video and audio layers, or in naming the - * output file. - * @member {string} odatatype Polymorphic Discriminator - */ + * The encoder can be configured to produce video and/or images (thumbnails) at different + * resolutions, by specifying a layer for each desired resolution. A layer represents the + * properties for the video or image at a resolution. +*/ export interface Layer { + /** + * The width of the output video for this layer. The value can be absolute (in pixels) or + * relative (in percentage). For example 50% means the output video has half as many pixels in + * width as the input. + */ width?: string; + /** + * The height of the output video for this layer. The value can be absolute (in pixels) or + * relative (in percentage). For example 50% means the output video has half as many pixels in + * height as the input. + */ height?: string; + /** + * The alphanumeric label for this layer, which can be used in multiplexing different video and + * audio layers, or in naming the output file. + */ label?: string; + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the VideoLayer class. - * @constructor - * Describes the settings to be used when encoding the input video into a - * desired output bitrate layer. - * - * @member {number} [bitrate] The average bitrate in bits per second at which - * to encode the input video when generating this layer. This is a required - * field. - * @member {number} [maxBitrate] The maximum bitrate (in bits per second), at - * which the VBV buffer should be assumed to refill. If not specified, defaults - * to the same value as bitrate. - * @member {number} [bFrames] The number of B-frames to be used when encoding - * this layer. If not specified, the encoder chooses an appropriate number - * based on the video profile and level. - * @member {string} [frameRate] The frame rate (in frames per second) at which - * to encode this layer. The value can be in the form of M/N where M and N are - * integers (For example, 30000/1001), or in the form of a number (For example, - * 30, or 29.97). The encoder enforces constraints on allowed frame rates based - * on the profile and level. If it is not specified, the encoder will use the - * same frame rate as the input video. - * @member {number} [slices] The number of slices to be used when encoding this - * layer. If not specified, default is zero, which means that encoder will use - * a single slice for each frame. - * @member {boolean} [adaptiveBFrame] Whether or not adaptive B-frames are to - * be used when encoding this layer. If not specified, the encoder will turn it - * on whenever the video profile permits its use. - */ + * Describes the settings to be used when encoding the input video into a desired output bitrate + * layer. +*/ export interface VideoLayer extends Layer { + /** + * The average bitrate in bits per second at which to encode the input video when generating this + * layer. This is a required field. + */ bitrate?: number; + /** + * The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. + * If not specified, defaults to the same value as bitrate. + */ maxBitrate?: number; + /** + * The number of B-frames to be used when encoding this layer. If not specified, the encoder + * chooses an appropriate number based on the video profile and level. + */ bFrames?: number; + /** + * The frame rate (in frames per second) at which to encode this layer. The value can be in the + * form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number + * (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on + * the profile and level. If it is not specified, the encoder will use the same frame rate as the + * input video. + */ frameRate?: string; + /** + * The number of slices to be used when encoding this layer. If not specified, default is zero, + * which means that encoder will use a single slice for each frame. + */ slices?: number; + /** + * Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, + * the encoder will turn it on whenever the video profile permits its use. + */ adaptiveBFrame?: boolean; } /** - * @class - * Initializes a new instance of the H264Layer class. - * @constructor - * Describes the settings to be used when encoding the input video into a - * desired output bitrate layer with the H.264 video codec. - * - * @member {string} [profile] Which profile of the H.264 standard should be - * used when encoding this layer. Default is Auto. Possible values include: - * 'Auto', 'Baseline', 'Main', 'High', 'High422', 'High444' - * @member {string} [level] Which level of the H.264 standard should be used - * when encoding this layer. The value can be Auto, or a number that matches - * the H.264 profile. If not specified, the default is Auto, which lets the - * encoder choose the Level that is appropriate for this layer. - * @member {moment.duration} [bufferWindow] The VBV buffer window length. The - * value should be in ISO 8601 format. The value should be in the range - * [0.1-100] seconds. The default is 5 seconds (for example, PT5S). - * @member {number} [referenceFrames] The number of reference frames to be used - * when encoding this layer. If not specified, the encoder determines an - * appropriate number based on the encoder complexity setting. - * @member {string} [entropyMode] The entropy mode to be used for this layer. - * If not specified, the encoder chooses the mode that is appropriate for the - * profile and level. Possible values include: 'Cabac', 'Cavlc' - */ + * Describes the settings to be used when encoding the input video into a desired output bitrate + * layer with the H.264 video codec. +*/ export interface H264Layer extends VideoLayer { + /** + * Which profile of the H.264 standard should be used when encoding this layer. Default is Auto. + * Possible values include: 'Auto', 'Baseline', 'Main', 'High', 'High422', 'High444' + */ profile?: string; + /** + * Which level of the H.264 standard should be used when encoding this layer. The value can be + * Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which + * lets the encoder choose the Level that is appropriate for this layer. + */ level?: string; + /** + * The VBV buffer window length. The value should be in ISO 8601 format. The value should be in + * the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S). + */ bufferWindow?: moment.Duration; + /** + * The number of reference frames to be used when encoding this layer. If not specified, the + * encoder determines an appropriate number based on the encoder complexity setting. + */ referenceFrames?: number; + /** + * The entropy mode to be used for this layer. If not specified, the encoder chooses the mode + * that is appropriate for the profile and level. Possible values include: 'Cabac', 'Cavlc' + */ entropyMode?: string; } /** - * @class - * Initializes a new instance of the H264Video class. - * @constructor * Describes all the properties for encoding a video with the H.264 codec. - * - * @member {boolean} [sceneChangeDetection] Whether or not the encoder should - * insert key frames at scene changes. If not specified, the default is false. - * This flag should be set to true only when the encoder is being configured to - * produce a single output video. - * @member {string} [complexity] Tells the encoder how to choose its encoding - * settings. The default value is Balanced. Possible values include: 'Speed', - * 'Balanced', 'Quality' - * @member {array} [layers] The collection of output H.264 layers to be - * produced by the encoder. - */ +*/ export interface H264Video extends Video { + /** + * Whether or not the encoder should insert key frames at scene changes. If not specified, the + * default is false. This flag should be set to true only when the encoder is being configured to + * produce a single output video. + */ sceneChangeDetection?: boolean; + /** + * Tells the encoder how to choose its encoding settings. The default value is Balanced. Possible + * values include: 'Speed', 'Balanced', 'Quality' + */ complexity?: string; + /** + * The collection of output H.264 layers to be produced by the encoder. + */ layers?: H264Layer[]; } /** - * @class - * Initializes a new instance of the JpgLayer class. - * @constructor * Describes the settings to produce a JPEG image from the input video. - * - * @member {number} [quality] The compression quality of the JPEG output. Range - * is from 0-100 and the default is 70. - */ +*/ export interface JpgLayer extends Layer { + /** + * The compression quality of the JPEG output. Range is from 0-100 and the default is 70. + */ quality?: number; } /** - * @class - * Initializes a new instance of the JpgImage class. - * @constructor - * Describes the properties for producing a series of JPEG images from the - * input video. - * - * @member {array} [layers] A collection of output JPEG image layers to be - * produced by the encoder. - */ + * Describes the properties for producing a series of JPEG images from the input video. +*/ export interface JpgImage extends Image { + /** + * A collection of output JPEG image layers to be produced by the encoder. + */ layers?: JpgLayer[]; } /** - * @class - * Initializes a new instance of the OutputFile class. - * @constructor * Represents an output file produced. - * - * @member {array} [labels] The list of labels that describe how the encoder - * should multiplex video and audio into an output file. For example, if the - * encoder is producing two video layers with labels v1 and v2, and one audio - * layer with label a1, then an array like '[v1, a1]' tells the encoder to - * produce an output file with the video track represented by v1 and the audio - * track represented by a1. - */ +*/ export interface OutputFile { + /** + * The list of labels that describe how the encoder should multiplex video and audio into an + * output file. For example, if the encoder is producing two video layers with labels v1 and v2, + * and one audio layer with label a1, then an array like '[v1, a1]' tells the encoder to produce + * an output file with the video track represented by v1 and the audio track represented by a1. + */ labels?: string[]; } /** - * @class - * Initializes a new instance of the MultiBitrateFormat class. - * @constructor - * Describes the properties for producing a collection of GOP aligned - * multi-bitrate files. The default behavior is to produce one output file for - * each video layer which is muxed together with all the audios. The exact - * output files produced can be controlled by specifying the outputFiles + * Describes the properties for producing a collection of GOP aligned multi-bitrate files. The + * default behavior is to produce one output file for each video layer which is muxed together with + * all the audios. The exact output files produced can be controlled by specifying the outputFiles * collection. - * - * @member {array} [outputFiles] The list of output files to produce. Each - * entry in the list is a set of audio and video layer labels to be muxed - * together . - */ +*/ export interface MultiBitrateFormat extends Format { + /** + * The list of output files to produce. Each entry in the list is a set of audio and video layer + * labels to be muxed together . + */ outputFiles?: OutputFile[]; } /** - * @class - * Initializes a new instance of the Mp4Format class. - * @constructor * Describes the properties for an output ISO MP4 file. - * - */ +*/ export interface Mp4Format extends MultiBitrateFormat { } /** - * @class - * Initializes a new instance of the PngLayer class. - * @constructor * Describes the settings to produce a PNG image from the input video. - * - */ +*/ export interface PngLayer extends Layer { } /** - * @class - * Initializes a new instance of the PngImage class. - * @constructor - * Describes the properties for producing a series of PNG images from the input - * video. - * - * @member {array} [layers] A collection of output PNG image layers to be - * produced by the encoder. - */ + * Describes the properties for producing a series of PNG images from the input video. +*/ export interface PngImage extends Image { + /** + * A collection of output PNG image layers to be produced by the encoder. + */ layers?: PngLayer[]; } /** - * @class - * Initializes a new instance of the BuiltInStandardEncoderPreset class. - * @constructor - * Describes a built-in preset for encoding the input video with the Standard - * Encoder. - * - * @member {string} presetName The built-in preset to be used for encoding - * videos. Possible values include: 'H264SingleBitrateSD', - * 'H264SingleBitrate720p', 'H264SingleBitrate1080p', 'AdaptiveStreaming', - * 'AACGoodQualityAudio', 'H264MultipleBitrate1080p', - * 'H264MultipleBitrate720p', 'H264MultipleBitrateSD' - */ + * Describes a built-in preset for encoding the input video with the Standard Encoder. +*/ export interface BuiltInStandardEncoderPreset extends Preset { + /** + * The built-in preset to be used for encoding videos. Possible values include: + * 'H264SingleBitrateSD', 'H264SingleBitrate720p', 'H264SingleBitrate1080p', 'AdaptiveStreaming', + * 'AACGoodQualityAudio', 'H264MultipleBitrate1080p', 'H264MultipleBitrate720p', + * 'H264MultipleBitrateSD' + */ presetName: string; } /** - * @class - * Initializes a new instance of the StandardEncoderPreset class. - * @constructor - * Describes all the settings to be used when encoding the input video with the - * Standard Encoder. - * - * @member {object} [filters] One or more filtering operations that are applied - * to the input media before encoding. - * @member {object} [filters.deinterlace] The de-interlacing settings. - * @member {string} [filters.deinterlace.parity] The field parity for - * de-interlacing, defaults to Auto. Possible values include: 'Auto', - * 'TopFieldFirst', 'BottomFieldFirst' - * @member {string} [filters.deinterlace.mode] The deinterlacing mode. Defaults - * to AutoPixelAdaptive. Possible values include: 'Off', 'AutoPixelAdaptive' - * @member {string} [filters.rotation] The rotation, if any, to be applied to - * the input video, before it is encoded. Default is Auto. Possible values - * include: 'Auto', 'None', 'Rotate0', 'Rotate90', 'Rotate180', 'Rotate270' - * @member {object} [filters.crop] The parameters for the rectangular window - * with which to crop the input video. - * @member {string} [filters.crop.left] The number of pixels from the - * left-margin. This can be absolute pixel value (e.g 100), or relative to the - * size of the video (For example, 50%). - * @member {string} [filters.crop.top] The number of pixels from the - * top-margin. This can be absolute pixel value (e.g 100), or relative to the - * size of the video (For example, 50%). - * @member {string} [filters.crop.width] The width of the rectangular region in - * pixels. This can be absolute pixel value (e.g 100), or relative to the size - * of the video (For example, 50%). - * @member {string} [filters.crop.height] The height of the rectangular region - * in pixels. This can be absolute pixel value (e.g 100), or relative to the - * size of the video (For example, 50%). - * @member {array} [filters.overlays] The properties of overlays to be applied - * to the input video. These could be audio, image or video overlays. - * @member {array} [codecs] The list of codecs to be used when encoding the - * input video. - * @member {array} [formats] The list of outputs to be produced by the encoder. - */ + * Describes all the settings to be used when encoding the input video with the Standard Encoder. +*/ export interface StandardEncoderPreset extends Preset { + /** + * One or more filtering operations that are applied to the input media before encoding. + */ filters?: Filters; + /** + * The list of codecs to be used when encoding the input video. + */ codecs?: Codec[]; + /** + * The list of outputs to be produced by the encoder. + */ formats?: Format[]; } /** - * @class - * Initializes a new instance of the VideoAnalyzerPreset class. - * @constructor - * A video analyzer preset that extracts insights (rich metadata) from both - * audio and video, and outputs a JSON format file. - * - * @member {string} [insightsToExtract] The type of insights to be extracted. - * If not set then based on the content the type will selected. If the content - * is audi only then only audio insights are extraced and if it is video only. - * Possible values include: 'AudioInsightsOnly', 'VideoInsightsOnly', - * 'AllInsights' - */ + * A video analyzer preset that extracts insights (rich metadata) from both audio and video, and + * outputs a JSON format file. +*/ export interface VideoAnalyzerPreset extends AudioAnalyzerPreset { + /** + * The type of insights to be extracted. If not set then based on the content the type will + * selected. If the content is audio only then only audio insights are extracted and if it is + * video only. Possible values include: 'AudioInsightsOnly', 'VideoInsightsOnly', 'AllInsights' + */ insightsToExtract?: string; } /** - * @class - * Initializes a new instance of the TransportStreamFormat class. - * @constructor - * Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC - * 13818-1) output video file(s). - * - */ + * Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output + * video file(s). +*/ export interface TransportStreamFormat extends MultiBitrateFormat { } /** - * @class - * Initializes a new instance of the VideoOverlay class. - * @constructor * Describes the properties of a video overlay. - * - * @member {object} [position] The location in the input video where the - * overlay is applied. - * @member {string} [position.left] The number of pixels from the left-margin. - * This can be absolute pixel value (e.g 100), or relative to the size of the - * video (For example, 50%). - * @member {string} [position.top] The number of pixels from the top-margin. - * This can be absolute pixel value (e.g 100), or relative to the size of the - * video (For example, 50%). - * @member {string} [position.width] The width of the rectangular region in - * pixels. This can be absolute pixel value (e.g 100), or relative to the size - * of the video (For example, 50%). - * @member {string} [position.height] The height of the rectangular region in - * pixels. This can be absolute pixel value (e.g 100), or relative to the size - * of the video (For example, 50%). - * @member {number} [opacity] The opacity of the overlay. This is a value in - * the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque. - * @member {object} [cropRectangle] An optional rectangular window used to crop - * the overlay image or video. - * @member {string} [cropRectangle.left] The number of pixels from the - * left-margin. This can be absolute pixel value (e.g 100), or relative to the - * size of the video (For example, 50%). - * @member {string} [cropRectangle.top] The number of pixels from the - * top-margin. This can be absolute pixel value (e.g 100), or relative to the - * size of the video (For example, 50%). - * @member {string} [cropRectangle.width] The width of the rectangular region - * in pixels. This can be absolute pixel value (e.g 100), or relative to the - * size of the video (For example, 50%). - * @member {string} [cropRectangle.height] The height of the rectangular region - * in pixels. This can be absolute pixel value (e.g 100), or relative to the - * size of the video (For example, 50%). - */ +*/ export interface VideoOverlay extends Overlay { + /** + * The location in the input video where the overlay is applied. + */ position?: Rectangle; + /** + * The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean + * the overlay is opaque. + */ opacity?: number; + /** + * An optional rectangular window used to crop the overlay image or video. + */ cropRectangle?: Rectangle; } /** - * @class - * Initializes a new instance of the TransformOutput class. - * @constructor - * Describes the properties of a TransformOutput, which are the rules to be - * applied while generating the desired output. - * - * @member {string} [onError] A Transform can define more than one outputs. - * This property defines what the service should do when one output fails - - * either continue to produce other outputs, or, stop the other outputs. The - * overall Job state will not reflect failures of outputs that are specified - * with 'ContinueJob'. The default is 'StopProcessingJob'. Possible values - * include: 'StopProcessingJob', 'ContinueJob' - * @member {string} [relativePriority] Sets the relative priority of the - * TransformOutputs within a Transform. This sets the priority that the service - * uses for processing TransformOutputs. The default priority is Normal. - * Possible values include: 'Low', 'Normal', 'High' - * @member {object} preset Preset that describes the operations that will be - * used to modify, transcode, or extract insights from the source file to - * generate the output. - * @member {string} [preset.odatatype] Polymorphic Discriminator - */ + * Describes the properties of a TransformOutput, which are the rules to be applied while + * generating the desired output. +*/ export interface TransformOutput { + /** + * A Transform can define more than one outputs. This property defines what the service should do + * when one output fails - either continue to produce other outputs, or, stop the other outputs. + * The overall Job state will not reflect failures of outputs that are specified with + * 'ContinueJob'. The default is 'StopProcessingJob'. Possible values include: + * 'StopProcessingJob', 'ContinueJob' + */ onError?: string; + /** + * Sets the relative priority of the TransformOutputs within a Transform. This sets the priority + * that the service uses for processing TransformOutputs. The default priority is Normal. + * Possible values include: 'Low', 'Normal', 'High' + */ relativePriority?: string; + /** + * Preset that describes the operations that will be used to modify, transcode, or extract + * insights from the source file to generate the output. + */ preset: Preset; } /** - * @class - * Initializes a new instance of the Transform class. - * @constructor - * A Transform encapsulates the rules or instructions for generating desired - * outputs from input media, such as by transcoding or by extracting insights. - * After the Transform is created, it can be applied to input media by creating - * Jobs. - * - * @member {date} [created] The UTC date and time when the Transform was - * created, in 'YYYY-MM-DDThh:mm:ssZ' format. - * @member {string} [description] An optional verbose description of the - * Transform. - * @member {date} [lastModified] The UTC date and time when the Transform was - * last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. - * @member {array} outputs An array of one or more TransformOutputs that the - * Transform should generate. - */ + * A Transform encapsulates the rules or instructions for generating desired outputs from input + * media, such as by transcoding or by extracting insights. After the Transform is created, it can + * be applied to input media by creating Jobs. +*/ export interface Transform extends ProxyResource { + /** + * The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. + */ readonly created?: Date; + /** + * An optional verbose description of the Transform. + */ description?: string; + /** + * The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. + */ readonly lastModified?: Date; + /** + * An array of one or more TransformOutputs that the Transform should generate. + */ outputs: TransformOutput[]; } /** - * @class - * Initializes a new instance of the JobInput class. - * @constructor * Base class for inputs to a Job. - * - * @member {string} odatatype Polymorphic Discriminator - */ +*/ export interface JobInput { + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the JobInputClip class. - * @constructor * Represents input files for a Job. - * - * @member {array} [files] List of files. Required for JobInputHttp. - * @member {string} [label] A label that is assigned to a JobInputClip, that is - * used to satisfy a reference used in the Transform. For example, a Transform - * can be authored so as to take an image file with the label 'xyz' and apply - * it as an overlay onto the input video before it is encoded. When submitting - * a Job, exactly one of the JobInputs should be the image file, and it should - * have the label 'xyz'. - */ +*/ export interface JobInputClip extends JobInput { + /** + * List of files. Required for JobInputHttp. + */ files?: string[]; + /** + * A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the + * Transform. For example, a Transform can be authored so as to take an image file with the label + * 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a + * Job, exactly one of the JobInputs should be the image file, and it should have the label + * 'xyz'. + */ label?: string; } /** - * @class - * Initializes a new instance of the JobInputs class. - * @constructor - * Describes a list of of inputs to a Job. - * - * @member {array} [inputs] List of inputs to a Job. - */ + * Describes a list of inputs to a Job. +*/ export interface JobInputs extends JobInput { + /** + * List of inputs to a Job. + */ inputs?: JobInput[]; } /** - * @class - * Initializes a new instance of the JobInputAsset class. - * @constructor * Represents an Asset for input into a Job. - * - * @member {string} assetName The name of the input Asset. - */ +*/ export interface JobInputAsset extends JobInputClip { + /** + * The name of the input Asset. + */ assetName: string; } /** - * @class - * Initializes a new instance of the JobInputHttp class. - * @constructor * Represents HTTPS job input. - * - * @member {string} [baseUri] Base URI for HTTPS job input. It will be - * concatenated with provided file names. If no base uri is given, then the - * provided file list is assumed to be fully qualified uris. - */ +*/ export interface JobInputHttp extends JobInputClip { + /** + * Base URI for HTTPS job input. It will be concatenated with provided file names. If no base + * uri is given, then the provided file list is assumed to be fully qualified uris. + */ baseUri?: string; } /** - * @class - * Initializes a new instance of the JobErrorDetail class. - * @constructor * Details of JobOutput errors. - * - * @member {string} [code] Code describing the error detail. - * @member {string} [message] A human-readable representation of the error. - */ +*/ export interface JobErrorDetail { + /** + * Code describing the error detail. + */ readonly code?: string; + /** + * A human-readable representation of the error. + */ readonly message?: string; } /** - * @class - * Initializes a new instance of the JobError class. - * @constructor * Details of JobOutput errors. - * - * @member {string} [code] Error code describing the error. Possible values - * include: 'ServiceError', 'ServiceTransientError', 'DownloadNotAccessible', - * 'DownloadTransientError', 'UploadNotAccessible', 'UploadTransientError', - * 'ConfigurationUnsupported', 'ContentMalformed', 'ContentUnsupported' - * @member {string} [message] A human-readable language-dependent - * representation of the error. - * @member {string} [category] Helps with categorization of errors. Possible - * values include: 'Service', 'Download', 'Upload', 'Configuration', 'Content' - * @member {string} [retry] Indicates that it may be possible to retry the Job. - * If retry is unsuccessful, please contact Azure support via Azure Portal. - * Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [details] An array of details about specific errors that led - * to this reported error. - */ +*/ export interface JobError { + /** + * Error code describing the error. Possible values include: 'ServiceError', + * 'ServiceTransientError', 'DownloadNotAccessible', 'DownloadTransientError', + * 'UploadNotAccessible', 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', + * 'ContentUnsupported' + */ readonly code?: string; + /** + * A human-readable language-dependent representation of the error. + */ readonly message?: string; + /** + * Helps with categorization of errors. Possible values include: 'Service', 'Download', 'Upload', + * 'Configuration', 'Content' + */ readonly category?: string; + /** + * Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact + * Azure support via Azure Portal. Possible values include: 'DoNotRetry', 'MayRetry' + */ readonly retry?: string; + /** + * An array of details about specific errors that led to this reported error. + */ readonly details?: JobErrorDetail[]; } /** - * @class - * Initializes a new instance of the JobOutput class. - * @constructor * Describes all the properties of a JobOutput. - * - * @member {object} [error] If the JobOutput is in the Error state, it contains - * the details of the error. - * @member {string} [error.code] Error code describing the error. Possible - * values include: 'ServiceError', 'ServiceTransientError', - * 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', - * 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', - * 'ContentUnsupported' - * @member {string} [error.message] A human-readable language-dependent - * representation of the error. - * @member {string} [error.category] Helps with categorization of errors. - * Possible values include: 'Service', 'Download', 'Upload', 'Configuration', - * 'Content' - * @member {string} [error.retry] Indicates that it may be possible to retry - * the Job. If retry is unsuccessful, please contact Azure support via Azure - * Portal. Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [error.details] An array of details about specific errors - * that led to this reported error. - * @member {string} [state] Describes the state of the JobOutput. Possible - * values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', - * 'Queued', 'Scheduled' - * @member {number} [progress] If the JobOutput is in a Processing state, this - * contains the Job completion percentage. The value is an estimate and not - * intended to be used to predict Job completion times. To determine if the - * JobOutput is complete, use the State property. - * @member {string} [label] A label that is assigned to a JobOutput in order to - * help uniquely identify it. This is useful when your Transform has more than - * one TransformOutput, whereby your Job has more than one JobOutput. In such - * cases, when you submit the Job, you will add two or more JobOutputs, in the - * same order as TransformOutputs in the Transform. Subsequently, when you - * retrieve the Job, either through events or on a GET request, you can use the - * label to easily identify the JobOutput. If a label is not provided, a - * default value of '{presetName}_{outputIndex}' will be used, where the preset - * name is the name of the preset in the corresponding TransformOutput and the - * output index is the relative index of the this JobOutput within the Job. - * Note that this index is the same as the relative index of the corresponding - * TransformOutput within its Transform. - * @member {string} odatatype Polymorphic Discriminator - */ +*/ export interface JobOutput { + /** + * If the JobOutput is in the Error state, it contains the details of the error. + */ readonly error?: JobError; + /** + * Describes the state of the JobOutput. Possible values include: 'Canceled', 'Canceling', + * 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled' + */ readonly state?: string; + /** + * If the JobOutput is in a Processing state, this contains the Job completion percentage. The + * value is an estimate and not intended to be used to predict Job completion times. To determine + * if the JobOutput is complete, use the State property. + */ readonly progress?: number; + /** + * A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful + * when your Transform has more than one TransformOutput, whereby your Job has more than one + * JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the + * same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, + * either through events or on a GET request, you can use the label to easily identify the + * JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be + * used, where the preset name is the name of the preset in the corresponding TransformOutput and + * the output index is the relative index of the this JobOutput within the Job. Note that this + * index is the same as the relative index of the corresponding TransformOutput within its + * Transform. + */ label?: string; + /** + * Polymorphic Discriminator + */ odatatype: string; } /** - * @class - * Initializes a new instance of the JobOutputAsset class. - * @constructor * Represents an Asset used as a JobOutput. - * - * @member {string} assetName The name of the output Asset. - */ +*/ export interface JobOutputAsset extends JobOutput { + /** + * The name of the output Asset. + */ assetName: string; } /** - * @class - * Initializes a new instance of the Job class. - * @constructor - * A Job resource type. The progress and state can be obtained by polling a Job - * or subscribing to events using EventGrid. - * - * @member {date} [created] The UTC date and time when the Job was created, in - * 'YYYY-MM-DDThh:mm:ssZ' format. - * @member {string} [state] The current state of the job. Possible values - * include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', - * 'Queued', 'Scheduled' - * @member {string} [description] Optional customer supplied description of the - * Job. - * @member {object} input The inputs for the Job. - * @member {string} [input.odatatype] Polymorphic Discriminator - * @member {date} [lastModified] The UTC date and time when the Job was last - * updated, in 'YYYY-MM-DDThh:mm:ssZ' format. - * @member {array} outputs The outputs for the Job. - * @member {string} [priority] Priority with which the job should be processed. - * Higher priority jobs are processed before lower priority jobs. If not set, - * the default is normal. Possible values include: 'Low', 'Normal', 'High' - * @member {object} [correlationData] Customer provided correlation data that - * will be returned in Job and JobOutput state events. - */ + * A Job resource type. The progress and state can be obtained by polling a Job or subscribing to + * events using EventGrid. +*/ export interface Job extends ProxyResource { + /** + * The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. + */ readonly created?: Date; + /** + * The current state of the job. Possible values include: 'Canceled', 'Canceling', 'Error', + * 'Finished', 'Processing', 'Queued', 'Scheduled' + */ readonly state?: string; + /** + * Optional customer supplied description of the Job. + */ description?: string; + /** + * The inputs for the Job. + */ input: JobInput; + /** + * The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. + */ readonly lastModified?: Date; + /** + * The outputs for the Job. + */ outputs: JobOutput[]; + /** + * Priority with which the job should be processed. Higher priority jobs are processed before + * lower priority jobs. If not set, the default is normal. Possible values include: 'Low', + * 'Normal', 'High' + */ priority?: string; + /** + * Customer provided correlation data that will be returned in Job and JobOutput state events. + */ correlationData?: { [propertyName: string]: string }; } /** - * @class - * Initializes a new instance of the TrackPropertyCondition class. - * @constructor * Class to specify one track property condition - * - * @member {string} property Track property type. Possible values include: - * 'Unknown', 'FourCC' - * @member {string} operation Track property condition operation. Possible - * values include: 'Unknown', 'Equal' - * @member {string} [value] Track property value - */ +*/ export interface TrackPropertyCondition { + /** + * Track property type. Possible values include: 'Unknown', 'FourCC' + */ property: string; + /** + * Track property condition operation. Possible values include: 'Unknown', 'Equal' + */ operation: string; + /** + * Track property value + */ value?: string; } /** - * @class - * Initializes a new instance of the TrackSelection class. - * @constructor * Class to select a track - * - * @member {array} [trackSelections] TrackSelections is a track property - * condition list which can specify track(s) - */ +*/ export interface TrackSelection { + /** + * TrackSelections is a track property condition list which can specify track(s) + */ trackSelections?: TrackPropertyCondition[]; } /** - * @class - * Initializes a new instance of the DefaultKey class. - * @constructor - * Class to specify properties of default content key for each encryption - * scheme - * - * @member {string} [label] Label can be used to specify Content Key when - * creating a Streaming Locator - * @member {string} [policyName] Policy used by Default Key - */ + * Class to specify properties of default content key for each encryption scheme +*/ export interface DefaultKey { + /** + * Label can be used to specify Content Key when creating a Streaming Locator + */ label?: string; + /** + * Policy used by Default Key + */ policyName?: string; } /** - * @class - * Initializes a new instance of the StreamingPolicyContentKey class. - * @constructor * Class to specify properties of content key - * - * @member {string} [label] Label can be used to specify Content Key when - * creating a Streaming Locator - * @member {string} [policyName] Policy used by Content Key - * @member {array} [tracks] Tracks which use this content key - */ +*/ export interface StreamingPolicyContentKey { + /** + * Label can be used to specify Content Key when creating a Streaming Locator + */ label?: string; + /** + * Policy used by Content Key + */ policyName?: string; + /** + * Tracks which use this content key + */ tracks?: TrackSelection[]; } /** - * @class - * Initializes a new instance of the StreamingPolicyContentKeys class. - * @constructor * Class to specify properties of all content keys in Streaming Policy - * - * @member {object} [defaultKey] Default content key for an encryption scheme - * @member {string} [defaultKey.label] Label can be used to specify Content Key - * when creating a Streaming Locator - * @member {string} [defaultKey.policyName] Policy used by Default Key - * @member {array} [keyToTrackMappings] Representing tracks needs separate - * content key - */ +*/ export interface StreamingPolicyContentKeys { + /** + * Default content key for an encryption scheme + */ defaultKey?: DefaultKey; + /** + * Representing tracks needs separate content key + */ keyToTrackMappings?: StreamingPolicyContentKey[]; } /** - * @class - * Initializes a new instance of the StreamingPolicyPlayReadyConfiguration class. - * @constructor * Class to specify configurations of PlayReady in Streaming Policy - * - * @member {string} [customLicenseAcquisitionUrlTemplate] The template for a - * customer service to deliver keys to end users. Not needed when using Azure - * Media Services for issuing keys. - * @member {string} [playReadyCustomAttributes] Custom attributes for PlayReady - */ +*/ export interface StreamingPolicyPlayReadyConfiguration { + /** + * The template for a customer service to deliver keys to end users. Not needed when using Azure + * Media Services for issuing keys. + */ customLicenseAcquisitionUrlTemplate?: string; + /** + * Custom attributes for PlayReady + */ playReadyCustomAttributes?: string; } /** - * @class - * Initializes a new instance of the StreamingPolicyWidevineConfiguration class. - * @constructor * Class to specify configurations of Widevine in Streaming Policy - * - * @member {string} [customLicenseAcquisitionUrlTemplate] The template for a - * customer service to deliver keys to end users. Not needed when using Azure - * Media Services for issuing keys. - */ +*/ export interface StreamingPolicyWidevineConfiguration { + /** + * The template for a customer service to deliver keys to end users. Not needed when using Azure + * Media Services for issuing keys. + */ customLicenseAcquisitionUrlTemplate?: string; } /** - * @class - * Initializes a new instance of the StreamingPolicyFairPlayConfiguration class. - * @constructor * Class to specify configurations of FairPlay in Streaming Policy - * - * @member {string} [customLicenseAcquisitionUrlTemplate] The template for a - * customer service to deliver keys to end users. Not needed when using Azure - * Media Services for issuing keys. - * @member {boolean} allowPersistentLicense All license to be persistent or not - */ +*/ export interface StreamingPolicyFairPlayConfiguration { + /** + * The template for a customer service to deliver keys to end users. Not needed when using Azure + * Media Services for issuing keys. + */ customLicenseAcquisitionUrlTemplate?: string; + /** + * All license to be persistent or not + */ allowPersistentLicense: boolean; } /** - * @class - * Initializes a new instance of the CbcsDrmConfiguration class. - * @constructor - * Class to specify DRM configurations of CommonEncryptionCbcs scheme in - * Streaming Policy - * - * @member {object} [fairPlay] FairPlay configurations - * @member {string} [fairPlay.customLicenseAcquisitionUrlTemplate] The template - * for a customer service to deliver keys to end users. Not needed when using - * Azure Media Services for issuing keys. - * @member {boolean} [fairPlay.allowPersistentLicense] All license to be - * persistent or not - * @member {object} [playReady] PlayReady configurations - * @member {string} [playReady.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {string} [playReady.playReadyCustomAttributes] Custom attributes for - * PlayReady - * @member {object} [widevine] Widevine configurations - * @member {string} [widevine.customLicenseAcquisitionUrlTemplate] The template - * for a customer service to deliver keys to end users. Not needed when using - * Azure Media Services for issuing keys. - */ + * Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy +*/ export interface CbcsDrmConfiguration { + /** + * FairPlay configurations + */ fairPlay?: StreamingPolicyFairPlayConfiguration; + /** + * PlayReady configurations + */ playReady?: StreamingPolicyPlayReadyConfiguration; + /** + * Widevine configurations + */ widevine?: StreamingPolicyWidevineConfiguration; } /** - * @class - * Initializes a new instance of the CencDrmConfiguration class. - * @constructor - * Class to specify DRM configurations of CommonEncryptionCenc scheme in - * Streaming Policy - * - * @member {object} [playReady] PlayReady configurations - * @member {string} [playReady.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {string} [playReady.playReadyCustomAttributes] Custom attributes for - * PlayReady - * @member {object} [widevine] Widevine configurations - * @member {string} [widevine.customLicenseAcquisitionUrlTemplate] The template - * for a customer service to deliver keys to end users. Not needed when using - * Azure Media Services for issuing keys. - */ + * Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy +*/ export interface CencDrmConfiguration { + /** + * PlayReady configurations + */ playReady?: StreamingPolicyPlayReadyConfiguration; + /** + * Widevine configurations + */ widevine?: StreamingPolicyWidevineConfiguration; } /** - * @class - * Initializes a new instance of the EnabledProtocols class. - * @constructor * Class to specify which protocols are enabled - * - * @member {boolean} download Enable Download protocol or not - * @member {boolean} dash Enable DASH protocol or not - * @member {boolean} hls Enable HLS protocol or not - * @member {boolean} smoothStreaming Enable SmoothStreaming protocol or not - */ +*/ export interface EnabledProtocols { + /** + * Enable Download protocol or not + */ download: boolean; + /** + * Enable DASH protocol or not + */ dash: boolean; + /** + * Enable HLS protocol or not + */ hls: boolean; + /** + * Enable SmoothStreaming protocol or not + */ smoothStreaming: boolean; } /** - * @class - * Initializes a new instance of the NoEncryption class. - * @constructor * Class for NoEncryption scheme - * - * @member {object} [enabledProtocols] Representing supported protocols - * @member {boolean} [enabledProtocols.download] Enable Download protocol or - * not - * @member {boolean} [enabledProtocols.dash] Enable DASH protocol or not - * @member {boolean} [enabledProtocols.hls] Enable HLS protocol or not - * @member {boolean} [enabledProtocols.smoothStreaming] Enable SmoothStreaming - * protocol or not - */ +*/ export interface NoEncryption { + /** + * Representing supported protocols + */ enabledProtocols?: EnabledProtocols; } /** - * @class - * Initializes a new instance of the EnvelopeEncryption class. - * @constructor * Class for EnvelopeEncryption encryption scheme - * - * @member {object} [enabledProtocols] Representing supported protocols - * @member {boolean} [enabledProtocols.download] Enable Download protocol or - * not - * @member {boolean} [enabledProtocols.dash] Enable DASH protocol or not - * @member {boolean} [enabledProtocols.hls] Enable HLS protocol or not - * @member {boolean} [enabledProtocols.smoothStreaming] Enable SmoothStreaming - * protocol or not - * @member {array} [clearTracks] Representing which tracks should not be - * encrypted - * @member {object} [contentKeys] Representing default content key for each - * encryption scheme and separate content keys for specific tracks - * @member {object} [contentKeys.defaultKey] Default content key for an - * encryption scheme - * @member {string} [contentKeys.defaultKey.label] Label can be used to specify - * Content Key when creating a Streaming Locator - * @member {string} [contentKeys.defaultKey.policyName] Policy used by Default - * Key - * @member {array} [contentKeys.keyToTrackMappings] Representing tracks needs - * separate content key - * @member {string} [customKeyAcquisitionUrlTemplate] KeyAcquistionUrlTemplate - * is used to point to user specified service to delivery content keys - */ +*/ export interface EnvelopeEncryption { + /** + * Representing supported protocols + */ enabledProtocols?: EnabledProtocols; + /** + * Representing which tracks should not be encrypted + */ clearTracks?: TrackSelection[]; + /** + * Representing default content key for each encryption scheme and separate content keys for + * specific tracks + */ contentKeys?: StreamingPolicyContentKeys; + /** + * KeyAcquistionUrlTemplate is used to point to user specified service to delivery content keys + */ customKeyAcquisitionUrlTemplate?: string; } /** - * @class - * Initializes a new instance of the CommonEncryptionCenc class. - * @constructor * Class for envelope encryption scheme - * - * @member {object} [enabledProtocols] Representing supported protocols - * @member {boolean} [enabledProtocols.download] Enable Download protocol or - * not - * @member {boolean} [enabledProtocols.dash] Enable DASH protocol or not - * @member {boolean} [enabledProtocols.hls] Enable HLS protocol or not - * @member {boolean} [enabledProtocols.smoothStreaming] Enable SmoothStreaming - * protocol or not - * @member {array} [clearTracks] Representing which tracks should not be - * encrypted - * @member {object} [contentKeys] Representing default content key for each - * encryption scheme and separate content keys for specific tracks - * @member {object} [contentKeys.defaultKey] Default content key for an - * encryption scheme - * @member {string} [contentKeys.defaultKey.label] Label can be used to specify - * Content Key when creating a Streaming Locator - * @member {string} [contentKeys.defaultKey.policyName] Policy used by Default - * Key - * @member {array} [contentKeys.keyToTrackMappings] Representing tracks needs - * separate content key - * @member {object} [drm] Configuration of DRMs for CommonEncryptionCenc - * encryption scheme - * @member {object} [drm.playReady] PlayReady configurations - * @member {string} [drm.playReady.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {string} [drm.playReady.playReadyCustomAttributes] Custom attributes - * for PlayReady - * @member {object} [drm.widevine] Widevine configurations - * @member {string} [drm.widevine.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - */ +*/ export interface CommonEncryptionCenc { + /** + * Representing supported protocols + */ enabledProtocols?: EnabledProtocols; + /** + * Representing which tracks should not be encrypted + */ clearTracks?: TrackSelection[]; + /** + * Representing default content key for each encryption scheme and separate content keys for + * specific tracks + */ contentKeys?: StreamingPolicyContentKeys; + /** + * Configuration of DRMs for CommonEncryptionCenc encryption scheme + */ drm?: CencDrmConfiguration; } /** - * @class - * Initializes a new instance of the CommonEncryptionCbcs class. - * @constructor * Class for CommonEncryptionCbcs encryption scheme - * - * @member {object} [enabledProtocols] Representing supported protocols - * @member {boolean} [enabledProtocols.download] Enable Download protocol or - * not - * @member {boolean} [enabledProtocols.dash] Enable DASH protocol or not - * @member {boolean} [enabledProtocols.hls] Enable HLS protocol or not - * @member {boolean} [enabledProtocols.smoothStreaming] Enable SmoothStreaming - * protocol or not - * @member {array} [clearTracks] Representing which tracks should not be - * encrypted - * @member {object} [contentKeys] Representing default content key for each - * encryption scheme and separate content keys for specific tracks - * @member {object} [contentKeys.defaultKey] Default content key for an - * encryption scheme - * @member {string} [contentKeys.defaultKey.label] Label can be used to specify - * Content Key when creating a Streaming Locator - * @member {string} [contentKeys.defaultKey.policyName] Policy used by Default - * Key - * @member {array} [contentKeys.keyToTrackMappings] Representing tracks needs - * separate content key - * @member {object} [drm] Configuration of DRMs for current encryption scheme - * @member {object} [drm.fairPlay] FairPlay configurations - * @member {string} [drm.fairPlay.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {boolean} [drm.fairPlay.allowPersistentLicense] All license to be - * persistent or not - * @member {object} [drm.playReady] PlayReady configurations - * @member {string} [drm.playReady.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {string} [drm.playReady.playReadyCustomAttributes] Custom attributes - * for PlayReady - * @member {object} [drm.widevine] Widevine configurations - * @member {string} [drm.widevine.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - */ +*/ export interface CommonEncryptionCbcs { + /** + * Representing supported protocols + */ enabledProtocols?: EnabledProtocols; + /** + * Representing which tracks should not be encrypted + */ clearTracks?: TrackSelection[]; + /** + * Representing default content key for each encryption scheme and separate content keys for + * specific tracks + */ contentKeys?: StreamingPolicyContentKeys; + /** + * Configuration of DRMs for current encryption scheme + */ drm?: CbcsDrmConfiguration; } /** - * @class - * Initializes a new instance of the StreamingPolicy class. - * @constructor * A Streaming Policy resource - * - * @member {date} [created] Creation time of Streaming Policy - * @member {string} [defaultContentKeyPolicyName] Default ContentKey used by - * current Streaming Policy - * @member {object} [envelopeEncryption] Configuration of EnvelopeEncryption - * @member {object} [envelopeEncryption.enabledProtocols] Representing - * supported protocols - * @member {boolean} [envelopeEncryption.enabledProtocols.download] Enable - * Download protocol or not - * @member {boolean} [envelopeEncryption.enabledProtocols.dash] Enable DASH - * protocol or not - * @member {boolean} [envelopeEncryption.enabledProtocols.hls] Enable HLS - * protocol or not - * @member {boolean} [envelopeEncryption.enabledProtocols.smoothStreaming] - * Enable SmoothStreaming protocol or not - * @member {array} [envelopeEncryption.clearTracks] Representing which tracks - * should not be encrypted - * @member {object} [envelopeEncryption.contentKeys] Representing default - * content key for each encryption scheme and separate content keys for - * specific tracks - * @member {object} [envelopeEncryption.contentKeys.defaultKey] Default content - * key for an encryption scheme - * @member {string} [envelopeEncryption.contentKeys.defaultKey.label] Label can - * be used to specify Content Key when creating a Streaming Locator - * @member {string} [envelopeEncryption.contentKeys.defaultKey.policyName] - * Policy used by Default Key - * @member {array} [envelopeEncryption.contentKeys.keyToTrackMappings] - * Representing tracks needs separate content key - * @member {string} [envelopeEncryption.customKeyAcquisitionUrlTemplate] - * KeyAcquistionUrlTemplate is used to point to user specified service to - * delivery content keys - * @member {object} [commonEncryptionCenc] Configuration of - * CommonEncryptionCenc - * @member {object} [commonEncryptionCenc.enabledProtocols] Representing - * supported protocols - * @member {boolean} [commonEncryptionCenc.enabledProtocols.download] Enable - * Download protocol or not - * @member {boolean} [commonEncryptionCenc.enabledProtocols.dash] Enable DASH - * protocol or not - * @member {boolean} [commonEncryptionCenc.enabledProtocols.hls] Enable HLS - * protocol or not - * @member {boolean} [commonEncryptionCenc.enabledProtocols.smoothStreaming] - * Enable SmoothStreaming protocol or not - * @member {array} [commonEncryptionCenc.clearTracks] Representing which tracks - * should not be encrypted - * @member {object} [commonEncryptionCenc.contentKeys] Representing default - * content key for each encryption scheme and separate content keys for - * specific tracks - * @member {object} [commonEncryptionCenc.contentKeys.defaultKey] Default - * content key for an encryption scheme - * @member {string} [commonEncryptionCenc.contentKeys.defaultKey.label] Label - * can be used to specify Content Key when creating a Streaming Locator - * @member {string} [commonEncryptionCenc.contentKeys.defaultKey.policyName] - * Policy used by Default Key - * @member {array} [commonEncryptionCenc.contentKeys.keyToTrackMappings] - * Representing tracks needs separate content key - * @member {object} [commonEncryptionCenc.drm] Configuration of DRMs for - * CommonEncryptionCenc encryption scheme - * @member {object} [commonEncryptionCenc.drm.playReady] PlayReady - * configurations - * @member {string} - * [commonEncryptionCenc.drm.playReady.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {string} - * [commonEncryptionCenc.drm.playReady.playReadyCustomAttributes] Custom - * attributes for PlayReady - * @member {object} [commonEncryptionCenc.drm.widevine] Widevine configurations - * @member {string} - * [commonEncryptionCenc.drm.widevine.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {object} [commonEncryptionCbcs] Configuration of - * CommonEncryptionCbcs - * @member {object} [commonEncryptionCbcs.enabledProtocols] Representing - * supported protocols - * @member {boolean} [commonEncryptionCbcs.enabledProtocols.download] Enable - * Download protocol or not - * @member {boolean} [commonEncryptionCbcs.enabledProtocols.dash] Enable DASH - * protocol or not - * @member {boolean} [commonEncryptionCbcs.enabledProtocols.hls] Enable HLS - * protocol or not - * @member {boolean} [commonEncryptionCbcs.enabledProtocols.smoothStreaming] - * Enable SmoothStreaming protocol or not - * @member {array} [commonEncryptionCbcs.clearTracks] Representing which tracks - * should not be encrypted - * @member {object} [commonEncryptionCbcs.contentKeys] Representing default - * content key for each encryption scheme and separate content keys for - * specific tracks - * @member {object} [commonEncryptionCbcs.contentKeys.defaultKey] Default - * content key for an encryption scheme - * @member {string} [commonEncryptionCbcs.contentKeys.defaultKey.label] Label - * can be used to specify Content Key when creating a Streaming Locator - * @member {string} [commonEncryptionCbcs.contentKeys.defaultKey.policyName] - * Policy used by Default Key - * @member {array} [commonEncryptionCbcs.contentKeys.keyToTrackMappings] - * Representing tracks needs separate content key - * @member {object} [commonEncryptionCbcs.drm] Configuration of DRMs for - * current encryption scheme - * @member {object} [commonEncryptionCbcs.drm.fairPlay] FairPlay configurations - * @member {string} - * [commonEncryptionCbcs.drm.fairPlay.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {boolean} [commonEncryptionCbcs.drm.fairPlay.allowPersistentLicense] - * All license to be persistent or not - * @member {object} [commonEncryptionCbcs.drm.playReady] PlayReady - * configurations - * @member {string} - * [commonEncryptionCbcs.drm.playReady.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {string} - * [commonEncryptionCbcs.drm.playReady.playReadyCustomAttributes] Custom - * attributes for PlayReady - * @member {object} [commonEncryptionCbcs.drm.widevine] Widevine configurations - * @member {string} - * [commonEncryptionCbcs.drm.widevine.customLicenseAcquisitionUrlTemplate] The - * template for a customer service to deliver keys to end users. Not needed - * when using Azure Media Services for issuing keys. - * @member {object} [noEncryption] Configurations of NoEncryption - * @member {object} [noEncryption.enabledProtocols] Representing supported - * protocols - * @member {boolean} [noEncryption.enabledProtocols.download] Enable Download - * protocol or not - * @member {boolean} [noEncryption.enabledProtocols.dash] Enable DASH protocol - * or not - * @member {boolean} [noEncryption.enabledProtocols.hls] Enable HLS protocol or - * not - * @member {boolean} [noEncryption.enabledProtocols.smoothStreaming] Enable - * SmoothStreaming protocol or not - */ +*/ export interface StreamingPolicy extends ProxyResource { + /** + * Creation time of Streaming Policy + */ readonly created?: Date; + /** + * Default ContentKey used by current Streaming Policy + */ defaultContentKeyPolicyName?: string; + /** + * Configuration of EnvelopeEncryption + */ envelopeEncryption?: EnvelopeEncryption; + /** + * Configuration of CommonEncryptionCenc + */ commonEncryptionCenc?: CommonEncryptionCenc; + /** + * Configuration of CommonEncryptionCbcs + */ commonEncryptionCbcs?: CommonEncryptionCbcs; + /** + * Configurations of NoEncryption + */ noEncryption?: NoEncryption; } /** - * @class - * Initializes a new instance of the StreamingLocatorContentKey class. - * @constructor * Class for content key in Streaming Locator - * - * @member {uuid} id ID of Content Key - * @member {string} [type] Encryption type of Content Key. Possible values - * include: 'CommonEncryptionCenc', 'CommonEncryptionCbcs', - * 'EnvelopeEncryption' - * @member {string} [labelReferenceInStreamingPolicy] Label of Content Key as - * specified in the Streaming Policy - * @member {string} [value] Value of of Content Key - * @member {string} [policyName] ContentKeyPolicy used by Content Key - * @member {array} [tracks] Tracks which use this Content Key - */ +*/ export interface StreamingLocatorContentKey { + /** + * ID of Content Key + */ id: string; + /** + * Encryption type of Content Key. Possible values include: 'CommonEncryptionCenc', + * 'CommonEncryptionCbcs', 'EnvelopeEncryption' + */ readonly type?: string; + /** + * Label of Content Key as specified in the Streaming Policy + */ labelReferenceInStreamingPolicy?: string; + /** + * Value of of Content Key + */ value?: string; + /** + * ContentKeyPolicy used by Content Key + */ readonly policyName?: string; + /** + * Tracks which use this Content Key + */ readonly tracks?: TrackSelection[]; } /** - * @class - * Initializes a new instance of the StreamingPath class. - * @constructor * Class of paths for streaming - * - * @member {string} streamingProtocol Streaming protocol. Possible values - * include: 'Hls', 'Dash', 'SmoothStreaming', 'Download' - * @member {string} encryptionScheme Encryption scheme. Possible values - * include: 'NoEncryption', 'EnvelopeEncryption', 'CommonEncryptionCenc', - * 'CommonEncryptionCbcs' - * @member {array} [paths] Streaming paths for each protocol and - * encryptionScheme pair - */ +*/ export interface StreamingPath { + /** + * Streaming protocol. Possible values include: 'Hls', 'Dash', 'SmoothStreaming', 'Download' + */ streamingProtocol: string; + /** + * Encryption scheme. Possible values include: 'NoEncryption', 'EnvelopeEncryption', + * 'CommonEncryptionCenc', 'CommonEncryptionCbcs' + */ encryptionScheme: string; + /** + * Streaming paths for each protocol and encryptionScheme pair + */ paths?: string[]; } /** - * @class - * Initializes a new instance of the ListContentKeysResponse class. - * @constructor * Class of response for listContentKeys action - * - * @member {array} [contentKeys] ContentKeys used by current Streaming Locator - */ +*/ export interface ListContentKeysResponse { + /** + * ContentKeys used by current Streaming Locator + */ contentKeys?: StreamingLocatorContentKey[]; } /** - * @class - * Initializes a new instance of the ListPathsResponse class. - * @constructor * Class of response for listPaths action - * - * @member {array} [streamingPaths] Streaming Paths supported by current - * Streaming Locator - * @member {array} [downloadPaths] Download Paths supported by current - * Streaming Locator - */ +*/ export interface ListPathsResponse { + /** + * Streaming Paths supported by current Streaming Locator + */ streamingPaths?: StreamingPath[]; + /** + * Download Paths supported by current Streaming Locator + */ downloadPaths?: string[]; } /** - * @class - * Initializes a new instance of the StreamingLocator class. - * @constructor * A Streaming Locator resource - * - * @member {string} assetName Asset Name - * @member {date} [created] The creation time of the Streaming Locator. - * @member {date} [startTime] The start time of the Streaming Locator. - * @member {date} [endTime] The end time of the Streaming Locator. - * @member {uuid} [streamingLocatorId] The StreamingLocatorId of the Streaming - * Locator. - * @member {string} streamingPolicyName 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' - * @member {string} [defaultContentKeyPolicyName] Name of the default - * ContentKeyPolicy used by this Streaming Locator. - * @member {array} [contentKeys] The ContentKeys used by this Streaming - * Locator. - * @member {string} [alternativeMediaId] Alternative Media ID of this Streaming - * Locator - */ +*/ export interface StreamingLocator extends ProxyResource { + /** + * Asset Name + */ assetName: string; + /** + * The creation time of the Streaming Locator. + */ readonly created?: Date; + /** + * The start time of the Streaming Locator. + */ startTime?: Date; + /** + * The end time of the Streaming Locator. + */ endTime?: Date; + /** + * The StreamingLocatorId of the Streaming Locator. + */ streamingLocatorId?: 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' + */ streamingPolicyName: string; + /** + * Name of the default ContentKeyPolicy used by this Streaming Locator. + */ defaultContentKeyPolicyName?: string; + /** + * The ContentKeys used by this Streaming Locator. + */ contentKeys?: StreamingLocatorContentKey[]; + /** + * Alternative Media ID of this Streaming Locator + */ alternativeMediaId?: string; } /** - * @class - * Initializes a new instance of the Hls class. - * @constructor * The HLS configuration. - * - * @member {number} [fragmentsPerTsSegment] The amount of fragments per HTTP - * Live Streaming (HLS) segment. - */ +*/ export interface Hls { + /** + * The amount of fragments per HTTP Live Streaming (HLS) segment. + */ fragmentsPerTsSegment?: number; } /** - * @class - * Initializes a new instance of the LiveOutput class. - * @constructor * The Live Output. - * - * @member {string} [description] The description of the Live Output. - * @member {string} assetName The asset name. - * @member {moment.duration} archiveWindowLength ISO 8601 timespan duration of - * the archive window length. This is duration that customer want to retain the - * recorded content. - * @member {string} [manifestName] The manifest file name. If not provided, - * the service will generate one automatically. - * @member {object} [hls] The HLS configuration. - * @member {number} [hls.fragmentsPerTsSegment] The amount of fragments per - * HTTP Live Streaming (HLS) segment. - * @member {number} [outputSnapTime] The output snapshot time. - * @member {date} [created] The exact time the Live Output was created. - * @member {date} [lastModified] The exact time the Live Output was last - * modified. - * @member {string} [provisioningState] The provisioning state of the Live - * Output. - * @member {string} [resourceState] The resource state of the Live Output. - * Possible values include: 'Creating', 'Running', 'Deleting' - */ +*/ export interface LiveOutput extends ProxyResource { + /** + * The description of the Live Output. + */ description?: string; + /** + * The asset name. + */ assetName: string; + /** + * ISO 8601 timespan duration of the archive window length. This is duration that customer want + * to retain the recorded content. + */ archiveWindowLength: moment.Duration; + /** + * The manifest file name. If not provided, the service will generate one automatically. + */ manifestName?: string; + /** + * The HLS configuration. + */ hls?: Hls; + /** + * The output snapshot time. + */ outputSnapTime?: number; + /** + * The exact time the Live Output was created. + */ readonly created?: Date; + /** + * The exact time the Live Output was last modified. + */ readonly lastModified?: Date; + /** + * The provisioning state of the Live Output. + */ readonly provisioningState?: string; + /** + * The resource state of the Live Output. Possible values include: 'Creating', 'Running', + * 'Deleting' + */ readonly resourceState?: string; } /** - * @class - * Initializes a new instance of the LiveEventEndpoint class. - * @constructor * The Live Event endpoint. - * - * @member {string} [protocol] The endpoint protocol. - * @member {string} [url] The endpoint URL. - */ +*/ export interface LiveEventEndpoint { + /** + * The endpoint protocol. + */ protocol?: string; + /** + * The endpoint URL. + */ url?: string; } /** - * @class - * Initializes a new instance of the IPRange class. - * @constructor * The IP address range in the CIDR scheme. - * - * @member {string} [name] The friendly name for the IP address range. - * @member {string} [address] The IP address. - * @member {number} [subnetPrefixLength] The subnet mask prefix length (see - * CIDR notation). - */ +*/ export interface IPRange { + /** + * The friendly name for the IP address range. + */ name?: string; + /** + * The IP address. + */ address?: string; + /** + * The subnet mask prefix length (see CIDR notation). + */ subnetPrefixLength?: number; } /** - * @class - * Initializes a new instance of the IPAccessControl class. - * @constructor * The IP access control. - * - * @member {array} [allow] The IP allow list. - */ +*/ export interface IPAccessControl { + /** + * The IP allow list. + */ allow?: IPRange[]; } /** - * @class - * Initializes a new instance of the LiveEventInputAccessControl class. - * @constructor * The IP access control for Live Event Input. - * - * @member {object} [ip] The IP access control properties. - * @member {array} [ip.allow] The IP allow list. - */ +*/ export interface LiveEventInputAccessControl { + /** + * The IP access control properties. + */ ip?: IPAccessControl; } /** - * @class - * Initializes a new instance of the LiveEventInput class. - * @constructor * The Live Event input. - * - * @member {string} streamingProtocol The streaming protocol for the Live - * Event. This is specified at creation time and cannot be updated. Possible - * values include: 'FragmentedMP4', 'RTMP' - * @member {object} [accessControl] The access control for LiveEvent Input. - * @member {object} [accessControl.ip] The IP access control properties. - * @member {array} [accessControl.ip.allow] The IP allow list. - * @member {string} [keyFrameIntervalDuration] ISO 8601 timespan duration of - * the key frame interval duration. - * @member {string} [accessToken] A unique identifier for a stream. This can - * be specified at creation time but cannot be updated. If omitted, the - * service will generate a unique value. - * @member {array} [endpoints] The input endpoints for the Live Event. - */ +*/ export interface LiveEventInput { + /** + * The streaming protocol for the Live Event. This is specified at creation time and cannot be + * updated. Possible values include: 'FragmentedMP4', 'RTMP' + */ streamingProtocol: string; + /** + * The access control for LiveEvent Input. + */ accessControl?: LiveEventInputAccessControl; + /** + * ISO 8601 timespan duration of the key frame interval duration. + */ keyFrameIntervalDuration?: string; + /** + * A unique identifier for a stream. This can be specified at creation time but cannot be + * updated. If omitted, the service will generate a unique value. + */ accessToken?: string; + /** + * The input endpoints for the Live Event. + */ endpoints?: LiveEventEndpoint[]; } /** - * @class - * Initializes a new instance of the LiveEventPreviewAccessControl class. - * @constructor * The IP access control for Live Event preview. - * - * @member {object} [ip] The IP access control properties. - * @member {array} [ip.allow] The IP allow list. - */ +*/ export interface LiveEventPreviewAccessControl { + /** + * The IP access control properties. + */ ip?: IPAccessControl; } /** - * @class - * Initializes a new instance of the LiveEventPreview class. - * @constructor * The Live Event preview. - * - * @member {array} [endpoints] The endpoints for preview. - * @member {object} [accessControl] The access control for LiveEvent preview. - * @member {object} [accessControl.ip] The IP access control properties. - * @member {array} [accessControl.ip.allow] The IP allow list. - * @member {string} [previewLocator] The identifier of the preview locator in - * Guid format. Specifying this at creation time allows the caller to know the - * preview locator url before the event is created. If omitted, the service - * will generate a random identifier. This value cannot be updated once the - * live event is created. - * @member {string} [streamingPolicyName] The name of streaming policy used for - * the LiveEvent preview. This value is specified at creation time and cannot - * be updated. - * @member {string} [alternativeMediaId] An Alternative Media Identifier - * associated with the StreamingLocator created for the preview. This value is - * specified at creation time and cannot be updated. The identifier can be - * used in the CustomLicenseAcquisitionUrlTemplate or the - * CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the - * StreamingPolicyName field. - */ +*/ export interface LiveEventPreview { + /** + * The endpoints for preview. + */ endpoints?: LiveEventEndpoint[]; + /** + * The access control for LiveEvent preview. + */ accessControl?: LiveEventPreviewAccessControl; + /** + * The identifier of the preview locator in Guid format. Specifying this at creation time allows + * the caller to know the preview locator url before the event is created. If omitted, the + * service will generate a random identifier. This value cannot be updated once the live event + * is created. + */ previewLocator?: string; + /** + * The name of streaming policy used for the LiveEvent preview. This value is specified at + * creation time and cannot be updated. + */ streamingPolicyName?: string; + /** + * An Alternative Media Identifier associated with the StreamingLocator created for the preview. + * This value is specified at creation time and cannot be updated. The identifier can be used in + * the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the + * StreamingPolicy specified in the StreamingPolicyName field. + */ alternativeMediaId?: string; } /** - * @class - * Initializes a new instance of the LiveEventEncoding class. - * @constructor * The Live Event encoding. - * - * @member {string} [encodingType] The encoding type for Live Event. This - * value is specified at creation time and cannot be updated. Possible values - * include: 'None', 'Basic' - * @member {string} [presetName] The encoding preset name. This value is - * specified at creation time and cannot be updated. - */ +*/ export interface LiveEventEncoding { + /** + * The encoding type for Live Event. This value is specified at creation time and cannot be + * updated. Possible values include: 'None', 'Basic' + */ encodingType?: string; + /** + * The encoding preset name. This value is specified at creation time and cannot be updated. + */ presetName?: string; } /** - * @class - * Initializes a new instance of the CrossSiteAccessPolicies class. - * @constructor * The client access policy. - * - * @member {string} [clientAccessPolicy] The content of clientaccesspolicy.xml - * used by Silverlight. - * @member {string} [crossDomainPolicy] The content of crossdomain.xml used by - * Silverlight. - */ +*/ export interface CrossSiteAccessPolicies { + /** + * The content of clientaccesspolicy.xml used by Silverlight. + */ clientAccessPolicy?: string; + /** + * The content of crossdomain.xml used by Silverlight. + */ crossDomainPolicy?: string; } /** - * @class - * Initializes a new instance of the LiveEventActionInput class. - * @constructor * The LiveEvent action input parameter definition. - * - * @member {boolean} [removeOutputsOnStop] The flag indicates if remove - * LiveOutputs on Stop. - */ +*/ export interface LiveEventActionInput { + /** + * The flag indicates if remove LiveOutputs on Stop. + */ removeOutputsOnStop?: boolean; } /** - * @class - * Initializes a new instance of the LiveEvent class. - * @constructor * The Live Event. - * - * @member {string} [description] The Live Event description. - * @member {object} input The Live Event input. - * @member {string} [input.streamingProtocol] The streaming protocol for the - * Live Event. This is specified at creation time and cannot be updated. - * Possible values include: 'FragmentedMP4', 'RTMP' - * @member {object} [input.accessControl] The access control for LiveEvent - * Input. - * @member {object} [input.accessControl.ip] The IP access control properties. - * @member {array} [input.accessControl.ip.allow] The IP allow list. - * @member {string} [input.keyFrameIntervalDuration] ISO 8601 timespan duration - * of the key frame interval duration. - * @member {string} [input.accessToken] A unique identifier for a stream. This - * can be specified at creation time but cannot be updated. If omitted, the - * service will generate a unique value. - * @member {array} [input.endpoints] The input endpoints for the Live Event. - * @member {object} [preview] The Live Event preview. - * @member {array} [preview.endpoints] The endpoints for preview. - * @member {object} [preview.accessControl] The access control for LiveEvent - * preview. - * @member {object} [preview.accessControl.ip] The IP access control - * properties. - * @member {array} [preview.accessControl.ip.allow] The IP allow list. - * @member {string} [preview.previewLocator] The identifier of the preview - * locator in Guid format. Specifying this at creation time allows the caller - * to know the preview locator url before the event is created. If omitted, - * the service will generate a random identifier. This value cannot be updated - * once the live event is created. - * @member {string} [preview.streamingPolicyName] The name of streaming policy - * used for the LiveEvent preview. This value is specified at creation time - * and cannot be updated. - * @member {string} [preview.alternativeMediaId] An Alternative Media - * Identifier associated with the StreamingLocator created for the preview. - * This value is specified at creation time and cannot be updated. The - * identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the - * CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the - * StreamingPolicyName field. - * @member {object} [encoding] The Live Event encoding. - * @member {string} [encoding.encodingType] The encoding type for Live Event. - * This value is specified at creation time and cannot be updated. Possible - * values include: 'None', 'Basic' - * @member {string} [encoding.presetName] The encoding preset name. This value - * is specified at creation time and cannot be updated. - * @member {string} [provisioningState] The provisioning state of the Live - * Event. - * @member {string} [resourceState] The resource state of the Live Event. - * Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping', - * 'Deleting' - * @member {object} [crossSiteAccessPolicies] The Live Event access policies. - * @member {string} [crossSiteAccessPolicies.clientAccessPolicy] The content of - * clientaccesspolicy.xml used by Silverlight. - * @member {string} [crossSiteAccessPolicies.crossDomainPolicy] The content of - * crossdomain.xml used by Silverlight. - * @member {boolean} [vanityUrl] Specifies whether to use a vanity url with the - * Live Event. This value is specified at creation time and cannot be updated. - * @member {array} [streamOptions] The options to use for the LiveEvent. This - * value is specified at creation time and cannot be updated. - * @member {date} [created] The exact time the Live Event was created. - * @member {date} [lastModified] The exact time the Live Event was last - * modified. - */ +*/ export interface LiveEvent extends TrackedResource { + /** + * The Live Event description. + */ description?: string; + /** + * The Live Event input. + */ input: LiveEventInput; + /** + * The Live Event preview. + */ preview?: LiveEventPreview; + /** + * The Live Event encoding. + */ encoding?: LiveEventEncoding; + /** + * The provisioning state of the Live Event. + */ readonly provisioningState?: string; + /** + * The resource state of the Live Event. Possible values include: 'Stopped', 'Starting', + * 'Running', 'Stopping', 'Deleting' + */ readonly resourceState?: string; + /** + * The Live Event access policies. + */ crossSiteAccessPolicies?: CrossSiteAccessPolicies; + /** + * Specifies whether to use a vanity url with the Live Event. This value is specified at + * creation time and cannot be updated. + */ vanityUrl?: boolean; + /** + * The options to use for the LiveEvent. This value is specified at creation time and cannot be + * updated. + */ streamOptions?: string[]; + /** + * The exact time the Live Event was created. + */ readonly created?: Date; + /** + * The exact time the Live Event was last modified. + */ readonly lastModified?: Date; } /** - * @class - * Initializes a new instance of the AkamaiSignatureHeaderAuthenticationKey class. - * @constructor * Akamai Signature Header authentication key. - * - * @member {string} [identifier] identifier of the key - * @member {string} [base64Key] authentication key - * @member {date} [expiration] The expiration time of the authentication key. - */ +*/ export interface AkamaiSignatureHeaderAuthenticationKey { + /** + * identifier of the key + */ identifier?: string; + /** + * authentication key + */ base64Key?: string; + /** + * The expiration time of the authentication key. + */ expiration?: Date; } /** - * @class - * Initializes a new instance of the AkamaiAccessControl class. - * @constructor * Akamai access control - * - * @member {array} [akamaiSignatureHeaderAuthenticationKeyList] authentication - * key list - */ +*/ export interface AkamaiAccessControl { + /** + * authentication key list + */ akamaiSignatureHeaderAuthenticationKeyList?: AkamaiSignatureHeaderAuthenticationKey[]; } /** - * @class - * Initializes a new instance of the StreamingEndpointAccessControl class. - * @constructor * StreamingEndpoint access control definition. - * - * @member {object} [akamai] The access control of Akamai - * @member {array} [akamai.akamaiSignatureHeaderAuthenticationKeyList] - * authentication key list - * @member {object} [ip] The IP access control of the StreamingEndpoint. - * @member {array} [ip.allow] The IP allow list. - */ +*/ export interface StreamingEndpointAccessControl { + /** + * The access control of Akamai + */ akamai?: AkamaiAccessControl; + /** + * The IP access control of the StreamingEndpoint. + */ ip?: IPAccessControl; } /** - * @class - * Initializes a new instance of the StreamingEntityScaleUnit class. - * @constructor * scale units definition - * - * @member {number} [scaleUnit] The scale unit number of the StreamingEndpoint. - */ +*/ export interface StreamingEntityScaleUnit { + /** + * The scale unit number of the StreamingEndpoint. + */ scaleUnit?: number; } /** - * @class - * Initializes a new instance of the StreamingEndpoint class. - * @constructor * The StreamingEndpoint. - * - * @member {string} [description] The StreamingEndpoint description. - * @member {number} scaleUnits The number of scale units. Use the Scale - * operation to adjust this value. - * @member {string} [availabilitySetName] The name of the AvailabilitySet used - * with this StreamingEndpoint for high availability streaming. This value can - * only be set at creation time. - * @member {object} [accessControl] The access control definition of the - * StreamingEndpoint. - * @member {object} [accessControl.akamai] The access control of Akamai - * @member {array} - * [accessControl.akamai.akamaiSignatureHeaderAuthenticationKeyList] - * authentication key list - * @member {object} [accessControl.ip] The IP access control of the - * StreamingEndpoint. - * @member {array} [accessControl.ip.allow] The IP allow list. - * @member {number} [maxCacheAge] Max cache age - * @member {array} [customHostNames] The custom host names of the - * StreamingEndpoint - * @member {string} [hostName] The StreamingEndpoint host name. - * @member {boolean} [cdnEnabled] The CDN enabled flag. - * @member {string} [cdnProvider] The CDN provider name. - * @member {string} [cdnProfile] The CDN profile name. - * @member {string} [provisioningState] The provisioning state of the - * StreamingEndpoint. - * @member {string} [resourceState] The resource state of the - * StreamingEndpoint. Possible values include: 'Stopped', 'Starting', - * 'Running', 'Stopping', 'Deleting', 'Scaling' - * @member {object} [crossSiteAccessPolicies] The StreamingEndpoint access - * policies. - * @member {string} [crossSiteAccessPolicies.clientAccessPolicy] The content of - * clientaccesspolicy.xml used by Silverlight. - * @member {string} [crossSiteAccessPolicies.crossDomainPolicy] The content of - * crossdomain.xml used by Silverlight. - * @member {date} [freeTrialEndTime] The free trial expiration time. - * @member {date} [created] The exact time the StreamingEndpoint was created. - * @member {date} [lastModified] The exact time the StreamingEndpoint was last - * modified. - */ +*/ export interface StreamingEndpoint extends TrackedResource { + /** + * The StreamingEndpoint description. + */ description?: string; + /** + * The number of scale units. Use the Scale operation to adjust this value. + */ scaleUnits: number; + /** + * The name of the AvailabilitySet used with this StreamingEndpoint for high availability + * streaming. This value can only be set at creation time. + */ availabilitySetName?: string; + /** + * The access control definition of the StreamingEndpoint. + */ accessControl?: StreamingEndpointAccessControl; + /** + * Max cache age + */ maxCacheAge?: number; + /** + * The custom host names of the StreamingEndpoint + */ customHostNames?: string[]; + /** + * The StreamingEndpoint host name. + */ readonly hostName?: string; + /** + * The CDN enabled flag. + */ cdnEnabled?: boolean; + /** + * The CDN provider name. + */ cdnProvider?: string; + /** + * The CDN profile name. + */ cdnProfile?: string; + /** + * The provisioning state of the StreamingEndpoint. + */ readonly provisioningState?: string; + /** + * The resource state of the StreamingEndpoint. Possible values include: 'Stopped', 'Starting', + * 'Running', 'Stopping', 'Deleting', 'Scaling' + */ readonly resourceState?: string; + /** + * The StreamingEndpoint access policies. + */ crossSiteAccessPolicies?: CrossSiteAccessPolicies; + /** + * The free trial expiration time. + */ readonly freeTrialEndTime?: Date; + /** + * The exact time the StreamingEndpoint was created. + */ readonly created?: Date; + /** + * The exact time the StreamingEndpoint was last modified. + */ readonly lastModified?: Date; } - /** - * @class - * Initializes a new instance of the AccountFilterCollection class. - * @constructor * A collection of AccountFilter items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface AccountFilterCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the OperationCollection class. - * @constructor * A collection of Operation items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface OperationCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the MediaServiceCollection class. - * @constructor * A collection of MediaService items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface MediaServiceCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the SubscriptionMediaServiceCollection class. - * @constructor * A collection of SubscriptionMediaService items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface SubscriptionMediaServiceCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the AssetCollection class. - * @constructor * A collection of Asset items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface AssetCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the AssetFilterCollection class. - * @constructor * A collection of AssetFilter items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface AssetFilterCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the ContentKeyPolicyCollection class. - * @constructor * A collection of ContentKeyPolicy items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface ContentKeyPolicyCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the TransformCollection class. - * @constructor * A collection of Transform items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface TransformCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the JobCollection class. - * @constructor * A collection of Job items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface JobCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the StreamingPolicyCollection class. - * @constructor * A collection of StreamingPolicy items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface StreamingPolicyCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the StreamingLocatorCollection class. - * @constructor * A collection of StreamingLocator items. - * - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). - */ +*/ export interface StreamingLocatorCollection extends Array { + /** + * A link to the next page of the collection (when the collection contains too many results to + * return in one response). + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the LiveEventListResult class. - * @constructor * @summary LiveEventListResult - * - * The LiveEvent list result. - * - * @member {number} [odatacount] The number of result. - * @member {string} [odatanextLink] Th link to the next set of results. Not - * empty if value contains incomplete list of Live Outputs. - */ + * @description The LiveEvent list result. +*/ export interface LiveEventListResult extends Array { + /** + * Th link to the next set of results. Not empty if value contains incomplete list of Live + * Outputs. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the LiveOutputListResult class. - * @constructor * @summary LiveOutputListResult - * - * The LiveOutput list result. - * - * @member {number} [odatacount] The number of result. - * @member {string} [odatanextLink] Th link to the next set of results. Not - * empty if value contains incomplete list of Live Outputs. - */ + * @description The LiveOutput list result. +*/ export interface LiveOutputListResult extends Array { + /** + * Th link to the next set of results. Not empty if value contains incomplete list of Live + * Outputs. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the StreamingEndpointListResult class. - * @constructor * @summary StreamingEndpointListResult - * - * The StreamingEndpoint list result. - * - * @member {number} [odatacount] The number of result. - * @member {string} [odatanextLink] Th link to the next set of results. Not - * empty if value contains incomplete list of StreamingEndpoints. - */ + * @description The StreamingEndpoint list result. +*/ export interface StreamingEndpointListResult extends Array { + /** + * Th link to the next set of results. Not empty if value contains incomplete list of + * StreamingEndpoints. + */ odatanextLink?: string; } diff --git a/lib/services/mediaServicesManagement/lib/models/job.js b/lib/services/mediaServicesManagement/lib/models/job.js index ac3677dc6e..4ba78ddce3 100644 --- a/lib/services/mediaServicesManagement/lib/models/job.js +++ b/lib/services/mediaServicesManagement/lib/models/job.js @@ -21,24 +21,24 @@ const models = require('./index'); class Job extends models['ProxyResource'] { /** * Create a Job. - * @member {date} [created] The UTC date and time when the Job was created, + * @property {date} [created] The UTC date and time when the Job was created, * in 'YYYY-MM-DDThh:mm:ssZ' format. - * @member {string} [state] The current state of the job. Possible values + * @property {string} [state] The current state of the job. Possible values * include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', * 'Queued', 'Scheduled' - * @member {string} [description] Optional customer supplied description of + * @property {string} [description] Optional customer supplied description of * the Job. - * @member {object} input The inputs for the Job. - * @member {string} [input.odatatype] Polymorphic Discriminator - * @member {date} [lastModified] The UTC date and time when the Job was last - * updated, in 'YYYY-MM-DDThh:mm:ssZ' format. - * @member {array} outputs The outputs for the Job. - * @member {string} [priority] Priority with which the job should be + * @property {object} input The inputs for the Job. + * @property {string} [input.odatatype] Polymorphic Discriminator + * @property {date} [lastModified] The UTC date and time when the Job was + * last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. + * @property {array} outputs The outputs for the Job. + * @property {string} [priority] Priority with which the job should be * processed. Higher priority jobs are processed before lower priority jobs. * If not set, the default is normal. Possible values include: 'Low', * 'Normal', 'High' - * @member {object} [correlationData] Customer provided correlation data that - * will be returned in Job and JobOutput state events. + * @property {object} [correlationData] Customer provided correlation data + * that will be returned in Job and JobOutput state events. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/jobCollection.js b/lib/services/mediaServicesManagement/lib/models/jobCollection.js index ae490c686f..d214490ade 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/jobCollection.js @@ -16,8 +16,9 @@ class JobCollection extends Array { /** * Create a JobCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/jobError.js b/lib/services/mediaServicesManagement/lib/models/jobError.js index 57c7703a42..87dd2f9cb0 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobError.js +++ b/lib/services/mediaServicesManagement/lib/models/jobError.js @@ -17,19 +17,19 @@ class JobError { /** * Create a JobError. - * @member {string} [code] Error code describing the error. Possible values + * @property {string} [code] Error code describing the error. Possible values * include: 'ServiceError', 'ServiceTransientError', 'DownloadNotAccessible', * 'DownloadTransientError', 'UploadNotAccessible', 'UploadTransientError', * 'ConfigurationUnsupported', 'ContentMalformed', 'ContentUnsupported' - * @member {string} [message] A human-readable language-dependent + * @property {string} [message] A human-readable language-dependent * representation of the error. - * @member {string} [category] Helps with categorization of errors. Possible - * values include: 'Service', 'Download', 'Upload', 'Configuration', + * @property {string} [category] Helps with categorization of errors. + * Possible values include: 'Service', 'Download', 'Upload', 'Configuration', * 'Content' - * @member {string} [retry] Indicates that it may be possible to retry the + * @property {string} [retry] Indicates that it may be possible to retry the * Job. If retry is unsuccessful, please contact Azure support via Azure * Portal. Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [details] An array of details about specific errors that + * @property {array} [details] An array of details about specific errors that * led to this reported error. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/jobErrorDetail.js b/lib/services/mediaServicesManagement/lib/models/jobErrorDetail.js index 95b16c6d6f..a62518d781 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobErrorDetail.js +++ b/lib/services/mediaServicesManagement/lib/models/jobErrorDetail.js @@ -17,8 +17,8 @@ class JobErrorDetail { /** * Create a JobErrorDetail. - * @member {string} [code] Code describing the error detail. - * @member {string} [message] A human-readable representation of the error. + * @property {string} [code] Code describing the error detail. + * @property {string} [message] A human-readable representation of the error. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/jobInput.js b/lib/services/mediaServicesManagement/lib/models/jobInput.js index 97d4988679..c508e644bf 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobInput.js +++ b/lib/services/mediaServicesManagement/lib/models/jobInput.js @@ -17,7 +17,7 @@ class JobInput { /** * Create a JobInput. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/jobInputAsset.js b/lib/services/mediaServicesManagement/lib/models/jobInputAsset.js index d86b44a912..90ae0d1a8c 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobInputAsset.js +++ b/lib/services/mediaServicesManagement/lib/models/jobInputAsset.js @@ -20,7 +20,7 @@ const models = require('./index'); class JobInputAsset extends models['JobInputClip'] { /** * Create a JobInputAsset. - * @member {string} assetName The name of the input Asset. + * @property {string} assetName The name of the input Asset. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/jobInputClip.js b/lib/services/mediaServicesManagement/lib/models/jobInputClip.js index d97e599b9e..467f497cef 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobInputClip.js +++ b/lib/services/mediaServicesManagement/lib/models/jobInputClip.js @@ -20,9 +20,9 @@ const models = require('./index'); class JobInputClip extends models['JobInput'] { /** * Create a JobInputClip. - * @member {array} [files] List of files. Required for JobInputHttp. - * @member {string} [label] A label that is assigned to a JobInputClip, that - * is used to satisfy a reference used in the Transform. For example, a + * @property {array} [files] List of files. Required for JobInputHttp. + * @property {string} [label] A label that is assigned to a JobInputClip, + * that is used to satisfy a reference used in the Transform. For example, a * Transform can be authored so as to take an image file with the label 'xyz' * and apply it as an overlay onto the input video before it is encoded. When * submitting a Job, exactly one of the JobInputs should be the image file, diff --git a/lib/services/mediaServicesManagement/lib/models/jobInputHttp.js b/lib/services/mediaServicesManagement/lib/models/jobInputHttp.js index 55958106d0..d07b2b85ac 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobInputHttp.js +++ b/lib/services/mediaServicesManagement/lib/models/jobInputHttp.js @@ -20,7 +20,7 @@ const models = require('./index'); class JobInputHttp extends models['JobInputClip'] { /** * Create a JobInputHttp. - * @member {string} [baseUri] Base URI for HTTPS job input. It will be + * @property {string} [baseUri] Base URI for HTTPS job input. It will be * concatenated with provided file names. If no base uri is given, then the * provided file list is assumed to be fully qualified uris. */ diff --git a/lib/services/mediaServicesManagement/lib/models/jobInputs.js b/lib/services/mediaServicesManagement/lib/models/jobInputs.js index 2ae98fa5de..11be9cf277 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobInputs.js +++ b/lib/services/mediaServicesManagement/lib/models/jobInputs.js @@ -13,14 +13,14 @@ const models = require('./index'); /** - * Describes a list of of inputs to a Job. + * Describes a list of inputs to a Job. * * @extends models['JobInput'] */ class JobInputs extends models['JobInput'] { /** * Create a JobInputs. - * @member {array} [inputs] List of inputs to a Job. + * @property {array} [inputs] List of inputs to a Job. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/jobOutput.js b/lib/services/mediaServicesManagement/lib/models/jobOutput.js index 6b5699f157..ad1ddb9403 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobOutput.js +++ b/lib/services/mediaServicesManagement/lib/models/jobOutput.js @@ -17,43 +17,44 @@ class JobOutput { /** * Create a JobOutput. - * @member {object} [error] If the JobOutput is in the Error state, it + * @property {object} [error] If the JobOutput is in the Error state, it * contains the details of the error. - * @member {string} [error.code] Error code describing the error. Possible + * @property {string} [error.code] Error code describing the error. Possible * values include: 'ServiceError', 'ServiceTransientError', * 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', * 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', * 'ContentUnsupported' - * @member {string} [error.message] A human-readable language-dependent + * @property {string} [error.message] A human-readable language-dependent * representation of the error. - * @member {string} [error.category] Helps with categorization of errors. + * @property {string} [error.category] Helps with categorization of errors. * Possible values include: 'Service', 'Download', 'Upload', 'Configuration', * 'Content' - * @member {string} [error.retry] Indicates that it may be possible to retry - * the Job. If retry is unsuccessful, please contact Azure support via Azure - * Portal. Possible values include: 'DoNotRetry', 'MayRetry' - * @member {array} [error.details] An array of details about specific errors - * that led to this reported error. - * @member {string} [state] Describes the state of the JobOutput. Possible + * @property {string} [error.retry] Indicates that it may be possible to + * retry the Job. If retry is unsuccessful, please contact Azure support via + * Azure Portal. Possible values include: 'DoNotRetry', 'MayRetry' + * @property {array} [error.details] An array of details about specific + * errors that led to this reported error. + * @property {string} [state] Describes the state of the JobOutput. Possible * values include: 'Canceled', 'Canceling', 'Error', 'Finished', * 'Processing', 'Queued', 'Scheduled' - * @member {number} [progress] If the JobOutput is in a Processing state, + * @property {number} [progress] If the JobOutput is in a Processing state, * this contains the Job completion percentage. The value is an estimate and * not intended to be used to predict Job completion times. To determine if * the JobOutput is complete, use the State property. - * @member {string} [label] A label that is assigned to a JobOutput in order - * to help uniquely identify it. This is useful when your Transform has more - * than one TransformOutput, whereby your Job has more than one JobOutput. In - * such cases, when you submit the Job, you will add two or more JobOutputs, - * in the same order as TransformOutputs in the Transform. Subsequently, when - * you retrieve the Job, either through events or on a GET request, you can - * use the label to easily identify the JobOutput. If a label is not - * provided, a default value of '{presetName}_{outputIndex}' will be used, - * where the preset name is the name of the preset in the corresponding - * TransformOutput and the output index is the relative index of the this - * JobOutput within the Job. Note that this index is the same as the relative - * index of the corresponding TransformOutput within its Transform. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} [label] A label that is assigned to a JobOutput in + * order to help uniquely identify it. This is useful when your Transform has + * more than one TransformOutput, whereby your Job has more than one + * JobOutput. In such cases, when you submit the Job, you will add two or + * more JobOutputs, in the same order as TransformOutputs in the Transform. + * Subsequently, when you retrieve the Job, either through events or on a GET + * request, you can use the label to easily identify the JobOutput. If a + * label is not provided, a default value of '{presetName}_{outputIndex}' + * will be used, where the preset name is the name of the preset in the + * corresponding TransformOutput and the output index is the relative index + * of the this JobOutput within the Job. Note that this index is the same as + * the relative index of the corresponding TransformOutput within its + * Transform. + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/jobOutputAsset.js b/lib/services/mediaServicesManagement/lib/models/jobOutputAsset.js index 98b2b3ee0c..0270e02478 100644 --- a/lib/services/mediaServicesManagement/lib/models/jobOutputAsset.js +++ b/lib/services/mediaServicesManagement/lib/models/jobOutputAsset.js @@ -20,7 +20,7 @@ const models = require('./index'); class JobOutputAsset extends models['JobOutput'] { /** * Create a JobOutputAsset. - * @member {string} assetName The name of the output Asset. + * @property {string} assetName The name of the output Asset. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/jpgImage.js b/lib/services/mediaServicesManagement/lib/models/jpgImage.js index d10e8ff30e..5c022773ff 100644 --- a/lib/services/mediaServicesManagement/lib/models/jpgImage.js +++ b/lib/services/mediaServicesManagement/lib/models/jpgImage.js @@ -21,7 +21,7 @@ const models = require('./index'); class JpgImage extends models['Image'] { /** * Create a JpgImage. - * @member {array} [layers] A collection of output JPEG image layers to be + * @property {array} [layers] A collection of output JPEG image layers to be * produced by the encoder. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/jpgLayer.js b/lib/services/mediaServicesManagement/lib/models/jpgLayer.js index 82c328bfc4..91fdcbd1ae 100644 --- a/lib/services/mediaServicesManagement/lib/models/jpgLayer.js +++ b/lib/services/mediaServicesManagement/lib/models/jpgLayer.js @@ -20,7 +20,7 @@ const models = require('./index'); class JpgLayer extends models['Layer'] { /** * Create a JpgLayer. - * @member {number} [quality] The compression quality of the JPEG output. + * @property {number} [quality] The compression quality of the JPEG output. * Range is from 0-100 and the default is 70. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/layer.js b/lib/services/mediaServicesManagement/lib/models/layer.js index 4d0920bf6a..be7fd48c1a 100644 --- a/lib/services/mediaServicesManagement/lib/models/layer.js +++ b/lib/services/mediaServicesManagement/lib/models/layer.js @@ -19,17 +19,18 @@ class Layer { /** * Create a Layer. - * @member {string} [width] The width of the output video for this layer. The - * value can be absolute (in pixels) or relative (in percentage). For example - * 50% means the output video has half as many pixels in width as the input. - * @member {string} [height] The height of the output video for this layer. + * @property {string} [width] The width of the output video for this layer. + * The value can be absolute (in pixels) or relative (in percentage). For + * example 50% means the output video has half as many pixels in width as the + * input. + * @property {string} [height] The height of the output video for this layer. * The value can be absolute (in pixels) or relative (in percentage). For * example 50% means the output video has half as many pixels in height as * the input. - * @member {string} [label] The alphanumeric label for this layer, which can - * be used in multiplexing different video and audio layers, or in naming the - * output file. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} [label] The alphanumeric label for this layer, which + * can be used in multiplexing different video and audio layers, or in naming + * the output file. + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/listContainerSasInput.js b/lib/services/mediaServicesManagement/lib/models/listContainerSasInput.js index b57953d33a..889f7f6cc5 100644 --- a/lib/services/mediaServicesManagement/lib/models/listContainerSasInput.js +++ b/lib/services/mediaServicesManagement/lib/models/listContainerSasInput.js @@ -17,9 +17,9 @@ class ListContainerSasInput { /** * Create a ListContainerSasInput. - * @member {string} [permissions] The permissions to set on the SAS URL. + * @property {string} [permissions] The permissions to set on the SAS URL. * Possible values include: 'Read', 'ReadWrite', 'ReadWriteDelete' - * @member {date} [expiryTime] The SAS URL expiration time. This must be + * @property {date} [expiryTime] The SAS URL expiration time. This must be * less than 24 hours from the current time. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/listContentKeysResponse.js b/lib/services/mediaServicesManagement/lib/models/listContentKeysResponse.js index de0d1fdb0f..1aac7a08e9 100644 --- a/lib/services/mediaServicesManagement/lib/models/listContentKeysResponse.js +++ b/lib/services/mediaServicesManagement/lib/models/listContentKeysResponse.js @@ -17,7 +17,7 @@ class ListContentKeysResponse { /** * Create a ListContentKeysResponse. - * @member {array} [contentKeys] ContentKeys used by current Streaming + * @property {array} [contentKeys] ContentKeys used by current Streaming * Locator */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/listPathsResponse.js b/lib/services/mediaServicesManagement/lib/models/listPathsResponse.js index 15c813856e..7dfc2db21d 100644 --- a/lib/services/mediaServicesManagement/lib/models/listPathsResponse.js +++ b/lib/services/mediaServicesManagement/lib/models/listPathsResponse.js @@ -17,9 +17,9 @@ class ListPathsResponse { /** * Create a ListPathsResponse. - * @member {array} [streamingPaths] Streaming Paths supported by current + * @property {array} [streamingPaths] Streaming Paths supported by current * Streaming Locator - * @member {array} [downloadPaths] Download Paths supported by current + * @property {array} [downloadPaths] Download Paths supported by current * Streaming Locator */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/listStreamingLocatorsResponse.js b/lib/services/mediaServicesManagement/lib/models/listStreamingLocatorsResponse.js index 9533ab636c..061e3d43a2 100644 --- a/lib/services/mediaServicesManagement/lib/models/listStreamingLocatorsResponse.js +++ b/lib/services/mediaServicesManagement/lib/models/listStreamingLocatorsResponse.js @@ -17,7 +17,7 @@ class ListStreamingLocatorsResponse { /** * Create a ListStreamingLocatorsResponse. - * @member {array} [streamingLocators] The list of Streaming Locators. + * @property {array} [streamingLocators] The list of Streaming Locators. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/liveEvent.js b/lib/services/mediaServicesManagement/lib/models/liveEvent.js index c5a0e1b180..d9cbb8e921 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveEvent.js +++ b/lib/services/mediaServicesManagement/lib/models/liveEvent.js @@ -20,66 +20,68 @@ const models = require('./index'); class LiveEvent extends models['TrackedResource'] { /** * Create a LiveEvent. - * @member {string} [description] The Live Event description. - * @member {object} input The Live Event input. - * @member {string} [input.streamingProtocol] The streaming protocol for the - * Live Event. This is specified at creation time and cannot be updated. + * @property {string} [description] The Live Event description. + * @property {object} input The Live Event input. + * @property {string} [input.streamingProtocol] The streaming protocol for + * the Live Event. This is specified at creation time and cannot be updated. * Possible values include: 'FragmentedMP4', 'RTMP' - * @member {object} [input.accessControl] The access control for LiveEvent + * @property {object} [input.accessControl] The access control for LiveEvent * Input. - * @member {object} [input.accessControl.ip] The IP access control + * @property {object} [input.accessControl.ip] The IP access control * properties. - * @member {array} [input.accessControl.ip.allow] The IP allow list. - * @member {string} [input.keyFrameIntervalDuration] ISO 8601 timespan + * @property {array} [input.accessControl.ip.allow] The IP allow list. + * @property {string} [input.keyFrameIntervalDuration] ISO 8601 timespan * duration of the key frame interval duration. - * @member {string} [input.accessToken] A unique identifier for a stream. + * @property {string} [input.accessToken] A unique identifier for a stream. * This can be specified at creation time but cannot be updated. If omitted, * the service will generate a unique value. - * @member {array} [input.endpoints] The input endpoints for the Live Event. - * @member {object} [preview] The Live Event preview. - * @member {array} [preview.endpoints] The endpoints for preview. - * @member {object} [preview.accessControl] The access control for LiveEvent - * preview. - * @member {object} [preview.accessControl.ip] The IP access control + * @property {array} [input.endpoints] The input endpoints for the Live + * Event. + * @property {object} [preview] The Live Event preview. + * @property {array} [preview.endpoints] The endpoints for preview. + * @property {object} [preview.accessControl] The access control for + * LiveEvent preview. + * @property {object} [preview.accessControl.ip] The IP access control * properties. - * @member {array} [preview.accessControl.ip.allow] The IP allow list. - * @member {string} [preview.previewLocator] The identifier of the preview + * @property {array} [preview.accessControl.ip.allow] The IP allow list. + * @property {string} [preview.previewLocator] The identifier of the preview * locator in Guid format. Specifying this at creation time allows the * caller to know the preview locator url before the event is created. If * omitted, the service will generate a random identifier. This value cannot * be updated once the live event is created. - * @member {string} [preview.streamingPolicyName] The name of streaming + * @property {string} [preview.streamingPolicyName] The name of streaming * policy used for the LiveEvent preview. This value is specified at * creation time and cannot be updated. - * @member {string} [preview.alternativeMediaId] An Alternative Media + * @property {string} [preview.alternativeMediaId] An Alternative Media * Identifier associated with the StreamingLocator created for the preview. * This value is specified at creation time and cannot be updated. The * identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the * CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the * StreamingPolicyName field. - * @member {object} [encoding] The Live Event encoding. - * @member {string} [encoding.encodingType] The encoding type for Live Event. - * This value is specified at creation time and cannot be updated. Possible - * values include: 'None', 'Basic' - * @member {string} [encoding.presetName] The encoding preset name. This + * @property {object} [encoding] The Live Event encoding. + * @property {string} [encoding.encodingType] The encoding type for Live + * Event. This value is specified at creation time and cannot be updated. + * Possible values include: 'None', 'Basic' + * @property {string} [encoding.presetName] The encoding preset name. This * value is specified at creation time and cannot be updated. - * @member {string} [provisioningState] The provisioning state of the Live + * @property {string} [provisioningState] The provisioning state of the Live * Event. - * @member {string} [resourceState] The resource state of the Live Event. + * @property {string} [resourceState] The resource state of the Live Event. * Possible values include: 'Stopped', 'Starting', 'Running', 'Stopping', * 'Deleting' - * @member {object} [crossSiteAccessPolicies] The Live Event access policies. - * @member {string} [crossSiteAccessPolicies.clientAccessPolicy] The content - * of clientaccesspolicy.xml used by Silverlight. - * @member {string} [crossSiteAccessPolicies.crossDomainPolicy] The content + * @property {object} [crossSiteAccessPolicies] The Live Event access + * policies. + * @property {string} [crossSiteAccessPolicies.clientAccessPolicy] The + * content of clientaccesspolicy.xml used by Silverlight. + * @property {string} [crossSiteAccessPolicies.crossDomainPolicy] The content * of crossdomain.xml used by Silverlight. - * @member {boolean} [vanityUrl] Specifies whether to use a vanity url with + * @property {boolean} [vanityUrl] Specifies whether to use a vanity url with * the Live Event. This value is specified at creation time and cannot be * updated. - * @member {array} [streamOptions] The options to use for the LiveEvent. + * @property {array} [streamOptions] The options to use for the LiveEvent. * This value is specified at creation time and cannot be updated. - * @member {date} [created] The exact time the Live Event was created. - * @member {date} [lastModified] The exact time the Live Event was last + * @property {date} [created] The exact time the Live Event was created. + * @property {date} [lastModified] The exact time the Live Event was last * modified. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/liveEventActionInput.js b/lib/services/mediaServicesManagement/lib/models/liveEventActionInput.js index c72c3c97ca..83b200df6f 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveEventActionInput.js +++ b/lib/services/mediaServicesManagement/lib/models/liveEventActionInput.js @@ -17,7 +17,7 @@ class LiveEventActionInput { /** * Create a LiveEventActionInput. - * @member {boolean} [removeOutputsOnStop] The flag indicates if remove + * @property {boolean} [removeOutputsOnStop] The flag indicates if remove * LiveOutputs on Stop. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/liveEventEncoding.js b/lib/services/mediaServicesManagement/lib/models/liveEventEncoding.js index 56714adbf0..96d2cc7992 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveEventEncoding.js +++ b/lib/services/mediaServicesManagement/lib/models/liveEventEncoding.js @@ -17,10 +17,10 @@ class LiveEventEncoding { /** * Create a LiveEventEncoding. - * @member {string} [encodingType] The encoding type for Live Event. This + * @property {string} [encodingType] The encoding type for Live Event. This * value is specified at creation time and cannot be updated. Possible values * include: 'None', 'Basic' - * @member {string} [presetName] The encoding preset name. This value is + * @property {string} [presetName] The encoding preset name. This value is * specified at creation time and cannot be updated. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/liveEventEndpoint.js b/lib/services/mediaServicesManagement/lib/models/liveEventEndpoint.js index 76d16e45f3..ad7d82bfc6 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveEventEndpoint.js +++ b/lib/services/mediaServicesManagement/lib/models/liveEventEndpoint.js @@ -17,8 +17,8 @@ class LiveEventEndpoint { /** * Create a LiveEventEndpoint. - * @member {string} [protocol] The endpoint protocol. - * @member {string} [url] The endpoint URL. + * @property {string} [protocol] The endpoint protocol. + * @property {string} [url] The endpoint URL. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/liveEventInput.js b/lib/services/mediaServicesManagement/lib/models/liveEventInput.js index 94c2bb4209..41e4e35f4e 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveEventInput.js +++ b/lib/services/mediaServicesManagement/lib/models/liveEventInput.js @@ -17,18 +17,18 @@ class LiveEventInput { /** * Create a LiveEventInput. - * @member {string} streamingProtocol The streaming protocol for the Live + * @property {string} streamingProtocol The streaming protocol for the Live * Event. This is specified at creation time and cannot be updated. Possible * values include: 'FragmentedMP4', 'RTMP' - * @member {object} [accessControl] The access control for LiveEvent Input. - * @member {object} [accessControl.ip] The IP access control properties. - * @member {array} [accessControl.ip.allow] The IP allow list. - * @member {string} [keyFrameIntervalDuration] ISO 8601 timespan duration of - * the key frame interval duration. - * @member {string} [accessToken] A unique identifier for a stream. This can - * be specified at creation time but cannot be updated. If omitted, the + * @property {object} [accessControl] The access control for LiveEvent Input. + * @property {object} [accessControl.ip] The IP access control properties. + * @property {array} [accessControl.ip.allow] The IP allow list. + * @property {string} [keyFrameIntervalDuration] ISO 8601 timespan duration + * of the key frame interval duration. + * @property {string} [accessToken] A unique identifier for a stream. This + * can be specified at creation time but cannot be updated. If omitted, the * service will generate a unique value. - * @member {array} [endpoints] The input endpoints for the Live Event. + * @property {array} [endpoints] The input endpoints for the Live Event. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/liveEventInputAccessControl.js b/lib/services/mediaServicesManagement/lib/models/liveEventInputAccessControl.js index a3d4514244..16c7747756 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveEventInputAccessControl.js +++ b/lib/services/mediaServicesManagement/lib/models/liveEventInputAccessControl.js @@ -17,8 +17,8 @@ class LiveEventInputAccessControl { /** * Create a LiveEventInputAccessControl. - * @member {object} [ip] The IP access control properties. - * @member {array} [ip.allow] The IP allow list. + * @property {object} [ip] The IP access control properties. + * @property {array} [ip.allow] The IP allow list. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/liveEventListResult.js b/lib/services/mediaServicesManagement/lib/models/liveEventListResult.js index 655285ed9d..bdfe2ef699 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveEventListResult.js +++ b/lib/services/mediaServicesManagement/lib/models/liveEventListResult.js @@ -17,8 +17,8 @@ class LiveEventListResult extends Array { /** * Create a LiveEventListResult. - * @member {number} [odatacount] The number of result. - * @member {string} [odatanextLink] Th link to the next set of results. Not + * @property {number} [odatacount] The number of result. + * @property {string} [odatanextLink] Th link to the next set of results. Not * empty if value contains incomplete list of Live Outputs. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/liveEventPreview.js b/lib/services/mediaServicesManagement/lib/models/liveEventPreview.js index f58b58966e..8a9d4c18e6 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveEventPreview.js +++ b/lib/services/mediaServicesManagement/lib/models/liveEventPreview.js @@ -17,19 +17,20 @@ class LiveEventPreview { /** * Create a LiveEventPreview. - * @member {array} [endpoints] The endpoints for preview. - * @member {object} [accessControl] The access control for LiveEvent preview. - * @member {object} [accessControl.ip] The IP access control properties. - * @member {array} [accessControl.ip.allow] The IP allow list. - * @member {string} [previewLocator] The identifier of the preview locator in - * Guid format. Specifying this at creation time allows the caller to know - * the preview locator url before the event is created. If omitted, the + * @property {array} [endpoints] The endpoints for preview. + * @property {object} [accessControl] The access control for LiveEvent + * preview. + * @property {object} [accessControl.ip] The IP access control properties. + * @property {array} [accessControl.ip.allow] The IP allow list. + * @property {string} [previewLocator] The identifier of the preview locator + * in Guid format. Specifying this at creation time allows the caller to + * know the preview locator url before the event is created. If omitted, the * service will generate a random identifier. This value cannot be updated * once the live event is created. - * @member {string} [streamingPolicyName] The name of streaming policy used + * @property {string} [streamingPolicyName] The name of streaming policy used * for the LiveEvent preview. This value is specified at creation time and * cannot be updated. - * @member {string} [alternativeMediaId] An Alternative Media Identifier + * @property {string} [alternativeMediaId] An Alternative Media Identifier * associated with the StreamingLocator created for the preview. This value * is specified at creation time and cannot be updated. The identifier can * be used in the CustomLicenseAcquisitionUrlTemplate or the diff --git a/lib/services/mediaServicesManagement/lib/models/liveEventPreviewAccessControl.js b/lib/services/mediaServicesManagement/lib/models/liveEventPreviewAccessControl.js index 8a8ff759da..eba4650c06 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveEventPreviewAccessControl.js +++ b/lib/services/mediaServicesManagement/lib/models/liveEventPreviewAccessControl.js @@ -17,8 +17,8 @@ class LiveEventPreviewAccessControl { /** * Create a LiveEventPreviewAccessControl. - * @member {object} [ip] The IP access control properties. - * @member {array} [ip.allow] The IP allow list. + * @property {object} [ip] The IP access control properties. + * @property {array} [ip.allow] The IP allow list. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/liveOutput.js b/lib/services/mediaServicesManagement/lib/models/liveOutput.js index f030de889a..a5170a88d1 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveOutput.js +++ b/lib/services/mediaServicesManagement/lib/models/liveOutput.js @@ -20,23 +20,23 @@ const models = require('./index'); class LiveOutput extends models['ProxyResource'] { /** * Create a LiveOutput. - * @member {string} [description] The description of the Live Output. - * @member {string} assetName The asset name. - * @member {moment.duration} archiveWindowLength ISO 8601 timespan duration + * @property {string} [description] The description of the Live Output. + * @property {string} assetName The asset name. + * @property {moment.duration} archiveWindowLength ISO 8601 timespan duration * of the archive window length. This is duration that customer want to * retain the recorded content. - * @member {string} [manifestName] The manifest file name. If not provided, - * the service will generate one automatically. - * @member {object} [hls] The HLS configuration. - * @member {number} [hls.fragmentsPerTsSegment] The amount of fragments per + * @property {string} [manifestName] The manifest file name. If not + * provided, the service will generate one automatically. + * @property {object} [hls] The HLS configuration. + * @property {number} [hls.fragmentsPerTsSegment] The amount of fragments per * HTTP Live Streaming (HLS) segment. - * @member {number} [outputSnapTime] The output snapshot time. - * @member {date} [created] The exact time the Live Output was created. - * @member {date} [lastModified] The exact time the Live Output was last + * @property {number} [outputSnapTime] The output snapshot time. + * @property {date} [created] The exact time the Live Output was created. + * @property {date} [lastModified] The exact time the Live Output was last * modified. - * @member {string} [provisioningState] The provisioning state of the Live + * @property {string} [provisioningState] The provisioning state of the Live * Output. - * @member {string} [resourceState] The resource state of the Live Output. + * @property {string} [resourceState] The resource state of the Live Output. * Possible values include: 'Creating', 'Running', 'Deleting' */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/liveOutputListResult.js b/lib/services/mediaServicesManagement/lib/models/liveOutputListResult.js index bf522cc767..a0bb00ead7 100644 --- a/lib/services/mediaServicesManagement/lib/models/liveOutputListResult.js +++ b/lib/services/mediaServicesManagement/lib/models/liveOutputListResult.js @@ -17,8 +17,8 @@ class LiveOutputListResult extends Array { /** * Create a LiveOutputListResult. - * @member {number} [odatacount] The number of result. - * @member {string} [odatanextLink] Th link to the next set of results. Not + * @property {number} [odatacount] The number of result. + * @property {string} [odatanextLink] Th link to the next set of results. Not * empty if value contains incomplete list of Live Outputs. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/location.js b/lib/services/mediaServicesManagement/lib/models/location.js index 467b6f0fc5..a83149f5cd 100644 --- a/lib/services/mediaServicesManagement/lib/models/location.js +++ b/lib/services/mediaServicesManagement/lib/models/location.js @@ -16,7 +16,7 @@ class Location { /** * Create a Location. - * @member {string} name + * @property {string} name */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/mediaService.js b/lib/services/mediaServicesManagement/lib/models/mediaService.js index c8988d3532..a91faf0a56 100644 --- a/lib/services/mediaServicesManagement/lib/models/mediaService.js +++ b/lib/services/mediaServicesManagement/lib/models/mediaService.js @@ -20,8 +20,9 @@ const models = require('./index'); class MediaService extends models['TrackedResource'] { /** * Create a MediaService. - * @member {uuid} [mediaServiceId] The Media Services account ID. - * @member {array} [storageAccounts] The storage accounts for this resource. + * @property {uuid} [mediaServiceId] The Media Services account ID. + * @property {array} [storageAccounts] The storage accounts for this + * resource. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/mediaServiceCollection.js b/lib/services/mediaServicesManagement/lib/models/mediaServiceCollection.js index 33c785580d..a73bf2c889 100644 --- a/lib/services/mediaServicesManagement/lib/models/mediaServiceCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/mediaServiceCollection.js @@ -16,8 +16,9 @@ class MediaServiceCollection extends Array { /** * Create a MediaServiceCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/metric.js b/lib/services/mediaServicesManagement/lib/models/metric.js index 386eca2813..de88415a2d 100644 --- a/lib/services/mediaServicesManagement/lib/models/metric.js +++ b/lib/services/mediaServicesManagement/lib/models/metric.js @@ -17,14 +17,14 @@ class Metric { /** * Create a Metric. - * @member {string} [name] The metric name. - * @member {string} [displayName] The metric display name. - * @member {string} [displayDescription] The metric display description. - * @member {string} [unit] The metric unit. Possible values include: 'Bytes', - * 'Count', 'Milliseconds' - * @member {string} [aggregationType] The metric aggregation type. Possible + * @property {string} [name] The metric name. + * @property {string} [displayName] The metric display name. + * @property {string} [displayDescription] The metric display description. + * @property {string} [unit] The metric unit. Possible values include: + * 'Bytes', 'Count', 'Milliseconds' + * @property {string} [aggregationType] The metric aggregation type. Possible * values include: 'Average', 'Count', 'Total' - * @member {array} [dimensions] The metric dimensions. + * @property {array} [dimensions] The metric dimensions. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/metricDimension.js b/lib/services/mediaServicesManagement/lib/models/metricDimension.js index 1071cd15d3..3b3ed27b20 100644 --- a/lib/services/mediaServicesManagement/lib/models/metricDimension.js +++ b/lib/services/mediaServicesManagement/lib/models/metricDimension.js @@ -17,9 +17,9 @@ class MetricDimension { /** * Create a MetricDimension. - * @member {string} [name] The metric dimension name. - * @member {string} [displayName] The display name for the dimension. - * @member {boolean} [toBeExportedForShoebox] Whether to export metric to + * @property {string} [name] The metric dimension name. + * @property {string} [displayName] The display name for the dimension. + * @property {boolean} [toBeExportedForShoebox] Whether to export metric to * shoebox. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/metricProperties.js b/lib/services/mediaServicesManagement/lib/models/metricProperties.js index 27dc241252..60938f7f5a 100644 --- a/lib/services/mediaServicesManagement/lib/models/metricProperties.js +++ b/lib/services/mediaServicesManagement/lib/models/metricProperties.js @@ -17,9 +17,9 @@ class MetricProperties { /** * Create a MetricProperties. - * @member {object} [serviceSpecification] The service specifications. - * @member {array} [serviceSpecification.metricSpecifications] List of metric - * specifications. + * @property {object} [serviceSpecification] The service specifications. + * @property {array} [serviceSpecification.metricSpecifications] List of + * metric specifications. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/multiBitrateFormat.js b/lib/services/mediaServicesManagement/lib/models/multiBitrateFormat.js index 7b6d40009d..c5b9d99366 100644 --- a/lib/services/mediaServicesManagement/lib/models/multiBitrateFormat.js +++ b/lib/services/mediaServicesManagement/lib/models/multiBitrateFormat.js @@ -24,7 +24,7 @@ const models = require('./index'); class MultiBitrateFormat extends models['Format'] { /** * Create a MultiBitrateFormat. - * @member {array} [outputFiles] The list of output files to produce. Each + * @property {array} [outputFiles] The list of output files to produce. Each * entry in the list is a set of audio and video layer labels to be muxed * together . */ diff --git a/lib/services/mediaServicesManagement/lib/models/noEncryption.js b/lib/services/mediaServicesManagement/lib/models/noEncryption.js index caccbec6d1..4715a3dd8c 100644 --- a/lib/services/mediaServicesManagement/lib/models/noEncryption.js +++ b/lib/services/mediaServicesManagement/lib/models/noEncryption.js @@ -17,12 +17,12 @@ class NoEncryption { /** * Create a NoEncryption. - * @member {object} [enabledProtocols] Representing supported protocols - * @member {boolean} [enabledProtocols.download] Enable Download protocol or - * not - * @member {boolean} [enabledProtocols.dash] Enable DASH protocol or not - * @member {boolean} [enabledProtocols.hls] Enable HLS protocol or not - * @member {boolean} [enabledProtocols.smoothStreaming] Enable + * @property {object} [enabledProtocols] Representing supported protocols + * @property {boolean} [enabledProtocols.download] Enable Download protocol + * or not + * @property {boolean} [enabledProtocols.dash] Enable DASH protocol or not + * @property {boolean} [enabledProtocols.hls] Enable HLS protocol or not + * @property {boolean} [enabledProtocols.smoothStreaming] Enable * SmoothStreaming protocol or not */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/oDataError.js b/lib/services/mediaServicesManagement/lib/models/oDataError.js index 0eff90e910..a447fc23f7 100644 --- a/lib/services/mediaServicesManagement/lib/models/oDataError.js +++ b/lib/services/mediaServicesManagement/lib/models/oDataError.js @@ -17,11 +17,11 @@ class ODataError { /** * Create a ODataError. - * @member {string} [code] A language-independent error name. - * @member {string} [message] The error message. - * @member {string} [target] The target of the error (for example, the name + * @property {string} [code] A language-independent error name. + * @property {string} [message] The error message. + * @property {string} [target] The target of the error (for example, the name * of the property in error). - * @member {array} [details] The error details. + * @property {array} [details] The error details. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/operation.js b/lib/services/mediaServicesManagement/lib/models/operation.js index b407d331ee..6f7cc20ead 100644 --- a/lib/services/mediaServicesManagement/lib/models/operation.js +++ b/lib/services/mediaServicesManagement/lib/models/operation.js @@ -17,18 +17,18 @@ class Operation { /** * Create a Operation. - * @member {string} name The operation name. - * @member {object} [display] The operation display name. - * @member {string} [display.provider] The service provider. - * @member {string} [display.resource] Resource on which the operation is + * @property {string} name The operation name. + * @property {object} [display] The operation display name. + * @property {string} [display.provider] The service provider. + * @property {string} [display.resource] Resource on which the operation is * performed. - * @member {string} [display.operation] The operation type. - * @member {string} [display.description] The operation description. - * @member {string} [origin] Origin of the operation. - * @member {object} [properties] Operation properties format. - * @member {object} [properties.serviceSpecification] The service + * @property {string} [display.operation] The operation type. + * @property {string} [display.description] The operation description. + * @property {string} [origin] Origin of the operation. + * @property {object} [properties] Operation properties format. + * @property {object} [properties.serviceSpecification] The service * specifications. - * @member {array} [properties.serviceSpecification.metricSpecifications] + * @property {array} [properties.serviceSpecification.metricSpecifications] * List of metric specifications. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/operationCollection.js b/lib/services/mediaServicesManagement/lib/models/operationCollection.js index 5bf734ed6b..b93d3496c2 100644 --- a/lib/services/mediaServicesManagement/lib/models/operationCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/operationCollection.js @@ -16,8 +16,9 @@ class OperationCollection extends Array { /** * Create a OperationCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/operationDisplay.js b/lib/services/mediaServicesManagement/lib/models/operationDisplay.js index 4862daa045..3e055e5324 100644 --- a/lib/services/mediaServicesManagement/lib/models/operationDisplay.js +++ b/lib/services/mediaServicesManagement/lib/models/operationDisplay.js @@ -17,10 +17,11 @@ class OperationDisplay { /** * Create a OperationDisplay. - * @member {string} [provider] The service provider. - * @member {string} [resource] Resource on which the operation is performed. - * @member {string} [operation] The operation type. - * @member {string} [description] The operation description. + * @property {string} [provider] The service provider. + * @property {string} [resource] Resource on which the operation is + * performed. + * @property {string} [operation] The operation type. + * @property {string} [description] The operation description. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/outputFile.js b/lib/services/mediaServicesManagement/lib/models/outputFile.js index e103899eed..065a108cc2 100644 --- a/lib/services/mediaServicesManagement/lib/models/outputFile.js +++ b/lib/services/mediaServicesManagement/lib/models/outputFile.js @@ -17,12 +17,12 @@ class OutputFile { /** * Create a OutputFile. - * @member {array} [labels] The list of labels that describe how the encoder - * should multiplex video and audio into an output file. For example, if the - * encoder is producing two video layers with labels v1 and v2, and one audio - * layer with label a1, then an array like '[v1, a1]' tells the encoder to - * produce an output file with the video track represented by v1 and the - * audio track represented by a1. + * @property {array} [labels] The list of labels that describe how the + * encoder should multiplex video and audio into an output file. For example, + * if the encoder is producing two video layers with labels v1 and v2, and + * one audio layer with label a1, then an array like '[v1, a1]' tells the + * encoder to produce an output file with the video track represented by v1 + * and the audio track represented by a1. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/overlay.js b/lib/services/mediaServicesManagement/lib/models/overlay.js index 85dc541953..b3ed2d9565 100644 --- a/lib/services/mediaServicesManagement/lib/models/overlay.js +++ b/lib/services/mediaServicesManagement/lib/models/overlay.js @@ -17,33 +17,33 @@ class Overlay { /** * Create a Overlay. - * @member {string} [inputLabel] The label of the job input which is to be + * @property {string} [inputLabel] The label of the job input which is to be * used as an overlay. The Input must specify exactly one file. You can * specify an image file in JPG or PNG formats, or an audio file (such as a * WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats * for the complete list of supported audio and video file formats. - * @member {moment.duration} [start] The start position, with reference to + * @property {moment.duration} [start] The start position, with reference to * the input video, at which the overlay starts. The value should be in ISO * 8601 format. For example, PT05S to start the overlay at 5 seconds in to * the input video. If not specified the overlay starts from the beginning of * the input video. - * @member {moment.duration} [end] The position in the input video at which + * @property {moment.duration} [end] The position in the input video at which * the overlay ends. The value should be in ISO 8601 duration format. For * example, PT30S to end the overlay at 30 seconds in to the input video. If * not specified the overlay will be applied until the end of the input video * if inputLoop is true. Else, if inputLoop is false, then overlay will last * as long as the duration of the overlay media. - * @member {moment.duration} [fadeInDuration] The duration over which the + * @property {moment.duration} [fadeInDuration] The duration over which the * overlay fades in onto the input video. The value should be in ISO 8601 * duration format. If not specified the default behavior is to have no fade * in (same as PT0S). - * @member {moment.duration} [fadeOutDuration] The duration over which the + * @property {moment.duration} [fadeOutDuration] The duration over which the * overlay fades out of the input video. The value should be in ISO 8601 * duration format. If not specified the default behavior is to have no fade * out (same as PT0S). - * @member {number} [audioGainLevel] The gain level of audio in the overlay. - * The value should be in the range [0, 1.0]. The default is 1.0. - * @member {string} odatatype Polymorphic Discriminator + * @property {number} [audioGainLevel] The gain level of audio in the + * overlay. The value should be in the range [0, 1.0]. The default is 1.0. + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/pngImage.js b/lib/services/mediaServicesManagement/lib/models/pngImage.js index 77dea14f6d..729ab8b60b 100644 --- a/lib/services/mediaServicesManagement/lib/models/pngImage.js +++ b/lib/services/mediaServicesManagement/lib/models/pngImage.js @@ -21,7 +21,7 @@ const models = require('./index'); class PngImage extends models['Image'] { /** * Create a PngImage. - * @member {array} [layers] A collection of output PNG image layers to be + * @property {array} [layers] A collection of output PNG image layers to be * produced by the encoder. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/presentationTimeRange.js b/lib/services/mediaServicesManagement/lib/models/presentationTimeRange.js index cd1039bf4f..e04553384e 100644 --- a/lib/services/mediaServicesManagement/lib/models/presentationTimeRange.js +++ b/lib/services/mediaServicesManagement/lib/models/presentationTimeRange.js @@ -18,13 +18,13 @@ class PresentationTimeRange { /** * Create a PresentationTimeRange. - * @member {number} startTimestamp The absolute start time boundary. - * @member {number} endTimestamp The absolute end time boundary. - * @member {number} presentationWindowDuration The relative to end sliding + * @property {number} startTimestamp The absolute start time boundary. + * @property {number} endTimestamp The absolute end time boundary. + * @property {number} presentationWindowDuration The relative to end sliding * window. - * @member {number} liveBackoffDuration The relative to end right edge. - * @member {number} timescale The time scale of time stamps. - * @member {boolean} forceEndTimestamp The indicator of forcing exsiting of + * @property {number} liveBackoffDuration The relative to end right edge. + * @property {number} timescale The time scale of time stamps. + * @property {boolean} forceEndTimestamp The indicator of forcing exsiting of * end time stamp. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/preset.js b/lib/services/mediaServicesManagement/lib/models/preset.js index 26d0963f1d..590f19814c 100644 --- a/lib/services/mediaServicesManagement/lib/models/preset.js +++ b/lib/services/mediaServicesManagement/lib/models/preset.js @@ -18,7 +18,7 @@ class Preset { /** * Create a Preset. - * @member {string} odatatype Polymorphic Discriminator + * @property {string} odatatype Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/provider.js b/lib/services/mediaServicesManagement/lib/models/provider.js index a0ee0b3967..0d7a1d4a14 100644 --- a/lib/services/mediaServicesManagement/lib/models/provider.js +++ b/lib/services/mediaServicesManagement/lib/models/provider.js @@ -17,7 +17,7 @@ class Provider { /** * Create a Provider. - * @member {string} providerName The provider name. + * @property {string} providerName The provider name. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/rectangle.js b/lib/services/mediaServicesManagement/lib/models/rectangle.js index b7be8b9704..d236149db4 100644 --- a/lib/services/mediaServicesManagement/lib/models/rectangle.js +++ b/lib/services/mediaServicesManagement/lib/models/rectangle.js @@ -18,18 +18,18 @@ class Rectangle { /** * Create a Rectangle. - * @member {string} [left] The number of pixels from the left-margin. This + * @property {string} [left] The number of pixels from the left-margin. This * can be absolute pixel value (e.g 100), or relative to the size of the * video (For example, 50%). - * @member {string} [top] The number of pixels from the top-margin. This can - * be absolute pixel value (e.g 100), or relative to the size of the video - * (For example, 50%). - * @member {string} [width] The width of the rectangular region in pixels. - * This can be absolute pixel value (e.g 100), or relative to the size of the + * @property {string} [top] The number of pixels from the top-margin. This + * can be absolute pixel value (e.g 100), or relative to the size of the * video (For example, 50%). - * @member {string} [height] The height of the rectangular region in pixels. + * @property {string} [width] The width of the rectangular region in pixels. * This can be absolute pixel value (e.g 100), or relative to the size of the * video (For example, 50%). + * @property {string} [height] The height of the rectangular region in + * pixels. This can be absolute pixel value (e.g 100), or relative to the + * size of the video (For example, 50%). */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/resource.js b/lib/services/mediaServicesManagement/lib/models/resource.js index e286b61d7b..64faca3c8a 100644 --- a/lib/services/mediaServicesManagement/lib/models/resource.js +++ b/lib/services/mediaServicesManagement/lib/models/resource.js @@ -20,9 +20,9 @@ const models = require('./index'); class Resource extends models['BaseResource'] { /** * Create a Resource. - * @member {string} [id] Fully qualified resource ID for the resource. - * @member {string} [name] The name of the resource. - * @member {string} [type] The type of the resource. + * @property {string} [id] Fully qualified resource ID for the resource. + * @property {string} [name] The name of the resource. + * @property {string} [type] The type of the resource. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/serviceSpecification.js b/lib/services/mediaServicesManagement/lib/models/serviceSpecification.js index 1c23d8c6b3..542cfe9d52 100644 --- a/lib/services/mediaServicesManagement/lib/models/serviceSpecification.js +++ b/lib/services/mediaServicesManagement/lib/models/serviceSpecification.js @@ -17,7 +17,7 @@ class ServiceSpecification { /** * Create a ServiceSpecification. - * @member {array} [metricSpecifications] List of metric specifications. + * @property {array} [metricSpecifications] List of metric specifications. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/standardEncoderPreset.js b/lib/services/mediaServicesManagement/lib/models/standardEncoderPreset.js index 88060556e6..d2e2fcfb30 100644 --- a/lib/services/mediaServicesManagement/lib/models/standardEncoderPreset.js +++ b/lib/services/mediaServicesManagement/lib/models/standardEncoderPreset.js @@ -21,37 +21,37 @@ const models = require('./index'); class StandardEncoderPreset extends models['Preset'] { /** * Create a StandardEncoderPreset. - * @member {object} [filters] One or more filtering operations that are + * @property {object} [filters] One or more filtering operations that are * applied to the input media before encoding. - * @member {object} [filters.deinterlace] The de-interlacing settings. - * @member {string} [filters.deinterlace.parity] The field parity for + * @property {object} [filters.deinterlace] The de-interlacing settings. + * @property {string} [filters.deinterlace.parity] The field parity for * de-interlacing, defaults to Auto. Possible values include: 'Auto', * 'TopFieldFirst', 'BottomFieldFirst' - * @member {string} [filters.deinterlace.mode] The deinterlacing mode. + * @property {string} [filters.deinterlace.mode] The deinterlacing mode. * Defaults to AutoPixelAdaptive. Possible values include: 'Off', * 'AutoPixelAdaptive' - * @member {string} [filters.rotation] The rotation, if any, to be applied to - * the input video, before it is encoded. Default is Auto. Possible values + * @property {string} [filters.rotation] The rotation, if any, to be applied + * to the input video, before it is encoded. Default is Auto. Possible values * include: 'Auto', 'None', 'Rotate0', 'Rotate90', 'Rotate180', 'Rotate270' - * @member {object} [filters.crop] The parameters for the rectangular window - * with which to crop the input video. - * @member {string} [filters.crop.left] The number of pixels from the + * @property {object} [filters.crop] The parameters for the rectangular + * window with which to crop the input video. + * @property {string} [filters.crop.left] The number of pixels from the * left-margin. This can be absolute pixel value (e.g 100), or relative to * the size of the video (For example, 50%). - * @member {string} [filters.crop.top] The number of pixels from the + * @property {string} [filters.crop.top] The number of pixels from the * top-margin. This can be absolute pixel value (e.g 100), or relative to the * size of the video (For example, 50%). - * @member {string} [filters.crop.width] The width of the rectangular region - * in pixels. This can be absolute pixel value (e.g 100), or relative to the - * size of the video (For example, 50%). - * @member {string} [filters.crop.height] The height of the rectangular + * @property {string} [filters.crop.width] The width of the rectangular + * region in pixels. This can be absolute pixel value (e.g 100), or relative + * to the size of the video (For example, 50%). + * @property {string} [filters.crop.height] The height of the rectangular * region in pixels. This can be absolute pixel value (e.g 100), or relative * to the size of the video (For example, 50%). - * @member {array} [filters.overlays] The properties of overlays to be + * @property {array} [filters.overlays] The properties of overlays to be * applied to the input video. These could be audio, image or video overlays. - * @member {array} [codecs] The list of codecs to be used when encoding the + * @property {array} [codecs] The list of codecs to be used when encoding the * input video. - * @member {array} [formats] The list of outputs to be produced by the + * @property {array} [formats] The list of outputs to be produced by the * encoder. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/storageAccount.js b/lib/services/mediaServicesManagement/lib/models/storageAccount.js index 3e97d302ea..640a0555ff 100644 --- a/lib/services/mediaServicesManagement/lib/models/storageAccount.js +++ b/lib/services/mediaServicesManagement/lib/models/storageAccount.js @@ -17,12 +17,12 @@ class StorageAccount { /** * Create a StorageAccount. - * @member {string} [id] The ID of the storage account resource. Media + * @property {string} [id] The ID of the storage account resource. Media * Services relies on tables and queues as well as blobs, so the primary * storage account must be a Standard Storage account (either * Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts * can be added as secondary storage accounts. - * @member {string} type The type of the storage account. Possible values + * @property {string} type The type of the storage account. Possible values * include: 'Primary', 'Secondary' */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/storageEncryptedAssetDecryptionData.js b/lib/services/mediaServicesManagement/lib/models/storageEncryptedAssetDecryptionData.js index 83ef8bfe00..ce3ca60f79 100644 --- a/lib/services/mediaServicesManagement/lib/models/storageEncryptedAssetDecryptionData.js +++ b/lib/services/mediaServicesManagement/lib/models/storageEncryptedAssetDecryptionData.js @@ -17,8 +17,8 @@ class StorageEncryptedAssetDecryptionData { /** * Create a StorageEncryptedAssetDecryptionData. - * @member {buffer} [key] The Asset File storage encryption key. - * @member {array} [assetFileEncryptionMetadata] Asset File encryption + * @property {buffer} [key] The Asset File storage encryption key. + * @property {array} [assetFileEncryptionMetadata] Asset File encryption * metadata. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingEndpoint.js b/lib/services/mediaServicesManagement/lib/models/streamingEndpoint.js index 1ae859ff2a..6a8a58e3c0 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingEndpoint.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingEndpoint.js @@ -20,42 +20,43 @@ const models = require('./index'); class StreamingEndpoint extends models['TrackedResource'] { /** * Create a StreamingEndpoint. - * @member {string} [description] The StreamingEndpoint description. - * @member {number} scaleUnits The number of scale units. Use the Scale + * @property {string} [description] The StreamingEndpoint description. + * @property {number} scaleUnits The number of scale units. Use the Scale * operation to adjust this value. - * @member {string} [availabilitySetName] The name of the AvailabilitySet + * @property {string} [availabilitySetName] The name of the AvailabilitySet * used with this StreamingEndpoint for high availability streaming. This * value can only be set at creation time. - * @member {object} [accessControl] The access control definition of the + * @property {object} [accessControl] The access control definition of the * StreamingEndpoint. - * @member {object} [accessControl.akamai] The access control of Akamai - * @member {array} + * @property {object} [accessControl.akamai] The access control of Akamai + * @property {array} * [accessControl.akamai.akamaiSignatureHeaderAuthenticationKeyList] * authentication key list - * @member {object} [accessControl.ip] The IP access control of the + * @property {object} [accessControl.ip] The IP access control of the * StreamingEndpoint. - * @member {array} [accessControl.ip.allow] The IP allow list. - * @member {number} [maxCacheAge] Max cache age - * @member {array} [customHostNames] The custom host names of the + * @property {array} [accessControl.ip.allow] The IP allow list. + * @property {number} [maxCacheAge] Max cache age + * @property {array} [customHostNames] The custom host names of the * StreamingEndpoint - * @member {string} [hostName] The StreamingEndpoint host name. - * @member {boolean} [cdnEnabled] The CDN enabled flag. - * @member {string} [cdnProvider] The CDN provider name. - * @member {string} [cdnProfile] The CDN profile name. - * @member {string} [provisioningState] The provisioning state of the + * @property {string} [hostName] The StreamingEndpoint host name. + * @property {boolean} [cdnEnabled] The CDN enabled flag. + * @property {string} [cdnProvider] The CDN provider name. + * @property {string} [cdnProfile] The CDN profile name. + * @property {string} [provisioningState] The provisioning state of the * StreamingEndpoint. - * @member {string} [resourceState] The resource state of the + * @property {string} [resourceState] The resource state of the * StreamingEndpoint. Possible values include: 'Stopped', 'Starting', * 'Running', 'Stopping', 'Deleting', 'Scaling' - * @member {object} [crossSiteAccessPolicies] The StreamingEndpoint access + * @property {object} [crossSiteAccessPolicies] The StreamingEndpoint access * policies. - * @member {string} [crossSiteAccessPolicies.clientAccessPolicy] The content - * of clientaccesspolicy.xml used by Silverlight. - * @member {string} [crossSiteAccessPolicies.crossDomainPolicy] The content + * @property {string} [crossSiteAccessPolicies.clientAccessPolicy] The + * content of clientaccesspolicy.xml used by Silverlight. + * @property {string} [crossSiteAccessPolicies.crossDomainPolicy] The content * of crossdomain.xml used by Silverlight. - * @member {date} [freeTrialEndTime] The free trial expiration time. - * @member {date} [created] The exact time the StreamingEndpoint was created. - * @member {date} [lastModified] The exact time the StreamingEndpoint was + * @property {date} [freeTrialEndTime] The free trial expiration time. + * @property {date} [created] The exact time the StreamingEndpoint was + * created. + * @property {date} [lastModified] The exact time the StreamingEndpoint was * last modified. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingEndpointAccessControl.js b/lib/services/mediaServicesManagement/lib/models/streamingEndpointAccessControl.js index a9bbe59b50..dbfc786669 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingEndpointAccessControl.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingEndpointAccessControl.js @@ -17,11 +17,11 @@ class StreamingEndpointAccessControl { /** * Create a StreamingEndpointAccessControl. - * @member {object} [akamai] The access control of Akamai - * @member {array} [akamai.akamaiSignatureHeaderAuthenticationKeyList] + * @property {object} [akamai] The access control of Akamai + * @property {array} [akamai.akamaiSignatureHeaderAuthenticationKeyList] * authentication key list - * @member {object} [ip] The IP access control of the StreamingEndpoint. - * @member {array} [ip.allow] The IP allow list. + * @property {object} [ip] The IP access control of the StreamingEndpoint. + * @property {array} [ip.allow] The IP allow list. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/streamingEndpointListResult.js b/lib/services/mediaServicesManagement/lib/models/streamingEndpointListResult.js index eaa9bfb83e..9bcfcc8897 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingEndpointListResult.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingEndpointListResult.js @@ -17,8 +17,8 @@ class StreamingEndpointListResult extends Array { /** * Create a StreamingEndpointListResult. - * @member {number} [odatacount] The number of result. - * @member {string} [odatanextLink] Th link to the next set of results. Not + * @property {number} [odatacount] The number of result. + * @property {string} [odatanextLink] Th link to the next set of results. Not * empty if value contains incomplete list of StreamingEndpoints. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingEntityScaleUnit.js b/lib/services/mediaServicesManagement/lib/models/streamingEntityScaleUnit.js index 55ae36f932..60006f8b5f 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingEntityScaleUnit.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingEntityScaleUnit.js @@ -17,7 +17,7 @@ class StreamingEntityScaleUnit { /** * Create a StreamingEntityScaleUnit. - * @member {number} [scaleUnit] The scale unit number of the + * @property {number} [scaleUnit] The scale unit number of the * StreamingEndpoint. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingLocator.js b/lib/services/mediaServicesManagement/lib/models/streamingLocator.js index d569d320f0..2b3ceefa50 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingLocator.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingLocator.js @@ -20,24 +20,24 @@ const models = require('./index'); class StreamingLocator extends models['ProxyResource'] { /** * Create a StreamingLocator. - * @member {string} assetName Asset Name - * @member {date} [created] The creation time of the Streaming Locator. - * @member {date} [startTime] The start time of the Streaming Locator. - * @member {date} [endTime] The end time of the Streaming Locator. - * @member {uuid} [streamingLocatorId] The StreamingLocatorId of the + * @property {string} assetName Asset Name + * @property {date} [created] The creation time of the Streaming Locator. + * @property {date} [startTime] The start time of the Streaming Locator. + * @property {date} [endTime] The end time of the Streaming Locator. + * @property {uuid} [streamingLocatorId] The StreamingLocatorId of the * Streaming Locator. - * @member {string} streamingPolicyName Name of the Streaming Policy used by - * this Streaming Locator. Either specify the name of Streaming Policy you + * @property {string} streamingPolicyName 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' - * @member {string} [defaultContentKeyPolicyName] Name of the default + * @property {string} [defaultContentKeyPolicyName] Name of the default * ContentKeyPolicy used by this Streaming Locator. - * @member {array} [contentKeys] The ContentKeys used by this Streaming + * @property {array} [contentKeys] The ContentKeys used by this Streaming * Locator. - * @member {string} [alternativeMediaId] Alternative Media ID of this + * @property {string} [alternativeMediaId] Alternative Media ID of this * Streaming Locator */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingLocatorCollection.js b/lib/services/mediaServicesManagement/lib/models/streamingLocatorCollection.js index 0214398c2f..11425c4e63 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingLocatorCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingLocatorCollection.js @@ -16,8 +16,9 @@ class StreamingLocatorCollection extends Array { /** * Create a StreamingLocatorCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/streamingLocatorContentKey.js b/lib/services/mediaServicesManagement/lib/models/streamingLocatorContentKey.js index 7efbc44059..9343c8ea18 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingLocatorContentKey.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingLocatorContentKey.js @@ -17,15 +17,15 @@ class StreamingLocatorContentKey { /** * Create a StreamingLocatorContentKey. - * @member {uuid} id ID of Content Key - * @member {string} [type] Encryption type of Content Key. Possible values + * @property {uuid} id ID of Content Key + * @property {string} [type] Encryption type of Content Key. Possible values * include: 'CommonEncryptionCenc', 'CommonEncryptionCbcs', * 'EnvelopeEncryption' - * @member {string} [labelReferenceInStreamingPolicy] Label of Content Key as - * specified in the Streaming Policy - * @member {string} [value] Value of of Content Key - * @member {string} [policyName] ContentKeyPolicy used by Content Key - * @member {array} [tracks] Tracks which use this Content Key + * @property {string} [labelReferenceInStreamingPolicy] Label of Content Key + * as specified in the Streaming Policy + * @property {string} [value] Value of of Content Key + * @property {string} [policyName] ContentKeyPolicy used by Content Key + * @property {array} [tracks] Tracks which use this Content Key */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/streamingPath.js b/lib/services/mediaServicesManagement/lib/models/streamingPath.js index 2736addbe7..ffd6041226 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingPath.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingPath.js @@ -17,12 +17,12 @@ class StreamingPath { /** * Create a StreamingPath. - * @member {string} streamingProtocol Streaming protocol. Possible values + * @property {string} streamingProtocol Streaming protocol. Possible values * include: 'Hls', 'Dash', 'SmoothStreaming', 'Download' - * @member {string} encryptionScheme Encryption scheme. Possible values + * @property {string} encryptionScheme Encryption scheme. Possible values * include: 'NoEncryption', 'EnvelopeEncryption', 'CommonEncryptionCenc', * 'CommonEncryptionCbcs' - * @member {array} [paths] Streaming paths for each protocol and + * @property {array} [paths] Streaming paths for each protocol and * encryptionScheme pair */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingPolicy.js b/lib/services/mediaServicesManagement/lib/models/streamingPolicy.js index 61e49465a7..69f6ebf7af 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingPolicy.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingPolicy.js @@ -20,139 +20,144 @@ const models = require('./index'); class StreamingPolicy extends models['ProxyResource'] { /** * Create a StreamingPolicy. - * @member {date} [created] Creation time of Streaming Policy - * @member {string} [defaultContentKeyPolicyName] Default ContentKey used by - * current Streaming Policy - * @member {object} [envelopeEncryption] Configuration of EnvelopeEncryption - * @member {object} [envelopeEncryption.enabledProtocols] Representing + * @property {date} [created] Creation time of Streaming Policy + * @property {string} [defaultContentKeyPolicyName] Default ContentKey used + * by current Streaming Policy + * @property {object} [envelopeEncryption] Configuration of + * EnvelopeEncryption + * @property {object} [envelopeEncryption.enabledProtocols] Representing * supported protocols - * @member {boolean} [envelopeEncryption.enabledProtocols.download] Enable + * @property {boolean} [envelopeEncryption.enabledProtocols.download] Enable * Download protocol or not - * @member {boolean} [envelopeEncryption.enabledProtocols.dash] Enable DASH + * @property {boolean} [envelopeEncryption.enabledProtocols.dash] Enable DASH * protocol or not - * @member {boolean} [envelopeEncryption.enabledProtocols.hls] Enable HLS + * @property {boolean} [envelopeEncryption.enabledProtocols.hls] Enable HLS * protocol or not - * @member {boolean} [envelopeEncryption.enabledProtocols.smoothStreaming] + * @property {boolean} [envelopeEncryption.enabledProtocols.smoothStreaming] * Enable SmoothStreaming protocol or not - * @member {array} [envelopeEncryption.clearTracks] Representing which tracks - * should not be encrypted - * @member {object} [envelopeEncryption.contentKeys] Representing default + * @property {array} [envelopeEncryption.clearTracks] Representing which + * tracks should not be encrypted + * @property {object} [envelopeEncryption.contentKeys] Representing default * content key for each encryption scheme and separate content keys for * specific tracks - * @member {object} [envelopeEncryption.contentKeys.defaultKey] Default + * @property {object} [envelopeEncryption.contentKeys.defaultKey] Default * content key for an encryption scheme - * @member {string} [envelopeEncryption.contentKeys.defaultKey.label] Label + * @property {string} [envelopeEncryption.contentKeys.defaultKey.label] Label * can be used to specify Content Key when creating a Streaming Locator - * @member {string} [envelopeEncryption.contentKeys.defaultKey.policyName] + * @property {string} [envelopeEncryption.contentKeys.defaultKey.policyName] * Policy used by Default Key - * @member {array} [envelopeEncryption.contentKeys.keyToTrackMappings] + * @property {array} [envelopeEncryption.contentKeys.keyToTrackMappings] * Representing tracks needs separate content key - * @member {string} [envelopeEncryption.customKeyAcquisitionUrlTemplate] + * @property {string} [envelopeEncryption.customKeyAcquisitionUrlTemplate] * KeyAcquistionUrlTemplate is used to point to user specified service to * delivery content keys - * @member {object} [commonEncryptionCenc] Configuration of + * @property {object} [commonEncryptionCenc] Configuration of * CommonEncryptionCenc - * @member {object} [commonEncryptionCenc.enabledProtocols] Representing + * @property {object} [commonEncryptionCenc.enabledProtocols] Representing * supported protocols - * @member {boolean} [commonEncryptionCenc.enabledProtocols.download] Enable - * Download protocol or not - * @member {boolean} [commonEncryptionCenc.enabledProtocols.dash] Enable DASH + * @property {boolean} [commonEncryptionCenc.enabledProtocols.download] + * Enable Download protocol or not + * @property {boolean} [commonEncryptionCenc.enabledProtocols.dash] Enable + * DASH protocol or not + * @property {boolean} [commonEncryptionCenc.enabledProtocols.hls] Enable HLS * protocol or not - * @member {boolean} [commonEncryptionCenc.enabledProtocols.hls] Enable HLS - * protocol or not - * @member {boolean} [commonEncryptionCenc.enabledProtocols.smoothStreaming] - * Enable SmoothStreaming protocol or not - * @member {array} [commonEncryptionCenc.clearTracks] Representing which + * @property {boolean} + * [commonEncryptionCenc.enabledProtocols.smoothStreaming] Enable + * SmoothStreaming protocol or not + * @property {array} [commonEncryptionCenc.clearTracks] Representing which * tracks should not be encrypted - * @member {object} [commonEncryptionCenc.contentKeys] Representing default + * @property {object} [commonEncryptionCenc.contentKeys] Representing default * content key for each encryption scheme and separate content keys for * specific tracks - * @member {object} [commonEncryptionCenc.contentKeys.defaultKey] Default + * @property {object} [commonEncryptionCenc.contentKeys.defaultKey] Default * content key for an encryption scheme - * @member {string} [commonEncryptionCenc.contentKeys.defaultKey.label] Label - * can be used to specify Content Key when creating a Streaming Locator - * @member {string} [commonEncryptionCenc.contentKeys.defaultKey.policyName] - * Policy used by Default Key - * @member {array} [commonEncryptionCenc.contentKeys.keyToTrackMappings] + * @property {string} [commonEncryptionCenc.contentKeys.defaultKey.label] + * Label can be used to specify Content Key when creating a Streaming Locator + * @property {string} + * [commonEncryptionCenc.contentKeys.defaultKey.policyName] Policy used by + * Default Key + * @property {array} [commonEncryptionCenc.contentKeys.keyToTrackMappings] * Representing tracks needs separate content key - * @member {object} [commonEncryptionCenc.drm] Configuration of DRMs for + * @property {object} [commonEncryptionCenc.drm] Configuration of DRMs for * CommonEncryptionCenc encryption scheme - * @member {object} [commonEncryptionCenc.drm.playReady] PlayReady + * @property {object} [commonEncryptionCenc.drm.playReady] PlayReady * configurations - * @member {string} + * @property {string} * [commonEncryptionCenc.drm.playReady.customLicenseAcquisitionUrlTemplate] * The template for a customer service to deliver keys to end users. Not * needed when using Azure Media Services for issuing keys. - * @member {string} + * @property {string} * [commonEncryptionCenc.drm.playReady.playReadyCustomAttributes] Custom * attributes for PlayReady - * @member {object} [commonEncryptionCenc.drm.widevine] Widevine + * @property {object} [commonEncryptionCenc.drm.widevine] Widevine * configurations - * @member {string} + * @property {string} * [commonEncryptionCenc.drm.widevine.customLicenseAcquisitionUrlTemplate] * The template for a customer service to deliver keys to end users. Not * needed when using Azure Media Services for issuing keys. - * @member {object} [commonEncryptionCbcs] Configuration of + * @property {object} [commonEncryptionCbcs] Configuration of * CommonEncryptionCbcs - * @member {object} [commonEncryptionCbcs.enabledProtocols] Representing + * @property {object} [commonEncryptionCbcs.enabledProtocols] Representing * supported protocols - * @member {boolean} [commonEncryptionCbcs.enabledProtocols.download] Enable - * Download protocol or not - * @member {boolean} [commonEncryptionCbcs.enabledProtocols.dash] Enable DASH - * protocol or not - * @member {boolean} [commonEncryptionCbcs.enabledProtocols.hls] Enable HLS + * @property {boolean} [commonEncryptionCbcs.enabledProtocols.download] + * Enable Download protocol or not + * @property {boolean} [commonEncryptionCbcs.enabledProtocols.dash] Enable + * DASH protocol or not + * @property {boolean} [commonEncryptionCbcs.enabledProtocols.hls] Enable HLS * protocol or not - * @member {boolean} [commonEncryptionCbcs.enabledProtocols.smoothStreaming] - * Enable SmoothStreaming protocol or not - * @member {array} [commonEncryptionCbcs.clearTracks] Representing which + * @property {boolean} + * [commonEncryptionCbcs.enabledProtocols.smoothStreaming] Enable + * SmoothStreaming protocol or not + * @property {array} [commonEncryptionCbcs.clearTracks] Representing which * tracks should not be encrypted - * @member {object} [commonEncryptionCbcs.contentKeys] Representing default + * @property {object} [commonEncryptionCbcs.contentKeys] Representing default * content key for each encryption scheme and separate content keys for * specific tracks - * @member {object} [commonEncryptionCbcs.contentKeys.defaultKey] Default + * @property {object} [commonEncryptionCbcs.contentKeys.defaultKey] Default * content key for an encryption scheme - * @member {string} [commonEncryptionCbcs.contentKeys.defaultKey.label] Label - * can be used to specify Content Key when creating a Streaming Locator - * @member {string} [commonEncryptionCbcs.contentKeys.defaultKey.policyName] - * Policy used by Default Key - * @member {array} [commonEncryptionCbcs.contentKeys.keyToTrackMappings] + * @property {string} [commonEncryptionCbcs.contentKeys.defaultKey.label] + * Label can be used to specify Content Key when creating a Streaming Locator + * @property {string} + * [commonEncryptionCbcs.contentKeys.defaultKey.policyName] Policy used by + * Default Key + * @property {array} [commonEncryptionCbcs.contentKeys.keyToTrackMappings] * Representing tracks needs separate content key - * @member {object} [commonEncryptionCbcs.drm] Configuration of DRMs for + * @property {object} [commonEncryptionCbcs.drm] Configuration of DRMs for * current encryption scheme - * @member {object} [commonEncryptionCbcs.drm.fairPlay] FairPlay + * @property {object} [commonEncryptionCbcs.drm.fairPlay] FairPlay * configurations - * @member {string} + * @property {string} * [commonEncryptionCbcs.drm.fairPlay.customLicenseAcquisitionUrlTemplate] * The template for a customer service to deliver keys to end users. Not * needed when using Azure Media Services for issuing keys. - * @member {boolean} + * @property {boolean} * [commonEncryptionCbcs.drm.fairPlay.allowPersistentLicense] All license to * be persistent or not - * @member {object} [commonEncryptionCbcs.drm.playReady] PlayReady + * @property {object} [commonEncryptionCbcs.drm.playReady] PlayReady * configurations - * @member {string} + * @property {string} * [commonEncryptionCbcs.drm.playReady.customLicenseAcquisitionUrlTemplate] * The template for a customer service to deliver keys to end users. Not * needed when using Azure Media Services for issuing keys. - * @member {string} + * @property {string} * [commonEncryptionCbcs.drm.playReady.playReadyCustomAttributes] Custom * attributes for PlayReady - * @member {object} [commonEncryptionCbcs.drm.widevine] Widevine + * @property {object} [commonEncryptionCbcs.drm.widevine] Widevine * configurations - * @member {string} + * @property {string} * [commonEncryptionCbcs.drm.widevine.customLicenseAcquisitionUrlTemplate] * The template for a customer service to deliver keys to end users. Not * needed when using Azure Media Services for issuing keys. - * @member {object} [noEncryption] Configurations of NoEncryption - * @member {object} [noEncryption.enabledProtocols] Representing supported + * @property {object} [noEncryption] Configurations of NoEncryption + * @property {object} [noEncryption.enabledProtocols] Representing supported * protocols - * @member {boolean} [noEncryption.enabledProtocols.download] Enable Download + * @property {boolean} [noEncryption.enabledProtocols.download] Enable + * Download protocol or not + * @property {boolean} [noEncryption.enabledProtocols.dash] Enable DASH * protocol or not - * @member {boolean} [noEncryption.enabledProtocols.dash] Enable DASH + * @property {boolean} [noEncryption.enabledProtocols.hls] Enable HLS * protocol or not - * @member {boolean} [noEncryption.enabledProtocols.hls] Enable HLS protocol - * or not - * @member {boolean} [noEncryption.enabledProtocols.smoothStreaming] Enable + * @property {boolean} [noEncryption.enabledProtocols.smoothStreaming] Enable * SmoothStreaming protocol or not */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingPolicyCollection.js b/lib/services/mediaServicesManagement/lib/models/streamingPolicyCollection.js index a2e8dc0eaf..c674d52980 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingPolicyCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingPolicyCollection.js @@ -16,8 +16,9 @@ class StreamingPolicyCollection extends Array { /** * Create a StreamingPolicyCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/streamingPolicyContentKey.js b/lib/services/mediaServicesManagement/lib/models/streamingPolicyContentKey.js index d8b421f105..cdd4a4f333 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingPolicyContentKey.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingPolicyContentKey.js @@ -17,10 +17,10 @@ class StreamingPolicyContentKey { /** * Create a StreamingPolicyContentKey. - * @member {string} [label] Label can be used to specify Content Key when + * @property {string} [label] Label can be used to specify Content Key when * creating a Streaming Locator - * @member {string} [policyName] Policy used by Content Key - * @member {array} [tracks] Tracks which use this content key + * @property {string} [policyName] Policy used by Content Key + * @property {array} [tracks] Tracks which use this content key */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/streamingPolicyContentKeys.js b/lib/services/mediaServicesManagement/lib/models/streamingPolicyContentKeys.js index abe6613eeb..27abda1235 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingPolicyContentKeys.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingPolicyContentKeys.js @@ -17,11 +17,12 @@ class StreamingPolicyContentKeys { /** * Create a StreamingPolicyContentKeys. - * @member {object} [defaultKey] Default content key for an encryption scheme - * @member {string} [defaultKey.label] Label can be used to specify Content + * @property {object} [defaultKey] Default content key for an encryption + * scheme + * @property {string} [defaultKey.label] Label can be used to specify Content * Key when creating a Streaming Locator - * @member {string} [defaultKey.policyName] Policy used by Default Key - * @member {array} [keyToTrackMappings] Representing tracks needs separate + * @property {string} [defaultKey.policyName] Policy used by Default Key + * @property {array} [keyToTrackMappings] Representing tracks needs separate * content key */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingPolicyFairPlayConfiguration.js b/lib/services/mediaServicesManagement/lib/models/streamingPolicyFairPlayConfiguration.js index 41f494cf0b..58af3d1f15 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingPolicyFairPlayConfiguration.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingPolicyFairPlayConfiguration.js @@ -17,10 +17,10 @@ class StreamingPolicyFairPlayConfiguration { /** * Create a StreamingPolicyFairPlayConfiguration. - * @member {string} [customLicenseAcquisitionUrlTemplate] The template for a - * customer service to deliver keys to end users. Not needed when using + * @property {string} [customLicenseAcquisitionUrlTemplate] The template for + * a customer service to deliver keys to end users. Not needed when using * Azure Media Services for issuing keys. - * @member {boolean} allowPersistentLicense All license to be persistent or + * @property {boolean} allowPersistentLicense All license to be persistent or * not */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingPolicyPlayReadyConfiguration.js b/lib/services/mediaServicesManagement/lib/models/streamingPolicyPlayReadyConfiguration.js index e380cebb4f..a498af5636 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingPolicyPlayReadyConfiguration.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingPolicyPlayReadyConfiguration.js @@ -17,10 +17,10 @@ class StreamingPolicyPlayReadyConfiguration { /** * Create a StreamingPolicyPlayReadyConfiguration. - * @member {string} [customLicenseAcquisitionUrlTemplate] The template for a - * customer service to deliver keys to end users. Not needed when using + * @property {string} [customLicenseAcquisitionUrlTemplate] The template for + * a customer service to deliver keys to end users. Not needed when using * Azure Media Services for issuing keys. - * @member {string} [playReadyCustomAttributes] Custom attributes for + * @property {string} [playReadyCustomAttributes] Custom attributes for * PlayReady */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/streamingPolicyWidevineConfiguration.js b/lib/services/mediaServicesManagement/lib/models/streamingPolicyWidevineConfiguration.js index a9f039ab78..efda190227 100644 --- a/lib/services/mediaServicesManagement/lib/models/streamingPolicyWidevineConfiguration.js +++ b/lib/services/mediaServicesManagement/lib/models/streamingPolicyWidevineConfiguration.js @@ -17,8 +17,8 @@ class StreamingPolicyWidevineConfiguration { /** * Create a StreamingPolicyWidevineConfiguration. - * @member {string} [customLicenseAcquisitionUrlTemplate] The template for a - * customer service to deliver keys to end users. Not needed when using + * @property {string} [customLicenseAcquisitionUrlTemplate] The template for + * a customer service to deliver keys to end users. Not needed when using * Azure Media Services for issuing keys. */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/subscriptionMediaService.js b/lib/services/mediaServicesManagement/lib/models/subscriptionMediaService.js index f2da82226f..5b1ba7ee55 100644 --- a/lib/services/mediaServicesManagement/lib/models/subscriptionMediaService.js +++ b/lib/services/mediaServicesManagement/lib/models/subscriptionMediaService.js @@ -20,8 +20,9 @@ const models = require('./index'); class SubscriptionMediaService extends models['TrackedResource'] { /** * Create a SubscriptionMediaService. - * @member {uuid} [mediaServiceId] The Media Services account ID. - * @member {array} [storageAccounts] The storage accounts for this resource. + * @property {uuid} [mediaServiceId] The Media Services account ID. + * @property {array} [storageAccounts] The storage accounts for this + * resource. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/subscriptionMediaServiceCollection.js b/lib/services/mediaServicesManagement/lib/models/subscriptionMediaServiceCollection.js index 18481ae09f..acda5c8d4e 100644 --- a/lib/services/mediaServicesManagement/lib/models/subscriptionMediaServiceCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/subscriptionMediaServiceCollection.js @@ -16,8 +16,9 @@ class SubscriptionMediaServiceCollection extends Array { /** * Create a SubscriptionMediaServiceCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/syncStorageKeysInput.js b/lib/services/mediaServicesManagement/lib/models/syncStorageKeysInput.js index 41d85897f9..00dcfc4ad6 100644 --- a/lib/services/mediaServicesManagement/lib/models/syncStorageKeysInput.js +++ b/lib/services/mediaServicesManagement/lib/models/syncStorageKeysInput.js @@ -17,7 +17,7 @@ class SyncStorageKeysInput { /** * Create a SyncStorageKeysInput. - * @member {string} [id] The ID of the storage account resource. + * @property {string} [id] The ID of the storage account resource. */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/trackPropertyCondition.js b/lib/services/mediaServicesManagement/lib/models/trackPropertyCondition.js index 8e235c44fb..b07344b27d 100644 --- a/lib/services/mediaServicesManagement/lib/models/trackPropertyCondition.js +++ b/lib/services/mediaServicesManagement/lib/models/trackPropertyCondition.js @@ -17,11 +17,11 @@ class TrackPropertyCondition { /** * Create a TrackPropertyCondition. - * @member {string} property Track property type. Possible values include: + * @property {string} property Track property type. Possible values include: * 'Unknown', 'FourCC' - * @member {string} operation Track property condition operation. Possible + * @property {string} operation Track property condition operation. Possible * values include: 'Unknown', 'Equal' - * @member {string} [value] Track property value + * @property {string} [value] Track property value */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/trackSelection.js b/lib/services/mediaServicesManagement/lib/models/trackSelection.js index 4b2642651f..004c216108 100644 --- a/lib/services/mediaServicesManagement/lib/models/trackSelection.js +++ b/lib/services/mediaServicesManagement/lib/models/trackSelection.js @@ -17,7 +17,7 @@ class TrackSelection { /** * Create a TrackSelection. - * @member {array} [trackSelections] TrackSelections is a track property + * @property {array} [trackSelections] TrackSelections is a track property * condition list which can specify track(s) */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/trackedResource.js b/lib/services/mediaServicesManagement/lib/models/trackedResource.js index ae22120642..73bdc6e949 100644 --- a/lib/services/mediaServicesManagement/lib/models/trackedResource.js +++ b/lib/services/mediaServicesManagement/lib/models/trackedResource.js @@ -20,8 +20,8 @@ const models = require('./index'); class TrackedResource extends models['Resource'] { /** * Create a TrackedResource. - * @member {object} [tags] Resource tags. - * @member {string} [location] The Azure Region of the resource. + * @property {object} [tags] Resource tags. + * @property {string} [location] The Azure Region of the resource. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/transform.js b/lib/services/mediaServicesManagement/lib/models/transform.js index 2f88fc5ea6..9f97e71c03 100644 --- a/lib/services/mediaServicesManagement/lib/models/transform.js +++ b/lib/services/mediaServicesManagement/lib/models/transform.js @@ -23,14 +23,14 @@ const models = require('./index'); class Transform extends models['ProxyResource'] { /** * Create a Transform. - * @member {date} [created] The UTC date and time when the Transform was + * @property {date} [created] The UTC date and time when the Transform was * created, in 'YYYY-MM-DDThh:mm:ssZ' format. - * @member {string} [description] An optional verbose description of the + * @property {string} [description] An optional verbose description of the * Transform. - * @member {date} [lastModified] The UTC date and time when the Transform was - * last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. - * @member {array} outputs An array of one or more TransformOutputs that the - * Transform should generate. + * @property {date} [lastModified] The UTC date and time when the Transform + * was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. + * @property {array} outputs An array of one or more TransformOutputs that + * the Transform should generate. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/transformCollection.js b/lib/services/mediaServicesManagement/lib/models/transformCollection.js index 2fadeaafc2..c9fd777c36 100644 --- a/lib/services/mediaServicesManagement/lib/models/transformCollection.js +++ b/lib/services/mediaServicesManagement/lib/models/transformCollection.js @@ -16,8 +16,9 @@ class TransformCollection extends Array { /** * Create a TransformCollection. - * @member {string} [odatanextLink] A link to the next page of the collection - * (when the collection contains too many results to return in one response). + * @property {string} [odatanextLink] A link to the next page of the + * collection (when the collection contains too many results to return in one + * response). */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/transformOutput.js b/lib/services/mediaServicesManagement/lib/models/transformOutput.js index 98293e6395..ed83bf2a37 100644 --- a/lib/services/mediaServicesManagement/lib/models/transformOutput.js +++ b/lib/services/mediaServicesManagement/lib/models/transformOutput.js @@ -18,20 +18,20 @@ class TransformOutput { /** * Create a TransformOutput. - * @member {string} [onError] A Transform can define more than one outputs. + * @property {string} [onError] A Transform can define more than one outputs. * This property defines what the service should do when one output fails - * either continue to produce other outputs, or, stop the other outputs. The * overall Job state will not reflect failures of outputs that are specified * with 'ContinueJob'. The default is 'StopProcessingJob'. Possible values * include: 'StopProcessingJob', 'ContinueJob' - * @member {string} [relativePriority] Sets the relative priority of the + * @property {string} [relativePriority] Sets the relative priority of the * TransformOutputs within a Transform. This sets the priority that the * service uses for processing TransformOutputs. The default priority is * Normal. Possible values include: 'Low', 'Normal', 'High' - * @member {object} preset Preset that describes the operations that will be - * used to modify, transcode, or extract insights from the source file to + * @property {object} preset Preset that describes the operations that will + * be used to modify, transcode, or extract insights from the source file to * generate the output. - * @member {string} [preset.odatatype] Polymorphic Discriminator + * @property {string} [preset.odatatype] Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/mediaServicesManagement/lib/models/video.js b/lib/services/mediaServicesManagement/lib/models/video.js index 27a5dc04e3..a3edad6faa 100644 --- a/lib/services/mediaServicesManagement/lib/models/video.js +++ b/lib/services/mediaServicesManagement/lib/models/video.js @@ -20,11 +20,11 @@ const models = require('./index'); class Video extends models['Codec'] { /** * Create a Video. - * @member {moment.duration} [keyFrameInterval] The distance between two key - * frames, thereby defining a group of pictures (GOP). The value should be a - * non-zero integer in the range [1, 30] seconds, specified in ISO 8601 + * @property {moment.duration} [keyFrameInterval] The distance between two + * key frames, thereby defining a group of pictures (GOP). The value should + * be a non-zero integer in the range [1, 30] seconds, specified in ISO 8601 * format. The default is 2 seconds (PT2S). - * @member {string} [stretchMode] The resizing mode - how the input video + * @property {string} [stretchMode] The resizing mode - how the input video * will be resized to fit the desired output resolution(s). Default is * AutoSize. Possible values include: 'None', 'AutoSize', 'AutoFit' */ diff --git a/lib/services/mediaServicesManagement/lib/models/videoAnalyzerPreset.js b/lib/services/mediaServicesManagement/lib/models/videoAnalyzerPreset.js index 1b23021e94..1f5af998a3 100644 --- a/lib/services/mediaServicesManagement/lib/models/videoAnalyzerPreset.js +++ b/lib/services/mediaServicesManagement/lib/models/videoAnalyzerPreset.js @@ -21,10 +21,10 @@ const models = require('./index'); class VideoAnalyzerPreset extends models['AudioAnalyzerPreset'] { /** * Create a VideoAnalyzerPreset. - * @member {string} [insightsToExtract] The type of insights to be extracted. - * If not set then based on the content the type will selected. If the - * content is audi only then only audio insights are extraced and if it is - * video only. Possible values include: 'AudioInsightsOnly', + * @property {string} [insightsToExtract] The type of insights to be + * extracted. If not set then based on the content the type will selected. + * If the content is audio only then only audio insights are extracted and if + * it is video only. Possible values include: 'AudioInsightsOnly', * 'VideoInsightsOnly', 'AllInsights' */ constructor() { diff --git a/lib/services/mediaServicesManagement/lib/models/videoLayer.js b/lib/services/mediaServicesManagement/lib/models/videoLayer.js index cc0e88751e..ff87247fbd 100644 --- a/lib/services/mediaServicesManagement/lib/models/videoLayer.js +++ b/lib/services/mediaServicesManagement/lib/models/videoLayer.js @@ -21,27 +21,27 @@ const models = require('./index'); class VideoLayer extends models['Layer'] { /** * Create a VideoLayer. - * @member {number} [bitrate] The average bitrate in bits per second at which - * to encode the input video when generating this layer. This is a required - * field. - * @member {number} [maxBitrate] The maximum bitrate (in bits per second), at - * which the VBV buffer should be assumed to refill. If not specified, + * @property {number} [bitrate] The average bitrate in bits per second at + * which to encode the input video when generating this layer. This is a + * required field. + * @property {number} [maxBitrate] The maximum bitrate (in bits per second), + * at which the VBV buffer should be assumed to refill. If not specified, * defaults to the same value as bitrate. - * @member {number} [bFrames] The number of B-frames to be used when encoding - * this layer. If not specified, the encoder chooses an appropriate number - * based on the video profile and level. - * @member {string} [frameRate] The frame rate (in frames per second) at + * @property {number} [bFrames] The number of B-frames to be used when + * encoding this layer. If not specified, the encoder chooses an appropriate + * number based on the video profile and level. + * @property {string} [frameRate] The frame rate (in frames per second) at * which to encode this layer. The value can be in the form of M/N where M * and N are integers (For example, 30000/1001), or in the form of a number * (For example, 30, or 29.97). The encoder enforces constraints on allowed * frame rates based on the profile and level. If it is not specified, the * encoder will use the same frame rate as the input video. - * @member {number} [slices] The number of slices to be used when encoding + * @property {number} [slices] The number of slices to be used when encoding * this layer. If not specified, default is zero, which means that encoder * will use a single slice for each frame. - * @member {boolean} [adaptiveBFrame] Whether or not adaptive B-frames are to - * be used when encoding this layer. If not specified, the encoder will turn - * it on whenever the video profile permits its use. + * @property {boolean} [adaptiveBFrame] Whether or not adaptive B-frames are + * to be used when encoding this layer. If not specified, the encoder will + * turn it on whenever the video profile permits its use. */ constructor() { super(); diff --git a/lib/services/mediaServicesManagement/lib/models/videoOverlay.js b/lib/services/mediaServicesManagement/lib/models/videoOverlay.js index 5c856ff78d..cf9903cbc3 100644 --- a/lib/services/mediaServicesManagement/lib/models/videoOverlay.js +++ b/lib/services/mediaServicesManagement/lib/models/videoOverlay.js @@ -20,34 +20,34 @@ const models = require('./index'); class VideoOverlay extends models['Overlay'] { /** * Create a VideoOverlay. - * @member {object} [position] The location in the input video where the + * @property {object} [position] The location in the input video where the * overlay is applied. - * @member {string} [position.left] The number of pixels from the + * @property {string} [position.left] The number of pixels from the * left-margin. This can be absolute pixel value (e.g 100), or relative to * the size of the video (For example, 50%). - * @member {string} [position.top] The number of pixels from the top-margin. - * This can be absolute pixel value (e.g 100), or relative to the size of the - * video (For example, 50%). - * @member {string} [position.width] The width of the rectangular region in - * pixels. This can be absolute pixel value (e.g 100), or relative to the + * @property {string} [position.top] The number of pixels from the + * top-margin. This can be absolute pixel value (e.g 100), or relative to the * size of the video (For example, 50%). - * @member {string} [position.height] The height of the rectangular region in + * @property {string} [position.width] The width of the rectangular region in * pixels. This can be absolute pixel value (e.g 100), or relative to the * size of the video (For example, 50%). - * @member {number} [opacity] The opacity of the overlay. This is a value in - * the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque. - * @member {object} [cropRectangle] An optional rectangular window used to + * @property {string} [position.height] The height of the rectangular region + * in pixels. This can be absolute pixel value (e.g 100), or relative to the + * size of the video (For example, 50%). + * @property {number} [opacity] The opacity of the overlay. This is a value + * in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque. + * @property {object} [cropRectangle] An optional rectangular window used to * crop the overlay image or video. - * @member {string} [cropRectangle.left] The number of pixels from the + * @property {string} [cropRectangle.left] The number of pixels from the * left-margin. This can be absolute pixel value (e.g 100), or relative to * the size of the video (For example, 50%). - * @member {string} [cropRectangle.top] The number of pixels from the + * @property {string} [cropRectangle.top] The number of pixels from the * top-margin. This can be absolute pixel value (e.g 100), or relative to the * size of the video (For example, 50%). - * @member {string} [cropRectangle.width] The width of the rectangular region - * in pixels. This can be absolute pixel value (e.g 100), or relative to the - * size of the video (For example, 50%). - * @member {string} [cropRectangle.height] The height of the rectangular + * @property {string} [cropRectangle.width] The width of the rectangular + * region in pixels. This can be absolute pixel value (e.g 100), or relative + * to the size of the video (For example, 50%). + * @property {string} [cropRectangle.height] The height of the rectangular * region in pixels. This can be absolute pixel value (e.g 100), or relative * to the size of the video (For example, 50%). */ diff --git a/lib/services/mediaServicesManagement/package.json b/lib/services/mediaServicesManagement/package.json index 0b68e10463..afa6b04527 100644 --- a/lib/services/mediaServicesManagement/package.json +++ b/lib/services/mediaServicesManagement/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}