@azure/arm-mediaservices package

Classes

AzureMediaServices

Interfaces

AacAudio

Describes Advanced Audio Codec (AAC) audio encoding settings.

AbsoluteClipTime

Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not.

AccessControl
AccountEncryption
AccountFilter

An Account Filter.

AccountFilterCollection

A collection of AccountFilter items.

AccountFilters

Interface representing a AccountFilters.

AccountFiltersCreateOrUpdateOptionalParams

Optional parameters.

AccountFiltersDeleteOptionalParams

Optional parameters.

AccountFiltersGetOptionalParams

Optional parameters.

AccountFiltersListNextOptionalParams

Optional parameters.

AccountFiltersListOptionalParams

Optional parameters.

AccountFiltersUpdateOptionalParams

Optional parameters.

AkamaiAccessControl

Akamai access control

AkamaiSignatureHeaderAuthenticationKey

Akamai Signature Header authentication key.

ArmStreamingEndpointCapacity

The streaming endpoint sku capacity.

ArmStreamingEndpointCurrentSku

The streaming endpoint current sku.

ArmStreamingEndpointSku

The streaming endpoint sku.

ArmStreamingEndpointSkuInfo
Asset

An Asset.

AssetCollection

A collection of Asset items.

AssetContainerSas

The Asset Storage container SAS URLs.

AssetFileEncryptionMetadata

The Asset File Storage encryption metadata.

AssetFilter

An Asset Filter.

AssetFilterCollection

A collection of AssetFilter items.

AssetFilters

Interface representing a AssetFilters.

AssetFiltersCreateOrUpdateOptionalParams

Optional parameters.

AssetFiltersDeleteOptionalParams

Optional parameters.

AssetFiltersGetOptionalParams

Optional parameters.

AssetFiltersListNextOptionalParams

Optional parameters.

AssetFiltersListOptionalParams

Optional parameters.

AssetFiltersUpdateOptionalParams

Optional parameters.

AssetStreamingLocator

Properties of the Streaming Locator.

AssetTrack

An Asset Track resource.

AssetTrackCollection

A collection of AssetTrack items.

AssetTrackOperationStatus

Status of asset track operation.

Assets

Interface representing a Assets.

AssetsCreateOrUpdateOptionalParams

Optional parameters.

AssetsDeleteOptionalParams

Optional parameters.

AssetsGetEncryptionKeyOptionalParams

Optional parameters.

AssetsGetOptionalParams

Optional parameters.

AssetsListContainerSasOptionalParams

Optional parameters.

AssetsListNextOptionalParams

Optional parameters.

AssetsListOptionalParams

Optional parameters.

AssetsListStreamingLocatorsOptionalParams

Optional parameters.

AssetsUpdateOptionalParams

Optional parameters.

AsyncOperationResult

The status of an async operation.

Audio

Defines the common properties for all audio codecs.

AudioAnalyzerPreset

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.

AudioOverlay

Describes the properties of an audio overlay.

AudioTrack

Represents an audio track in the asset.

AudioTrackDescriptor

A TrackSelection to select audio tracks.

AzureMediaServicesOptionalParams

Optional parameters.

BuiltInStandardEncoderPreset

Describes a built-in preset for encoding the input video with the Standard Encoder.

CbcsDrmConfiguration

Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy

CencDrmConfiguration

Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy

CheckNameAvailabilityInput

The input to the check name availability request.

ClearKeyEncryptionConfiguration

Class to specify ClearKey configuration of common encryption schemes in Streaming Policy

ClipTime

Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media.

Codec

Describes the basic properties of all codecs.

CommonEncryptionCbcs

Class for CommonEncryptionCbcs encryption scheme

CommonEncryptionCenc

Class for envelope encryption scheme

ContentKeyPolicies

Interface representing a ContentKeyPolicies.

ContentKeyPoliciesCreateOrUpdateOptionalParams

Optional parameters.

ContentKeyPoliciesDeleteOptionalParams

Optional parameters.

ContentKeyPoliciesGetOptionalParams

Optional parameters.

ContentKeyPoliciesGetPolicyPropertiesWithSecretsOptionalParams

Optional parameters.

ContentKeyPoliciesListNextOptionalParams

Optional parameters.

ContentKeyPoliciesListOptionalParams

Optional parameters.

ContentKeyPoliciesUpdateOptionalParams

Optional parameters.

ContentKeyPolicy

A Content Key Policy resource.

ContentKeyPolicyClearKeyConfiguration

Represents a configuration for non-DRM keys.

ContentKeyPolicyCollection

A collection of ContentKeyPolicy items.

ContentKeyPolicyConfiguration

Base class for Content Key Policy configuration. A derived class must be used to create a configuration.

ContentKeyPolicyFairPlayConfiguration

Specifies a configuration for FairPlay licenses.

ContentKeyPolicyFairPlayOfflineRentalConfiguration
ContentKeyPolicyOpenRestriction

Represents an open restriction. License or key will be delivered on every request.

ContentKeyPolicyOption

Represents a policy option.

ContentKeyPolicyPlayReadyConfiguration

Specifies a configuration for PlayReady licenses.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

Specifies that the content key ID is in the PlayReady header.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

Specifies that the content key ID is specified in the PlayReady configuration.

ContentKeyPolicyPlayReadyContentKeyLocation

Base class for content key ID location. A derived class must be used to represent the location.

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules.

ContentKeyPolicyPlayReadyLicense

The PlayReady license

ContentKeyPolicyPlayReadyPlayRight

Configures the Play Right in the PlayReady license.

ContentKeyPolicyProperties

The properties of the Content Key Policy.

ContentKeyPolicyRestriction

Base class for Content Key Policy restrictions. A derived class must be used to create a restriction.

ContentKeyPolicyRestrictionTokenKey

Base class for Content Key Policy key for token validation. A derived class must be used to create a token key.

ContentKeyPolicyRsaTokenKey

Specifies a RSA key for token validation

ContentKeyPolicySymmetricTokenKey

Specifies a symmetric key for token validation.

ContentKeyPolicyTokenClaim

Represents a token claim.

ContentKeyPolicyTokenRestriction

Represents a token restriction. Provided token must match these requirements for successful license or key delivery.

ContentKeyPolicyUnknownConfiguration

Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version.

ContentKeyPolicyUnknownRestriction

Represents a ContentKeyPolicyRestriction that is unavailable in the current API version.

ContentKeyPolicyWidevineConfiguration

Specifies a configuration for Widevine licenses.

ContentKeyPolicyX509CertificateTokenKey

Specifies a certificate for token validation.

CopyAudio

A codec flag, which tells the encoder to copy the input audio bitstream.

CopyVideo

A codec flag, which tells the encoder to copy the input video bitstream without re-encoding.

CrossSiteAccessPolicies

The client access policy.

DDAudio

Describes Dolby Digital Audio Codec (AC3) audio encoding settings. The current implementation for Dolby Digital Audio support are: Audio channel numbers at 1((mono), 2(stereo), 6(5.1side); Audio sampling frequency rates at: 32K/44.1K/48K Hz; Audio bitrate values as AC3 specification supports: 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000, 384000, 448000, 512000, 576000, 640000 bps.

DashSettings

The DASH setting for a track.

DefaultKey

Class to specify properties of default content key for each encryption scheme

Deinterlace

Describes the de-interlacing settings.

EdgePolicies
EdgeUsageDataCollectionPolicy
EdgeUsageDataEventHub
EnabledProtocols

Class to specify which protocols are enabled

EntityNameAvailabilityCheckOutput

The response from the check name availability request.

EnvelopeEncryption

Class for EnvelopeEncryption encryption scheme

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

FaceDetectorPreset

Describes all the settings to be used when analyzing a video in order to detect (and optionally redact) all the faces present.

Fade

Describes the properties of a Fade effect applied to the input media.

FilterTrackPropertyCondition

The class to specify one track property condition.

FilterTrackSelection

Representing a list of FilterTrackPropertyConditions to select a track. The filters are combined using a logical AND operation.

Filters

Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding.

FirstQuality

Filter First Quality

Format

Base class for output.

FromAllInputFile

An InputDefinition that looks across all of the files provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to allow selection of a single track across a set of input files.

FromEachInputFile

An InputDefinition that looks at each input file provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to select tracks from each file given.

H264Layer

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec.

H264Video

Describes all the properties for encoding a video with the H.264 codec.

H265Layer

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.265 video codec.

H265Video

Describes all the properties for encoding a video with the H.265 codec.

H265VideoLayer

Describes the settings to be used when encoding the input video into a desired output bitrate layer.

Hls

HTTP Live Streaming (HLS) packing setting for the live output.

HlsSettings

The HLS setting for a track.

IPAccessControl

The IP access control.

IPRange

The IP address range in the CIDR scheme.

Image

Describes the basic properties for generating thumbnails from the input video

ImageFormat

Describes the properties for an output image file.

InputDefinition

Base class for defining an input. Use sub classes of this class to specify tracks selections and related metadata.

InputFile

An InputDefinition for a single file. TrackSelections are scoped to the file specified.

Job

A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid.

JobCollection

A collection of Job items.

JobError

Details of JobOutput errors.

JobErrorDetail

Details of JobOutput errors.

JobInput

Base class for inputs to a Job.

JobInputAsset

Represents an Asset for input into a Job.

JobInputClip

Represents input files for a Job.

JobInputHttp

Represents HTTPS job input.

JobInputSequence

A Sequence contains an ordered list of Clips where each clip is a JobInput. The Sequence will be treated as a single input.

JobInputs

Describes a list of inputs to a Job.

JobOutput

Describes all the properties of a JobOutput.

JobOutputAsset

Represents an Asset used as a JobOutput.

Jobs

Interface representing a Jobs.

JobsCancelJobOptionalParams

Optional parameters.

JobsCreateOptionalParams

Optional parameters.

JobsDeleteOptionalParams

Optional parameters.

JobsGetOptionalParams

Optional parameters.

JobsListNextOptionalParams

Optional parameters.

JobsListOptionalParams

Optional parameters.

JobsUpdateOptionalParams

Optional parameters.

JpgFormat

Describes the settings for producing JPEG thumbnails.

JpgImage

Describes the properties for producing a series of JPEG images from the input video.

JpgLayer

Describes the settings to produce a JPEG image from the input video.

KeyDelivery
KeyVaultProperties
Layer

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.

ListContainerSasInput

The parameters to the list SAS request.

ListContentKeysResponse

Class of response for listContentKeys action

ListEdgePoliciesInput
ListPathsResponse

Class of response for listPaths action

ListStreamingLocatorsResponse

The Streaming Locators associated with this Asset.

LiveEvent

The live event.

LiveEventActionInput

The LiveEvent action input parameter definition.

LiveEventEncoding

Specifies the live event type and optional encoding settings for encoding live events.

LiveEventEndpoint

The live event endpoint.

LiveEventInput

The live event input.

LiveEventInputAccessControl

The IP access control for live event input.

LiveEventInputTrackSelection

A track selection condition. This property is reserved for future use, any value set on this property will be ignored.

LiveEventListResult

The LiveEvent list result.

LiveEventOutputTranscriptionTrack

Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored.

LiveEventPreview

Live event preview settings.

LiveEventPreviewAccessControl

The IP access control for the live event preview endpoint.

LiveEventTranscription

Describes the transcription tracks in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored.

LiveEvents

Interface representing a LiveEvents.

LiveEventsAllocateOptionalParams

Optional parameters.

LiveEventsAsyncOperationOptionalParams

Optional parameters.

LiveEventsCreateOptionalParams

Optional parameters.

LiveEventsDeleteOptionalParams

Optional parameters.

LiveEventsGetOptionalParams

Optional parameters.

LiveEventsListNextOptionalParams

Optional parameters.

LiveEventsListOptionalParams

Optional parameters.

LiveEventsOperationLocationOptionalParams

Optional parameters.

LiveEventsResetOptionalParams

Optional parameters.

LiveEventsStartOptionalParams

Optional parameters.

LiveEventsStopOptionalParams

Optional parameters.

LiveEventsUpdateOptionalParams

Optional parameters.

LiveOutput

The Live Output.

LiveOutputListResult

The LiveOutput list result.

LiveOutputs

Interface representing a LiveOutputs.

LiveOutputsAsyncOperationOptionalParams

Optional parameters.

LiveOutputsCreateOptionalParams

Optional parameters.

LiveOutputsDeleteOptionalParams

Optional parameters.

LiveOutputsGetOptionalParams

Optional parameters.

LiveOutputsListNextOptionalParams

Optional parameters.

LiveOutputsListOptionalParams

Optional parameters.

LiveOutputsOperationLocationOptionalParams

Optional parameters.

Locations

Interface representing a Locations.

LocationsCheckNameAvailabilityOptionalParams

Optional parameters.

LogSpecification

A diagnostic log emitted by service.

MediaService

A Media Services account.

MediaServiceCollection

A collection of MediaService items.

MediaServiceIdentity
MediaServiceOperationStatus

Status of media service operation.

MediaServiceUpdate

A Media Services account update.

MediaServicesOperationResults

Interface representing a MediaServicesOperationResults.

MediaServicesOperationResultsGetHeaders

Defines headers for MediaServicesOperationResults_get operation.

MediaServicesOperationResultsGetOptionalParams

Optional parameters.

MediaServicesOperationStatuses

Interface representing a MediaServicesOperationStatuses.

MediaServicesOperationStatusesGetOptionalParams

Optional parameters.

Mediaservices

Interface representing a Mediaservices.

MediaservicesCreateOrUpdateHeaders

Defines headers for Mediaservices_createOrUpdate operation.

MediaservicesCreateOrUpdateOptionalParams

Optional parameters.

MediaservicesDeleteOptionalParams

Optional parameters.

MediaservicesGetOptionalParams

Optional parameters.

MediaservicesListBySubscriptionNextOptionalParams

Optional parameters.

MediaservicesListBySubscriptionOptionalParams

Optional parameters.

MediaservicesListEdgePoliciesOptionalParams

Optional parameters.

MediaservicesListNextOptionalParams

Optional parameters.

MediaservicesListOptionalParams

Optional parameters.

MediaservicesSyncStorageKeysOptionalParams

Optional parameters.

MediaservicesUpdateHeaders

Defines headers for Mediaservices_update operation.

MediaservicesUpdateOptionalParams

Optional parameters.

MetricDimension

A metric dimension.

MetricSpecification

A metric emitted by service.

Mp4Format

Describes the properties for an output ISO MP4 file.

MultiBitrateFormat

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.

NoEncryption

Class for NoEncryption scheme

Operation

An operation.

OperationCollection

A collection of Operation items.

OperationDisplay

Operation details.

OperationResults

Interface representing a OperationResults.

OperationResultsGetHeaders

Defines headers for OperationResults_get operation.

OperationResultsGetOptionalParams

Optional parameters.

OperationStatuses

Interface representing a OperationStatuses.

OperationStatusesGetOptionalParams

Optional parameters.

Operations

Interface representing a Operations.

OperationsListOptionalParams

Optional parameters.

OutputFile

Represents an output file produced.

Overlay

Base type for all overlays - image, audio or video.

PngFormat

Describes the settings for producing PNG thumbnails.

PngImage

Describes the properties for producing a series of PNG images from the input video.

PngLayer

Describes the settings to produce a PNG image from the input video.

PresentationTimeRange

The presentation time range, this is asset related and not recommended for Account Filter.

Preset

Base type for all Presets, which define the recipe or instructions on how the input media files should be processed.

PresetConfigurations

An object of optional configuration settings for encoder.

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionListResult

List of private endpoint connection associated with the specified storage account

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Properties

The service specification property.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Rectangle

Describes the properties of a rectangular window applied to the input media before processing it.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceIdentity
SelectAudioTrackByAttribute

Select audio tracks from the input by specifying an attribute and an attribute filter.

SelectAudioTrackById

Select audio tracks from the input by specifying a track identifier.

SelectVideoTrackByAttribute

Select video tracks from the input by specifying an attribute and an attribute filter.

SelectVideoTrackById

Select video tracks from the input by specifying a track identifier.

ServiceSpecification

The service metric specifications.

StandardEncoderPreset

Describes all the settings to be used when encoding the input video with the Standard Encoder.

StorageAccount

The storage account details.

StorageEncryptedAssetDecryptionData

Data needed to decrypt asset files encrypted with legacy storage encryption.

StreamingEndpoint

The streaming endpoint.

StreamingEndpointAccessControl

Streaming endpoint access control definition.

StreamingEndpointListResult

The streaming endpoint list result.

StreamingEndpointSkuInfoListResult
StreamingEndpoints

Interface representing a StreamingEndpoints.

StreamingEndpointsAsyncOperationOptionalParams

Optional parameters.

StreamingEndpointsCreateOptionalParams

Optional parameters.

StreamingEndpointsDeleteOptionalParams

Optional parameters.

StreamingEndpointsGetOptionalParams

Optional parameters.

StreamingEndpointsListNextOptionalParams

Optional parameters.

StreamingEndpointsListOptionalParams

Optional parameters.

StreamingEndpointsOperationLocationOptionalParams

Optional parameters.

StreamingEndpointsScaleOptionalParams

Optional parameters.

StreamingEndpointsSkusOptionalParams

Optional parameters.

StreamingEndpointsStartOptionalParams

Optional parameters.

StreamingEndpointsStopOptionalParams

Optional parameters.

StreamingEndpointsUpdateOptionalParams

Optional parameters.

StreamingEntityScaleUnit

scale units definition

StreamingLocator

A Streaming Locator resource

StreamingLocatorCollection

A collection of StreamingLocator items.

StreamingLocatorContentKey

Class for content key in Streaming Locator

StreamingLocators

Interface representing a StreamingLocators.

StreamingLocatorsCreateOptionalParams

Optional parameters.

StreamingLocatorsDeleteOptionalParams

Optional parameters.

StreamingLocatorsGetOptionalParams

Optional parameters.

StreamingLocatorsListContentKeysOptionalParams

Optional parameters.

StreamingLocatorsListNextOptionalParams

Optional parameters.

StreamingLocatorsListOptionalParams

Optional parameters.

StreamingLocatorsListPathsOptionalParams

Optional parameters.

StreamingPath

Class of paths for streaming

StreamingPolicies

Interface representing a StreamingPolicies.

StreamingPoliciesCreateOptionalParams

Optional parameters.

StreamingPoliciesDeleteOptionalParams

Optional parameters.

StreamingPoliciesGetOptionalParams

Optional parameters.

StreamingPoliciesListNextOptionalParams

Optional parameters.

StreamingPoliciesListOptionalParams

Optional parameters.

StreamingPolicy

A Streaming Policy resource

StreamingPolicyCollection

A collection of StreamingPolicy items.

StreamingPolicyContentKey

Class to specify properties of content key

StreamingPolicyContentKeys

Class to specify properties of all content keys in Streaming Policy

StreamingPolicyFairPlayConfiguration

Class to specify configurations of FairPlay in Streaming Policy

StreamingPolicyPlayReadyConfiguration

Class to specify configurations of PlayReady in Streaming Policy

StreamingPolicyWidevineConfiguration

Class to specify configurations of Widevine in Streaming Policy

SyncStorageKeysInput

The input to the sync storage keys request.

SystemData

Metadata pertaining to creation and last modification of the resource.

TextTrack

Represents a text track in an asset. A text track is usually used for sparse data related to the audio or video tracks.

TrackBase

Base type for concrete track types. A derived type must be used to represent the Track.

TrackDescriptor

Base type for all TrackDescriptor types, which define the metadata and selection for tracks that should be processed by a Job

TrackPropertyCondition

Class to specify one track property condition

TrackSelection

Class to select a track

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Tracks

Interface representing a Tracks.

TracksCreateOrUpdateHeaders

Defines headers for Tracks_createOrUpdate operation.

TracksCreateOrUpdateOptionalParams

Optional parameters.

TracksDeleteHeaders

Defines headers for Tracks_delete operation.

TracksDeleteOptionalParams

Optional parameters.

TracksGetOptionalParams

Optional parameters.

TracksListOptionalParams

Optional parameters.

TracksUpdateHeaders

Defines headers for Tracks_update operation.

TracksUpdateOptionalParams

Optional parameters.

TracksUpdateTrackDataHeaders

Defines headers for Tracks_updateTrackData operation.

TracksUpdateTrackDataOptionalParams

Optional parameters.

Transform

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.

TransformCollection

A collection of Transform items.

TransformOutput

Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output.

Transforms

Interface representing a Transforms.

TransformsCreateOrUpdateOptionalParams

Optional parameters.

TransformsDeleteOptionalParams

Optional parameters.

TransformsGetOptionalParams

Optional parameters.

TransformsListNextOptionalParams

Optional parameters.

TransformsListOptionalParams

Optional parameters.

TransformsUpdateOptionalParams

Optional parameters.

TransportStreamFormat

Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output video file(s).

UserAssignedManagedIdentity
UtcClipTime

Specifies the clip time as a Utc time position in the media file. The Utc time can point to a different position depending on whether the media file starts from a timestamp of zero or not.

Video

Describes the basic properties for encoding the input video.

VideoAnalyzerPreset

A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file.

VideoLayer

Describes the settings to be used when encoding the input video into a desired output bitrate layer.

VideoOverlay

Describes the properties of a video overlay.

VideoTrack

Represents a video track in the asset.

VideoTrackDescriptor

A TrackSelection to select video tracks.

Type Aliases

AacAudioProfile

Defines values for AacAudioProfile.
KnownAacAudioProfile can be used interchangeably with AacAudioProfile, this enum contains the known values that the service supports.

Known values supported by the service

AacLc: Specifies that the output audio is to be encoded into AAC Low Complexity profile (AAC-LC).
HeAacV1: Specifies that the output audio is to be encoded into HE-AAC v1 profile.
HeAacV2: Specifies that the output audio is to be encoded into HE-AAC v2 profile.

AccountEncryptionKeyType

Defines values for AccountEncryptionKeyType.
KnownAccountEncryptionKeyType can be used interchangeably with AccountEncryptionKeyType, this enum contains the known values that the service supports.

Known values supported by the service

SystemKey: The Account Key is encrypted with a System Key.
CustomerKey: The Account Key is encrypted with a Customer Key.

AccountFiltersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AccountFiltersGetResponse

Contains response data for the get operation.

AccountFiltersListNextResponse

Contains response data for the listNext operation.

AccountFiltersListResponse

Contains response data for the list operation.

AccountFiltersUpdateResponse

Contains response data for the update operation.

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: An internal action.

AnalysisResolution

Defines values for AnalysisResolution.
KnownAnalysisResolution can be used interchangeably with AnalysisResolution, this enum contains the known values that the service supports.

Known values supported by the service

SourceResolution
StandardDefinition

AssetContainerPermission

Defines values for AssetContainerPermission.
KnownAssetContainerPermission can be used interchangeably with AssetContainerPermission, this enum contains the known values that the service supports.

Known values supported by the service

Read: The SAS URL will allow read access to the container.
ReadWrite: The SAS URL will allow read and write access to the container.
ReadWriteDelete: The SAS URL will allow read, write and delete access to the container.

AssetFiltersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AssetFiltersGetResponse

Contains response data for the get operation.

AssetFiltersListNextResponse

Contains response data for the listNext operation.

AssetFiltersListResponse

Contains response data for the list operation.

AssetFiltersUpdateResponse

Contains response data for the update operation.

AssetStorageEncryptionFormat

Defines values for AssetStorageEncryptionFormat.
KnownAssetStorageEncryptionFormat can be used interchangeably with AssetStorageEncryptionFormat, this enum contains the known values that the service supports.

Known values supported by the service

None: The Asset does not use client-side storage encryption (this is the only allowed value for new Assets).
MediaStorageClientEncryption: The Asset is encrypted with Media Services client-side encryption.

AssetsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AssetsGetEncryptionKeyResponse

Contains response data for the getEncryptionKey operation.

AssetsGetResponse

Contains response data for the get operation.

AssetsListContainerSasResponse

Contains response data for the listContainerSas operation.

AssetsListNextResponse

Contains response data for the listNext operation.

AssetsListResponse

Contains response data for the list operation.

AssetsListStreamingLocatorsResponse

Contains response data for the listStreamingLocators operation.

AssetsUpdateResponse

Contains response data for the update operation.

AsyncOperationStatus

Defines values for AsyncOperationStatus.
KnownAsyncOperationStatus can be used interchangeably with AsyncOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
InProgress

AttributeFilter

Defines values for AttributeFilter.
KnownAttributeFilter can be used interchangeably with AttributeFilter, this enum contains the known values that the service supports.

Known values supported by the service

All: All tracks will be included.
Top: The first track will be included when the attribute is sorted in descending order. Generally used to select the largest bitrate.
Bottom: The first track will be included when the attribute is sorted in ascending order. Generally used to select the smallest bitrate.
ValueEquals: Any tracks that have an attribute equal to the value given will be included.

AudioAnalysisMode

Defines values for AudioAnalysisMode.
KnownAudioAnalysisMode can be used interchangeably with AudioAnalysisMode, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Performs all operations included in the Basic mode, additionally performing language detection and speaker diarization.
Basic: This mode performs speech-to-text transcription and generation of a VTT subtitle/caption file. The output of this mode includes an Insights JSON file including only the keywords, transcription,and timing information. Automatic language detection and speaker diarization are not included in this mode.

AudioAnalyzerPresetUnion
AudioTrackDescriptorUnion
AudioUnion
BlurType

Defines values for BlurType.
KnownBlurType can be used interchangeably with BlurType, this enum contains the known values that the service supports.

Known values supported by the service

Box: Box: debug filter, bounding box only
Low: Low: box-car blur filter
Med: Med: Gaussian blur filter
High: High: Confuse blur filter
Black: Black: Black out filter

ChannelMapping

Defines values for ChannelMapping.
KnownChannelMapping can be used interchangeably with ChannelMapping, this enum contains the known values that the service supports.

Known values supported by the service

FrontLeft: The Front Left Channel.
FrontRight: The Front Right Channel.
Center: The Center Channel.
LowFrequencyEffects: Low Frequency Effects Channel. Sometimes referred to as the subwoofer.
BackLeft: The Back Left Channel. Sometimes referred to as the Left Surround Channel.
BackRight: The Back Right Channel. Sometimes referred to as the Right Surround Channel.
StereoLeft: The Left Stereo channel. Sometimes referred to as Down Mix Left.
StereoRight: The Right Stereo channel. Sometimes referred to as Down Mix Right.

ClipTimeUnion
CodecUnion
Complexity

Defines values for Complexity.
KnownComplexity can be used interchangeably with Complexity, this enum contains the known values that the service supports.

Known values supported by the service

Speed: Configures the encoder to use settings optimized for faster encoding. Quality is sacrificed to decrease encoding time.
Balanced: Configures the encoder to use settings that achieve a balance between speed and quality.
Quality: Configures the encoder to use settings optimized to produce higher quality output at the expense of slower overall encode time.

ContentKeyPoliciesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ContentKeyPoliciesGetPolicyPropertiesWithSecretsResponse

Contains response data for the getPolicyPropertiesWithSecrets operation.

ContentKeyPoliciesGetResponse

Contains response data for the get operation.

ContentKeyPoliciesListNextResponse

Contains response data for the listNext operation.

ContentKeyPoliciesListResponse

Contains response data for the list operation.

ContentKeyPoliciesUpdateResponse

Contains response data for the update operation.

ContentKeyPolicyConfigurationUnion
ContentKeyPolicyFairPlayRentalAndLeaseKeyType

Defines values for ContentKeyPolicyFairPlayRentalAndLeaseKeyType.
KnownContentKeyPolicyFairPlayRentalAndLeaseKeyType can be used interchangeably with ContentKeyPolicyFairPlayRentalAndLeaseKeyType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Represents a ContentKeyPolicyFairPlayRentalAndLeaseKeyType that is unavailable in current API version.
Undefined: Key duration is not specified.
DualExpiry: Dual expiry for offline rental.
PersistentUnlimited: Content key can be persisted with an unlimited duration
PersistentLimited: Content key can be persisted and the valid duration is limited by the Rental Duration value

ContentKeyPolicyPlayReadyContentKeyLocationUnion
ContentKeyPolicyPlayReadyContentType

Defines values for ContentKeyPolicyPlayReadyContentType.
KnownContentKeyPolicyPlayReadyContentType can be used interchangeably with ContentKeyPolicyPlayReadyContentType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Represents a ContentKeyPolicyPlayReadyContentType that is unavailable in current API version.
Unspecified: Unspecified content type.
UltraVioletDownload: Ultraviolet download content type.
UltraVioletStreaming: Ultraviolet streaming content type.

ContentKeyPolicyPlayReadyLicenseType

Defines values for ContentKeyPolicyPlayReadyLicenseType.
KnownContentKeyPolicyPlayReadyLicenseType can be used interchangeably with ContentKeyPolicyPlayReadyLicenseType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Represents a ContentKeyPolicyPlayReadyLicenseType that is unavailable in current API version.
NonPersistent: Non persistent license.
Persistent: Persistent license. Allows offline playback.

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Defines values for ContentKeyPolicyPlayReadyUnknownOutputPassingOption.
KnownContentKeyPolicyPlayReadyUnknownOutputPassingOption can be used interchangeably with ContentKeyPolicyPlayReadyUnknownOutputPassingOption, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Represents a ContentKeyPolicyPlayReadyUnknownOutputPassingOption that is unavailable in current API version.
NotAllowed: Passing the video portion of protected content to an Unknown Output is not allowed.
Allowed: Passing the video portion of protected content to an Unknown Output is allowed.
AllowedWithVideoConstriction: Passing the video portion of protected content to an Unknown Output is allowed but with constrained resolution.

ContentKeyPolicyRestrictionTokenKeyUnion
ContentKeyPolicyRestrictionTokenType

Defines values for ContentKeyPolicyRestrictionTokenType.
KnownContentKeyPolicyRestrictionTokenType can be used interchangeably with ContentKeyPolicyRestrictionTokenType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Represents a ContentKeyPolicyRestrictionTokenType that is unavailable in current API version.
Swt: Simple Web Token.
Jwt: JSON Web Token.

ContentKeyPolicyRestrictionUnion
CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DefaultAction

Defines values for DefaultAction.
KnownDefaultAction can be used interchangeably with DefaultAction, this enum contains the known values that the service supports.

Known values supported by the service

Allow: All public IP addresses are allowed.
Deny: Public IP addresses are blocked.

DeinterlaceMode

Defines values for DeinterlaceMode.
KnownDeinterlaceMode can be used interchangeably with DeinterlaceMode, this enum contains the known values that the service supports.

Known values supported by the service

Off: Disables de-interlacing of the source video.
AutoPixelAdaptive: Apply automatic pixel adaptive de-interlacing on each frame in the input video.

DeinterlaceParity

Defines values for DeinterlaceParity.
KnownDeinterlaceParity can be used interchangeably with DeinterlaceParity, this enum contains the known values that the service supports.

Known values supported by the service

Auto: Automatically detect the order of fields
TopFieldFirst: Apply top field first processing of input video.
BottomFieldFirst: Apply bottom field first processing of input video.

EncoderNamedPreset

Defines values for EncoderNamedPreset.
KnownEncoderNamedPreset can be used interchangeably with EncoderNamedPreset, this enum contains the known values that the service supports.

Known values supported by the service

H264SingleBitrateSD: Produces an MP4 file where the video is encoded with H.264 codec at 2200 kbps and a picture height of 480 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps.
H264SingleBitrate720p: Produces an MP4 file where the video is encoded with H.264 codec at 4500 kbps and a picture height of 720 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps.
H264SingleBitrate1080p: Produces an MP4 file where the video is encoded with H.264 codec at 6750 kbps and a picture height of 1080 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps.
AdaptiveStreaming: Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution, bitrate and frame rate. The auto-generated preset will never exceed the input resolution. For example, if the input is 720p, output will remain 720p at best.
AACGoodQualityAudio: Produces a single MP4 file containing only AAC stereo audio encoded at 192 kbps.
DDGoodQualityAudio: Produces a single MP4 file containing only DD(Digital Dolby) stereo audio encoded at 192 kbps.
ContentAwareEncodingExperimental: Exposes an experimental preset for content-aware encoding. Given any input content, the service attempts to automatically determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. The underlying algorithms will continue to evolve over time. The output will contain MP4 files with video and audio interleaved.
ContentAwareEncoding: Produces a set of GOP-aligned MP4s by using content-aware encoding. Given any input content, the service performs an initial lightweight analysis of the input content, and uses the results to determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. This preset is particularly effective for low and medium complexity videos, where the output files will be at lower bitrates but at a quality that still delivers a good experience to viewers. The output will contain MP4 files with video and audio interleaved.
CopyAllBitrateNonInterleaved: Copy all video and audio streams from the input asset as non-interleaved video and audio output files. This preset can be used to clip an existing asset or convert a group of key frame (GOP) aligned MP4 files as an asset that can be streamed.
H264MultipleBitrate1080p: Produces a set of 8 GOP-aligned MP4 files, ranging from 6000 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 1080p and goes down to 180p.
H264MultipleBitrate720p: Produces a set of 6 GOP-aligned MP4 files, ranging from 3400 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 720p and goes down to 180p.
H264MultipleBitrateSD: Produces a set of 5 GOP-aligned MP4 files, ranging from 1900kbps to 400 kbps, and stereo AAC audio. Resolution starts at 480p and goes down to 240p.
H265ContentAwareEncoding: Produces a set of GOP-aligned MP4s by using content-aware encoding. Given any input content, the service performs an initial lightweight analysis of the input content, and uses the results to determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. This preset is particularly effective for low and medium complexity videos, where the output files will be at lower bitrates but at a quality that still delivers a good experience to viewers. The output will contain MP4 files with video and audio interleaved.
H265AdaptiveStreaming: Produces a set of GOP aligned MP4 files with H.265 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution, bitrate and frame rate. The auto-generated preset will never exceed the input resolution. For example, if the input is 720p, output will remain 720p at best.
H265SingleBitrate720p: Produces an MP4 file where the video is encoded with H.265 codec at 1800 kbps and a picture height of 720 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps.
H265SingleBitrate1080p: Produces an MP4 file where the video is encoded with H.265 codec at 3500 kbps and a picture height of 1080 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps.
H265SingleBitrate4K: Produces an MP4 file where the video is encoded with H.265 codec at 9500 kbps and a picture height of 2160 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps.

EncryptionScheme

Defines values for EncryptionScheme.
KnownEncryptionScheme can be used interchangeably with EncryptionScheme, this enum contains the known values that the service supports.

Known values supported by the service

NoEncryption: NoEncryption scheme
EnvelopeEncryption: EnvelopeEncryption scheme
CommonEncryptionCenc: CommonEncryptionCenc scheme
CommonEncryptionCbcs: CommonEncryptionCbcs scheme

EntropyMode

Defines values for EntropyMode.
KnownEntropyMode can be used interchangeably with EntropyMode, this enum contains the known values that the service supports.

Known values supported by the service

Cabac: Context Adaptive Binary Arithmetic Coder (CABAC) entropy encoding.
Cavlc: Context Adaptive Variable Length Coder (CAVLC) entropy encoding.

FaceRedactorMode

Defines values for FaceRedactorMode.
KnownFaceRedactorMode can be used interchangeably with FaceRedactorMode, this enum contains the known values that the service supports.

Known values supported by the service

Analyze: Analyze mode detects faces and outputs a metadata file with the results. Allows editing of the metadata file before faces are blurred with Redact mode.
Redact: Redact mode consumes the metadata file from Analyze mode and redacts the faces found.
Combined: Combined mode does the Analyze and Redact steps in one pass when editing the analyzed faces is not desired.

FilterTrackPropertyCompareOperation

Defines values for FilterTrackPropertyCompareOperation.
KnownFilterTrackPropertyCompareOperation can be used interchangeably with FilterTrackPropertyCompareOperation, this enum contains the known values that the service supports.

Known values supported by the service

Equal: The equal operation.
NotEqual: The not equal operation.

FilterTrackPropertyType

Defines values for FilterTrackPropertyType.
KnownFilterTrackPropertyType can be used interchangeably with FilterTrackPropertyType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: The unknown track property type.
Type: The type.
Name: The name.
Language: The language.
FourCC: The fourCC.
Bitrate: The bitrate.

FormatUnion
H264Complexity

Defines values for H264Complexity.
KnownH264Complexity can be used interchangeably with H264Complexity, this enum contains the known values that the service supports.

Known values supported by the service

Speed: Tells the encoder to use settings that are optimized for faster encoding. Quality is sacrificed to decrease encoding time.
Balanced: Tells the encoder to use settings that achieve a balance between speed and quality.
Quality: Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time.

H264RateControlMode

Defines values for H264RateControlMode.
KnownH264RateControlMode can be used interchangeably with H264RateControlMode, this enum contains the known values that the service supports.

Known values supported by the service

ABR: Average Bitrate (ABR) mode that hits the target bitrate: Default mode.
CBR: Constant Bitrate (CBR) mode that tightens bitrate variations around target bitrate.
CRF: Constant Rate Factor (CRF) mode that targets at constant subjective quality.

H264VideoProfile

Defines values for H264VideoProfile.
KnownH264VideoProfile can be used interchangeably with H264VideoProfile, this enum contains the known values that the service supports.

Known values supported by the service

Auto: Tells the encoder to automatically determine the appropriate H.264 profile.
Baseline: Baseline profile
Main: Main profile
High: High profile.
High422: High 4:2:2 profile.
High444: High 4:4:4 predictive profile.

H265Complexity

Defines values for H265Complexity.
KnownH265Complexity can be used interchangeably with H265Complexity, this enum contains the known values that the service supports.

Known values supported by the service

Speed: Tells the encoder to use settings that are optimized for faster encoding. Quality is sacrificed to decrease encoding time.
Balanced: Tells the encoder to use settings that achieve a balance between speed and quality.
Quality: Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time.

H265VideoProfile

Defines values for H265VideoProfile.
KnownH265VideoProfile can be used interchangeably with H265VideoProfile, this enum contains the known values that the service supports.

Known values supported by the service

Auto: Tells the encoder to automatically determine the appropriate H.265 profile.
Main: Main profile (https://x265.readthedocs.io/en/default/cli.html?highlight=profile#profile-level-tier)
Main10: Main 10 profile (https://en.wikipedia.org/wiki/High_Efficiency_Video_Coding#Main_10)

ImageFormatUnion
ImageUnion
InputDefinitionUnion
InsightsType

Defines values for InsightsType.
KnownInsightsType can be used interchangeably with InsightsType, this enum contains the known values that the service supports.

Known values supported by the service

AudioInsightsOnly: Generate audio only insights. Ignore video even if present. Fails if no audio is present.
VideoInsightsOnly: Generate video only insights. Ignore audio if present. Fails if no video is present.
AllInsights: Generate both audio and video insights. Fails if either audio or video Insights fail.

InterleaveOutput

Defines values for InterleaveOutput.
KnownInterleaveOutput can be used interchangeably with InterleaveOutput, this enum contains the known values that the service supports.

Known values supported by the service

NonInterleavedOutput: The output is video-only or audio-only.
InterleavedOutput: The output includes both audio and video.

JobErrorCategory

Defines values for JobErrorCategory.
KnownJobErrorCategory can be used interchangeably with JobErrorCategory, this enum contains the known values that the service supports.

Known values supported by the service

Service: The error is service related.
Download: The error is download related.
Upload: The error is upload related.
Configuration: The error is configuration related.
Content: The error is related to data in the input files.
Account: The error is related to account information.

JobErrorCode

Defines values for JobErrorCode.
KnownJobErrorCode can be used interchangeably with JobErrorCode, this enum contains the known values that the service supports.

Known values supported by the service

ServiceError: Fatal service error, please contact support.
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support.
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source.
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source.
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination.
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination.
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration.
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files.
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files.
IdentityUnsupported: There was an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support.

JobInputClipUnion
JobInputUnion
JobOutputUnion
JobRetry

Defines values for JobRetry.
KnownJobRetry can be used interchangeably with JobRetry, this enum contains the known values that the service supports.

Known values supported by the service

DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected.
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job.

JobState

Defines values for JobState.
KnownJobState can be used interchangeably with JobState, this enum contains the known values that the service supports.

Known values supported by the service

Canceled: The job was canceled. This is a final state for the job.
Canceling: The job is in the process of being canceled. This is a transient state for the job.
Error: The job has encountered an error. This is a final state for the job.
Finished: The job is finished. This is a final state for the job.
Processing: The job is processing. This is a transient state for the job.
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state.
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states.

JobsCreateResponse

Contains response data for the create operation.

JobsGetResponse

Contains response data for the get operation.

JobsListNextResponse

Contains response data for the listNext operation.

JobsListResponse

Contains response data for the list operation.

JobsUpdateResponse

Contains response data for the update operation.

LiveEventEncodingType

Defines values for LiveEventEncodingType.
KnownLiveEventEncodingType can be used interchangeably with LiveEventEncodingType, this enum contains the known values that the service supports.

Known values supported by the service

None: This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated.
Standard: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution.
Premium1080p: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution.
PassthroughBasic: The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available.
PassthroughStandard: The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed.

LiveEventInputProtocol

Defines values for LiveEventInputProtocol.
KnownLiveEventInputProtocol can be used interchangeably with LiveEventInputProtocol, this enum contains the known values that the service supports.

Known values supported by the service

FragmentedMP4: Smooth Streaming input will be sent by the contribution encoder to the live event.
RTMP: RTMP input will be sent by the contribution encoder to the live event.

LiveEventResourceState

Defines values for LiveEventResourceState.
KnownLiveEventResourceState can be used interchangeably with LiveEventResourceState, this enum contains the known values that the service supports.

Known values supported by the service

Stopped: This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed.
Allocating: Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state.
StandBy: Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state.
Starting: The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state.
Running: The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing.
Stopping: The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state.
Deleting: The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state.

LiveEventsAsyncOperationResponse

Contains response data for the asyncOperation operation.

LiveEventsCreateResponse

Contains response data for the create operation.

LiveEventsGetResponse

Contains response data for the get operation.

LiveEventsListNextResponse

Contains response data for the listNext operation.

LiveEventsListResponse

Contains response data for the list operation.

LiveEventsOperationLocationResponse

Contains response data for the operationLocation operation.

LiveEventsUpdateResponse

Contains response data for the update operation.

LiveOutputResourceState

Defines values for LiveOutputResourceState.
KnownLiveOutputResourceState can be used interchangeably with LiveOutputResourceState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Live output is being created. No content is archived in the asset until the live output is in running state.
Running: Live output is running and archiving live streaming content to the asset if there is valid input from a contribution encoder.
Deleting: Live output is being deleted. The live asset is being converted from live to on-demand asset. Any streaming URLs created on the live output asset continue to work.

LiveOutputsAsyncOperationResponse

Contains response data for the asyncOperation operation.

LiveOutputsCreateResponse

Contains response data for the create operation.

LiveOutputsGetResponse

Contains response data for the get operation.

LiveOutputsListNextResponse

Contains response data for the listNext operation.

LiveOutputsListResponse

Contains response data for the list operation.

LiveOutputsOperationLocationResponse

Contains response data for the operationLocation operation.

LocationsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

MediaServicesOperationResultsGetResponse

Contains response data for the get operation.

MediaServicesOperationStatusesGetResponse

Contains response data for the get operation.

MediaservicesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

MediaservicesGetResponse

Contains response data for the get operation.

MediaservicesListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

MediaservicesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

MediaservicesListEdgePoliciesResponse

Contains response data for the listEdgePolicies operation.

MediaservicesListNextResponse

Contains response data for the listNext operation.

MediaservicesListResponse

Contains response data for the list operation.

MediaservicesUpdateResponse

Contains response data for the update operation.

MetricAggregationType

Defines values for MetricAggregationType.
KnownMetricAggregationType can be used interchangeably with MetricAggregationType, this enum contains the known values that the service supports.

Known values supported by the service

Average: The average.
Count: The count of a number of items, usually requests.
Total: The sum.

MetricUnit

Defines values for MetricUnit.
KnownMetricUnit can be used interchangeably with MetricUnit, this enum contains the known values that the service supports.

Known values supported by the service

Bytes: The number of bytes.
Count: The count.
Milliseconds: The number of milliseconds.

MultiBitrateFormatUnion
OnErrorType

Defines values for OnErrorType.
KnownOnErrorType can be used interchangeably with OnErrorType, this enum contains the known values that the service supports.

Known values supported by the service

StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped.
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue.

OperationResultsGetResponse

Contains response data for the get operation.

OperationStatusesGetResponse

Contains response data for the get operation.

OperationsListResponse

Contains response data for the list operation.

OverlayUnion
PresetUnion
Priority

Defines values for Priority.
KnownPriority can be used interchangeably with Priority, this enum contains the known values that the service supports.

Known values supported by the service

Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs.
Normal: Used for TransformOutputs that can be generated at Normal priority.
High: Used for TransformOutputs that should take precedence over others.

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

PrivateEndpointConnectionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list operation.

PrivateEndpointServiceConnectionStatus

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

PrivateLinkResourcesGetResponse

Contains response data for the get operation.

PrivateLinkResourcesListResponse

Contains response data for the list operation.

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Failed: Provisioning state failed.
InProgress: Provisioning state in progress.
Succeeded: Provisioning state succeeded.

PublicNetworkAccess

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Public network access is enabled.
Disabled: Public network access is disabled.

Rotation

Defines values for Rotation.
KnownRotation can be used interchangeably with Rotation, this enum contains the known values that the service supports.

Known values supported by the service

Auto: Automatically detect and rotate as needed.
None: Do not rotate the video. If the output format supports it, any metadata about rotation is kept intact.
Rotate0: Do not rotate the video but remove any metadata about the rotation.
Rotate90: Rotate 90 degrees clockwise.
Rotate180: Rotate 180 degrees clockwise.
Rotate270: Rotate 270 degrees clockwise.

SecurityLevel

Defines values for SecurityLevel.
KnownSecurityLevel can be used interchangeably with SecurityLevel, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Represents a SecurityLevel that is unavailable in current API version.
SL150: For clients under development or test. No protection against unauthorized use.
SL2000: For hardened devices and applications consuming commercial content. Software or hardware protection.
SL3000: For hardened devices only. Hardware protection.

StorageAccountType

Defines values for StorageAccountType.
KnownStorageAccountType can be used interchangeably with StorageAccountType, this enum contains the known values that the service supports.

Known values supported by the service

Primary: The primary storage account for the Media Services account.
Secondary: A secondary storage account for the Media Services account.

StorageAuthentication

Defines values for StorageAuthentication.
KnownStorageAuthentication can be used interchangeably with StorageAuthentication, this enum contains the known values that the service supports.

Known values supported by the service

System: System authentication.
ManagedIdentity: Managed Identity authentication.

StreamOptionsFlag

Defines values for StreamOptionsFlag.
KnownStreamOptionsFlag can be used interchangeably with StreamOptionsFlag, this enum contains the known values that the service supports.

Known values supported by the service

Default: Live streaming with no special latency optimizations.
LowLatency: The live event provides lower end to end latency by reducing its internal buffers.
LowLatencyV2: The live event is optimized for end to end latency. This option is only available for encoding live events with RTMP input. The outputs can be streamed using HLS or DASH formats. The outputs' archive or DVR rewind length is limited to 6 hours. Use "LowLatency" stream option for all other scenarios.

StreamingEndpointResourceState

Defines values for StreamingEndpointResourceState.
KnownStreamingEndpointResourceState can be used interchangeably with StreamingEndpointResourceState, this enum contains the known values that the service supports.

Known values supported by the service

Stopped: The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint.
Starting: The streaming endpoint is transitioning to the running state.
Running: The streaming endpoint is running. It is able to stream content to clients
Stopping: The streaming endpoint is transitioning to the stopped state.
Deleting: The streaming endpoint is being deleted.
Scaling: The streaming endpoint is increasing or decreasing scale units.

StreamingEndpointsAsyncOperationResponse

Contains response data for the asyncOperation operation.

StreamingEndpointsCreateResponse

Contains response data for the create operation.

StreamingEndpointsGetResponse

Contains response data for the get operation.

StreamingEndpointsListNextResponse

Contains response data for the listNext operation.

StreamingEndpointsListResponse

Contains response data for the list operation.

StreamingEndpointsOperationLocationResponse

Contains response data for the operationLocation operation.

StreamingEndpointsSkusResponse

Contains response data for the skus operation.

StreamingEndpointsUpdateResponse

Contains response data for the update operation.

StreamingLocatorContentKeyType

Defines values for StreamingLocatorContentKeyType.
KnownStreamingLocatorContentKeyType can be used interchangeably with StreamingLocatorContentKeyType, this enum contains the known values that the service supports.

Known values supported by the service

CommonEncryptionCenc: Common Encryption using CENC
CommonEncryptionCbcs: Common Encryption using CBCS
EnvelopeEncryption: Envelope Encryption

StreamingLocatorsCreateResponse

Contains response data for the create operation.

StreamingLocatorsGetResponse

Contains response data for the get operation.

StreamingLocatorsListContentKeysResponse

Contains response data for the listContentKeys operation.

StreamingLocatorsListNextResponse

Contains response data for the listNext operation.

StreamingLocatorsListPathsResponse

Contains response data for the listPaths operation.

StreamingLocatorsListResponse

Contains response data for the list operation.

StreamingPoliciesCreateResponse

Contains response data for the create operation.

StreamingPoliciesGetResponse

Contains response data for the get operation.

StreamingPoliciesListNextResponse

Contains response data for the listNext operation.

StreamingPoliciesListResponse

Contains response data for the list operation.

StreamingPolicyStreamingProtocol

Defines values for StreamingPolicyStreamingProtocol.
KnownStreamingPolicyStreamingProtocol can be used interchangeably with StreamingPolicyStreamingProtocol, this enum contains the known values that the service supports.

Known values supported by the service

Hls: HLS protocol
Dash: DASH protocol
SmoothStreaming: SmoothStreaming protocol
Download: Download protocol

StretchMode

Defines values for StretchMode.
KnownStretchMode can be used interchangeably with StretchMode, this enum contains the known values that the service supports.

Known values supported by the service

None: Strictly respect the output resolution without considering the pixel aspect ratio or display aspect ratio of the input video.
AutoSize: Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9.
AutoFit: Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right.

TrackAttribute

Defines values for TrackAttribute.
KnownTrackAttribute can be used interchangeably with TrackAttribute, this enum contains the known values that the service supports.

Known values supported by the service

Bitrate: The bitrate of the track.
Language: The language of the track.

TrackBaseUnion
TrackDescriptorUnion
TrackPropertyCompareOperation

Defines values for TrackPropertyCompareOperation.
KnownTrackPropertyCompareOperation can be used interchangeably with TrackPropertyCompareOperation, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown track property compare operation
Equal: Equal operation

TrackPropertyType

Defines values for TrackPropertyType.
KnownTrackPropertyType can be used interchangeably with TrackPropertyType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown track property
FourCC: Track FourCC

TracksCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

TracksDeleteResponse

Contains response data for the delete operation.

TracksGetResponse

Contains response data for the get operation.

TracksListResponse

Contains response data for the list operation.

TracksUpdateResponse

Contains response data for the update operation.

TracksUpdateTrackDataResponse

Contains response data for the updateTrackData operation.

TransformsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

TransformsGetResponse

Contains response data for the get operation.

TransformsListNextResponse

Contains response data for the listNext operation.

TransformsListResponse

Contains response data for the list operation.

TransformsUpdateResponse

Contains response data for the update operation.

VideoSyncMode

Defines values for VideoSyncMode.
KnownVideoSyncMode can be used interchangeably with VideoSyncMode, this enum contains the known values that the service supports.

Known values supported by the service

Auto: This is the default method. Chooses between Cfr and Vfr depending on muxer capabilities. For output format MP4, the default mode is Cfr.
Passthrough: The presentation timestamps on frames are passed through from the input file to the output file writer. Recommended when the input source has variable frame rate, and are attempting to produce multiple layers for adaptive streaming in the output which have aligned GOP boundaries. Note: if two or more frames in the input have duplicate timestamps, then the output will also have the same behavior
Cfr: Input frames will be repeated and/or dropped as needed to achieve exactly the requested constant frame rate. Recommended when the output frame rate is explicitly set at a specified value
Vfr: Similar to the Passthrough mode, but if the input has frames that have duplicate timestamps, then only one frame is passed through to the output, and others are dropped. Recommended when the number of output frames is expected to be equal to the number of input frames. For example, the output is used to calculate a quality metric like PSNR against the input

VideoTrackDescriptorUnion
VideoUnion
Visibility

Defines values for Visibility.
KnownVisibility can be used interchangeably with Visibility, this enum contains the known values that the service supports.

Known values supported by the service

Hidden: The track is hidden to video player.
Visible: The track is visible to video player.

Enums

KnownAacAudioProfile

Known values of AacAudioProfile that the service accepts.

KnownAccountEncryptionKeyType

Known values of AccountEncryptionKeyType that the service accepts.

KnownActionType

Known values of ActionType that the service accepts.

KnownAnalysisResolution

Known values of AnalysisResolution that the service accepts.

KnownAssetContainerPermission

Known values of AssetContainerPermission that the service accepts.

KnownAssetStorageEncryptionFormat

Known values of AssetStorageEncryptionFormat that the service accepts.

KnownAsyncOperationStatus

Known values of AsyncOperationStatus that the service accepts.

KnownAttributeFilter

Known values of AttributeFilter that the service accepts.

KnownAudioAnalysisMode

Known values of AudioAnalysisMode that the service accepts.

KnownBlurType

Known values of BlurType that the service accepts.

KnownChannelMapping

Known values of ChannelMapping that the service accepts.

KnownComplexity

Known values of Complexity that the service accepts.

KnownContentKeyPolicyFairPlayRentalAndLeaseKeyType

Known values of ContentKeyPolicyFairPlayRentalAndLeaseKeyType that the service accepts.

KnownContentKeyPolicyPlayReadyContentType

Known values of ContentKeyPolicyPlayReadyContentType that the service accepts.

KnownContentKeyPolicyPlayReadyLicenseType

Known values of ContentKeyPolicyPlayReadyLicenseType that the service accepts.

KnownContentKeyPolicyPlayReadyUnknownOutputPassingOption

Known values of ContentKeyPolicyPlayReadyUnknownOutputPassingOption that the service accepts.

KnownContentKeyPolicyRestrictionTokenType

Known values of ContentKeyPolicyRestrictionTokenType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDefaultAction

Known values of DefaultAction that the service accepts.

KnownDeinterlaceMode

Known values of DeinterlaceMode that the service accepts.

KnownDeinterlaceParity

Known values of DeinterlaceParity that the service accepts.

KnownEncoderNamedPreset

Known values of EncoderNamedPreset that the service accepts.

KnownEncryptionScheme

Known values of EncryptionScheme that the service accepts.

KnownEntropyMode

Known values of EntropyMode that the service accepts.

KnownFaceRedactorMode

Known values of FaceRedactorMode that the service accepts.

KnownFilterTrackPropertyCompareOperation

Known values of FilterTrackPropertyCompareOperation that the service accepts.

KnownFilterTrackPropertyType

Known values of FilterTrackPropertyType that the service accepts.

KnownH264Complexity

Known values of H264Complexity that the service accepts.

KnownH264RateControlMode

Known values of H264RateControlMode that the service accepts.

KnownH264VideoProfile

Known values of H264VideoProfile that the service accepts.

KnownH265Complexity

Known values of H265Complexity that the service accepts.

KnownH265VideoProfile

Known values of H265VideoProfile that the service accepts.

KnownInsightsType

Known values of InsightsType that the service accepts.

KnownInterleaveOutput

Known values of InterleaveOutput that the service accepts.

KnownJobErrorCategory

Known values of JobErrorCategory that the service accepts.

KnownJobErrorCode

Known values of JobErrorCode that the service accepts.

KnownJobRetry

Known values of JobRetry that the service accepts.

KnownJobState

Known values of JobState that the service accepts.

KnownLiveEventEncodingType

Known values of LiveEventEncodingType that the service accepts.

KnownLiveEventInputProtocol

Known values of LiveEventInputProtocol that the service accepts.

KnownLiveEventResourceState

Known values of LiveEventResourceState that the service accepts.

KnownLiveOutputResourceState

Known values of LiveOutputResourceState that the service accepts.

KnownMetricAggregationType

Known values of MetricAggregationType that the service accepts.

KnownMetricUnit

Known values of MetricUnit that the service accepts.

KnownOnErrorType

Known values of OnErrorType that the service accepts.

KnownPriority

Known values of Priority that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownRotation

Known values of Rotation that the service accepts.

KnownSecurityLevel

Known values of SecurityLevel that the service accepts.

KnownStorageAccountType

Known values of StorageAccountType that the service accepts.

KnownStorageAuthentication

Known values of StorageAuthentication that the service accepts.

KnownStreamOptionsFlag

Known values of StreamOptionsFlag that the service accepts.

KnownStreamingEndpointResourceState

Known values of StreamingEndpointResourceState that the service accepts.

KnownStreamingLocatorContentKeyType

Known values of StreamingLocatorContentKeyType that the service accepts.

KnownStreamingPolicyStreamingProtocol

Known values of StreamingPolicyStreamingProtocol that the service accepts.

KnownStretchMode

Known values of StretchMode that the service accepts.

KnownTrackAttribute

Known values of TrackAttribute that the service accepts.

KnownTrackPropertyCompareOperation

Known values of TrackPropertyCompareOperation that the service accepts.

KnownTrackPropertyType

Known values of TrackPropertyType that the service accepts.

KnownVideoSyncMode

Known values of VideoSyncMode that the service accepts.

KnownVisibility

Known values of Visibility that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.